1. Diese Seite verwendet Cookies. Wenn du dich weiterhin auf dieser Seite aufhältst, akzeptierst du unseren Einsatz von Cookies. Weitere Informationen

[Java] doxygen mainpage: Methodenreferenz verlinken

Dieses Thema im Forum "Sonstige Sprachen" wurde erstellt von vfl_freak, 15. Februar 2016.

  1. vfl_freak

    vfl_freak Premium-User

    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:
    Code (C++):
    1. + 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
    Code (Java):
    1. + 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:
    Code (Java):
    1. + KOMANDO_XYZ: com::abc::xyz::myFabulousClass::myMethod
    2. + KOMANDO_XYZ: com::abc::xyz::myFabulousClass::myMethod()
    3. + 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. vfl_freak

    vfl_freak Premium-User

    Moinsen,

    großes Kino ...
    Code (Java):
    1. + 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
     
    sheel gefällt das.
  3. vfl_freak

    vfl_freak Premium-User

    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
     
  4. sheel

    sheel I love Asm Administrator

    vfl_freak gefällt das.
  5. vfl_freak

    vfl_freak Premium-User

    Moin Sheel,

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

    Danke und Gruß
    Klaus
     
  6. vfl_freak

    vfl_freak Premium-User

    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 ???
     
  7. sheel

    sheel I love Asm Administrator

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

    vfl_freak Premium-User

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

    sheel I love Asm Administrator

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

    vfl_freak Premium-User

    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. sheel

    sheel I love Asm Administrator

    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
     
    vfl_freak gefällt das.
  12. vfl_freak

    vfl_freak Premium-User

    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
     
  13. sheel

    sheel I love Asm Administrator

    Da das Menü auch automatisch generiert wird und der Code nicht gerade einfach wartbar ist, eher unwarscheinlich.

    Könnte sein, weiß es nicht mehr :D
     
  14. vfl_freak

    vfl_freak Premium-User

    Ok, dann hat es sich (wohl endgültig) erledigt *grins* :cool:
     
Die Seite wird geladen...