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

/******************************************************************************
 *
 * 
 *
 * Copyright (C) 1997-2001 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 all attributes of a HTML tag are ignored 
(the HREF and NAME attributes for the A tag are the only exception).

<ul>
<li><tt>\<A HREF="..."\></tt> Starts a HTML hyper-link (HTML only). 
<li><tt>\<A NAME="..."\></tt> Starts an named anchor (HTML only).
<li>\c </A>    Ends a link or anchor (HTML only).
<li>\c <B>     Starts a piece of text displayed in a bold font.
<li>\c </B>    Ends a \c <B> section.
<li>\c <BODY>  Does not generate any output.
<li>\c </BODY> Does not generate any output.
<li>\c <BR>    Forces a line break.
<li>\c <CENTER> starts a section of centered text.
<li>\c </CENTER> ends a section of centered text.
<li>\c <CODE>  Starts a piece of text displayed in a typewriter font.
<li>\c </CODE> End a \c <CODE> section.
<li>\c <DD>    Starts an item description.
<li>\c <DFN>   Starts a piece of text displayed in a typewriter font.
<li>\c </DFN>  Ends a \c <DFN> section.
<li>\c <DL>    Starts a description list.
<li>\c </DL>   Ends a description list.
<li>\c <DT>    Starts an item title.
<li>\c </DT>   Ends an item title.
<li>\c <EM>    Starts a piece of text displayed in an italic font.
<li>\c </EM>   Ends a \c <EM> section.
<li>\c <FORM>  Does not generate any output.
<li>\c </FORM> Does not generate any output.
<li>\c <HR>    Writes a horizontal ruler.
<li>\c <H1>    Starts an unnumbered section.
<li>\c </H1>   Ends an unnumberd section.
<li>\c <H2>    Starts an unnumbered subsection.
<li>\c </H2>   Ends an unnumbered subsection.
<li>\c <H?>    Where ? is one of {3,4,5,6}, starts an unnumbered subsubsection using \c <H3> in HTML.
<li>\c </H?>   Where ? is one of {3,4,5,6}, ends an unnumbered subsubsection using \c <H3> in HTML.
<li>\c <I>     Starts a piece of text displayed in an italic font.
<li>\c <INPUT> Does not generate any output.
<li>\c </I>    Ends a \c <I> section.
<li>\c <IMG>   This command is written with attributes to the HTML output only.
<li>\c <LI>    Starts a new list item.
<li>\c </LI>   Ends a list item.
<li>\c <META>  Does not generate any output.
<li>\c <MULTICOL> ignored by doxygen.
<li>\c </MUTLICOL> ignored by doxygen.
<li>\c <OL>    Starts a numbered item list.
<li>\c </OL>   Ends a numbered item list.
<li>\c <P>     Starts a new paragraph.
<li>\c </P>    Ends a paragraph.
<li>\c <PRE>   Starts a preformatted fragment.
<li>\c </PRE>  Ends a preformatted fragment.
<li>\c <SMALL> Starts a section of text displayed in a smaller font.
<li>\c </SMALL> Ends a \c <SMALL> section.
<li>\c <STRONG> Starts a section of bold text.
<li>\c </STRONG> Ends a section of bold text.
<li>\c <SUB>   Starts a piece of text displayed in subscript.
<li>\c </SUB>  Ends a \c <SUB> section.
<li>\c <SUP>   Starts a piece of text displayed in superscript.
<li>\c </SUP>  Ends a \c </SUP> section.
<li>\c <TABLE> starts a table.
<li>\c </TABLE> ends a table.
<li>\c <TD>    Starts a new table data element.
<li>\c </TD>   Ends a table data element.
<li>\c <TR>    Starts a new table row.
<li>\c </TR>   Ends a table row.
<li>\c <TT>    Starts a piece of text displayed in a typewriter font.
<li>\c </TT>   Ends a \c <TT> section.
<li>\c <KBD>   Starts a piece of text displayed in a typewriter font.
<li>\c </KBD>  Ends a \c <KBD> section.
<li>\c <UL>    Starts an unnumbered item list.
<li>\c </UL>   Ends an unnumbered item list.
<li>\c <VAR>   Starts a piece of text displayed in an italic font.
<li>\c </VAR>  Ends a \c </VAR> section.
</ul>

The special HTML character entities that are recognized by Doxygen:

<ul>
<li>\c &copy; the copyright symbol
<li>\c &quot; a double quote
<li>\c &?uml;   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>\c &?acute; 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>\c &?grave; 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>\c &?circ;  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>\c &?tilde; where ? is one of {A,N,O,a,n,o},
       writes a character with a tilde accent (like &atilde;).
<li>\c &szlig; write a sharp s (i.e. &szlig;) to the output.
<li>\c &?cedil; where ? is one of {c,C},
       writes a c-cedille (like &ccedil;).
<li>\c &?ring; where ? is one of {a,A},
       writes an \c a with a ring (like &aring;).
<li>\c &nbsp; a non breakable space.
</ul>

*/