FPDoc in Unit

Für Fragen zur Programmiersprache auf welcher Lazarus aufbaut

FPDoc in Unit

Beitragvon MitjaStachowiak » 30. Apr 2017, 13:42 FPDoc in Unit

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?
MitjaStachowiak
 
Beiträge: 317
Registriert: 15. Mai 2010, 12:46
OS, Lazarus, FPC: Win 7, Lazarus 32/64 (Codetyphon-Edition) | 
CPU-Target: 64 bit
Nach oben

Beitragvon marcov » 30. Apr 2017, 17:58 Re: FPDoc in Unit

Ich glaube pas(2)doc ist mehr In-Quellen orientiert.
marcov
 
Beiträge: 992
Registriert: 5. Aug 2008, 08:37
Wohnort: Eindhoven (Niederlande)
OS, Lazarus, FPC: Windows ,Linux,FreeBSD,Dos (L trunk FPC trunk) | 
CPU-Target: 32/64,PPC(+64), ARM
Nach oben

Beitragvon MitjaStachowiak » 30. Apr 2017, 19:45 Re: FPDoc in Unit

Wo finde ich das denn?
MitjaStachowiak
 
Beiträge: 317
Registriert: 15. Mai 2010, 12:46
OS, Lazarus, FPC: Win 7, Lazarus 32/64 (Codetyphon-Edition) | 
CPU-Target: 64 bit
Nach oben

Beitragvon m.fuchs » 30. Apr 2017, 21:26 Re: FPDoc in Unit

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
m.fuchs
 
Beiträge: 1634
Registriert: 22. Sep 2006, 18:32
Wohnort: Berlin
OS, Lazarus, FPC: Winux (L 1.6, FPC 3.0) | 
CPU-Target: x86, x64, arm
Nach oben

Beitragvon jc99 » 16. Jun 2017, 03:32 Re: FPDoc in Unit

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
jc99
 
Beiträge: 30
Registriert: 19. Mai 2017, 17:04
Wohnort: Nord-Baden
OS, Lazarus, FPC: Win10x64, L 1.8rc3, FPC3.0.2 | 
CPU-Target: 64
Nach oben

• Themenende •

Zurück zu Freepascal



Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder und 1 Gast

porpoises-institution
accuracy-worried