Using FPDoc
FPDoc is the command-line tool that is used to combine Pascal source file units and XML-formatted documentation files to create reference documentation in a variety of formats. FPDoc can create documentation in the following formats:
HTML: HTML with Style Sheets and JavaScript. JavaScript is used to create the class properties and class method window.
XHTML: It is a stricter HTML syntax.
LaTeX: It generates LaTeX files that can be used to create Postscript or PDF. Free Pascal provides the
fpc.sty
file for use with LaTeX.Text: It includes plain ASCII text files. There's no cross-referencing.
Man: Unix man pages. For each function, procedure, and method identifier, a separate man page is created. Separate units are created for constants, types, variables, and resource strings.
CHM: It is a compressed HTML file. It is compressed using
lzx
compression.RTF: It stands for Rich Text Format files.
FPDoc has many command-line options, including the following:
input
: This is the name of the...