✔ [Java] doxygen mainpage: Methodenreferenz verlinken

[vfl_freak]

Hallo zusammen,

wir haben hier in der Firma vor einigen Monaten beschlossen, doxygen zur Dokumentation des Codes unserer Client/Server-Architektur einzusetzen. Nachdem ich jetzt einige C++-Projekte erfolgreich ungesetzt habe, bin ich Java/Eclipse auf ein dummes Hindernis bei Schreiben der mainpage gestossen ...

Wirr wollen dort jeweils eine Auflistung der verfügbaren Kommandos darstellen und dabei für jedes Kommando eine Link direkt zur entsprechenden Methode einfügen.

In C++ hat sauber funktioniert:

+ KOMANDO_XYZ: myFabulousClass::myMethod

Hiermit wurde ein Link erzeugt, der direkt die Methode "myMethod" in der Klasse "myFabulousClass" anzeigte!

Nun unter Java klappt das offensichtlich nicht! Die gleiche Eingabe erzeugt keine Verlinkung
Mit keiner Verlinkung meine ich, dass einfach nur der Text geschrieben wird!

Ich bekomme zwar mit voller Qualifizierung

+ KOMANDO_XYZ: com::abc::xyz::myFabulousClass

einen Link auf die Klasse, komme aber von da nicht weiter zur bestimmten Methode innerhalb dieser Klasse.

Das folgende schlägt alles fehl:

+ KOMANDO_XYZ: com::abc::xyz::myFabulousClass::myMethod
+ KOMANDO_XYZ: com::abc::xyz::myFabulousClass::myMethod()
+ KOMANDO_XYZ: com::abc::xyz::myFabulousClass::myMethod( ... myParameter ... )

"\ref" darf an der Stelle auch nicht verwendet werden, gibt einen entsprechenden Fehler beim übersetzen.
"@see" liefert mir zwar die (ander Stelle sehr unschöne) neue Zeile mit der Einleitung "siehe auch", aber auch hierbei ist das Ziel nicht verlinkt ...

Hat jemand eine Idee, wie sich dies unter Java umsetzen läßt?
Gibt es ggf. einen Befehl oder eine Option, die nicht kenne ??

Danke und Gruß
Klaus

 

[vfl_freak]

Moinsen,

großes Kino ...

+ KOMANDO_XYZ: com::abc::xyz::myFabulousClass::myMethod

funktioniert schon, aber nur dann, wenn "myMethod" public deklariert ist ....
Anderfalls wird sie gar von Doxygen beachtet

Hat sich also erledigt !
Gruß Klaus

 

[vfl_freak]

Moin,
habe jetzt in einem anderen Forum noch den Tipp bekommen, dass man 'möglicherweise' die Sichtbarkeit zur Dokumentation ändern könne, was mir aber spntan nichts sagt!
Hat vlt. irgendwer dazu eine Idee ??
Danke und Gruß
Klaus

 

[sheel]

Was ist denn mit EXTRACT_PRIVATE=YES ?
https://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_extract_private

 

[vfl_freak]

Moin Sheel,

ok, das klingt nach einem Ansatz
Werde es mal ausprobieren und dann berichten !

Danke und Gruß
Klaus

 

[vfl_freak]

Hi Sheel,

so, habe eben ein wenig rumgefrickelt und die Einstellungen im Wizard gefunden!
Es klappt

Ich lasse es jetzt sogar mit EXTRACT_ALL laufen ..... dann kann ich dokumentieren bis der Arzt kommt

Nochmals Danke
Gruß Klaus

BTW: ABSCHLIESSEN klappt hier nicht mehr ???

 

[sheel]

Was soll denn abgeschlossen werden?
Falls du die Erledigt-Markierung meinst, die ist schon da.

 

[vfl_freak]

ja, die würde ich meinen ... nur wo finde ich sie ???

 

[sheel]

Ganz oben, links vom Titel des Themas, ist ein grüner Haken,
Auch in der Threadliste sichtbar.

 

[vfl_freak]

Moin Sheel,

ja, das hatte ich befürchtet ...

Ich sehe den Haken zwar, aber läßt sich nicht anklicken
Sieht aus wie ein normales Icon ... (FF 44.0.2)

EDIT: in der Liste scheint es ein Filter für Posts mit diesem 'Icon' zu sein ....

Gruß Klaus