summaryrefslogtreecommitdiffstats
path: root/doc/htmlcmds.doc
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2014-02-08 19:46:56 (GMT)
committeralbert-github <albert.tests@gmail.com>2014-02-08 19:46:56 (GMT)
commit1bd64ac0e925ba2ff069ec64c026ea3c32f85600 (patch)
tree0a4663d5a76502ceb35b774ac9dc491763d978b7 /doc/htmlcmds.doc
parent0178674db5f4391e41c389d21f42656684939167 (diff)
downloadDoxygen-1bd64ac0e925ba2ff069ec64c026ea3c32f85600.zip
Doxygen-1bd64ac0e925ba2ff069ec64c026ea3c32f85600.tar.gz
Doxygen-1bd64ac0e925ba2ff069ec64c026ea3c32f85600.tar.bz2
Recognize all HTML4 special character entities
In doxygen a limited number of HTML4 special character entities are recognized, with this patch the full list of HTML4 special character entities (see http://www.w3.org/TR/html4/sgml/entities.html) is supported (as far as they can be represented in the output format). - doxygen_manual.tex - latexgen.cpp Added wasysym package to support per thousand sign (perthousand command from textcomp didn't work properly) Added option for textcomp package so currency symbol would work properly - htmlcmds.doc Adjusted documentation, listing all entities - compound.xsd - xmlgen.cpp Removed in xsd file all references for special HTML4 character entities and placed placeholder so doxygen (in xmlgen.cpp)can automatically add the right element names. - util.cpp - util.h Define all entities with their representation for all output formats. Define access routines to the different representations Mapping (for recognition of the entities) based on running through the list of available entities, after validation of the order of the entities. A few entities contain now besides letters also numbers at the end. - docparser.h Define symbols for all entities as well as a helper struct and enum. The member m_letter is not used anymore and thus removed. All existing symbols were renamed so no confusion (i.e. errors when forgetting to rename some symbols) can occur. Obsolete references to letter removed, all letters with accents etc. are explicitly defined and not through the generic accent name plus an extra letter. - docparser.cpp Adjust used symbols to their new names. Remove references to letter (as used for accents etc.) Replace list of explicitly supported entities with call to symbol code access routine. - docbookvisitor.cpp - htmldocvisitor.cpp - latexdocvisitor.cpp - mandocvisitor.cpp - perlmodgen.cpp - printdocvisitor.h - rtfdocvisitor.cpp - textdocvisitor.cpp - xmldocvisitor.cpp Replace list of explicitly supported entities with call to access routine and use returned value to output.
Diffstat (limited to 'doc/htmlcmds.doc')
-rw-r--r--doc/htmlcmds.doc362
1 files changed, 263 insertions, 99 deletions
diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc
index 7038e99..96abe0a 100644
--- a/doc/htmlcmds.doc
+++ b/doc/htmlcmds.doc
@@ -109,106 +109,270 @@ of a HTML tag are passed on to the HTML output only
<li><tt>\</VAR\></tt> Ends a <tt>\<VAR\></tt> section.
</ul>
-The special HTML character entities that are recognized by Doxygen:
-
+The special HTML4 character entities.<br>
+The list of entities with their descriptions has been taken from <a href="http://www.w3.org/TR/html4/sgml/entities.html">Character entity references in HTML 4</a>.
+( Portions &copy; 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.)
+<ul>
+<li><tt>\&nbsp;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` no-break space = non-breaking space: &nbsp;
+<li><tt>\&iexcl;</tt>`&nbsp;&nbsp;&nbsp;` inverted exclamation mark: &iexcl;
+<li><tt>\&cent;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` cent sign: &cent;
+<li><tt>\&pound;</tt>`&nbsp;&nbsp;&nbsp;` pound sign: &pound;
+<li><tt>\&curren;</tt>`&nbsp;&nbsp;` currency sign: &curren;
+<li><tt>\&yen;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` yen sign = yuan sign: &yen;
+<li><tt>\&brvbar;</tt>`&nbsp;&nbsp;` broken bar = broken vertical bar: &brvbar;
+<li><tt>\&sect;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` section sign: &sect;
+<li><tt>\&uml;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` diaeresis = spacing diaeresis: &uml;
+<li><tt>\&copy;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` copyright sign: &copy;
+<li><tt>\&ordf;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` feminine ordinal indicator: &ordf;
+<li><tt>\&laquo;</tt>`&nbsp;&nbsp;&nbsp;` left-pointing double angle quotation mark = left pointing guillemet: &laquo;
+<li><tt>\&not;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` not sign: &not;
+<li><tt>\&shy;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` soft hyphen = discretionary hyphen: &shy;
+<li><tt>\&reg;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` registered sign = registered trade mark sign: &reg;
+<li><tt>\&macr;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` macron = spacing macron = overline = APL overbar: &macr;
+<li><tt>\&deg;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` degree sign: &deg;
+<li><tt>\&plusmn;</tt>`&nbsp;&nbsp;` plus-minus sign = plus-or-minus sign: &plusmn;
+<li><tt>\&sup2;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` superscript two = superscript digit two = squared: &sup2;
+<li><tt>\&sup3;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` superscript three = superscript digit three = cubed: &sup3;
+<li><tt>\&acute;</tt>`&nbsp;&nbsp;&nbsp;` acute accent = spacing acute: &acute;
+<li><tt>\&micro;</tt>`&nbsp;&nbsp;&nbsp;` micro sign: &micro;
+<li><tt>\&para;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` pilcrow sign = paragraph sign: &para;
+<li><tt>\&middot;</tt>`&nbsp;&nbsp;` middle dot = Georgian comma = Greek middle dot: &middot;
+<li><tt>\&cedil;</tt>`&nbsp;&nbsp;&nbsp;` cedilla = spacing cedilla: &cedil;
+<li><tt>\&sup1;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` superscript one = superscript digit one: &sup1;
+<li><tt>\&ordm;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` masculine ordinal indicator: &ordm;
+<li><tt>\&raquo;</tt>`&nbsp;&nbsp;&nbsp;` right-pointing double angle quotation mark = right pointing guillemet: &raquo;
+<li><tt>\&frac14;</tt>`&nbsp;&nbsp;` vulgar fraction one quarter = fraction one quarter: &frac14;
+<li><tt>\&frac12;</tt>`&nbsp;&nbsp;` vulgar fraction one half = fraction one half: &frac12;
+<li><tt>\&frac34;</tt>`&nbsp;&nbsp;` vulgar fraction three quarters = fraction three quarters: &frac34;
+<li><tt>\&iquest;</tt>`&nbsp;&nbsp;` inverted question mark = turned question mark: &iquest;
+<li><tt>\&Agrave;</tt>`&nbsp;&nbsp;` latin capital letter A with grave = latin capital letter A grave: &Agrave;
+<li><tt>\&Aacute;</tt>`&nbsp;&nbsp;` latin capital letter A with acute: &Aacute;
+<li><tt>\&Acirc;</tt>`&nbsp;&nbsp;&nbsp;` latin capital letter A with circumflex: &Acirc;
+<li><tt>\&Atilde;</tt>`&nbsp;&nbsp;` latin capital letter A with tilde: &Atilde;
+<li><tt>\&Auml;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` latin capital letter A with diaeresis: &Auml;
+<li><tt>\&Aring;</tt>`&nbsp;&nbsp;&nbsp;` latin capital letter A with ring above = latin capital letter A ring: &Aring;
+<li><tt>\&AElig;</tt>`&nbsp;&nbsp;&nbsp;` latin capital letter AE = latin capital ligature AE: &AElig;
+<li><tt>\&Ccedil;</tt>`&nbsp;&nbsp;` latin capital letter C with cedilla: &Ccedil;
+<li><tt>\&Egrave;</tt>`&nbsp;&nbsp;` latin capital letter E with grave: &Egrave;
+<li><tt>\&Eacute;</tt>`&nbsp;&nbsp;` latin capital letter E with acute: &Eacute;
+<li><tt>\&Ecirc;</tt>`&nbsp;&nbsp;&nbsp;` latin capital letter E with circumflex: &Ecirc;
+<li><tt>\&Euml;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` latin capital letter E with diaeresis: &Euml;
+<li><tt>\&Igrave;</tt>`&nbsp;&nbsp;` latin capital letter I with grave: &Igrave;
+<li><tt>\&Iacute;</tt>`&nbsp;&nbsp;` latin capital letter I with acute: &Iacute;
+<li><tt>\&Icirc;</tt>`&nbsp;&nbsp;&nbsp;` latin capital letter I with circumflex: &Icirc;
+<li><tt>\&Iuml;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` latin capital letter I with diaeresis: &Iuml;
+<li><tt>\&ETH;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` latin capital letter ETH: &ETH;
+<li><tt>\&Ntilde;</tt>`&nbsp;&nbsp;` latin capital letter N with tilde: &Ntilde;
+<li><tt>\&Ograve;</tt>`&nbsp;&nbsp;` latin capital letter O with grave: &Ograve;
+<li><tt>\&Oacute;</tt>`&nbsp;&nbsp;` latin capital letter O with acute: &Oacute;
+<li><tt>\&Ocirc;</tt>`&nbsp;&nbsp;&nbsp;` latin capital letter O with circumflex: &Ocirc;
+<li><tt>\&Otilde;</tt>`&nbsp;&nbsp;` latin capital letter O with tilde: &Otilde;
+<li><tt>\&Ouml;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` latin capital letter O with diaeresis: &Ouml;
+<li><tt>\&times;</tt>`&nbsp;&nbsp;&nbsp;` multiplication sign: &times;
+<li><tt>\&Oslash;</tt>`&nbsp;&nbsp;` latin capital letter O with stroke = latin capital letter O slash: &Oslash;
+<li><tt>\&Ugrave;</tt>`&nbsp;&nbsp;` latin capital letter U with grave: &Ugrave;
+<li><tt>\&Uacute;</tt>`&nbsp;&nbsp;` latin capital letter U with acute: &Uacute;
+<li><tt>\&Ucirc;</tt>`&nbsp;&nbsp;&nbsp;` latin capital letter U with circumflex: &Ucirc;
+<li><tt>\&Uuml;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` latin capital letter U with diaeresis: &Uuml;
+<li><tt>\&Yacute;</tt>`&nbsp;&nbsp;` latin capital letter Y with acute: &Yacute;
+<li><tt>\&THORN;</tt>`&nbsp;&nbsp;&nbsp;` latin capital letter THORN: &THORN;
+<li><tt>\&szlig;</tt>`&nbsp;&nbsp;&nbsp;` latin small letter sharp s = ess-zed: &szlig;
+<li><tt>\&agrave;</tt>`&nbsp;&nbsp;` latin small letter a with grave = latin small letter a grave: &agrave;
+<li><tt>\&aacute;</tt>`&nbsp;&nbsp;` latin small letter a with acute: &aacute;
+<li><tt>\&acirc;</tt>`&nbsp;&nbsp;&nbsp;` latin small letter a with circumflex: &acirc;
+<li><tt>\&atilde;</tt>`&nbsp;&nbsp;` latin small letter a with tilde: &atilde;
+<li><tt>\&auml;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` latin small letter a with diaeresis: &auml;
+<li><tt>\&aring;</tt>`&nbsp;&nbsp;&nbsp;` latin small letter a with ring above = latin small letter a ring: &aring;
+<li><tt>\&aelig;</tt>`&nbsp;&nbsp;&nbsp;` latin small letter ae = latin small ligature ae: &aelig;
+<li><tt>\&ccedil;</tt>`&nbsp;&nbsp;` latin small letter c with cedilla: &ccedil;
+<li><tt>\&egrave;</tt>`&nbsp;&nbsp;` latin small letter e with grave: &egrave;
+<li><tt>\&eacute;</tt>`&nbsp;&nbsp;` latin small letter e with acute: &eacute;
+<li><tt>\&ecirc;</tt>`&nbsp;&nbsp;&nbsp;` latin small letter e with circumflex: &ecirc;
+<li><tt>\&euml;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` latin small letter e with diaeresis: &euml;
+<li><tt>\&igrave;</tt>`&nbsp;&nbsp;` latin small letter i with grave: &igrave;
+<li><tt>\&iacute;</tt>`&nbsp;&nbsp;` latin small letter i with acute: &iacute;
+<li><tt>\&icirc;</tt>`&nbsp;&nbsp;&nbsp;` latin small letter i with circumflex: &icirc;
+<li><tt>\&iuml;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` latin small letter i with diaeresis: &iuml;
+<li><tt>\&eth;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` latin small letter eth: &eth;
+<li><tt>\&ntilde;</tt>`&nbsp;&nbsp;` latin small letter n with tilde: &ntilde;
+<li><tt>\&ograve;</tt>`&nbsp;&nbsp;` latin small letter o with grave: &ograve;
+<li><tt>\&oacute;</tt>`&nbsp;&nbsp;` latin small letter o with acute: &oacute;
+<li><tt>\&ocirc;</tt>`&nbsp;&nbsp;&nbsp;` latin small letter o with circumflex: &ocirc;
+<li><tt>\&otilde;</tt>`&nbsp;&nbsp;` latin small letter o with tilde: &otilde;
+<li><tt>\&ouml;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` latin small letter o with diaeresis: &ouml;
+<li><tt>\&divide;</tt>`&nbsp;&nbsp;` division sign: &divide;
+<li><tt>\&oslash;</tt>`&nbsp;&nbsp;` latin small letter o with stroke, = latin small letter o slash: &oslash;
+<li><tt>\&ugrave;</tt>`&nbsp;&nbsp;` latin small letter u with grave: &ugrave;
+<li><tt>\&uacute;</tt>`&nbsp;&nbsp;` latin small letter u with acute: &uacute;
+<li><tt>\&ucirc;</tt>`&nbsp;&nbsp;&nbsp;` latin small letter u with circumflex: &ucirc;
+<li><tt>\&uuml;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` latin small letter u with diaeresis: &uuml;
+<li><tt>\&yacute;</tt>`&nbsp;&nbsp;` latin small letter y with acute: &yacute;
+<li><tt>\&thorn;</tt>`&nbsp;&nbsp;&nbsp;` latin small letter thorn: &thorn;
+<li><tt>\&yuml;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` latin small letter y with diaeresis: &yuml;
+<li><tt>\&fnof;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` latin small f with hook = function = florin: &fnof;
+<li><tt>\&Alpha;</tt>`&nbsp;&nbsp;&nbsp;` greek capital letter alpha: &Alpha;
+<li><tt>\&Beta;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` greek capital letter beta: &Beta;
+<li><tt>\&Gamma;</tt>`&nbsp;&nbsp;&nbsp;` greek capital letter gamma: &Gamma;
+<li><tt>\&Delta;</tt>`&nbsp;&nbsp;&nbsp;` greek capital letter delta: &Delta;
+<li><tt>\&Epsilon;</tt>`&nbsp;` greek capital letter epsilon: &Epsilon;
+<li><tt>\&Zeta;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` greek capital letter zeta: &Zeta;
+<li><tt>\&Eta;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek capital letter eta: &Eta;
+<li><tt>\&Theta;</tt>`&nbsp;&nbsp;&nbsp;` greek capital letter theta: &Theta;
+<li><tt>\&Iota;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` greek capital letter iota: &Iota;
+<li><tt>\&Kappa;</tt>`&nbsp;&nbsp;&nbsp;` greek capital letter kappa: &Kappa;
+<li><tt>\&Lambda;</tt>`&nbsp;&nbsp;` greek capital letter lambda: &Lambda;
+<li><tt>\&Mu;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek capital letter mu: &Mu;
+<li><tt>\&Nu;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek capital letter nu: &Nu;
+<li><tt>\&Xi;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek capital letter xi: &Xi;
+<li><tt>\&Omicron;</tt>`&nbsp;` greek capital letter omicron: &Omicron;
+<li><tt>\&Pi;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek capital letter pi: &Pi;
+<li><tt>\&Rho;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek capital letter rho: &Rho;
+<li><tt>\&Sigma;</tt>`&nbsp;&nbsp;&nbsp;` greek capital letter sigma: &Sigma;
+<li><tt>\&Tau;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek capital letter tau: &Tau;
+<li><tt>\&Upsilon;</tt>`&nbsp;` greek capital letter upsilon: &Upsilon;
+<li><tt>\&Phi;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek capital letter phi: &Phi;
+<li><tt>\&Chi;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek capital letter chi: &Chi;
+<li><tt>\&Psi;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek capital letter psi: &Psi;
+<li><tt>\&Omega;</tt>`&nbsp;&nbsp;&nbsp;` greek capital letter omega: &Omega;
+<li><tt>\&alpha;</tt>`&nbsp;&nbsp;&nbsp;` greek small letter alpha: &alpha;
+<li><tt>\&beta;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` greek small letter beta: &beta;
+<li><tt>\&gamma;</tt>`&nbsp;&nbsp;&nbsp;` greek small letter gamma: &gamma;
+<li><tt>\&delta;</tt>`&nbsp;&nbsp;&nbsp;` greek small letter delta: &delta;
+<li><tt>\&epsilon;</tt>`&nbsp;` greek small letter epsilon: &epsilon;
+<li><tt>\&zeta;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` greek small letter zeta: &zeta;
+<li><tt>\&eta;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek small letter eta: &eta;
+<li><tt>\&theta;</tt>`&nbsp;&nbsp;&nbsp;` greek small letter theta: &theta;
+<li><tt>\&iota;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` greek small letter iota: &iota;
+<li><tt>\&kappa;</tt>`&nbsp;&nbsp;&nbsp;` greek small letter kappa: &kappa;
+<li><tt>\&lambda;</tt>`&nbsp;&nbsp;` greek small letter lambda: &lambda;
+<li><tt>\&mu;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek small letter mu: &mu;
+<li><tt>\&nu;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek small letter nu: &nu;
+<li><tt>\&xi;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek small letter xi: &xi;
+<li><tt>\&omicron;</tt>`&nbsp;` greek small letter omicron: &omicron;
+<li><tt>\&pi;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek small letter pi: &pi;
+<li><tt>\&rho;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek small letter rho: &rho;
+<li><tt>\&sigmaf;</tt>`&nbsp;&nbsp;` greek small letter final sigma: &sigmaf;
+<li><tt>\&sigma;</tt>`&nbsp;&nbsp;&nbsp;` greek small letter sigma: &sigma;
+<li><tt>\&tau;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek small letter tau: &tau;
+<li><tt>\&upsilon;</tt>`&nbsp;` greek small letter upsilon: &upsilon;
+<li><tt>\&phi;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek small letter phi: &phi;
+<li><tt>\&chi;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek small letter chi: &chi;
+<li><tt>\&psi;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek small letter psi: &psi;
+<li><tt>\&omega;</tt>`&nbsp;&nbsp;&nbsp;` greek small letter omega: &omega;
+<li><tt>\&thetasym;</tt> greek small letter theta symbol: &thetasym;
+<li><tt>\&upsih;</tt>`&nbsp;&nbsp;&nbsp;` greek upsilon with hook symbol: &upsih;
+<li><tt>\&piv;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greek pi symbol: &piv;
+<li><tt>\&bull;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` bullet = black small circle: &bull;
+<li><tt>\&hellip;</tt>`&nbsp;&nbsp;` horizontal ellipsis = three dot leader: &hellip;
+<li><tt>\&prime;</tt>`&nbsp;&nbsp;&nbsp;` prime = minutes = feet: &prime;
+<li><tt>\&Prime;</tt>`&nbsp;&nbsp;&nbsp;` double prime = seconds = inches: &Prime;
+<li><tt>\&oline;</tt>`&nbsp;&nbsp;&nbsp;` overline = spacing overscore: &oline;
+<li><tt>\&frasl;</tt>`&nbsp;&nbsp;&nbsp;` fraction slash: &frasl;
+<li><tt>\&weierp;</tt>`&nbsp;&nbsp;` script capital P = power set = Weierstrass p: &weierp;
+<li><tt>\&image;</tt>`&nbsp;&nbsp;&nbsp;` blackletter capital I = imaginary part: &image;
+<li><tt>\&real;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` blackletter capital R = real part symbol: &real;
+<li><tt>\&trade;</tt>`&nbsp;&nbsp;&nbsp;` trade mark sign: &trade;
+<li><tt>\&alefsym;</tt>`&nbsp;` alef symbol = first transfinite cardinal: &alefsym;
+<li><tt>\&larr;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` leftwards arrow: &larr;
+<li><tt>\&uarr;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` upwards arrow: &uarr;
+<li><tt>\&rarr;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` rightwards arrow: &rarr;
+<li><tt>\&darr;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` downwards arrow: &darr;
+<li><tt>\&harr;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` left right arrow: &harr;
+<li><tt>\&crarr;</tt>`&nbsp;&nbsp;&nbsp;` downwards arrow with corner leftwards = carriage return: &crarr;
+<li><tt>\&lArr;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` leftwards double arrow: &lArr;
+<li><tt>\&uArr;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` upwards double arrow: &uArr;
+<li><tt>\&rArr;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` rightwards double arrow: &rArr;
+<li><tt>\&dArr;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` downwards double arrow: &dArr;
+<li><tt>\&hArr;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` left right double arrow: &hArr;
+<li><tt>\&forall;</tt>`&nbsp;&nbsp;` for all: &forall;
+<li><tt>\&part;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` partial differential: &part;
+<li><tt>\&exist;</tt>`&nbsp;&nbsp;&nbsp;` there exists: &exist;
+<li><tt>\&empty;</tt>`&nbsp;&nbsp;&nbsp;` empty set = null set = diameter: &empty;
+<li><tt>\&nabla;</tt>`&nbsp;&nbsp;&nbsp;` nabla = backward difference: &nabla;
+<li><tt>\&isin;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` element of: &isin;
+<li><tt>\&notin;</tt>`&nbsp;&nbsp;&nbsp;` not an element of: &notin;
+<li><tt>\&ni;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` contains as member: &ni;
+<li><tt>\&prod;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` n-ary product = product sign: &prod;
+<li><tt>\&sum;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` n-ary sumation: &sum;
+<li><tt>\&minus;</tt>`&nbsp;&nbsp;&nbsp;` minus sign: &minus;
+<li><tt>\&lowast;</tt>`&nbsp;&nbsp;` asterisk operator: &lowast;
+<li><tt>\&radic;</tt>`&nbsp;&nbsp;&nbsp;` square root = radical sign: &radic;
+<li><tt>\&prop;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` proportional to: &prop;
+<li><tt>\&infin;</tt>`&nbsp;&nbsp;&nbsp;` infinity: &infin;
+<li><tt>\&ang;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` angle: &ang;
+<li><tt>\&and;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` logical and = wedge: &and;
+<li><tt>\&or;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` logical or = vee: &or;
+<li><tt>\&cap;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` intersection = cap: &cap;
+<li><tt>\&cup;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` union = cup: &cup;
+<li><tt>\&int;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` integral: &int;
+<li><tt>\&there4;</tt>`&nbsp;&nbsp;` therefore: &there4;
+<li><tt>\&sim;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` tilde operator = varies with = similar to: &sim;
+<li><tt>\&cong;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` approximately equal to: &cong;
+<li><tt>\&asymp;</tt>`&nbsp;&nbsp;&nbsp;` almost equal to = asymptotic to: &asymp;
+<li><tt>\&ne;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` not equal to: &ne;
+<li><tt>\&equiv;</tt>`&nbsp;&nbsp;&nbsp;` identical to: &equiv;
+<li><tt>\&le;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` less-than or equal to: &le;
+<li><tt>\&ge;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greater-than or equal to: &ge;
+<li><tt>\&sub;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` subset of: &sub;
+<li><tt>\&sup;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` superset of: &sup;
+<li><tt>\&nsub;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` not a subset of: &nsub;
+<li><tt>\&sube;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` subset of or equal to: &sube;
+<li><tt>\&supe;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` superset of or equal to: &supe;
+<li><tt>\&oplus;</tt>`&nbsp;&nbsp;&nbsp;` circled plus = direct sum: &oplus;
+<li><tt>\&otimes;</tt>`&nbsp;&nbsp;` circled times = vector product: &otimes;
+<li><tt>\&perp;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` up tack = orthogonal to = perpendicular: &perp;
+<li><tt>\&sdot;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` dot operator: &sdot;
+<li><tt>\&lceil;</tt>`&nbsp;&nbsp;&nbsp;` left ceiling = apl upstile: &lceil;
+<li><tt>\&rceil;</tt>`&nbsp;&nbsp;&nbsp;` right ceiling: &rceil;
+<li><tt>\&lfloor;</tt>`&nbsp;&nbsp;` left floor = apl downstile: &lfloor;
+<li><tt>\&rfloor;</tt>`&nbsp;&nbsp;` right floor: &rfloor;
+<li><tt>\&lang;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` left-pointing angle bracket = bra: &lang;
+<li><tt>\&rang;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` right-pointing angle bracket = ket: &rang;
+<li><tt>\&loz;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` lozenge: &loz;
+<li><tt>\&spades;</tt>`&nbsp;&nbsp;` black spade suit: &spades;
+<li><tt>\&clubs;</tt>`&nbsp;&nbsp;&nbsp;` black club suit = shamrock: &clubs;
+<li><tt>\&hearts;</tt>`&nbsp;&nbsp;` black heart suit = valentine: &hearts;
+<li><tt>\&diams;</tt>`&nbsp;&nbsp;&nbsp;` black diamond suit: &diams;
+<li><tt>\&quot;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` quotation mark = APL quote: &quot;
+<li><tt>\&amp;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` ampersand: &amp;
+<li><tt>\&lt;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` less-than sign: &lt;
+<li><tt>\&gt;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` greater-than sign: &gt;
+<li><tt>\&OElig;</tt>`&nbsp;&nbsp;&nbsp;` latin capital ligature OE: &OElig;
+<li><tt>\&oelig;</tt>`&nbsp;&nbsp;&nbsp;` latin small ligature oe: &oelig;
+<li><tt>\&Scaron;</tt>`&nbsp;&nbsp;` latin capital letter S with caron: &Scaron;
+<li><tt>\&scaron;</tt>`&nbsp;&nbsp;` latin small letter s with caron: &scaron;
+<li><tt>\&Yuml;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` latin capital letter Y with diaeresis: &Yuml;
+<li><tt>\&circ;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` modifier letter circumflex accent: &circ;
+<li><tt>\&tilde;</tt>`&nbsp;&nbsp;&nbsp;` small tilde: &tilde;
+<li><tt>\&ensp;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` en space: &ensp;
+<li><tt>\&emsp;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` em space: &emsp;
+<li><tt>\&thinsp;</tt>`&nbsp;&nbsp;` thin space: &thinsp;
+<li><tt>\&zwnj;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` zero width non-joiner: &zwnj;
+<li><tt>\&zwj;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` zero width joiner: &zwj;
+<li><tt>\&lrm;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` left-to-right mark: &lrm;
+<li><tt>\&rlm;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` right-to-left mark: &rlm;
+<li><tt>\&ndash;</tt>`&nbsp;&nbsp;&nbsp;` en dash: &ndash;
+<li><tt>\&mdash;</tt>`&nbsp;&nbsp;&nbsp;` em dash: &mdash;
+<li><tt>\&lsquo;</tt>`&nbsp;&nbsp;&nbsp;` left single quotation mark: &lsquo;
+<li><tt>\&rsquo;</tt>`&nbsp;&nbsp;&nbsp;` right single quotation mark: &rsquo;
+<li><tt>\&sbquo;</tt>`&nbsp;&nbsp;&nbsp;` single low-9 quotation mark: &sbquo;
+<li><tt>\&ldquo;</tt>`&nbsp;&nbsp;&nbsp;` left double quotation mark: &ldquo;
+<li><tt>\&rdquo;</tt>`&nbsp;&nbsp;&nbsp;` right double quotation mark: &rdquo;
+<li><tt>\&bdquo;</tt>`&nbsp;&nbsp;&nbsp;` double low-9 quotation mark: &bdquo;
+<li><tt>\&dagger;</tt>`&nbsp;&nbsp;` dagger: &dagger;
+<li><tt>\&Dagger;</tt>`&nbsp;&nbsp;` double dagger: &Dagger;
+<li><tt>\&permil;</tt>`&nbsp;&nbsp;` per mille sign: &permil;
+<li><tt>\&lsaquo;</tt>`&nbsp;&nbsp;` single left-pointing angle quotation mark: &lsaquo;
+<li><tt>\&rsaquo;</tt>`&nbsp;&nbsp;` single right-pointing angle quotation mark: &rsaquo;
+<li><tt>\&euro;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;` euro sign: &euro;
+</ul>
+Doxygen extensions:
<ul>
-<li><tt>\&copy;</tt> the copyright symbol
-<li><tt>\&trade;</tt> the trade mark symbol
-<li><tt>\&reg;</tt> the registered trade mark symbol
-<li><tt>\&lt;</tt> less-than symbol
-<li><tt>\&gt;</tt> greater-than symbol
-<li><tt>\&amp;</tt> ampersand
-<li><tt>\&apos;</tt> single quotation mark (straight)
-<li><tt>\&quot;</tt> double quotation mark (straight)
-<li><tt>\&lsquo;</tt> left single quotation mark
-<li><tt>\&rsquo;</tt> right single quotation mark
-<li><tt>\&ldquo;</tt> left double quotation mark
-<li><tt>\&rdquo;</tt> right double quotation mark
-<li><tt>\&ndash;</tt> n-dash (for numeric ranges, e.g. 2&ndash;8)
-<li><tt>\&mdash;</tt> m-dash (for parenthetical punctuation &mdash; like this)
-<li><tt>\&?uml;</tt> 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><tt>\&?acute;</tt> where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y},
- writes a character with an acute accent (like &aacute;).
-<li><tt>\&?grave;</tt> 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><tt>\&?circ;</tt> 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><tt>\&?tilde;</tt> where ? is one of {A,N,O,a,n,o},
- writes a character with a tilde accent (like &atilde;).
-<li><tt>\&szlig;</tt> write a sharp s (i.e. &szlig;) to the output.
-<li><tt>\&?cedil;</tt> where ? is one of {c,C},
- writes a c-cedille (like &ccedil;).
-<li><tt>\&?ring;</tt> where ? is one of {a,A},
- writes an <tt>a</tt> with a ring (like &aring;).
-<li><tt>\&nbsp;</tt> a non breakable space.
-<li><tt>\&Gamma;</tt> Greek letter Gamma &Gamma;.
-<li><tt>\&Delta;</tt> Greek letter Delta &Delta;.
-<li><tt>\&Theta;</tt> Greek letter Theta &Theta;.
-<li><tt>\&Lambda;</tt> Greek letter Lambda &Lambda;.
-<li><tt>\&Xi;</tt> Greek letter Xi &Xi;.
-<li><tt>\&Pi;</tt> Greek letter Pi &Pi;.
-<li><tt>\&Sigma;</tt> Greek letter Sigma &Sigma;.
-<li><tt>\&Upsilon;</tt> Greek letter Upsilon &Upsilon;.
-<li><tt>\&Phi;</tt> Greek letter Phi &Phi;.
-<li><tt>\&Psi;</tt> Greek letter Psi &Psi;.
-<li><tt>\&Omega;</tt> Greek letter Omega &Omega;.
-<li><tt>\&alpha;</tt> Greek letter alpha &alpha;.
-<li><tt>\&beta;</tt> Greek letter beta &beta;.
-<li><tt>\&gamma;</tt> Greek letter gamma &gamma;.
-<li><tt>\&delta;</tt> Greek letter delta &delta;.
-<li><tt>\&epsilon;</tt> Greek letter epsilon &epsilon;.
-<li><tt>\&zeta;</tt> Greek letter zeta &zeta;.
-<li><tt>\&eta;</tt> Greek letter eta &eta;.
-<li><tt>\&theta;</tt> Greek letter theta &theta;.
-<li><tt>\&iota;</tt> Greek letter iota &iota;.
-<li><tt>\&kappa;</tt> Greek letter kappa &kappa;.
-<li><tt>\&lambda;</tt> Greek letter lambda &lambda;.
-<li><tt>\&mu;</tt> Greek letter mu &mu;.
-<li><tt>\&nu;</tt> Greek letter nu &nu;.
-<li><tt>\&xi;</tt> Greek letter xi &xi;.
-<li><tt>\&pi;</tt> Greek letter pi &pi;.
-<li><tt>\&rho;</tt> Greek letter rho &rho;.
-<li><tt>\&sigma;</tt> Greek letter sigma &sigma;.
-<li><tt>\&tau;</tt> Greek letter tau &tau;.
-<li><tt>\&upsilon;</tt> Greek letter upsilon &upsilon;.
-<li><tt>\&phi;</tt> Greek letter phi &phi;.
-<li><tt>\&chi;</tt> Greek letter chi &chi;.
-<li><tt>\&psi;</tt> Greek letter psi &psi;.
-<li><tt>\&omega;</tt> Greek letter omega &omega;.
-<li><tt>\&sigmaf;</tt> Greek final sigma &sigmaf;.
-<li><tt>\&sect;</tt> section sign &sect;.
-<li><tt>\&deg;</tt> degree &deg;.
-<li><tt>\&prime;</tt> prime &prime;.
-<li><tt>\&Prime;</tt> double prime &Prime;.
-<li><tt>\&infin;</tt> infinity &infin;.
-<li><tt>\&empty;</tt> empty set &empty;.
-<li><tt>\&plusmn;</tt> plus or minus &plusmn;.
-<li><tt>\&times;</tt> multiplication sign &times;.
-<li><tt>\&minus;</tt> minus sign &minus;.
-<li><tt>\&sdot;</tt> centered dot &sdot;.
-<li><tt>\&part;</tt> partial derivative &part;.
-<li><tt>\&nabla;</tt> nabla symbol &nabla;.
-<li><tt>\&radic;</tt> square root &radic;.
-<li><tt>\&perp;</tt> perpendicular symbol &perp;.
-<li><tt>\&sum;</tt> sum &sum;.
-<li><tt>\&int;</tt> integral &int;.
-<li><tt>\&prod;</tt> product &prod;.
-<li><tt>\&sim;</tt> similar to &sim;.
-<li><tt>\&asymp;</tt> approximately equal to &asymp;.
-<li><tt>\&ne;</tt> not equal to &ne;.
-<li><tt>\&equiv;</tt> equivalent to &equiv;.
-<li><tt>\&prop;</tt> proportional to &prop;.
-<li><tt>\&le;</tt> less than or equal to &le;.
-<li><tt>\&ge;</tt> greater than or equal to &ge;.
-<li><tt>\&larr;</tt> left arrow &larr;.
-<li><tt>\&rarr;</tt> right arrow &rarr;.
-<li><tt>\&isin;</tt> in the set &isin;.
-<li><tt>\&notin;</tt> not in the set &notin;.
-<li><tt>\&lceil;</tt> left ceiling sign &lceil;.
-<li><tt>\&rceil;</tt> right ceiling sign &rceil;.
-<li><tt>\&lfloor;</tt> left floor sign &lfloor;.
-<li><tt>\&rfloor;</tt> right floor sign &rfloor;.
+<li><tt>\&tm;</tt>`&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;` trade mark sign: &tm;
+<li><tt>\&apos;</tt>`&nbsp;&nbsp;&nbsp;` apostrophe: &apos;
</ul>
Finally, to put invisible comments inside comment blocks, HTML style