[fpc-devel] FPDoc sources

Graeme Geldenhuys graemeg.lists at gmail.com
Tue Aug 30 22:40:57 CEST 2011

On 30/08/2011, Hans-Peter Diettrich  wrote:
> Unfortunately fpdoc ignores all given xml files, when no corresponding
> source file is given at the same time.

Isn't that exactly what I said... fpdoc only uses what you supply to it.

> Does a documentation tool serve
> the user, or has the user to serve the tool???

You are more than welcome to extend the tool if you want. I (and
probably many others) would also welcome an alternative to Makefile
usage for building fpc's docs. I loathe Makefiles.

> FCL have such irregular requirements, that much work is required to
> provide a usable command line for the compilation of the according
> documentation.

Lazarus IDE already contains all that information, so it's just a
matter of extracting the paths and writing the fpdoc command line
options to a batch file.

> The Lazarus IDE already includes the FPDoc Editor, which allows to
> document every identifier in the sources :-)

I wasn't referring to editing documentation, but rather "managing a
documentation project". Just like you use an IDE to manage a source
code project, so too one could use a tool to manage a fpdoc
documentation project.

In fact, I remember seeing something like that already. A quick search
shows that fpde (included with FPC, but for GTK1 only), and Lazarus's
lazde tool have this functionality already. See the Build dialog. You
can specify the output format, source and include directories, some
fpdoc parameters etc..  You can load and save a documentation project.
I have no idea if it is fully implemented, but would imagine it is a
bit outdated compared to fpdoc features. I can't compile either fpde
or lazde projects at the moment. Maybe you have better luck.



  - Graeme -

fpGUI - a cross-platform Free Pascal GUI toolkit

More information about the fpc-devel mailing list