+ Antworten
Ergebnis 1 bis 5 von 5

Thema: [Java] doxygen mainpage: Methodenreferenz verlinken

  1. #1
    User Kilobyte Themenstarter
    Avatar von vfl_freak
    Registriert seit
    01.08.2013
    Ort
    Osnabrück
    Fachbeiträge
    210
    Genannt
    9 Post(s)
    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++ Code:
    1.  
    2. + 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 Code:
    1.  
    2. + 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 Code:
    1.  
    2. + KOMANDO_XYZ: com::abc::xyz::myFabulousClass::myMethod
    3. + KOMANDO_XYZ: com::abc::xyz::myFabulousClass::myMethod()
    4. + 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 ...
    Java Code:
    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
    Der Pessimist sagt: "Schlimmer kann es nicht mehr werden ..." - Der Optimist sagt: "DOCH, es kann!!"

  2. #2
    Frequent User Halbes Megabyte Avatar von mogel
    Registriert seit
    01.08.2013
    Ort
    Geheimversteck
    Fachbeiträge
    654
    Genannt
    93 Post(s)
    Zitat Zitat von vfl_freak Beitrag anzeigen
    funktioniert schon, aber nur dann, wenn "myMethod" public deklariert ist ....
    macht Sinn - Du kannst aber auch irgendwo die Sichtbarkeit zur Dokumentation anpassen
    Internal Development and Investment Optimization Trainer
    [Java] doxygen mainpage: Methodenreferenz verlinken

    TreeDo - die clevere ToDo-Liste - 2:0

  3. #3
    Global Moderator Floppy Disc
    Registriert seit
    30.07.2013
    Fachbeiträge
    847
    Genannt
    112 Post(s)
    Zitat Zitat von vfl_freak Beitrag anzeigen
    Anderfalls wird sie gar von Doxygen beachtet
    Wozu auch, ist ein Implementierungsdetail, koenntest genausogut den Quelltext ausdrucken :/
    Macht JavaDoc genauso..
    Maven is never completely installed

  4. #4
    User Kilobyte Themenstarter
    Avatar von vfl_freak
    Registriert seit
    01.08.2013
    Ort
    Osnabrück
    Fachbeiträge
    210
    Genannt
    9 Post(s)
    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
    Der Pessimist sagt: "Schlimmer kann es nicht mehr werden ..." - Der Optimist sagt: "DOCH, es kann!!"

  5. #5
    User Kilobyte Themenstarter
    Avatar von vfl_freak
    Registriert seit
    01.08.2013
    Ort
    Osnabrück
    Fachbeiträge
    210
    Genannt
    9 Post(s)
    yeep - habe hier (https://www.stack.nl/~dimitri/doxyge...xtract_private) passende Parameter gefunden und auch erfolgreich eingesetzt

    Danke und Gruß
    Klaus
    Der Pessimist sagt: "Schlimmer kann es nicht mehr werden ..." - Der Optimist sagt: "DOCH, es kann!!"

+ Antworten Thema als "gelöst" markieren

Direkt antworten Direkt antworten

Nenne das erste Element im Periodensystem der Elemente?

Aktive Benutzer

Aktive Benutzer

Aktive Benutzer in diesem Thema: 1 (Registrierte Benutzer: 0, Gäste: 1)

Ähnliche Themen

  1. Antworten: 2
    Letzter Beitrag: 02.09.2014, 14:43
  2. [DoxyGen]: ungewollte Zeilenumbrüche in Kommentaren
    Von vfl_freak im Forum Allgemeine Themen
    Antworten: 2
    Letzter Beitrag: 04.04.2014, 10:56
  3. Java mit Doxygen dokumentieren
    Von noch_anfaenger im Forum Java-Grundlagen
    Antworten: 3
    Letzter Beitrag: 16.10.2009, 12:15

Berechtigungen

  • Neue Themen erstellen: Ja
  • Themen beantworten: Ja
  • Anhänge hochladen: Nein
  • Beiträge bearbeiten: Nein
  •