|
1 /****************************************************************************** |
|
2 * |
|
3 * |
|
4 * |
|
5 * Copyright (C) 1997-2008 by Dimitri van Heesch. |
|
6 * |
|
7 * Permission to use, copy, modify, and distribute this software and its |
|
8 * documentation under the terms of the GNU General Public License is hereby |
|
9 * granted. No representations are made about the suitability of this software |
|
10 * for any purpose. It is provided "as is" without express or implied warranty. |
|
11 * See the GNU General Public License for more details. |
|
12 * |
|
13 * Documents produced by Doxygen are derivative works derived from the |
|
14 * input used in their production; they are not affected by this license. |
|
15 * |
|
16 */ |
|
17 /*! \page htmlcmds HTML Commands |
|
18 |
|
19 Here is a list of all HTML commands that may be used inside the |
|
20 documentation. Note that although these HTML tags are translated to the |
|
21 proper commands for outer formats other than HTML, all attributes |
|
22 of a HTML tag are passed on to the HTML output only |
|
23 (the HREF and NAME attributes for the A tag are the only exception). |
|
24 |
|
25 <ul> |
|
26 <li><tt>\<A HREF="..."\></tt> Starts a HTML hyper-link (HTML only). |
|
27 <li><tt>\<A NAME="..."\></tt> Starts an named anchor (HTML only). |
|
28 <li><tt>\</A\></tt> Ends a link or anchor (HTML only). |
|
29 <li><tt>\<B\></tt> Starts a piece of text displayed in a bold font. |
|
30 <li><tt>\</B\></tt> Ends a <tt>\<B\></tt> section. |
|
31 <li><tt>\<BODY\></tt> Does not generate any output. |
|
32 <li><tt>\</BODY\></tt> Does not generate any output. |
|
33 <li><tt>\<BR\></tt> Forces a line break. |
|
34 <li><tt>\<CENTER\></tt> starts a section of centered text. |
|
35 <li><tt>\</CENTER\></tt> ends a section of centered text. |
|
36 <li><tt>\<CAPTION\></tt> Starts a caption. Use within a table only. |
|
37 <li><tt>\</CAPTION\></tt> Ends a caption. Use within a table only. |
|
38 <li><tt>\<CODE\></tt> Starts a piece of text displayed in a typewriter font. |
|
39 Note that for C# code, this command is equivalent to |
|
40 \ref cmdcode "\\code". |
|
41 <li><tt>\</CODE\></tt> End a <tt>\<CODE\></tt> section. |
|
42 Note that for C# code, this command is equivalent to |
|
43 \ref cmdendcode "\\endcode". |
|
44 <li><tt>\<DD\></tt> Starts an item description. |
|
45 <li><tt>\<DFN\></tt> Starts a piece of text displayed in a typewriter font. |
|
46 <li><tt>\</DFN\></tt> Ends a <tt>\<DFN\></tt> section. |
|
47 <li><tt>\<DIV></tt> Starts a section with a specific style (HTML only) |
|
48 <li><tt>\</DIV></tt> Ends a section with a specific style (HTML only) |
|
49 <li><tt>\<DL\></tt> Starts a description list. |
|
50 <li><tt>\</DL\></tt> Ends a description list. |
|
51 <li><tt>\<DT\></tt> Starts an item title. |
|
52 <li><tt>\</DT\></tt> Ends an item title. |
|
53 <li><tt>\<EM\></tt> Starts a piece of text displayed in an italic font. |
|
54 <li><tt>\</EM\></tt> Ends a <tt>\<EM\></tt> section. |
|
55 <li><tt>\<FORM\></tt> Does not generate any output. |
|
56 <li><tt>\</FORM\></tt> Does not generate any output. |
|
57 <li><tt>\<HR\></tt> Writes a horizontal ruler. |
|
58 <li><tt>\<H1\></tt> Starts an unnumbered section. |
|
59 <li><tt>\</H1\></tt> Ends an unnumberd section. |
|
60 <li><tt>\<H2\></tt> Starts an unnumbered subsection. |
|
61 <li><tt>\</H2\></tt> Ends an unnumbered subsection. |
|
62 <li><tt>\<H3\></tt> Starts an unnumbered subsubsection. |
|
63 <li><tt>\</H3\></tt> Ends an unnumbered subsubsection. |
|
64 <li><tt>\<I\></tt> Starts a piece of text displayed in an italic font. |
|
65 <li><tt>\<INPUT\></tt> Does not generate any output. |
|
66 <li><tt>\</I\></tt> Ends a <tt>\<I\></tt> section. |
|
67 <li><tt>\<IMG\></tt> This command is written with attributes to the HTML output only. |
|
68 <li><tt>\<LI\></tt> Starts a new list item. |
|
69 <li><tt>\</LI\></tt> Ends a list item. |
|
70 <li><tt>\<META\></tt> Does not generate any output. |
|
71 <li><tt>\<MULTICOL\></tt> ignored by doxygen. |
|
72 <li><tt>\</MUTLICOL\></tt> ignored by doxygen. |
|
73 <li><tt>\<OL\></tt> Starts a numbered item list. |
|
74 <li><tt>\</OL\></tt> Ends a numbered item list. |
|
75 <li><tt>\<P\></tt> Starts a new paragraph. |
|
76 <li><tt>\</P\></tt> Ends a paragraph. |
|
77 <li><tt>\<PRE\></tt> Starts a preformatted fragment. |
|
78 <li><tt>\</PRE\></tt> Ends a preformatted fragment. |
|
79 <li><tt>\<SMALL\></tt> Starts a section of text displayed in a smaller font. |
|
80 <li><tt>\</SMALL\></tt> Ends a <tt>\<SMALL\></tt> section. |
|
81 <li><tt>\<SPAN></tt> Starts an inline text fragment with a specific style (HTML only) |
|
82 <li><tt>\</SPAN></tt> Ends an inline text fragment with a specific style (HTML only) |
|
83 <li><tt>\<STRONG\></tt> Starts a section of bold text. |
|
84 <li><tt>\</STRONG\></tt> Ends a section of bold text. |
|
85 <li><tt>\<SUB\></tt> Starts a piece of text displayed in subscript. |
|
86 <li><tt>\</SUB\></tt> Ends a <tt>\<SUB\></tt> section. |
|
87 <li><tt>\<SUP\></tt> Starts a piece of text displayed in superscript. |
|
88 <li><tt>\</SUP\></tt> Ends a <tt>\</SUP\></tt> section. |
|
89 <li><tt>\<TABLE\></tt> starts a table. |
|
90 <li><tt>\</TABLE\></tt> ends a table. |
|
91 <li><tt>\<TD\></tt> Starts a new table data element. |
|
92 <li><tt>\</TD\></tt> Ends a table data element. |
|
93 <li><tt>\<TR\></tt> Starts a new table row. |
|
94 <li><tt>\</TR\></tt> Ends a table row. |
|
95 <li><tt>\<TT\></tt> Starts a piece of text displayed in a typewriter font. |
|
96 <li><tt>\</TT\></tt> Ends a <tt>\<TT\></tt> section. |
|
97 <li><tt>\<KBD\></tt> Starts a piece of text displayed in a typewriter font. |
|
98 <li><tt>\</KBD\></tt> Ends a <tt>\<KBD\></tt> section. |
|
99 <li><tt>\<UL\></tt> Starts an unnumbered item list. |
|
100 <li><tt>\</UL\></tt> Ends an unnumbered item list. |
|
101 <li><tt>\<VAR\></tt> Starts a piece of text displayed in an italic font. |
|
102 <li><tt>\</VAR\></tt> Ends a <tt>\</VAR\></tt> section. |
|
103 </ul> |
|
104 |
|
105 The special HTML character entities that are recognized by Doxygen: |
|
106 |
|
107 <ul> |
|
108 <li><tt>\©</tt> the copyright symbol |
|
109 <li><tt>\&tm;</tt> the trade mark symbol |
|
110 <li><tt>\®</tt> the registered trade mark symbol |
|
111 <li><tt>\<</tt> less-than symbol |
|
112 <li><tt>\></tt> greater-than symbol |
|
113 <li><tt>\&</tt> ampersand |
|
114 <li><tt>\'</tt> single quotation mark (straight) |
|
115 <li><tt>\"</tt> double quotation mark (straight) |
|
116 <li><tt>\‘</tt> left single quotation mark |
|
117 <li><tt>\’</tt> right single quotation mark |
|
118 <li><tt>\“</tt> left double quotation mark |
|
119 <li><tt>\”</tt> right double quotation mark |
|
120 <li><tt>\–</tt> n-dash (for numeric ranges, eg. 2–8) |
|
121 <li><tt>\—</tt> m-dash (for parenthetical punctuation — like this) |
|
122 <li><tt>\&?uml;</tt> where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y}, |
|
123 writes a character with a diaeresis accent (like ä). |
|
124 <li><tt>\&?acute;</tt> where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y}, |
|
125 writes a character with a acute accent (like á). |
|
126 <li><tt>\&?grave;</tt> where ? is one of {A,E,I,O,U,a,e,i,o,u,y}, |
|
127 writes a character with a grave accent (like à). |
|
128 <li><tt>\&?circ;</tt> where ? is one of {A,E,I,O,U,a,e,i,o,u,y}, |
|
129 writes a character with a circumflex accent (like â). |
|
130 <li><tt>\&?tilde;</tt> where ? is one of {A,N,O,a,n,o}, |
|
131 writes a character with a tilde accent (like ã). |
|
132 <li><tt>\ß</tt> write a sharp s (i.e. ß) to the output. |
|
133 <li><tt>\&?cedil;</tt> where ? is one of {c,C}, |
|
134 writes a c-cedille (like ç). |
|
135 <li><tt>\&?ring;</tt> where ? is one of {a,A}, |
|
136 writes an <tt>a</tt> with a ring (like å). |
|
137 <li><tt>\ </tt> a non breakable space. |
|
138 </ul> |
|
139 |
|
140 Finally, to put invisible comments inside comment blocks, HTML style |
|
141 comments can be used: |
|
142 \verbatim |
|
143 /*! <!-- This is a comment with a comment block --> Visible text */ |
|
144 \endverbatim |
|
145 |
|
146 */ |
|
147 |