FPDoc in Unit

Für Fragen zur Programmiersprache auf welcher Lazarus aufbaut
Antworten
MitjaStachowiak
Lazarusforum e. V.
Beiträge: 394
Registriert: Sa 15. Mai 2010, 13:46
CPU-Target: 64 bit
Kontaktdaten:

FPDoc in Unit

Beitrag von MitjaStachowiak »

Hallo,
ich habe mir eben mal das FPDoc angesehen. Ist 'ne tolle Sache, hat aber einen Haken: Wenn ich in einem Projekt eine Unit einbinde, dann denke ich nie daran, die Doc-XMLs mitzugeben. Besser wäre es, wenn man das FPDoc als Kommentar in die .pas-Dateien einfügen könnte. Ein großer Kommentar am Anfang, der im Editor ausgeblendet wird, und fertig...

Geht das schon? Kommt das bald?

Wie managt ihr, dass die Dokumentation zusammen mit den Units geliefert wird?

marcov
Beiträge: 1100
Registriert: Di 5. Aug 2008, 09:37
OS, Lazarus, FPC: Windows ,Linux,FreeBSD,Dos (L trunk FPC trunk)
CPU-Target: 32/64,PPC(+64), ARM
Wohnort: Eindhoven (Niederlande)

Re: FPDoc in Unit

Beitrag von marcov »

Ich glaube pas(2)doc ist mehr In-Quellen orientiert.

MitjaStachowiak
Lazarusforum e. V.
Beiträge: 394
Registriert: Sa 15. Mai 2010, 13:46
CPU-Target: 64 bit
Kontaktdaten:

Re: FPDoc in Unit

Beitrag von MitjaStachowiak »

Wo finde ich das denn?

Benutzeravatar
m.fuchs
Lazarusforum e. V.
Beiträge: 2636
Registriert: Fr 22. Sep 2006, 19:32
OS, Lazarus, FPC: Winux (Lazarus 2.0.10, FPC 3.2.0)
CPU-Target: x86, x64, arm
Wohnort: Berlin
Kontaktdaten:

Re: FPDoc in Unit

Beitrag von m.fuchs »

https://github.com/pasdoc/pasdoc/wiki

EIn Beispiel für den Einsatz ist die Doku von Synapse (http://synapse.ararat.cz/doc/help/).
Software, Bibliotheken, Vorträge und mehr: https://www.ypa-software.de

jc99
Beiträge: 29
Registriert: Fr 19. Mai 2017, 18:04
OS, Lazarus, FPC: Win10x64, L 1.8rc3, FPC3.0.2
CPU-Target: 64
Wohnort: Nord-Baden
Kontaktdaten:

Re: FPDoc in Unit

Beitrag von jc99 »

MitjaStachowiak hat geschrieben:Hallo,

Geht das schon? Kommt das bald?

Wie managt ihr, dass die Dokumentation zusammen mit den Units geliefert wird?

Indem ich das Verzeichniss mit dem XML-Dateien mit in die Repository aufnehme.

Geht das schon? Kommt das bald?
Ja, das wäre Schön, bzw. mal eine Aufgabe für jemanden:
Zu Schreiben sei eine Komponente die in FPDoc oder Extern die die FPDoc-XML-Dateien in den Source-Code einarbeitet- Möglichst Kompatibel mit Pas2Doc o.Ä:
und gegebenfalls auch umgekehrt Die XML-Dateien aus dem Source-Code erstellt. Mit der PasSrc-Komponente sollte das handlebar sein.

Man braucht das Rad ja nicht neu zu erfinden wenn nur eine Kleinigkeit fehlt. (Wo hab ich das denn gerade schon mal gehört ? ! ... war da nicht was mit 6*7)
OS: ...-Win10 x64
Laz: ...-1.8rc1
https://github.com/joecare99/public
'~| . . /'' . .
,_|oe \_,are

Antworten