FPDoc :
Free Pascal code documenter: Reference manual


____________________________________________________________________
Reference manual for FPDoc
Document version 0.9
May 30, 2003

Michaël Van Canneyt

____________________________________________________________________________
Contents
1 Introduction
 1.1 About this document
 1.2 About FPDoc
 1.3 Getting more information.
2 Compiling and Installing FPDoc
 2.1 Compiling
 2.2 Installation
3 FPDoc usage
 3.1 fpdoc
 3.2 FPDoc command-line options reference
   content
   descr
   format
   help
   hide-protected
   html-search
   import
   input
   lang
   latex-highlight
   output
   package
   show-private
 3.3 makeskel
   introduction
 3.4 Makeskel option reference
   disable-arguments
   disable-errors
   disable-function-results
   disable-private
   disable-protected
   disable-seealso
   emitclassseparator
   help
   input
   lang
   output
   package
4 The description file
 4.1 Introduction
 4.2 Element names and cross-referencing
   Element name conventions
   Cross referencing: the link tag
 4.3 Tag reference
   Overview
   b : format bold
   caption : Specify table caption
   code : format as pascal code
   descr : Descriptions
   dd : definition data.
   dl : definition list.
   dt : definition term.
   element : Identifier documentation
   errors : Error section.
   fpdoc-description : Global tag
   i : Format italics
   li : list element
   link : Cross-reference
   module : Unit reference
   ol : Numbered list.
   p : Paragraph
   package : Package reference
   pre : Insert text as-is
   remark : format as remark
   seealso : Cross-reference section
   short : Short description
   table : Table start
   td : Table cell
   th : Table header
   tr : table row
   u : Format underlined
   ul : bulleted list
   var : variable
5 Generated output files.
 5.1 HTML output
 5.2 Latex output