6 Running Txt2FPDoc

Generating the XML file for FPDoc is very simple. Assuming your documentation file is documention.txt, you can convert it to documentation.xml with the following command:

     ~$ txt2fpdoc -o documentation.xml documentation.txt

Sometimes something goes wrong and it can be helpful to see the documentation analyzed by Txt2FPDoc after passing through the preprocessor. This can be done with:

     ~$ txt2fpdoc --dump documentation.txt

Txt2FPDoc options are:

-h, --help

Print a usage message, then exit.

-v, --version

Print the version number, then exit.

-o, --output=OUTFILE

Specify output file name.

-d, --dump

Dump preprocessor output, then exit.