Forum: PC-Programmierung Doxygen: Ein Kommentar für mehrere Defines


von Hans (Gast)


Lesenswert?

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

von Rolf Magnus (Gast)


Lesenswert?

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)

/** @} */

von Hans (Gast)


Lesenswert?

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

von Vlad T. (vlad_tepesch)


Lesenswert?

gab es nicht einen \copydoc befehl oder sowas, der die Dok. des 
benannten objekltes Kopiert

von Jürgen M. (Gast)


Lesenswert?

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

von Troll (Gast)


Lesenswert?

Ich weiß nicht obs daran liegt, aber oben steht noch:

* @name Taktgeber

direkt nach dem /**.

Bei dir fehlt das.

Bitte melde dich an um einen Beitrag zu schreiben. Anmeldung ist kostenlos und dauert nur eine Minute.
Bestehender Account
Schon ein Account bei Google/GoogleMail? Keine Anmeldung erforderlich!
Mit Google-Account einloggen
Noch kein Account? Hier anmelden.