Download The Doxygen user guide

Transcript
115
• ® 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, eg. 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.
Finally, to put invisible comments inside comment blocks, HTML style comments can be used:
/*! <!-- This is a comment with a comment block --> Visible text */
23
XML Commands
Doxygen supports most of the XML commands that are typically used in C# code comments. The XML
tags are defined in Appendix E of the ECMA-334 standard, which defines the C# language. Unfortunately,
the specification is not very precise and a number of the examples given are of poor quality.
Here is the list of tags supported by doxygen:
• <c> Identifies inline text that should be rendered as a piece of code.
<tt>text</tt>.
c
User Manual for Doxygen 1.5.3, written by Dimitri van Heesch 1997-2006
Similar to using