Doxygen standard labels

[Alexander Kornrumpf]

Hi!

Wie kann ich mit doxygen Standardabschnitte referenzieren?

Beispiel:

\ref todo

funktioniert. Das Label der todoList ist offensichtlich "todo".

Wie lauten die Labels der anderen Abschnitte die erzeugt werden? google nach "doxygen ref" ist offensichtlich keine so gute Idee.

[grid]

Hi,

vielleicht hilft dir ja dies hier weiter: http://www.doxygen.nl/commands.html#cmdxrefitem
Dmnach sind noch die Listen bug, test und deprecated vordefiniert.

Ansonsten kannst du zu jedem element mit dem namen eine Referenz einfügen. Sofern das nicht sowieso schon automatisch passiert. Vgl. http://www.doxygen.nl/commands.html#cmdpage

Welche Standardabschnitte meinst du denn?

Gruß
GriD

[Alexander Kornrumpf]

Zum Beispiel Examples. \ref examples funktioniert aber scheints nicht.

Ziel ist sinngemäß folgendes machen zu können:

"If you want to improve this software have a look at the \ref todo" <- geht, wird zu "...at the Todo-List".
"For some examples cf. \ref examples" <- geht nicht.


Trotzdem Danke.

[grid]

Ja leider muss man bei doxygen manchmal einen Umweg gehen, wenn an etwas verlinken will. Aber es geht.

Zwei Möglichkeiten, welche im Prinzip dasselbe machen:

1. An der Stelle, an der ein Link zu der Examples-Seite (leider keine Liste/Section) einfach folgenden Text einfügen:

Code: Alles auswählen

<a href="./examples.html">See Examples</a> 

Das ist leider etwas umständlich, deswegen der zweite Vorschlag:

2. In der Konfigurations- Datei einen Alias definieren [1]. Das müsste dann so aussehen:

Code: Alles auswählen

  ALIASES += se="<a href=\"./examples.html\">See Examples</a> 

Dann kannst du mit \se den link einfügen lassen. In den Aliasen kannst du beliebig HTML und doxygen Code schreiben und auch Parameter einfügen. An der Stelle, an der du mit \example my_examples.cpp auf ein Beispiel verweist wird ja sowieso ein link hinzugefügt.



[1] http://www.stack.nl/~dimitri/doxygen/custcmd.html

[Alexander Kornrumpf]

Ich hätte dazu sagen sollen, dass ich auch den latex output von doxygen verwenden möchte :(

Aber für den HTML Teil ist das schonmal eine gute Lösung, danke!