[Java] doxygen mainpage: Methodenreferenz verlinken


#1

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 :frowning:
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

*** Edit ***

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 :grr:

Hat sich also erledigt !
Gruß Klaus


#2

macht Sinn - Du kannst aber auch irgendwo die Sichtbarkeit zur Dokumentation anpassen


#3

Wozu auch, ist ein Implementierungsdetail, koenntest genausogut den Quelltext ausdrucken :confused:
Macht JavaDoc genauso…


#4

Moin,

nun ja, wir wollen die Doxygen-Kommentierung über einen WebSpace einem größeren Personenkreis zugänglich machen, da bei uns ein komplettes Reengeniering angestossen werden soll …
Und da wäre es schon nett, zu den einzelnen Kommandos direkt an die relevanten Stellen verzweigen zu können!

Aber die Sichtbarkeit muss ich mal prüfen, sagt mir so spontaqn nichts - Danke an Mogel

Gruß Klaus


#5

yeep - habe hier (https://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_extract_private) passende Parameter gefunden und auch erfolgreich eingesetzt :lol:

Danke und Gruß
Klaus