FPDoc is a tool that combines a Pascal unit file and a description file in XML format and produces reference documentation for the unit. The reference documentation contains documentation for all of the identifiers found in the unit’s interface section. The documentation is fully cross-referenced, making it easy to navigate. It is also possible to refer to other documentation sets written with FPDoc, making it possible to maintain larger documentation sets for large projects.
Contrary to some other documentation techniques, FPDoc does not require the presence of formatted comments in the source code. It takes a source file and a documentation file (in XML format) and merges these two together to a full documentation of the source. This means that the code doesn’t get obfuscated with large pieces of comment, making it hard to read and understand.
FPDoc is package-oriented, which means that it considers units as part of a package. Documentation for all units in a package can be generated in one run.
At the moment of writing, the documentation can be generated in the following formats:
Note that pascal program files cannot be parsed by fpdoc, it is therefor impossible to create documentation for a program. Only units are supported.