[fpc-devel] fpdoc --input parameter suggestion

Hans-Peter Diettrich DrDiettrich1 at aol.com
Fri Dec 2 13:52:50 CET 2011

Graeme Geldenhuys schrieb:

> I'm not sure how the Makefiles in the FPC_Docs repository generates
> fpdoc parameters, but I found that I only need to specify the search
> paths in the first --input parameter.

This doesn't look correct to me, at least not for the trunk fpdoc and 
the RTL documentation.

> Alternatively... Why can't we use introduce a new --searchpath
> parameter to fpdoc. That parameter contains, you guessed it, the
> search path to all documentation units. Then --input parameter is
> simply used to specify the source *.pas unit, nothing more. Pretty
> much like my second example above.

I was already thinking about package options, which are applied to all 
input files, e.g.
   <units options="-Fi..." linux="-Fi...", win="...">
where 'options' apply to all units, while the optional platform specific 
options are selected by e.g. --ostarget.

But unit specific options may still be required, no need to change the 
current commandline support. It may be desireable, however, to allow for 
commandline *overrides* of the project options.

BTW, I already added the following debug options to my improved fpdoc:
-n for a dry run, not creating output files,
-v for verbose messages, useful to find missing includes and bad links.

A project file is created for every invocation of fpdoc. It can be 
renamed or moved to a safe place, for updates and later use. I found it 
very useful in fixing script flaws, instead of editing the Makefile. 
Another use were e.g. the creation of extended or shrunk documentation, 
by adding --show-private or --hide_protected to the commandline.


More information about the fpc-devel mailing list