/******************************************************************************
*
*
*
* Copyright (C) 1997-2013 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).
Ends an unnumbered item list.
\ Starts a piece of text displayed in an italic font.
\ Ends a \ section.
The special HTML character entities that are recognized by Doxygen:
- \© the copyright symbol
- \™ the trade mark symbol
- \® the registered trade mark symbol
- \< less-than symbol
- \> greater-than symbol
- \& ampersand
- \' single quotation mark (straight)
- \" double quotation mark (straight)
- \‘ left single quotation mark
- \’ right single quotation mark
- \“ left double quotation mark
- \” right double quotation mark
- \– n-dash (for numeric ranges, e.g. 2–8)
- \— m-dash (for parenthetical punctuation — like this)
- \&?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 ä).
- \&?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 á).
- \&?grave; where ? is one of {A,E,I,O,U,a,e,i,o,u,y},
writes a character with a grave accent (like à).
- \&?circ; where ? is one of {A,E,I,O,U,a,e,i,o,u,y},
writes a character with a circumflex accent (like â).
- \&?tilde; where ? is one of {A,N,O,a,n,o},
writes a character with a tilde accent (like ã).
- \ß write a sharp s (i.e. ß) to the output.
- \&?cedil; where ? is one of {c,C},
writes a c-cedille (like ç).
- \&?ring; where ? is one of {a,A},
writes an a with a ring (like å).
- \ a non breakable space.
- \Γ Greek letter Gamma Γ.
- \Δ Greek letter Delta Δ.
- \Θ Greek letter Theta Θ.
- \Λ Greek letter Lambda Λ.
- \Ξ Greek letter Xi Ξ.
- \Π Greek letter Pi Π.
- \Σ Greek letter Sigma Σ.
- \Υ Greek letter Upsilon Υ.
- \Φ Greek letter Phi Φ.
- \Ψ Greek letter Psi Ψ.
- \Ω Greek letter Omega Ω.
- \α Greek letter alpha α.
- \β Greek letter beta β.
- \γ Greek letter gamma γ.
- \δ Greek letter delta δ.
- \ε Greek letter epsilon ε.
- \ζ Greek letter zeta ζ.
- \η Greek letter eta η.
- \θ Greek letter theta θ.
- \ι Greek letter iota ι.
- \κ Greek letter kappa κ.
- \λ Greek letter lambda λ.
- \μ Greek letter mu μ.
- \ν Greek letter nu ν.
- \ξ Greek letter xi ξ.
- \π Greek letter pi π.
- \ρ Greek letter rho ρ.
- \σ Greek letter sigma σ.
- \τ Greek letter tau τ.
- \υ Greek letter upsilon υ.
- \φ Greek letter phi φ.
- \χ Greek letter chi χ.
- \ψ Greek letter psi ψ.
- \ω Greek letter omega ω.
- \ς Greek final sigma ς.
- \§ section sign §.
- \° degree °.
- \′ prime ′.
- \″ double prime ″.
- \∞ infinity ∞.
- \∅ empty set ∅.
- \± plus or minus ±.
- \× multiplication sign ×.
- \− minus sign −.
- \⋅ centered dot ⋅.
- \∂ partial derivative ∂.
- \∇ nabla symbol ∇.
- \√ square root √.
- \⊥ perpendicular symbol ⊥.
- \∑ sum ∑.
- \∫ integral ∫.
- \∏ product ∏.
- \∼ similar to ∼.
- \≈ approximately equal to ≈.
- \≠ not equal to ≠.
- \≡ equivalent to ≡.
- \∝ proportional to ∝.
- \≤ less than or equal to ≤.
- \≥ greater than or equal to ≥.
- \← left arrow ←.
- \→ right arrow →.
- \∈ in the set ∈.
- \∉ not in the set ∉.
- \⌈ left ceiling sign ⌈.
- \⌉ right ceiling sign ⌉.
- \⌊ left floor sign ⌊.
- \⌋ right floor sign ⌋.
Finally, to put invisible comments inside comment blocks, HTML style
comments can be used:
\verbatim
/*! Visible text */
\endverbatim
*/