[next] [tail] [up]

Overview

The tags can roughly be divided in 2 groups:
  1. Documentation structure tags. These are needed for fpdoc to do it’s work. They determine what elements are documented. See table (4.1)
  2. Text structure and formartting tags. These tags indicate blocks of text, such as paragraphs, tables, lists and remarks, but also specify formatting: apply formatting (make-up) to the text, or to provide links to other parts of the text. These mostly occur in text structure tags. See table (4.2)

Table 4.1: Documentation structure tags

Tag Description Page
descr Element description 104
element Identifier documentation 112
errors Error section 114
fpdoc-description Global tag 116
module Unit tag 126
package Package global tab 133
seealso Cross-reference section 139
short Short description 141
Table 4.2: Text formatting tags
Tag Description Page
b Format bold 98
caption Specify table caption 100
code Syntax highlight code 102
dd definition data 106
dl definition list 108
dt Definition term 110
i format italics 117
li list element 119
link Cross-reference 121
ol numbered list 128
p paragraph 130
pre Preformatted text 134
remark remark paragraph 137
table Table 143
td Table cell 145
th Table header 147
tr Table row 149
u format underlined 151
ul bulleted list 153
var format as variable 155
The nodes for formatting a text resemble closely the basic HTML formatting tags with the following exceptions:

Also, if special formatting tags such as a table or lists are inserted, then the remaining text must be inside a paragraph tag. This means that the following is wrong: 

 <descr>
 Some beginning text
 <ol>
 <li>A list item</li>
 </ol>
 some ending text
 </descr>
Instead, the correct XML should be 
 <descr>
 <p>Some beginning text</p>
 <ol>
 <li>A list item</li>
 </ol>
 <p>some ending text</p>
 </descr>

[next] [front] [up]