|
|
|
Wie mit Doxygen dokumentieren? |
|
| Gast |
|
 |
Beiträge: ---
|
|
|
|
Anmeldedatum: ---
|
|
|
|
Wohnort: ---
|
|
|
|
Version: ---
|
|
|
|
 |
|
Verfasst am: 08.07.2013, 10:19
Titel: Wie mit Doxygen dokumentieren?
|
 |
| |
 |
 |
Hallo zusammen!
Ich habe folgendes Problem. Ich möchte eine Dokumentation (oder wenigstens irgendetwas in die Richtung) zu einem Matlab code mit Doxygen erstellen.
Ich habe auch alle erforderlichen Programme heruntergeladen (denke ich), aber keine Ahnung wie ich diese jetzt anwende. Ich habe Doxygen und Perl. Benötige ich noch etwas anderes?
Es gibt zwar einige Tutorials im Internet, die besagen, wie man die benötigten Sachen installieren soll, ich habe aber keines gefunden, das zeigt, wie man sie dann tatsächlich anwendet.
Die Situation in dem script, für das ich gerne die Dokumentation hätte sieht wie folgt aus.
Es gibt eine main-Methode, in der auf mehrere andere Methoden zugegriffen wird. Diese Methoden stehen alle in dem gleichen Skript.
Vor jeder Methode ist ein Kommentarblock a la:
So habe ich die Syntax in gewissen tutorials geshen. Ist das richtig so? Was brauche ich noch und wie benutze ich doxygen dann letztenendes?
Ich hoffe mein Problem ist klargeworden und ihr könnt mir helfen.
|
|
|
|
|
|
| Jan S |
Moderator
|
|
Beiträge: 11.057
|
|
|
|
Anmeldedatum: 08.07.10
|
|
|
|
Wohnort: Heidelberg
|
|
|
|
Version: 2009a, 2016b
|
|
|
|
|
|
|
Verfasst am: 08.07.2013, 10:51
Titel: Re: Wie mit Doxygen dokumentieren?
|
|
|
|
|
| Gast |
|
|
Beiträge: ---
|
|
|
|
Anmeldedatum: ---
|
|
|
|
Wohnort: ---
|
|
|
|
Version: ---
|
|
|
|
|
|
|
Verfasst am: 08.07.2013, 10:56
Titel:
|
|
Sorry,
ja in dieser Weise habe ich doxygen installiert wobei ich mir nicht sicher war, wo das doxyfile überall hin muss, bzw. welches doxyfile ich wo mit welchem ersetzen muss (bezogen auf diese Stelle:)
| Zitat: |
get the Doxyfile file from the C:\DoxygenMatlbab directory and replace the default Doxyfile provided by Doxygen
|
Ich hoffe, ich enthalte euch nicht noch mehr notwendige Informationen vor und ihr könnt mir jetzt helfen.
|
|
|
|
| Mmmartina |
Forum-Meister
|
|
Beiträge: 745
|
|
|
|
Anmeldedatum: 30.10.12
|
|
|
|
Wohnort: hier
|
|
|
|
Version: R2020a
|
|
|
|
|
|
|
Verfasst am: 08.07.2013, 11:37
Titel:
|
|
| |
|
|
So ganz weiß ich nicht, was du schon probiert hast und wo genau du hängst.
Ich versuche es mal grob, da es bei mir auch schon locker 5 Jahre her ist, dass ich das letzte Mal mit Doxygen gearbeitet habe:
Doxygen ist ein recht "simples" Programm, welches (fast) beliebigen Quellcode nach Schlüsselwörten durchsucht und daraus eine Doku aufbaut.
Die Einstellungen tätigst du direkt in einer Doxygen-Datei (mir fällt der name dieser nicht mehr ein) mit einem Text-editor. Dazu sollte es auch nähere Informationen im Internet geben, was welche Einstellung bedeutet.
Diese Datei ist aber der dreh-und-angelpunkt der ganzen Sache. Da kommt der Pfad rein, der Titel, was durchsucht werden soll, in welcher Tiefe/detailiertheit, was erstellt werden soll, etc.
Das müsste soweit ich mich noch erinnern kann, so passen. Du musst halt vor jeder Funktion solch einen Header einfügen und alles passend ausfüllen. Dann Doxygen drüber laufen lassen - fertig.
_________________
LG
Martina
"Wenn wir bedenken, daß wir alle verrückt sind, ist das Leben erklärt." (Mark Twain))
|
|
|
|
| Gast |
|
|
Beiträge: ---
|
|
|
|
Anmeldedatum: ---
|
|
|
|
Wohnort: ---
|
|
|
|
Version: ---
|
|
|
|
|
|
|
Verfasst am: 08.07.2013, 12:25
Titel:
|
|
| Zitat: |
Die Einstellungen tätigst du direkt in einer Doxygen-Datei (mir fällt der name dieser nicht mehr ein) mit einem Text-editor. Dazu sollte es auch nähere Informationen im Internet geben, was welche Einstellung bedeutet.
|
Genau dazu habe ich nichts gefunden. Kennt jemand dazu ein Tutorial? Ich finde immer nur den kleinen aufgeführten Ausschnitt...
| Zitat: |
| Dann Doxygen drüber laufen lassen - fertig. |
Genau da liegt mein Hauptproblem. Ich verstehe die Handhabung von doxygen nicht und weiß nicht, was ich machen muss, damit es "drüber läuft".
Hoffe mein Problem ist klarer geworden.
|
|
|
|
| Mmmartina |
Forum-Meister
|
|
Beiträge: 745
|
|
|
|
Anmeldedatum: 30.10.12
|
|
|
|
Wohnort: hier
|
|
|
|
Version: R2020a
|
|
|
|
|
|
|
Verfasst am: 08.07.2013, 20:13
Titel:
|
|
| |
|
|
| Anonymous hat Folgendes geschrieben: |
| Zitat: |
Die Einstellungen tätigst du direkt in einer Doxygen-Datei (mir fällt der name dieser nicht mehr ein) mit einem Text-editor. Dazu sollte es auch nähere Informationen im Internet geben, was welche Einstellung bedeutet.
|
Genau dazu habe ich nichts gefunden. Kennt jemand dazu ein Tutorial? Ich finde immer nur den kleinen aufgeführten Ausschnitt... |
Aber die Doxygenseite kennst du?
Da steht eigentlich alles, was man braucht.
http://www.stack.nl/~dimitri/doxygen/manual/index.html
Zum config-file findest du dort etwas unter configuration. Im Zweifel kopier mal eine der Zeilen ins google und suche danach -> dann bekommst du als beispiel andere doxygen-config-files.
| Anonymous hat Folgendes geschrieben: |
| Zitat: |
| Dann Doxygen drüber laufen lassen - fertig. |
Genau da liegt mein Hauptproblem. Ich verstehe die Handhabung von doxygen nicht und weiß nicht, was ich machen muss, damit es "drüber läuft".
Hoffe mein Problem ist klarer geworden. |
oben angebene Website -> Doxygen usage
_________________
LG
Martina
"Wenn wir bedenken, daß wir alle verrückt sind, ist das Leben erklärt." (Mark Twain))
|
|
|
|
| Perluser |
Gast
|
|
Beiträge: ---
|
|
|
|
Anmeldedatum: ---
|
|
|
|
Wohnort: ---
|
|
|
|
Version: ---
|
|
|
|
|
|
|
Verfasst am: 04.06.2014, 06:49
Titel:
|
|
| |
|
|
Hallo,
ich kann den Threaderöffner nur zustimmen. Die Installation und Handhabung von doxygen ist meiner Meinung nach eine kleine Katastrophe.
Ich möchte das Programm als Perl Dokumentationswerkzeug nutzen.
Bei der Installation des Filters habe ich mir ziemlich einen abgebrochen. Dazu kommt: Ich kann im Wizard immer noch nicht "Perl" auswählen sondern (hoffe) das alles erfolgreich installiert wurde. Muss aber zwangsweise im doxygen Wizard "Optimiert für PHP oder C einstellen" ...?
Ich schaffe es bis jetzt alle Variablen und nahezu alle subroutines auszulesen, die dann auch in der HTML Doku angezeigt werden.
- doxygen Kommentare werden nicht erkannt. Außer ich benutze C Commands (#include XY.h) und ich habe extra 1:1 Kommentare aus einer doxygen Perl Filter Doku genutzt
- An die hübschen Diagramme denke ich erst gar nicht. Würde Sie aber gerne sehen
Hat da jemand Erfahrung und weiß warum z.B. die Kommentare nicht ausglesen werden? Wenn ich die Datei doxygen-filter-perl aus meinem Doxygen-Filter-Perl-1.62.tar.gz als Input_Filter nutze, dann ließt mir das Programm nur meine Dateistrukturen aus und nicht mal mehr die Variablen....
Kann da jemand helfen?
|
|
|
|
| Perluser |
Gast
|
|
Beiträge: ---
|
|
|
|
Anmeldedatum: ---
|
|
|
|
Wohnort: ---
|
|
|
|
Version: ---
|
|
|
|
|
|
|
Verfasst am: 04.06.2014, 07:53
Titel:
|
|
Ich habe einen Teilerfolg erzielen können. Als Input_Filter nicht direkt die Datei aus dem tar.gz angeben sondern die Datei, welche ins Perl Verzeichnis durch das "make" aufgelöst wurde. Klingt logisch, muss man aber erstmal finden ...
Weniger Fehlermeldungen mehr Ergebnis!
Werd jetzt mal schauen wie die Diagramme funktionieren.
|
|
|
|
| Perluser |
Gast
|
|
Beiträge: ---
|
|
|
|
Anmeldedatum: ---
|
|
|
|
Wohnort: ---
|
|
|
|
Version: ---
|
|
|
|
|
|
|
Verfasst am: 04.06.2014, 08:52
Titel:
|
|
Ich habs! "Einfach" im Wizard->Expert Reiter-> Have Dot anhaken -> dann den Pfad zum graphviz in -> DOT_PATH eintragen (../Program Files (x86)/Graphviz2.38/bin)
Vielleicht hilft es ja jemanden mit ähnlichen Problemen.
Gruß!
|
|
|
|
|
|
|
Einstellungen und Berechtigungen
|
|
Du kannst Beiträge in dieses Forum schreiben.
Du kannst auf Beiträge in diesem Forum antworten.
Du kannst deine Beiträge in diesem Forum nicht bearbeiten.
Du kannst deine Beiträge in diesem Forum nicht löschen.
Du kannst an Umfragen in diesem Forum nicht mitmachen.
Du kannst Dateien in diesem Forum posten
Du kannst Dateien in diesem Forum herunterladen
|
|
Impressum
| Nutzungsbedingungen
| Datenschutz
| FAQ
|  RSS
Hosted by:
Copyright © 2007 - 2024
goMatlab.de | Dies ist keine offizielle Website der Firma The Mathworks
MATLAB, Simulink, Stateflow, Handle Graphics, Real-Time Workshop, SimBiology, SimHydraulics, SimEvents, and xPC TargetBox are registered trademarks and The MathWorks, the L-shaped membrane logo, and Embedded MATLAB are trademarks of The MathWorks, Inc.
|
|
