it-swarm.com.de

So verwenden Sie Eclox, das Doxygen-Plugin für Eclipse

Wie kann ich Eclox in Eclipse 3.5 zum Laufen bringen?

Ich verwende Ubuntu 9.04. Ich habe Doxygen von Ubuntu-Repositories (Version 1.5.8) installiert. Dann habe ich Eclox über die Update-Site auf Eclipse installiert.

Trotzdem bekomme ich in keinem Menü die Möglichkeit, es einzuleiten.

Auch die eclox-Site scheint keine Anleitung für den Einstieg zu haben.

Bitte helfen.

22
ruwan.jayaweera

Egal, ich habe es herausgefunden.

Zuerst müssen Sie eine DoxyFile (die Konfigurationsdatei) erstellen, indem Sie den Quellpfad und den Ausgabepfad angeben.

Dann können nur Sie die Dokumentation erstellen, indem Sie mit der rechten Maustaste auf das Projekt klicken und die Option "Dokumentation erstellen" auswählen.

Danke trotzdem!

16
ruwan.jayaweera

Übrigens gibt es in org.gna.eclox_0.8.0.jar ein Handbuch, obwohl sie dies nicht auf der Projektseite gepostet haben !!!

Hier ist der Inhalt

      Eclox, a Doxygen frontend plugin for Eclipse.
            <http://gna.org/projects/eclox>
  1. INSTALLATION

    Es gibt zwei Möglichkeiten, das Plugin zu installieren: über die Update-Site oder über Über die Paketfunktion.

    Die Update-Site ist der bequemere Weg, um Eclox zu installieren. Es befindet sich Unter https://anb0s.github.io/eclox . Weitere Informationen finden Sie in Eclipse-Benutzer Guilde.

    Wenn Sie die Paketfunktion verwenden, müssen Sie den Archivinhalt in das Stammverzeichnis Ihrer Eclipse-Site extrahieren. Weitere Informationen finden Sie in der Eclipse-Bedienungsanleitung.

  2. AUFBAU

    Sobald das Plugin installiert ist, müssen Sie sicherstellen, dass die Standardvariable PATH-Umgebung Die doxygen-Binärdatei für das Plugin erreichbar macht. Wenn nicht, können Sie PATH aktualisieren, um das Verzeichnis in die Doxygen-Binärdatei aufzunehmen, oder Sie können Eclox mitteilen, wo sich diese Binärdatei auf Ihrem System befindet (was meiner Meinung nach die bessere Lösung ist). Öffnen Sie dazu das Voreinstellungsdialogfenster von Eclipse Und gehen Sie in den neuen Abschnitt "Doxygen".

  3. VERWENDUNGSZWECK

    Sie können neue Doxygen-Projekte (auch Doxyfiles genannt) mit dem Assistenten für die Erstellung von .__ erstellen. Gehen Sie zu "Datei-> Neu-> Andere-> Andere-> Doxygen-Konfiguration". Drücken Sie __.next und legen Sie den Speicherort und den Namen der Datei fest. Dann wird eine leere doxy-Datei Am angegebenen Ort erstellt. Der Assistent fügt automatisch die Erweiterung ". Doxyfile" hinzu.

    Sie sollten jetzt eine Datei mit einem blauen @ -sign-Symbol sehen. Dies ist Ihre neue Doxyfile. Ein Doppelklick darauf öffnet den Editor. Sie können nun die Einstellungen durchsuchen und bearbeiten.

    Nachdem Sie alle Doxyfile-Felder ordnungsgemäß festgelegt haben, können Sie eine -Dokumentationserstellung über das Symbol der Symbolleiste mit einem blauen @ -Zeichen starten. In Falls die Schaltfläche nicht in der Symbolleiste angezeigt wird, muss Ihre aktuelle Perspektive Konfiguriert werden. Gehen Sie zu "Fenster-> Perspektive anpassen-> Befehle" undin "Verfügbare Befehlsgruppen", aktivieren Sie "Doxygen". Außerdem können Sie die Laetest-Builds durchsuchen, indem Sie auf den Abwärtspfeil rechts neben der Symbolleistenschaltfläche klicken.

    Wenn der Dokumentations-Build gestartet wird, wird eine neue Ansicht mit dem Build-Protokoll geöffnet ... In seiner Symbolleiste kann über eine Schaltfläche mit dem Namen "Stop" der aktuelle Build-Prozess angehalten werden. Der aktuelle Build wird auch in der Eclipse-Auftragsfortschrittsansicht angezeigt und Sie können den Job von dort aus steuern.

    Die Build-Symbolleistenaktion bestimmt die nächste zu erstellende doxy-Datei, abhängig von Dem aktuell aktiven Workbench-Teil (Editor oder Ansicht) und der aktuellen Auswahlin diesem Teil. Wenn der aktive Teil beispielsweise ein Doxyfile-Editor ist, wird die nächste zu erstellende Doxyfile-Datei bearbeitet. Wenn der aktive Teil der Ressourcen-Explorer ist und die aktuelle Auswahl eine doxy-Datei ist, wird diese doxy-Datei als nächste aufgerufen. Falls die Auswahl des aktiven Teils nicht mit einer Doxydatei übereinstimmt, wird die zuletzt erstellte Doxydatei neu erstellt. Wenn die Build-Historie leer ist, werden Sie nach der zu erstellenden doxy-Datei gefragt.

HTH Jedermann

28
siva.p

Ich hatte gerade ein Problem beim Einstellen des Doxygen-Binärpfads in Eclox 0.8.0-Einstellungen in Eclipse unter Mac OS X 10.7 ..__ Es gibt keine Möglichkeit, den Pfad über Eclipse-Voreinstellungen) zu konfigurieren-> Doxygen.

Die Lösung besteht darin, die Voreinstellungsdatei manuell zu bearbeiten

  1. fügen Sie einen (falschen) Ort hinzu, sagen wir /Applications, indem Sie den oben genannten Assistenten verwenden.
  2. schließen Sie Eclipse
  3. bearbeiten Sie diese Datei: $WORKSPACE/.metadata/.plugins/org.Eclipse.core.runtime/.settings/org.gna.eclox.core.prefs: Ersetzen Sie den Wert für doxygen.default (derzeit eclox.core.doxygen.CustomDoxygen /Applications\n) durch eclox.core.doxygen.CustomDoxygen /Applications/Doxygen.app/Contents/Resources/doxygen\n.
  4. starten Sie Eclipse erneut
3
klaus

Für MacOS-Benutzer gibt es eine sehr einfache Möglichkeit, sich mit der Ausgabe der Doxygen-Version fortzubewegen. Der Link, der Details enthält, ist hier: https://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse

Nach der Installation des Eclox-Plugging:

1) "gehe zu" Eclipse -> Preferences -> Oxygen " 2)" Drücke Shift + CMD + G und füge hinzu: "/Applications/Doxygen.app/Contents/Resources/doxygen"3 Doxygens Version sollte angezeigt werden

1
MickaelT

Wie Claus musste ich maual in die Voreinstellungsdatei hineingraben, da Eclox 0.8.0 einfach keinen guten Pfad aus dem Eclipse-Voreinstellungs-Dateiaussteller .. __ nehmen würde. Bearbeiten Sie diese Datei: $WORKSPACE/.metadata/.plugins/org.Eclipse.core.runtime/.settings/org.gna.eclox.core.prefs und ändern Sie den angegebenen Pfad ( In meinem Fall musste ich wechseln 

doxygen.default=eclox.core.doxygen.CustomDoxygen C\:\\Programm Files\\doxygen\\bin

zu diesem 

doxygen.default=eclox.core.doxygen.CustomDoxygen C\:\\Programme\\doxygen\\bin

Hoffe das hilft.

0
goeck

Ich finde eine Webseite https://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse , auf der Sie weitere Details finden. Für Mac-Benutzer müssen Sie insbesondere Drücken Sie Umschalt + CMD + G und dann Hinzufügen: "/Applications/Doxygen.app/Contents/Resources/doxygen", wenn Sie das Doxygen in Eclipse konfigurieren, bevor Sie die .doxygfile mithilfe von Eclox kompilieren .

0
Yong Yang

Alternativ zu Eclipse verwenden Sie Javadoc :

  1. Aus dem Menü (... Suche Projektlauf ...)

Projekt> Javadoc generieren

  1. Sie sollten sich in einem Java-Projekt befinden und Kommentare mit Tags hinzufügen.

!!!

0

dies kann Ihnen oder jedem Windows-Benutzer helfen, der versucht, Eclox zu installieren:

Anleitung zum Installieren von eclox - Document Transcript

Schritt 1: Gehen Sie zur eclox-Website ( http://home.gna.org/eclox/ ) und kopieren Sie den Update-Link address.Step 

schritt 2: Fügen Sie den Link in den Update Manager in Eclipse ein und drücken Sie OK.

Schritt 3: Wählen Sie das Eclox-Element aus und schließen Sie die Installation ab.

Schritt 4: Wenn die Installation abgeschlossen ist, sollten Sie ein Projekt auswählen, in dem Sie die Sauerstoffdokumente erstellen möchten. Dann erstellen Sie ein Doxygen-Projekt dafür.

Schritt 5: Konfigurieren Sie die Optionen. Hinweis: Sie müssen die „Eingabeverzeichnisse“ korrekt angeben und den Punkt „Rekursiv scannen“ auswählen. Speichern Sie schließlich die Konfigurationsdatei.

Schritt 6: Finden Sie das "@" und wählen Sie "Choose Doxyfile ...".

Schritt 7: Wählen Sie ein doxyfile aus. Schritt 8: Warten Sie einige Sekunden, bis die Dubletten generiert werden.

sein von diesem Link: http://www.slideshare.net/pickerweng/tutorial-for-installing-eclox

0
j2emanue