Doxygen: Ein Kommentar für mehrere Defines

Gast #2157198
Hallo!

Ich mache gerade meine ersten Gehversuche in Doxygen und stieß gleich 
auf ein Problem:

Ich möchte einen globalen Kommentar für mehrere defines (später auch 
mehrere Variablen oder Funktionen) machen.

So was in der Art:

//!Die folgenden Macros entkoppen den Taktgeber von der Basisfrequenz
#define AX1  (PL*73)
#define AXZ  (PL*67)
#define ATZ  (PL*68)


Das soll dann nicht nur das erste Marko kommentieren, sondern für alle 
gelten. Also in Doxygen irgendwie so aussehen:

Defines:

Die folgenden Macros entkoppen den Taktgeber von der Basisfrequenz
#define AX1  (PL*73)
#define AXZ  (PL*67)
#define ATZ  (PL*67)

Geht so was überhaupt?

Gruß

Hans
Gast #2157493
Probier mal das:

/**
 * @name Taktgeber
 * Die folgenden Macros entkoppen den Taktgeber von der Basisfrequenz
 * @{
 */

#define AX1  (PL*73)
#define AXZ  (PL*67)
#define ATZ  (PL*68)

/** @} */
Gast #2157699
Hallo Rolf,

vielen Dank, das ist es!
Das es irgendwie mit "Grouping" zu tun haben muß, hatte ich mir schon 
gedacht, leider habe ich aber das "C++-lastige" Beispiel in der 
Dokumentation nicht geblickt.

Danke

Hans
Gast #2231152
Hans schrieb:
> Ich mache gerade meine ersten Gehversuche in Doxygen und stieß gleich
> auf ein Problem:

Dito.. :(

Rolf Magnus schrieb:
> /**
>  * @name Taktgeber
>  * Die folgenden Macros entkoppen den Taktgeber von der Basisfrequenz
>  * @{
>  */
>
> #define AX1  (PL*73)
> #define AXZ  (PL*67)
> #define ATZ  (PL*68)
>
> /** @} */


Wie fasst man die #defines für die "Define Documentation" zusammen?
Wenn ich das so schreiben würde:
/**
 * Die folgenden Macros entkoppen den Taktgeber von der Basisfrequenz
 * @{
 */

#define AX1  (PL*73)
#define AXZ  (PL*67)
#define ATZ  (PL*68)

/** @} */

werden die nicht zusammengefasst.

Viele Grüße
Jürgen

Antwort schreiben

Eine eigene Frage? Dieser Thread ist über 15 Jahre alt. Stell sie in einem eigenen Thread – dort lesen mehr Leute mit, und sie wird öfter und schneller beantwortet.

Neuen Thread starten

Eine Lösung, Ergänzung oder Rückmeldung zu diesem Thread? Dann antworte hier.

Formatierung
  • [c]C-Code[/c]
  • [code]Code in anderen Sprachen, ASCII-Zeichnungen[/code]
  • [math]Formel in LaTeX-Syntax[/math]
  • [[Titel]] – Link zu einem Artikel
  • Verweis auf einen anderen Beitrag: Rechtsklick auf dessen Beitrags-ID (#8078628), „Adresse kopieren“, in den Text einfügen

Mehr zur Formatierung

Längeren Sourcecode als Anhang, nicht in den Text. JPG nur für Fotos und Scans; Zeichnungen und Screenshots als PNG oder GIF. Siehe Bildformate.

Schon registriert? Anmelden

Wird nicht angezeigt. Wir schicken dir einen Link; sobald du damit bestätigst, erscheint dein Beitrag.

Mit dem Abschicken legst du einen kostenlosen Account an und erkennst die Nutzungsbedingungen und die Datenschutzerklärung an.