FPDoc :
Free Pascal code documenter: Reference manual


____________________________________________________________________
Reference manual for FPDoc
Document version 0.9
May 15, 2005

Michael 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
  3.2.1 content
  3.2.2 descr
  3.2.3 format
  3.2.4 help
  3.2.5 hide-protected
  3.2.6 html-search
  3.2.7 import
  3.2.8 input
  3.2.9 lang
  3.2.10 latex-highlight
  3.2.11 output
  3.2.12 package
  3.2.13 show-private
  3.2.14 warn-no-node
 3.3 makeskel
  3.3.1 introduction
 3.4 Makeskel option reference
  3.4.1 descr
  3.4.2 suse:descr
  3.4.3 disable-arguments
  3.4.4 disable-errors
  3.4.5 disable-function-results
  3.4.6 disable-private
  3.4.7 disable-protected
  3.4.8 disable-seealso
  3.4.9 emitclassseparator
  3.4.10 help
  3.4.11 input
  3.4.12 lang
  3.4.13 output
  3.4.14 package
  3.4.15 update
4 The description file
 4.1 Introduction
 4.2 Element names and cross-referencing
  4.2.1 Element name conventions
  4.2.2 Cross referencing: the link tag
 4.3 Tag reference
  4.3.1 Overview
  4.3.2 b : format bold
  4.3.3 caption : Specify table caption
  4.3.4 code : format as pascal code
  4.3.5 descr : Descriptions
  4.3.6 dd : definition data.
  4.3.7 dl : definition list.
  4.3.8 dt : definition term.
  4.3.9 element : Identifier documentation
  4.3.10 errors : Error section.
  4.3.11 fpdoc-description : Global tag
  4.3.12 i : Format italics
  4.3.13 li : list element
  4.3.14 link : Cross-reference
  4.3.15 module : Unit reference
  4.3.16 ol : Numbered list.
  4.3.17 p : Paragraph
  4.3.18 package : Package reference
  4.3.19 pre : Insert text as-is
  4.3.20 remark : format as remark
  4.3.21 seealso : Cross-reference section
  4.3.22 short : Short description
  4.3.23 table : Table start
  4.3.24 td : Table cell
  4.3.25 th : Table header
  4.3.26 tr : table row
  4.3.27 u : Format underlined
  4.3.28 ul : bulleted list
  4.3.29 var : variable
5 Generated output files.
 5.1 HTML output
 5.2 Latex output