doxygen_manual-1.8.1 (1035109), страница 38

Просмтор этого файла доступен только зарегистрированным пользователям. Но у нас супер быстрая регистрация: достаточно только электронной почты!

Текст из файла (страница 38)

All commands are disabled in a verbatim block.WarningMake sure you include a \endverbatim command for each \verbatim command or the parser will get confused!See alsosection \code, and section \verbinclude.21.148 \xmlonlyStarts a block of text that will be verbatim included in the generated XML output only.

The block ends with aendxmlonly command.This command can be used to include custom XML tags.See alsosection \manonly, section \rtfonly, section \latexonly, and section \htmlonly.Generated by Doxygen154Special Commands21.149 \\This command writes a backslash character (\) to the output. The backslash has to be escaped in some casesbecause doxygen uses it to detect commands.21.150 \@This command writes an at-sign (@) to the output. The at-sign has to be escaped in some cases because doxygenuses it to detect JavaDoc commands.21.151 \∼[LanguageId]This command enables/disables a language specific filter. This can be used to put documentation for differentlanguage into one comment block and use the OUTPUT_LANGUAGE tag to filter out only a specific language.

Use\∼language_id to enable output for a specific language only and \∼ to enable output for all languages (this is alsothe default mode).Example:/*! \~english This is english \~dutch Dit is Nederlands \~german Dieses istdeutsch. \~ output for all languages.*/21.152 \&This command writes the & character to output.

This character has to be escaped because it has a special meaningin HTML.21.153 \$This command writes the $ character to the output. This character has to be escaped in some cases, because it isused to expand environment variables.21.154 \#This command writes the # character to the output. This character has to be escaped in some cases, because it isused to refer to documented entities.21.155 <This command writes the < character to the output. This character has to be escaped because it has a specialmeaning in HTML.21.156 >This command writes the > character to the output. This character has to be escaped because it has a specialmeaning in HTML.Generated by Doxygen21.157 \%15521.157 \%This command writes the % character to the output. This character has to be escaped in some cases, because it isused to prevent auto-linking to word that is also a documented class or struct.21.158 \”This command writes the " character to the output.

This character has to be escaped in some cases, because it isused in pairs to indicate an unformatted text fragment.21.159 \.This command writes a dot to the output. This can be useful to prevent ending a brief description when JAVADOC_AUTOBRIEF is enabled or to prevent starting a numbered list when the dot follows a number at the start of aline.21.160 \::This command write a double colon (::) to the output.

This character sequence has to be escaped in some cases,because it is used to ref to documented entities.Commands included for Qt compatibilityThe following commands are supported to remain compatible to the Qt class browser generator. Do not use thesecommands in your own documentation.• \annotatedclasslist• \classhierarchy• \define• \functionindex• \header• \headerfilelist• \inherit• \l• \postheaderGenerated by Doxygen156Special CommandsGenerated by DoxygenChapter 22HTML commandsHere is a list of all HTML commands that may be used inside the documentation. Note that although these HTMLtags are translated to the proper commands for output formats other than HTML, all attributes of a HTML tag arepassed 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 an 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.• <BODY> Does not generate any output.• </BODY> Does not generate any output.• <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 for C# code, this command isequivalent to \code.• </CODE> Ends a <CODE> section. Note that for C# code, this command is equivalent to \endcode.• <DD> Starts 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.158HTML commands• <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.• <FORM> Does not generate any output.• </FORM> Does not generate any output.• <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.• <I> Starts a piece of text displayed in an italic font.• <INPUT> Does not generate any output.• </I> Ends a <I> section.• <IMG> This command is written with attributes to the HTML output only.• <LI> Starts a new list item.• </LI> Ends a list item.• <META> Does not generate any output.• <MULTICOL> ignored by doxygen.• </MUTLICOL> ignored by doxygen.• <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.Generated by Doxygen159• <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 HTML character entities that are recognized by Doxygen:• © the copyright symbol• &tm; 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 á).Generated by Doxygen160HTML commands• &?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 */Generated by DoxygenChapter 23XML commandsDoxygen supports most of the XML commands that are typically used in C# code comments.

The XML tags aredefined in Appendix E of the ECMA-334 standard, which defines the C# language. Unfortunately, the specificationis 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.

Характеристики

Список файлов лабораторной работы