[fpc-devel] convert comment help to fpcdoc

[Graeme Geldenhuys]

On 17 July 2011 12:28, Hans-Peter Diettrich <DrDiettrich1 at aol.com> wrote:
>
> I've been working on PasDoc for a while (PasDoc2), and ended up in adding
> documentation in external files. But inline documentation makes sense in the
> implementation section, which is not handled by PasDoc.


The tiOPF had all its documentation as comments inside the source
code. That is the quickest way to obfuscate your source code -
especially if you have descent documentation (consisting of 5 or more
lines of text) for each class, method, function etc. That made the
source code very hard to read.

tiOPF now moved to using fpdoc instead - documentation living outside
the source code. Then registering that help with the IDE (using INF,
CHM or HTML), gives you offline context sensitive help, so it is still
very easy to find help on any subject - and the source code stays
readable by humans.


-- 
Regards,
  - Graeme -


_______________________________________________
fpGUI - a cross-platform Free Pascal GUI toolkit
http://fpgui.sourceforge.net