Doxygen: HTML Commands

Doxygen

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).

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

The special HTML4 character entities.
The list of entities with their descriptions has been taken from Character entity references in HTML 4. ( Portions © International Organization for Standardization 1986 Permission to copy in any form is granted for use with conforming SGML systems and applications as defined in ISO 8879, provided this notice is included in all copies.)

- `&nbsp;``` no-break space = non-breaking space:
- `&iexcl;``` inverted exclamation mark: ¡
- `&cent;``` cent sign: ¢
- `&pound;``` pound sign: £
- `&curren;``` currency sign: ¤
- `&yen;``` yen sign = yuan sign: ¥
- `&brvbar;``` broken bar = broken vertical bar: ¦
- `&sect;``` section sign: §
- `&uml;``` diaeresis = spacing diaeresis: ¨
- `&copy;``` copyright sign: ©
- `&ordf;``` feminine ordinal indicator: ª
- `&laquo;``` left-pointing double angle quotation mark = left pointing guillemet: «
- `&not;``` not sign: ¬
- `&shy;``` soft hyphen = discretionary hyphen:
- `&reg;``` registered sign = registered trade mark sign: ®
- `&macr;``` macron = spacing macron = overline = APL overbar: ¯
- `&deg;``` degree sign: °
- `&plusmn;``` plus-minus sign = plus-or-minus sign: ±
- `&sup2;``` superscript two = superscript digit two = squared: ²
- `&sup3;``` superscript three = superscript digit three = cubed: ³
- `&acute;``` acute accent = spacing acute: ´
- `&micro;``` micro sign: µ
- `&para;``` pilcrow sign = paragraph sign: ¶
- `&middot;``` middle dot = Georgian comma = Greek middle dot: ·
- `&cedil;``` cedilla = spacing cedilla: ¸
- `&sup1;``` superscript one = superscript digit one: ¹
- `&ordm;``` masculine ordinal indicator: º
- `&raquo;``` right-pointing double angle quotation mark = right pointing guillemet: »
- `&frac14;``` vulgar fraction one quarter = fraction one quarter: ¼
- `&frac12;``` vulgar fraction one half = fraction one half: ½
- `&frac34;``` vulgar fraction three quarters = fraction three quarters: ¾
- `&iquest;``` inverted question mark = turned question mark: ¿
- `&Agrave;``` latin capital letter A with grave = latin capital letter A grave: À
- `&Aacute;``` latin capital letter A with acute: Á
- `&Acirc;``` latin capital letter A with circumflex: Â
- `&Atilde;``` latin capital letter A with tilde: Ã
- `&Auml;``` latin capital letter A with diaeresis: Ä
- `&Aring;``` latin capital letter A with ring above = latin capital letter A ring: Å
- `&AElig;``` latin capital letter AE = latin capital ligature AE: Æ
- `&Ccedil;``` latin capital letter C with cedilla: Ç
- `&Egrave;``` latin capital letter E with grave: È
- `&Eacute;``` latin capital letter E with acute: É
- `&Ecirc;``` latin capital letter E with circumflex: Ê
- `&Euml;``` latin capital letter E with diaeresis: Ë
- `&Igrave;``` latin capital letter I with grave: Ì
- `&Iacute;``` latin capital letter I with acute: Í
- `&Icirc;``` latin capital letter I with circumflex: Î
- `&Iuml;``` latin capital letter I with diaeresis: Ï
- `&ETH;``` latin capital letter ETH: Ð
- `&Ntilde;``` latin capital letter N with tilde: Ñ
- `&Ograve;``` latin capital letter O with grave: Ò
- `&Oacute;``` latin capital letter O with acute: Ó
- `&Ocirc;``` latin capital letter O with circumflex: Ô
- `&Otilde;``` latin capital letter O with tilde: Õ
- `&Ouml;``` latin capital letter O with diaeresis: Ö
- `&times;``` multiplication sign: ×
- `&Oslash;``` latin capital letter O with stroke = latin capital letter O slash: Ø
- `&Ugrave;``` latin capital letter U with grave: Ù
- `&Uacute;``` latin capital letter U with acute: Ú
- `&Ucirc;``` latin capital letter U with circumflex: Û
- `&Uuml;``` latin capital letter U with diaeresis: Ü
- `&Yacute;``` latin capital letter Y with acute: Ý
- `&THORN;``` latin capital letter THORN: Þ
- `&szlig;``` latin small letter sharp s = ess-zed: ß
- `&agrave;``` latin small letter a with grave = latin small letter a grave: à
- `&aacute;``` latin small letter a with acute: á
- `&acirc;``` latin small letter a with circumflex: â
- `&atilde;``` latin small letter a with tilde: ã
- `&auml;``` latin small letter a with diaeresis: ä
- `&aring;``` latin small letter a with ring above = latin small letter a ring: å
- `&aelig;``` latin small letter ae = latin small ligature ae: æ
- `&ccedil;``` latin small letter c with cedilla: ç
- `&egrave;``` latin small letter e with grave: è
- `&eacute;``` latin small letter e with acute: é
- `&ecirc;``` latin small letter e with circumflex: ê
- `&euml;``` latin small letter e with diaeresis: ë
- `&igrave;``` latin small letter i with grave: ì
- `&iacute;``` latin small letter i with acute: í
- `&icirc;``` latin small letter i with circumflex: î
- `&iuml;``` latin small letter i with diaeresis: ï
- `&eth;``` latin small letter eth: ð
- `&ntilde;``` latin small letter n with tilde: ñ
- `&ograve;``` latin small letter o with grave: ò
- `&oacute;``` latin small letter o with acute: ó
- `&ocirc;``` latin small letter o with circumflex: ô
- `&otilde;``` latin small letter o with tilde: õ
- `&ouml;``` latin small letter o with diaeresis: ö
- `&divide;``` division sign: ÷
- `&oslash;``` latin small letter o with stroke, = latin small letter o slash: ø
- `&ugrave;``` latin small letter u with grave: ù
- `&uacute;``` latin small letter u with acute: ú
- `&ucirc;``` latin small letter u with circumflex: û
- `&uuml;``` latin small letter u with diaeresis: ü
- `&yacute;``` latin small letter y with acute: ý
- `&thorn;``` latin small letter thorn: þ
- `&yuml;``` latin small letter y with diaeresis: ÿ
- `&fnof;``` latin small f with hook = function = florin: ƒ
- `&Alpha;``` greek capital letter alpha: Α
- `&Beta;``` greek capital letter beta: Β
- `&Gamma;``` greek capital letter gamma: Γ
- `&Delta;``` greek capital letter delta: Δ
- `&Epsilon;``` greek capital letter epsilon: Ε
- `&Zeta;``` greek capital letter zeta: Ζ
- `&Eta;``` greek capital letter eta: Η
- `&Theta;``` greek capital letter theta: Θ
- `&Iota;``` greek capital letter iota: Ι
- `&Kappa;``` greek capital letter kappa: Κ
- `&Lambda;``` greek capital letter lambda: Λ
- `&Mu;``` greek capital letter mu: Μ
- `&Nu;``` greek capital letter nu: Ν
- `&Xi;``` greek capital letter xi: Ξ
- `&Omicron;``` greek capital letter omicron: Ο
- `&Pi;``` greek capital letter pi: Π
- `&Rho;``` greek capital letter rho: Ρ
- `&Sigma;``` greek capital letter sigma: Σ
- `&Tau;``` greek capital letter tau: Τ
- `&Upsilon;``` greek capital letter upsilon: Υ
- `&Phi;``` greek capital letter phi: Φ
- `&Chi;``` greek capital letter chi: Χ
- `&Psi;``` greek capital letter psi: Ψ
- `&Omega;``` greek capital letter omega: Ω
- `&alpha;``` greek small letter alpha: α
- `&beta;``` greek small letter beta: β
- `&gamma;``` greek small letter gamma: γ
- `&delta;``` greek small letter delta: δ
- `&epsilon;``` greek small letter epsilon: ε
- `&zeta;``` greek small letter zeta: ζ
- `&eta;``` greek small letter eta: η
- `&theta;``` greek small letter theta: θ
- `&iota;``` greek small letter iota: ι
- `&kappa;``` greek small letter kappa: κ
- `&lambda;``` greek small letter lambda: λ
- `&mu;``` greek small letter mu: μ
- `&nu;``` greek small letter nu: ν
- `&xi;``` greek small letter xi: ξ
- `&omicron;``` greek small letter omicron: ο
- `&pi;``` greek small letter pi: π
- `&rho;``` greek small letter rho: ρ
- `&sigmaf;``` greek small letter final sigma: ς
- `&sigma;``` greek small letter sigma: σ
- `&tau;``` greek small letter tau: τ
- `&upsilon;``` greek small letter upsilon: υ
- `&phi;``` greek small letter phi: φ
- `&chi;``` greek small letter chi: χ
- `&psi;``` greek small letter psi: ψ
- `&omega;``` greek small letter omega: ω
- `&thetasym;` greek small letter theta symbol: ϑ
- `&upsih;``` greek upsilon with hook symbol: ϒ
- `&piv;``` greek pi symbol: ϖ
- `&bull;``` bullet = black small circle: •
- `&hellip;``` horizontal ellipsis = three dot leader: …
- `&prime;``` prime = minutes = feet: ′
- `&Prime;``` double prime = seconds = inches: ″
- `&oline;``` overline = spacing overscore: ‾
- `&frasl;``` fraction slash: ⁄
- `&weierp;``` script capital P = power set = Weierstrass p: ℘
- `&image;``` blackletter capital I = imaginary part: ℑ
- `&real;``` blackletter capital R = real part symbol: ℜ
- `&trade;``` trade mark sign: ™
- `&alefsym;``` alef symbol = first transfinite cardinal: ℵ
- `&larr;``` leftwards arrow: ←
- `&uarr;``` upwards arrow: ↑
- `&rarr;``` rightwards arrow: →
- `&darr;``` downwards arrow: ↓
- `&harr;``` left right arrow: ↔
- `&crarr;``` downwards arrow with corner leftwards = carriage return: ↵
- `&lArr;``` leftwards double arrow: ⇐
- `&uArr;``` upwards double arrow: ⇑
- `&rArr;``` rightwards double arrow: ⇒
- `&dArr;``` downwards double arrow: ⇓
- `&hArr;``` left right double arrow: ⇔
- `&forall;``` for all: ∀
- `&part;``` partial differential: ∂
- `&exist;``` there exists: ∃
- `&empty;``` empty set = null set = diameter: ∅
- `&nabla;``` nabla = backward difference: ∇
- `&isin;``` element of: ∈
- `&notin;``` not an element of: ∉
- `&ni;``` contains as member: ∋
- `&prod;``` n-ary product = product sign: ∏
- `&sum;``` n-ary sumation: ∑
- `&minus;``` minus sign: −
- `&lowast;``` asterisk operator: ∗
- `&radic;``` square root = radical sign: √
- `&prop;``` proportional to: ∝
- `&infin;``` infinity: ∞
- `&ang;``` angle: ∠
- `&and;``` logical and = wedge: ∧
- `&or;``` logical or = vee: ∨
- `&cap;``` intersection = cap: ∩
- `&cup;``` union = cup: ∪
- `&int;``` integral: ∫
- `&there4;``` therefore: ∴
- `&sim;``` tilde operator = varies with = similar to: ∼
- `&cong;``` approximately equal to: ≅
- `&asymp;``` almost equal to = asymptotic to: ≈
- `&ne;``` not equal to: ≠
- `&equiv;``` identical to: ≡
- `&le;``` less-than or equal to: ≤
- `&ge;``` greater-than or equal to: ≥
- `&sub;``` subset of: ⊂
- `&sup;``` superset of: ⊃
- `&nsub;``` not a subset of: ⊄
- `&sube;``` subset of or equal to: ⊆
- `&supe;``` superset of or equal to: ⊇
- `&oplus;``` circled plus = direct sum: ⊕
- `&otimes;``` circled times = vector product: ⊗
- `&perp;``` up tack = orthogonal to = perpendicular: ⊥
- `&sdot;``` dot operator: ⋅
- `&lceil;``` left ceiling = apl upstile: ⌈
- `&rceil;``` right ceiling: ⌉
- `&lfloor;``` left floor = apl downstile: ⌊
- `&rfloor;``` right floor: ⌋
- `&lang;``` left-pointing angle bracket = bra: ⟨
- `&rang;``` right-pointing angle bracket = ket: ⟩
- `&loz;``` lozenge: ◊
- `&spades;``` black spade suit: ♠
- `&clubs;``` black club suit = shamrock: ♣
- `&hearts;``` black heart suit = valentine: ♥
- `&diams;``` black diamond suit: ♦
- `&quot;``` quotation mark = APL quote: "
- `&amp;``` ampersand: &
- `&lt;``` less-than sign: <
- `&gt;``` greater-than sign: >
- `&OElig;``` latin capital ligature OE: Œ
- `&oelig;``` latin small ligature oe: œ
- `&Scaron;``` latin capital letter S with caron: Š
- `&scaron;``` latin small letter s with caron: š
- `&Yuml;``` latin capital letter Y with diaeresis: Ÿ
- `&circ;``` modifier letter circumflex accent: ˆ
- `&tilde;``` small tilde: ˜
- `&ensp;``` en space:
- `&emsp;``` em space:
- `&thinsp;``` thin space:
- `&zwnj;``` zero width non-joiner: ‌
- `&zwj;``` zero width joiner: ‍
- `&lrm;``` left-to-right mark: ‎
- `&rlm;``` right-to-left mark: ‏
- `&ndash;``` en dash: –
- `&mdash;``` em dash: —
- `&lsquo;``` left single quotation mark: ‘
- `&rsquo;``` right single quotation mark: ’
- `&sbquo;``` single low-9 quotation mark: ‚
- `&ldquo;``` left double quotation mark: “
- `&rdquo;``` right double quotation mark: ”
- `&bdquo;``` double low-9 quotation mark: „
- `&dagger;``` dagger: †
- `&Dagger;``` double dagger: ‡
- `&permil;``` per mille sign: ‰
- `&lsaquo;``` single left-pointing angle quotation mark: ‹
- `&rsaquo;``` single right-pointing angle quotation mark: ›
- `&euro;``` euro sign: €

Doxygen extensions:

- `&tm;``` trade mark sign: ™
- `&apos;``` apostrophe: '

Finally, to put invisible comments inside comment blocks, HTML style comments can be used:

    /*! <!-- This is a comment with a comment block --> Visible text */

Go to the next section or return to the index.