[fpc-devel] fpdoc and fv

Marco van de Voort marcov at stack.nl
Mon Aug 25 11:27:32 CEST 2008


In our previous episode, Michael Schnell said:
> > Lazarus context sensitive help shows documentation of the fpdoc files and
> > comments from pasdoc (similar to javadoc, DelphiCodeToDoc) and it browses
> > through the class hierarchy to show ancestor help. The help content can be
> > edited in the IDE context sensitive or via lazde and Kirk is doing a great job
> > here.
> In the German Lazarus forum there recently has been a discussion on 
> improving the (German) help. There had been a suggestion to use a Wiki 
> to update / enhance the help texts

Personally I despise wiki'ed manuals. They are horrible quality,
over-hyperlinked beasts of ugly. I always get the feeling that those
"everybody hacks away online" manuals are more obsessed with the process
than with the result.

To avoid the chaos of too many cooks spoiling the broth, but still have
finely grained user input in the docs, FPC at one point tried an annotate
system (people being able to annotate problems in the FPC docs on a per page
basis in wiki style), however it was plagued with technical problems, and
never caught on.

I still like the principle though. It is still visible on the FPC docs page
(the "with comments" option)




More information about the fpc-devel mailing list