doc/htmlcmds.doc


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219

/******************************************************************************
 *
 * 
 *
 * Copyright (C) 1997-2012 by Dimitri van Heesch.
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation under the terms of the GNU General Public License is hereby 
 * granted. No representations are made about the suitability of this software 
 * for any purpose. It is provided "as is" without express or implied warranty.
 * See the GNU General Public License for more details.
 *
 * Documents produced by Doxygen are derivative works derived from the
 * input used in their production; they are not affected by this license.
 *
 */
/*! \page htmlcmds HTML Commands

Here is a list of all HTML commands that may be used inside the
documentation. Note that although these HTML tags are translated to the
proper commands for output formats other than HTML, all attributes 
of a HTML tag are passed on to the HTML output only 
(the HREF and NAME attributes for the A tag are the only exception).

<ul>
<li><tt>\<A HREF="..."\></tt> Starts a hyperlink 
                       (if supported by the output format). 
<li><tt>\<A NAME="..."\></tt> Starts an named anchor 
                       (if supported by the output format).
<li><tt>\</A\></tt>    Ends a link or anchor 
<li><tt>\<B\></tt>     Starts a piece of text displayed in a bold font.
<li><tt>\</B\></tt>    Ends a <tt>\<B\></tt> section.
<li><tt>\<BLOCKQUOTE\></tt> Starts a quotation block.
<li><tt>\</BLOCKQUOTE\></tt> Ends the quotation block.
<li><tt>\<BODY\></tt>  Does not generate any output.
<li><tt>\</BODY\></tt> Does not generate any output.
<li><tt>\<BR\></tt>    Forces a line break.
<li><tt>\<CENTER\></tt> starts a section of centered text.
<li><tt>\</CENTER\></tt> ends a section of centered text.
<li><tt>\<CAPTION\></tt> Starts a caption. Use within a table only.
<li><tt>\</CAPTION\></tt> Ends a caption. Use within a table only.
<li><tt>\<CODE\></tt>  Starts a piece of text displayed in a typewriter font.
                       Note that for C# code, this command is equivalent to 
                       \ref cmdcode "\\code".
<li><tt>\</CODE\></tt> Ends a <tt>\<CODE\></tt> section.
                       Note that for C# code, this command is equivalent to
                       \ref cmdendcode "\\endcode".
<li><tt>\<DD\></tt>    Starts an item description.
<li><tt>\<DFN\></tt>   Starts a piece of text displayed in a typewriter font.
<li><tt>\</DFN\></tt>  Ends a <tt>\<DFN\></tt> section.
<li><tt>\<DIV></tt>    Starts a section with a specific style (HTML only)
<li><tt>\</DIV></tt>   Ends a section with a specific style (HTML only)
<li><tt>\<DL\></tt>    Starts a description list.
<li><tt>\</DL\></tt>   Ends a description list.
<li><tt>\<DT\></tt>    Starts an item title.
<li><tt>\</DT\></tt>   Ends an item title.
<li><tt>\<EM\></tt>    Starts a piece of text displayed in an italic font.
<li><tt>\</EM\></tt>   Ends a <tt>\<EM\></tt> section.
<li><tt>\<FORM\></tt>  Does not generate any output.
<li><tt>\</FORM\></tt> Does not generate any output.
<li><tt>\<HR\></tt>    Writes a horizontal ruler.
<li><tt>\<H1\></tt>    Starts an unnumbered section.
<li><tt>\</H1\></tt>   Ends an unnumbered section.
<li><tt>\<H2\></tt>    Starts an unnumbered subsection.
<li><tt>\</H2\></tt>   Ends an unnumbered subsection.
<li><tt>\<H3\></tt>    Starts an unnumbered subsubsection.
<li><tt>\</H3\></tt>   Ends an unnumbered subsubsection.
<li><tt>\<I\></tt>     Starts a piece of text displayed in an italic font.
<li><tt>\<INPUT\></tt> Does not generate any output.
<li><tt>\</I\></tt>    Ends a <tt>\<I\></tt> section.
<li><tt>\<IMG\></tt>   This command is written with attributes to the HTML output only.
<li><tt>\<LI\></tt>    Starts a new list item.
<li><tt>\</LI\></tt>   Ends a list item.
<li><tt>\<META\></tt>  Does not generate any output.
<li><tt>\<MULTICOL\></tt> ignored by doxygen.
<li><tt>\</MUTLICOL\></tt> ignored by doxygen.
<li><tt>\<OL\></tt>    Starts a numbered item list.
<li><tt>\</OL\></tt>   Ends a numbered item list.
<li><tt>\<P\></tt>     Starts a new paragraph.
<li><tt>\</P\></tt>    Ends a paragraph.
<li><tt>\<PRE\></tt>   Starts a preformatted fragment.
<li><tt>\</PRE\></tt>  Ends a preformatted fragment.
<li><tt>\<SMALL\></tt> Starts a section of text displayed in a smaller font.
<li><tt>\</SMALL\></tt> Ends a <tt>\<SMALL\></tt> section.
<li><tt>\<SPAN></tt>   Starts an inline text fragment with a specific style (HTML only)
<li><tt>\</SPAN></tt>  Ends an inline text fragment with a specific style (HTML only)
<li><tt>\<STRONG\></tt> Starts a section of bold text.
<li><tt>\</STRONG\></tt> Ends a section of bold text.
<li><tt>\<SUB\></tt>   Starts a piece of text displayed in subscript.
<li><tt>\</SUB\></tt>  Ends a <tt>\<SUB\></tt> section.
<li><tt>\<SUP\></tt>   Starts a piece of text displayed in superscript.
<li><tt>\</SUP\></tt>  Ends a <tt>\</SUP\></tt> section.
<li><tt>\<TABLE\></tt> starts a table.
<li><tt>\</TABLE\></tt> ends a table.
<li><tt>\<TD\></tt>    Starts a new table data element.
<li><tt>\</TD\></tt>   Ends a table data element.
<li><tt>\<TH\></tt>    Starts a new table header.
<li><tt>\</TH\></tt>   Ends a table header.
<li><tt>\<TR\></tt>    Starts a new table row.
<li><tt>\</TR\></tt>   Ends a table row.
<li><tt>\<TT\></tt>    Starts a piece of text displayed in a typewriter font.
<li><tt>\</TT\></tt>   Ends a <tt>\<TT\></tt> section.
<li><tt>\<KBD\></tt>   Starts a piece of text displayed in a typewriter font.
<li><tt>\</KBD\></tt>  Ends a <tt>\<KBD\></tt> section.
<li><tt>\<UL\></tt>    Starts an unnumbered item list.
<li><tt>\</UL\></tt>   Ends an unnumbered item list.
<li><tt>\<VAR\></tt>   Starts a piece of text displayed in an italic font.
<li><tt>\</VAR\></tt>  Ends a <tt>\<VAR\></tt> section.
</ul>

The special HTML character entities that are recognized by Doxygen:

<ul>
<li><tt>\&copy;</tt> the copyright symbol
<li><tt>\&tm;</tt> the trade mark symbol
<li><tt>\&reg;</tt> the registered trade mark symbol
<li><tt>\&lt;</tt> less-than symbol
<li><tt>\&gt;</tt> greater-than symbol
<li><tt>\&amp;</tt> ampersand
<li><tt>\&apos;</tt> single quotation mark (straight)
<li><tt>\&quot;</tt> double quotation mark (straight)
<li><tt>\&lsquo;</tt> left single quotation mark
<li><tt>\&rsquo;</tt> right single quotation mark
<li><tt>\&ldquo;</tt> left double quotation mark
<li><tt>\&rdquo;</tt> right double quotation mark
<li><tt>\&ndash;</tt> n-dash (for numeric ranges, e.g. 2&ndash;8)
<li><tt>\&mdash;</tt> m-dash (for parenthetical punctuation &mdash; like this)
<li><tt>\&?uml;</tt>   where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y}, 
       writes a character with a diaeresis accent (like &auml;).
<li><tt>\&?acute;</tt> where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y},
       writes a character with a acute accent (like &aacute;). 
<li><tt>\&?grave;</tt> where ? is one of {A,E,I,O,U,a,e,i,o,u,y},
       writes a character with a grave accent (like &agrave;).
<li><tt>\&?circ;</tt>  where ? is one of {A,E,I,O,U,a,e,i,o,u,y},
       writes a character with a circumflex accent (like &acirc;).
<li><tt>\&?tilde;</tt> where ? is one of {A,N,O,a,n,o},
       writes a character with a tilde accent (like &atilde;).
<li><tt>\&szlig;</tt> write a sharp s (i.e. &szlig;) to the output.
<li><tt>\&?cedil;</tt> where ? is one of {c,C},
       writes a c-cedille (like &ccedil;).
<li><tt>\&?ring;</tt> where ? is one of {a,A},
       writes an <tt>a</tt> with a ring (like &aring;).
<li><tt>\&nbsp;</tt> a non breakable space.
<li><tt>\&Gamma;</tt> Greek letter Gamma &Gamma;.
<li><tt>\&Delta;</tt> Greek letter Delta &Delta;.
<li><tt>\&Theta;</tt> Greek letter Theta &Theta;.
<li><tt>\&Lambda;</tt> Greek letter Lambda &Lambda;.
<li><tt>\&Xi;</tt> Greek letter Xi &Xi;.
<li><tt>\&Pi;</tt> Greek letter Pi &Pi;.
<li><tt>\&Sigma;</tt> Greek letter Sigma &Sigma;.
<li><tt>\&Upsilon;</tt> Greek letter Upsilon &Upsilon;.
<li><tt>\&Phi;</tt> Greek letter Phi &Phi;.
<li><tt>\&Psi;</tt> Greek letter Psi &Psi;.
<li><tt>\&Omega;</tt> Greek letter Omega &Omega;.
<li><tt>\&alpha;</tt> Greek letter alpha &alpha;.
<li><tt>\&beta;</tt> Greek letter beta &beta;.
<li><tt>\&gamma;</tt> Greek letter gamma &gamma;.
<li><tt>\&delta;</tt> Greek letter delta &delta;.
<li><tt>\&epsilon;</tt> Greek letter epsilon &epsilon;.
<li><tt>\&zeta;</tt> Greek letter zeta &zeta;.
<li><tt>\&eta;</tt> Greek letter eta &eta;.
<li><tt>\&theta;</tt> Greek letter theta &theta;.
<li><tt>\&iota;</tt> Greek letter iota &iota;.
<li><tt>\&kappa;</tt> Greek letter kappa &kappa;.
<li><tt>\&lambda;</tt> Greek letter lambda &lambda;.
<li><tt>\&mu;</tt> Greek letter mu &mu;.
<li><tt>\&nu;</tt> Greek letter nu &nu;.
<li><tt>\&xi;</tt> Greek letter xi &xi;.
<li><tt>\&pi;</tt> Greek letter pi &pi;.
<li><tt>\&rho;</tt> Greek letter rho &rho;.
<li><tt>\&sigma;</tt> Greek letter sigma &sigma;.
<li><tt>\&tau;</tt> Greek letter tau &tau;.
<li><tt>\&upsilon;</tt> Greek letter upsilon &upsilon;.
<li><tt>\&phi;</tt> Greek letter phi &phi;.
<li><tt>\&chi;</tt> Greek letter chi &chi;.
<li><tt>\&psi;</tt> Greek letter psi &psi;.
<li><tt>\&omega;</tt> Greek letter omega &omega;.
<li><tt>\&sigmaf;</tt> Greek final sigma &sigmaf;.
<li><tt>\&sect;</tt> section sign &sect;.
<li><tt>\&deg;</tt> degree &deg;.
<li><tt>\&prime;</tt> prime &prime;.
<li><tt>\&Prime;</tt> double prime &Prime;.
<li><tt>\&infin;</tt> infinity &infin;.
<li><tt>\&empty;</tt> empty set &empty;.
<li><tt>\&plusmn;</tt> plus or minus &plusmn;.
<li><tt>\&times;</tt> multiplication sign &times;.
<li><tt>\&minus;</tt> minus sign &minus;.
<li><tt>\&sdot;</tt> centered dot &sdot;.
<li><tt>\&part;</tt> partial derivative &part;.
<li><tt>\&nabla;</tt> nabla symbol &nabla;.
<li><tt>\&radic;</tt> square root &radic;.
<li><tt>\&perp;</tt> perpendicular symbol &perp;.
<li><tt>\&sum;</tt> sum &sum;.
<li><tt>\&int;</tt> integral &int;.
<li><tt>\&prod;</tt> product &prod;.
<li><tt>\&sim;</tt> similar to &sim;.
<li><tt>\&asymp;</tt> approximately equal to &asymp;.
<li><tt>\&ne;</tt> not equal to &ne;.
<li><tt>\&equiv;</tt> equivalent to &equiv;.
<li><tt>\&prop;</tt> proportional to &prop;.
<li><tt>\&le;</tt> less than or equal to &le;.
<li><tt>\&ge;</tt> greater than or equal to &ge;.
<li><tt>\&larr;</tt> left arrow &larr;.
<li><tt>\&rarr;</tt> right arrow &rarr;.
<li><tt>\&isin;</tt> in the set &isin;.
<li><tt>\&notin;</tt> not in the set &notin;.
<li><tt>\&lceil;</tt> left ceiling sign &lceil;.
<li><tt>\&rceil;</tt> right ceiling sign &rceil;.
<li><tt>\&lfloor;</tt> left floor sign &lfloor;.
<li><tt>\&rfloor;</tt> right floor sign &rfloor;.
</ul>

Finally, to put invisible comments inside comment blocks, HTML style
comments can be used:
\verbatim
/*! <!-- This is a comment with a comment block --> Visible text */
\endverbatim

*/