5.3.1 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 (5.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 (5.2)


Table 5.1: Documentation structure tags
Tag

Description

Page



descr

Element description

164
element

Identifier documentation

172
errors

Error section

174
fpdoc-description

Global tag

176
module

Unit tag

188
package

Package global tab

199
seealso

Cross-reference section

207
short

Short description

209
topic

Topic page

217





Table 5.2: Text formatting tags
Tag

Description

Page



b

Format bold

158
caption

Specify table caption

160
code

Syntax highlight code

162
dd

definition data

166
dl

definition list

168
dt

Definition term

170
i

format italics

177
img

include image

179
li

list element

181
link

Cross-reference

183
ol

numbered list

194
p

paragraph

196
pre

Preformatted text

200
remark

remark paragraph

205
table

Table

211
td

Table cell

213
th

Table header

215
tr

Table row

219
u

format underlined

221
ul

bulleted list

223
var

format as variable

228




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>