Step by Step Anleitung für Doxygen und PHP gesucht

[Forumsgast]

Ich habe Doxygen installiert und einige meiner PHP files mit den entsprechenden Tags versehen.

Nun hätte ich gehofft, dass in der Dokumentation (die Files sind alle in der Doku gelandet) z.B. eine Sektioon "Functions" wäre, in der ich alle Funktionen finden kann, die definiert wurden.

Nun finde ich unter "files/file members/function" meine Funktionen. ok.

Allerdings ist die Art der Doku weit weg von dem, was ich mir vorgestellt hatte (siehe Bilder).

Ich mache irgendwas falsch, komme aber durch Lese der Doku nicht weiter.

Frage daher, ob es vielleicht ein Tutorila gibt, das speziell für PHP files gemacht wurde und die nötigen Doku-Einträge erklärt.

1000 Dank
jwka

[Forumsgast]

Deine Kommentare sind nicht sauber. Lies dir mal http://www.stack.nl/~dimitri/doxygen/starting.html ff. durch da findest du alles. Doxygen generiert für meinen Zweck (siehe http://files.adventure-php-framework...tml/index.html) sehr schöne Dokumentationen.

[Forumsgast]

Beispiele gesucht

Hallo Dr.e.

es ist mir schon klar, dass ICH irgendwelche Fehler mache bei den Kommentaren oder bei der Einleitung der Kommentare oder bei der Konfiguration ... nur: welche?

Ich habe auch die Doku gelesen, aber ich werde nicht so recht schlau daraus. Es ist ja vieles für C/C++ und auch für Python beschrieben und da kriege ich den Link nicht zu PHP (wo ich ja auch noch kein Profi bin).

Oft ist's ja bei solchen Sachen ein minimaler Hinweis, der dann die Erleuchtung bringt und man in Meilenstiefeln endlich weiter kommt.

Daher suche ich nach einem PHP file, der "für Doxygen" korrekt und umfangreich kommentiert ist, um zu sehen, was aus dem PHP-File wohin in der Doku kommt und wo wohl mein Fehler steckt.

Vielleicht kannst Du mir einen der PHP Files als link senden, in dem Du besonders viele Doku reingepackt hast? Und evtl. auch den Config File hochladen, damit ich den gegen meinen vergleichen kann.

Danke
jwka

[Forumsgast]

Hi,

das APF steht unter http://adventure-php-framework.org/Seite/008-Downloads für jeden frei zum Download zur Verfügung. In den Files (z.B. apps/core/pagecontroller/pagecontroller.php) kannst du dir die Semantik der Kommentare und unter http://files.adventure-php-framework...tml/index.html den Output ansehen. Kommentierst du wie in den Files des APF zu sehen, erhälst du auch eine entsprechende Ausgabe. Ein Sample-File findest du unter http://media.adventure-php-framework...n_example.conf.

[Forumsgast]

Hi,

danke für die schnelle Antwort! Habe mir das reingezogen und muss sagen, dass ich ein bischen enttäuscht bin vom Output - bis jetzt.

Mag sein, dass es an PHP liegt. Wahrscheinlich werde ich nicht drum herum kommen, mich tiefer einzulesen, denn ich hätte mir gewünscht, dass "auf oberster Ebene" auch Funktionsdefinitionen zu finden sind, "parallel" zu "Files", "Directories" etc. und dass man Funktionen nochmals zusätzlich strukturieren kann.

Auch, dass bestimme "Tags" einen eigenen /** ... */ Kasten brauchen (z.B. Package) weil sonst "der Rest" nicht dem Tag zugeordnet wird, was später kommt, ist m.E. nicht gut dokumentiert.

Aber erstmal 1000 Dank für die Hilfe!

jwka

[Forumsgast]

Hallo jwka,

ich verstehe dein Problem nicht. Code sollte ohnehin vernünftig dokumentiert werden und on das nun per /* ... */ oder /** ... */ passiert ist doch zweitrangig. Da du sowohl in PHP als auch in anderen Programmiersprachen Konstrukte in Dateien mischen kannst, braucht der doxygen-Parser einen Hint, welcher DOC-Block zu welchem Element gehört. Ziehst du das konsequent durch ist der Output sehr reichhaltig (siehe Link zur APF-API). Ganz frei nach dem Motto: garbage in garbage out!