FPDoc - Eine Datei für ein Paket

[Socke]

Hallo zusammen,

die aktuelle Situation: für ein Package mit mehreren Units habe ich eine einzige FPDoc-Dokumentations-XML-Datei. Im Dokumentationseditor (LazDE) kann diese bearbeitet und auch in ein anderes Ausgabeformat (HTML) überbracht werden.
In Lazarus selbst wird diese Datei jedoch nicht verwendet. Weder im integrierten Editor noch in der Tooltip-Hilfe wird die Dokumentation verwendet.

Gibt es eine Möglichkeit, der IDE dieses Verhalten beizubringen? Muss ich erst einen Bug-Report/Patch schreiben? Und wie handhabt ihr eure Dokumentation?

Viele Grüße

[m.fuchs]

Und wie handhabt ihr eure Dokumentation?

Ich verwende PasDoc (http://pasdoc.sipsolutions.net/). Die Dokumentation steht als Kommentar über dem jeweiligen Programmteil. Damit ist auch die Tooltipp-Hilfe versorgt. Und der Dokumentationsteil ist nicht weit vom Quellcode entfernt. Das hilft ein bisschen, die Aktualität zu halten.
Vernünftige Ausgabeformate sind auch vorhanden, wobei ich nur HTML verwende.

Ein Beispiel ist die Synapse-Dokumentation (http://synapse.ararat.cz/doc/help/).

[Socke]

Wie vollständig ist denn hier die IDE-Integeration? Die Tooltip-Hilfe hattest du bereits angesprochen. Mir fallen da noch weitere Fragen ein, wie z.B.

• grafische Oberfläche um eine lesbare Dokumentation zu erstellen
• Code-Vervollständigung für die Tags
• ggf. sogar ein eigener Editor (wie der integrierte FPDoc-Editor)

[m.fuchs]

Wie vollständig ist denn hier die IDE-Integeration?

Praktisch nicht vorhanden.

Die Tooltip-Hilfe hattest du bereits angesprochen.

Die ergibt sich nur aus der Tatasache, dass die Dokumentation halt in Kommentaren vor dem passenden Quellcode steht. Damit kümmert sich Lazarus um die Anzeige.

• grafische Oberfläche um eine lesbare Dokumentation zu erstellen

Nix dergleichen, du steuerst alles über Kommentare im Quellcode und Kommandozeilenparameter. Wobei, es gibt wohl auch ein GUI-Tool, aber das habe ich noch nciht ausprobiert.

• Code-Vervollständigung für die Tags

Das gibt es nicht. Lazarus setzt wohl ausschließlich auf FpDoc. Ich konnte mich bloss nicht mit dem System anfreunden, deswegen habe ich nach einer Alternative gesucht.

• ggf. sogar ein eigener Editor (wie der integrierte FPDoc-Editor)

Auch dazu ist mir nichts bekannt. Hatte aber auch bisher noch keine Notwendigkeit dafür gesehen.

[soerensen3]

Ich habe mich sowieso schon gefragt ob es nicht besser wäre, ein Programm zu schreiben was auf den Code Tools aufbaut. Der hat praktisch die komplette Funktionalität die für eine Dokumentation benötigt wird (eventuell muss man ihn um das Auswerten von Kommentaren erweitern) und wird ständig aktualisiert. Außerdem beherschen die Code Tools auch Macros zu 100% (im Gegensatz zu fpdoc oder pasdoc (nur teilweise)). Dann müsste man bei neuen Features auch nicht an zwei Stellen Änderungen implementieren. Es würde ja auch schon reichen wenn das Programm in ein Format exportiert was von anderen Dokumentationstools importiert werden könnten. (http://wiki.freepascal.org/Codetools/de)

EDIT:
Ich habe gerade gesehen im examples Ordner gibts den FPDoc Manager. Ist es das was du suchst? Das Working Directory bei Run Parameters muss nur angepasst werden und ich habe die Zeile mit der FPC Version einfach mal auskommentiert, da ich nicht fpc 2.71 habe. Zumindest kompiliert es dann, ob es so funktioniert weiß ich nicht, die Zeile wird ja einen Grund haben.

[Socke]

Ich habe gerade gesehen im examples Ordner gibts den FPDoc Manager. Ist es das was du suchst? Das Working Directory bei Run Parameters muss nur angepasst werden und ich habe die Zeile mit der FPC Version einfach mal auskommentiert, da ich nicht fpc 2.71 habe. Zumindest kompiliert es dann, ob es so funktioniert weiß ich nicht, die Zeile wird ja einen Grund haben.

Vielen Dank für den Hinweis.
Das Programm kann ich bei mir (FPC 2.7.1) erstellen und starten. So ganz wird mir jedoch der Zweck der Anwendung nicht klar. Jedenfalls scheint es noch sehr tief im Alpha-Stadium zu stecken.

[Socke]

die aktuelle Situation: für ein Package mit mehreren Units habe ich eine einzige FPDoc-Dokumentations-XML-Datei. Im Dokumentationseditor (LazDE) kann diese bearbeitet und auch in ein anderes Ausgabeformat (HTML) überbracht werden.
In Lazarus selbst wird diese Datei jedoch nicht verwendet. Weder im integrierten Editor noch in der Tooltip-Hilfe wird die Dokumentation verwendet.

Es gibt eine Lösung: FPDocMover ist ein kleines Komandozeilenprogramm mit dem man die FPDoc-Dateien zerlegen und wieder zusammensetzen kann.