[fpc-devel] FPDoc sources

michael.vancanneyt at wisa.be michael.vancanneyt at wisa.be
Tue Aug 30 15:46:43 CEST 2011

On Tue, 30 Aug 2011, Hans-Peter Diettrich wrote:

> michael.vancanneyt at wisa.be schrieb:
>>> IMO fpdoc should always create output from the given xml files, regardless 
>>> of whether according source files are also given.
>> If you think logically for a moment, you'll understand why this is simply 
>> not
>> possible.
> It is easily possible, of course. When I want documentation created from 
> source files, then I use something like PasDoc. When I create xml files for 
> fpdoc, I expect that these form the base of the documentation. Everything 
> else is unlogical :-(

What can I say ? You have a strange sense of logic.

Since the purpose of fpdoc is to document things from pascal source code,
for me it follows that it must read the source code first.

This has 2 consequences:

As you can see, the description files do not contain any structural
information (type info, function info), just identifiers. The structural
information is read from the primary location: the pascal sources.

Doing this means ALL identifiers are allways present in the documentation,
and the ones for which documentation happens to be available are documented.

If it were any other way, we wouldn't need source code or XML, we could just
use Open Office or Word, that would be equally useful.


More information about the fpc-devel mailing list