This document is the reference manual for Txt2FPDoc
version
0.8.6.
Chapter 2 explains how to compile and install Txt2FPDoc
.
(Compiling and Installing Txt2FPDoc)
Chapters 3 , 4 and 5 explain how to write documentation for your code
with Txt2FPDoc
. (Documenting Your Code,
Descriptions, The Preprocessor)
Chapter 6 explains how to run Txt2FPDoc
. (Running Txt2FPDoc)
Appendices A, B and C describe in detail the Txt2FPDoc
syntax.
They are not to be read but to serve as a reference. (Headers,
Structure of Main Components, Documentation File Grammar)
Appendix D provides complete examples, i.e., source code, documentation file and commands to build html documentation. (Complete Examples)