Recent

Author Topic: fpDoc or PasDoc  (Read 684 times)

egsuh

  • Hero Member
  • *****
  • Posts: 1394
fpDoc or PasDoc
« on: June 10, 2024, 04:10:19 am »
I know that I have to study them, but have a quick question ---

At first glance, they seem that I can put comments regarding my own codes, but they also say that I can write user-help texts using them. Is it possible to display user-help texts using them? Or producing a help file similar to manuals?

Thaddy

  • Hero Member
  • *****
  • Posts: 15139
  • Censorship about opinions does not belong here.
Re: fpDoc or PasDoc
« Reply #1 on: June 10, 2024, 07:11:26 am »
Yes, with both. you can use e.g. the default browser or the htmlviewer package as viewer or a pdf viewer, or...
Fpdoc can generate help for many formats, more than pasdoc.
I use fpdoc for both user help and technical documentation.
It has a somewhat longer learning curve than pasdoc but in the end it is better.
Pasdoc needs sourcecode instrumentation. There is also a documenter written in kol but we probably need to update that. the latter only outputs html.
For professional looking documentation i would ude fpdoc, since once setup correctly it always generates consistent, professionally looking documentation. All FPC documentation is written using fpdoc and it has many output formats.
« Last Edit: June 10, 2024, 10:39:05 am by Thaddy »
Of course the national anthem of the U.S.A. was written by Jimi Hendrix, didn't you know that?

Leledumbo

  • Hero Member
  • *****
  • Posts: 8766
  • Programming + Glam Metal + Tae Kwon Do = Me
Re: fpDoc or PasDoc
« Reply #2 on: June 18, 2024, 06:57:05 am »
At first glance, they seem that I can put comments regarding my own codes, but they also say that I can write user-help texts using them. Is it possible to display user-help texts using them? Or producing a help file similar to manuals?
By user-help texts, is the attached screenshot what you mean (mouse hover on identifiers)? Or by pressing F1 on identifiers? In both cases, both fpdoc and pasdoc can do. The entire RTL/FCL/LCL documentation is generated using fpdoc, while some libraries like synapse uses pasdoc instead. The main difference between the two is on where to put the documentation. fpdoc uses separate xml files, while pasdoc uses inline comments similar to javadoc, phpdoc and similar tools for other languages.

 

TinyPortal © 2005-2018