DoxyPress
1.7.0
|
The following is a list of HTML tags which can be used in your documentation. The HTML tags are translated to the proper commands for output formats which are not HTML. However, the attributes of a HTML tag will only be used when generating HTML output and are ignored for all other output formats.
For the a
tag all output formats support the href
and name
attributes.
HTML Tags | Description |
---|---|
<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 an 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 |
</code> | Ends a <code> section |
<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="..." ...> | The src attribute is mandatory, other attributes for this tag only work with HTML output |
<kbd> | Starts a piece of text displayed in a typewriter font |
</kbd> | Ends a <KBD> section |
<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 |
<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 following is a table containing the HTML characters or entities which can be used in your documentation.
Characters or Entities | Description |
---|---|
| non-breaking space |
¡ | Inverted exclamation mark: ¡ |
¢ | cent sign: ¢ |
£ | pound sign: £ |
¤ | currency sign: ¤ |
¥ | yen sign: ¥ |
¦ | broken vertical bar: ¦ |
§ | section sign: § |
¨ | spacing diaeresis: ¨ |
© | copyright sign: © |
ª | feminine ordinal indicator: ª |
« | left pointing guillemet: « |
¬ | not sign: ¬ |
­ | soft hyphen, discretionary hyphen: |
® | registered trade mark sign: ® |
¯ | overline: ¯ |
° | degree sign: ° |
± | plus minus sign: ± |
¹ | superscript digit one: ¹ |
² | superscript digit two: ² |
³ | superscript digit three: ³ |
´ | acute accent: ´ |
µ | micro sign: µ |
¶ | pilcrow sign, paragraph sign: ¶ |
· | middle dot: · |
¸ | cedilla: ¸ |
º | masculine ordinal indicator: º |
» | right pointing guillemet: » |
¼ | fraction one quarter: ¼ |
½ | fraction one half: ½ |
¾ | fraction three quarters: ¾ |
¿ | inverted question mark: ¿ |
À | latin capital letter A with grave: À |
Á | latin capital letter A with acute: Á |
 | latin capital letter A with circumflex:  |
à | latin capital letter A with tilde: à |
Ä | latin capital letter A with diaeresis: Ä |
Å | latin capital letter A with ring above: Å |
Æ | latin capital letter AE: Æ |
Ç | latin capital letter C with cedilla: Ç |
È | latin capital letter E with grave: È |
É | latin capital letter E with acute: É |
Ê | latin capital letter E with circumflex: Ê |
Ë | latin capital letter E with diaeresis: Ë |
Ì | latin capital letter I with grave: Ì |
Í | latin capital letter I with acute: Í |
Î | latin capital letter I with circumflex: Î |
Ï | latin capital letter I with diaeresis: Ï |
Ð | latin capital letter ETH: Ð |
Ñ | latin capital letter N with tilde: Ñ |
Ò | latin capital letter O with grave: Ò |
Ó | latin capital letter O with acute: Ó |
Ô | latin capital letter O with circumflex: Ô |
Õ | latin capital letter O with tilde: Õ |
Ö | latin capital letter O with diaeresis: Ö |
× | multiplication sign: × |
Ø | latin capital letter O with slash: Ø |
Ù | latin capital letter U with grave: Ù |
Ú | latin capital letter U with acute: Ú |
Û | latin capital letter U with circumflex: Û |
Ü | latin capital letter U with diaeresis: Ü |
Ý | latin capital letter Y with acute: Ý |
Þ | latin capital letter THORN: Þ |
ß | latin small letter sharp s, esszett: ß |
à | latin small letter a with grave: à |
á | latin small letter a with acute: á |
â | latin small letter a with circumflex: â |
ã | latin small letter a with tilde: ã |
ä | latin small letter a with diaeresis: ä |
å | latin small letter a with ring above: å |
æ | latin small letter ae: æ |
ç | latin small letter c with cedilla: ç |
è | latin small letter e with grave: è |
é | latin small letter e with acute: é |
ê | latin small letter e with circumflex: ê |
ë | latin small letter e with diaeresis: ë |
ì | latin small letter i with grave: ì |
í | latin small letter i with acute: í |
î | latin small letter i with circumflex: î |
ï | latin small letter i with diaeresis: ï |
ð | latin small letter eth: ð |
ñ | latin small letter n with tilde: ñ |
ò | latin small letter o with grave: ò |
ó | latin small letter o with acute: ó |
ô | latin small letter o with circumflex: ô |
õ | latin small letter o with tilde: õ |
ö | latin small letter o with diaeresis: ö |
÷ | division sign: ÷ |
ø | latin small letter o with slash: ø |
ù | latin small letter u with grave: ù |
ú | latin small letter u with acute: ú |
û | latin small letter u with circumflex: û |
ü | latin small letter u with diaeresis: ü |
ý | latin small letter y with acute: ý |
þ | latin small letter thorn: þ |
ÿ | latin small letter y with diaeresis: ÿ |
ƒ | latin small f with hook = function = florin: ƒ |
Α | greek capital letter alpha: Α |
Β | greek capital letter beta: Β |
Γ | greek capital letter gamma: Γ |
Δ | greek capital letter delta: Δ |
Ε | greek capital letter epsilon: Ε |
Ζ | greek capital letter zeta: Ζ |
Η | greek capital letter eta: Η |
Θ | greek capital letter theta: Θ |
Ι | greek capital letter iota: Ι |
Κ | greek capital letter kappa: Κ |
Λ | greek capital letter lambda: Λ |
Μ | greek capital letter mu: Μ |
Ν | greek capital letter nu: Ν |
Ξ | greek capital letter xi: Ξ |
Ο | greek capital letter omicron: Ο |
Π | greek capital letter pi: Π |
Ρ | greek capital letter rho: Ρ |
Σ | greek capital letter sigma: Σ |
Τ | greek capital letter tau: Τ |
Υ | greek capital letter upsilon: Υ |
Φ | greek capital letter phi: Φ |
Χ | greek capital letter chi: Χ |
Ψ | greek capital letter psi: Ψ |
Ω | greek capital letter omega: Ω |
α | greek small letter alpha: α |
β | greek small letter beta: β |
γ | greek small letter gamma: γ |
δ | greek small letter delta: δ |
ε | greek small letter epsilon: ε |
ζ | greek small letter zeta: ζ |
η | greek small letter eta: η |
θ | greek small letter theta: θ |
ι | greek small letter iota: ι |
κ | greek small letter kappa: κ |
λ | greek small letter lambda: λ |
μ | greek small letter mu: μ |
ν | greek small letter nu: ν |
ξ | greek small letter xi: ξ |
ο | greek small letter omicron: ο |
π | greek small letter pi: π |
ρ | greek small letter rho: ρ |
ς | greek small letter final sigma: ς |
σ | greek small letter sigma: σ |
τ | greek small letter tau: τ |
υ | greek small letter upsilon: υ |
φ | greek small letter phi: φ |
χ | greek small letter chi: χ |
ψ | greek small letter psi: ψ |
ω | greek small letter omega: ω |
ϑ | greek small letter theta symbol: ϑ |
ϒ | greek upsilon with hook symbol: ϒ |
ϖ | greek pi symbol: ϖ |
• | bullet: • |
… | horizontal ellipsis: … |
′ | prime: ′ |
″ | double prime: ″ |
‾ | overline: ‾ |
⁄ | fraction slash: ⁄ |
℘ | script capital P: ℘ |
ℑ | blackletter capital I: ℑ |
ℜ | blackletter capital R: ℜ |
™ | trade mark sign: ™ |
ℵ | alef symbol: ℵ |
← | leftwards arrow: ← |
↑ | upwards arrow: ↑ |
→ | rightwards arrow: → |
↓ | downwards arrow: ↓ |
↔ | left right arrow: ↔ |
↵ | carriage return: ↵ |
⇐ | leftwards double arrow: ⇐ |
⇑ | upwards double arrow: ⇑ |
⇒ | rightwards double arrow: ⇒ |
⇓ | downwards double arrow: ⇓ |
⇔ | left right double arrow: ⇔ |
∀ | for all: ∀ |
∂ | partial differential: ∂ |
∃ | there exists: ∃ |
∅ | empty set, diameter: ∅ |
∇ | nabla, backward difference: ∇ |
∈ | element of: ∈ |
∉ | not an element of: ∉ |
∋ | contains as member: ∋ |
∏ | product sign: ∏ |
∑ | summation: ∑ |
− | minus sign: − |
∗ | asterisk operator: ∗ |
√ | square root: √ |
∝ | proportional to: ∝ |
∞ | infinity: ∞ |
∠ | angle: ∠ |
∧ | logical and: ∧ |
∨ | logical or: ∨ |
∩ | intersection: ∩ |
∪ | union: ∪ |
∫ | integral: ∫ |
∴ | therefore: ∴ |
∼ | tilde operator: ∼ |
≅ | approximately equal to: ≅ |
≈ | almost equal to: ≈ |
≠ | not equal to: ≠ |
≡ | identical to: ≡ |
≤ | less-than or equal to: ≤ |
≥ | greater-than or equal to: ≥ |
⊂ | subset of: ⊂ |
⊃ | superset of: ⊃ |
⊄ | not a subset of: ⊄ |
⊆ | subset of or equal to: ⊆ |
⊇ | superset of or equal to: ⊇ |
⊕ | circled plus: ⊕ |
⊗ | circled times: ⊗ |
⊥ | perpendicular: ⊥ |
⋅ | dot operator: ⋅ |
⌈ | left ceiling: ⌈ |
⌉ | right ceiling: ⌉ |
⌊ | left floor: ⌊ |
⌋ | right floor: ⌋ |
⟨ | left-pointing angle bracket: 〈 |
⟩ | right-pointing angle bracket: 〉 |
◊ | lozenge: ◊ |
♠ | black spade suit: ♠ |
♣ | black club suit: ♣ |
♥ | black heart suit: ♥ |
♦ | black diamond suit: ♦ |
" | quotation mark: " |
& | ampersand: & |
< | less-than sign: < |
> | greater-than sign: > |
Œ | latin capital ligature OE: Œ |
œ | latin small ligature oe: œ |
Š | latin capital letter S with caron: Š |
š | latin small letter s with caron: š |
Ÿ | latin capital letter Y with diaeresis: Ÿ |
ˆ | modifier letter circumflex accent: ˆ |
˜ | small tilde: ˜ |
  | en space: |
  | em space: |
  | thin space: |
‌ | zero width non-joiner: |
‍ | zero width joiner: |
‎ | left-to-right mark: |
‏ | right-to-left mark: |
– | en dash: – |
— | em dash: — |
‘ | left single quotation mark: ‘ |
’ | right single quotation mark: ’ |
‚ | single low-9 quotation mark: ‚ |
“ | left double quotation mark: “ |
” | right double quotation mark: ” |
„ | double low-9 quotation mark: „ |
† | dagger: † |
‡ | double dagger: ‡ |
‰ | per mille sign: ‰ |
‹ | single left-pointing angle quotation mark: ‹ |
› | single right-pointing angle quotation mark: › |
€ | euro sign: € |
The following is a table containing characters or entities specific to DoxyPress which can be used in your documentation.
DoxyPress Characters | Description |
---|---|
&tm; | Trade mark sign: ™ |
' | Apostrophe: ' |