Anzeige

 [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:
C++:
+ 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
Java:
+ 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:
Java:
+ 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
 
#2
Moinsen,

großes Kino ...
Java:
+ 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
 
#3
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
 
#6
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 :D

Nochmals Danke :cool:
Gruß Klaus

BTW: ABSCHLIESSEN klappt hier nicht mehr ???
 
#10
Moin Sheel,

ja, das hatte ich befürchtet ... :cool:

Ich sehe den Haken zwar, aber läßt sich nicht anklicken :eek:
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
 
#11
Ah so, jetzt versteh ich den Grund der Verwirrung erst :)

Der Haken ist nicht anklickbar und nur sichtbar, wenn das
Thema schon als erledigt markiert wurde, als Signal dafür.

Der Link, um es zu setzen, verschwindet nach Klick (bisschen
blöd, aber so ists); aufheben erfordert paar Mausklicks mehr.

Habs gerade aufgehoben, jetzt findest du den Link dann wieder unter dem Titel eher auf der rechten Seite
 
#12
Ah, ok - Danke !
Ist aber wirklich seeeeeeehr gut versteckt :p
Kann man das nicht irgendwo bei letzten/aktuellen Beitrage 'anbringen' ??

Das bedeutet, dass Du es zuvor auf "erledigt" gesetzt hattest??
Also ich war es bestimmt nicht :D

Danke und Gruß
Klaus
 
Anzeige

Neue Beiträge

Anzeige