doxygen_manual-1.8.1 (1035109), страница 33
Текст из файла (страница 33)
Thiscommand is equivalent to \var, \property, and \fn.Generated by Doxygen21.45 \union <name> [<header-file>] [<header-name>]129See alsosection \fn, \property, and \var.21.45 \union <name> [<header-file>] [<header-name>]Indicates that a comment block contains documentation for a union with name <name>. The arguments are equalto the arguments of the \class command.See alsosection \class.21.46 \var (variable declaration)Indicates that a comment block contains documentation for a variable or enum value (either global or as a memberof a class). This command is equivalent to \typedef, \property, and \fn.See alsosection \fn, \property, and \typedef.21.47 \weakgroup <name> [(title)]Can be used exactly like \addtogroup, but has a lower priority when it comes to resolving conflicting groupingdefinitions.See alsopage Grouping and section \addtogroup.Section indicators21.48 \attention { attention text }Starts a paragraph where a message that needs attention may be entered.
The paragraph will be indented. Thetext of the paragraph has no special internal structure. All visual enhancement commands may be used inside theparagraph. Multiple adjacent \attention commands will be joined into a single paragraph. The \attention commandends when a blank line or some other sectioning command is encountered.21.49 \author { list of authors }Starts a paragraph where one or more author names may be entered. The paragraph will be indented.
The textof the paragraph has no special internal structure. All visual enhancement commands may be used inside theparagraph. Multiple adjacent \author commands will be joined into a single paragraph. Each author description willstart a new line. Alternatively, one \author command may mention several authors. The \author command endswhen a blank line or some other sectioning command is encountered.Example:/*!* \brief* \detailsGenerated by DoxygenPretty nice class.This class is used to demonstrate a number of section commands.130Special CommandsJohn Doe* \authorJan Doe* \author4.1a* \version1990-2011* \dateFirst initialize the system.* \preNot all memory is freed when deleting an object of this class.* \bugImproper use can crash your application* \warning* \copyright GNU Public License.*/class SomeNiceClass {};21.50 \authors { list of authors }Equivalent to \author.21.51 \brief { brief description }Starts a paragraph that serves as a brief description.
For classes and files the brief description will be used in listsand at the start of the documentation page. For class and file members, the brief description will be placed at thedeclaration of the member and prepended to the detailed description. A brief description may span several lines(although it is advised to keep it brief!).
A brief description ends when a blank line or another sectioning commandis encountered. If multiple \brief commands are present they will be joined. See section \author for an example.Synonymous to \short.21.52 \bug { bug description }Starts a paragraph where one or more bugs may be reported. The paragraph will be indented. The text of theparagraph has no special internal structure.
All visual enhancement commands may be used inside the paragraph.Multiple adjacent \bug commands will be joined into a single paragraph. Each bug description will start on a newline. Alternatively, one \bug command may mention several bugs. The \bug command ends when a blank line orsome other sectioning command is encountered. See section \author for an example.21.53 \cond [<section-label>]Starts a conditional section that ends with a corresponding \endcond command, which is typically found in anothercomment block.
The main purpose of this pair of commands is to (conditionally) exclude part of a file from processing(in older version of doxygen this could only be achieved using C preprocessor commands).The section between \cond and \endcond commands can be included by adding its section label to the ENABLED_SECTIONS configuration option. If the section label is omitted, the section will be excluded from processingunconditionally.For conditional sections within a comment block one should use a \if ...
\endif block.Conditional sections can be nested. In this case a nested section will only be shown if it and its containing sectionare included.Here is an example showing the commands in action:/** An interface */class Intf{public:/** A method */virtual void func() = 0;Generated by Doxygen21.54 \copyright { copyright description }131/// @cond TEST/** A method used for testing */virtual void test() = 0;/// @endcond};/// @cond DEV/** The implementation of the interface*/class Implementation : public Intf{public:void func();/// @cond TESTvoid test();/// @endcond/// @cond/** This method is obsolete and does* not show up in the documentation.*/void obsolete();/// @endcond};/// @endcondThe output will be different depending on whether or not ENABLED_SECTIONS contains TEST, or DEVSee alsosection \endcond.21.54 \copyright { copyright description }Starts a paragraph where the copyright of an entity can be described.
This paragraph will be indented. The text ofthe paragraph has no special internal structure. See section \author for an example.21.55 \date { date description }Starts a paragraph where one or more dates may be entered. The paragraph will be indented. The text of theparagraph has no special internal structure. All visual enhancement commands may be used inside the paragraph.Multiple adjacent \date commands will be joined into a single paragraph. Each date description will start on a newline.
Alternatively, one \date command may mention several dates. The \date command ends when a blank line orsome other sectioning command is encountered. See section \author for an example.21.56 \deprecated { description }Starts a paragraph indicating that this documentation block belongs to a deprecated entity. Can be used to describealternatives, expected life span, etc.21.57 \details { detailed description }Just like \brief starts a brief description, \details starts the detailed description. You can also start a new paragraph(blank line) then the \details command is not needed.Generated by Doxygen132Special Commands21.58 \elseStarts a conditional section if the previous conditional section was not enabled.
The previous section should havebeen started with a \if, \ifnot, or \elseif command.See also\if, \ifnot, \elseif, \endif.21.59 \elseif <section-label>Starts a conditional documentation section if the previous section was not enabled. A conditional section is disabledby default. To enable it you must put the section-label after the ENABLED_SECTIONS tag in the configuration file.Conditional blocks can be nested. A nested section is only enabled if all enclosing sections are enabled as well.See alsosections \endif, \ifnot, \else, and \elseif.21.60 \endcondEnds a conditional section that was started by \cond.See alsosection \cond.21.61 \endifEnds a conditional section that was started by \if or \ifnot For each \if or \ifnot one and only onematching \endif must follow.See alsosections \if and \ifnot.21.62 \exception <exception-object> { exception description }Starts an exception description for an exception object with name <exception-object>.
Followed by a description ofthe exception. The existence of the exception object is not checked. The text of the paragraph has no special internalstructure. All visual enhancement commands may be used inside the paragraph. Multiple adjacent \exceptioncommands will be joined into a single paragraph. Each exception description will start on a new line. The \exceptiondescription ends when a blank line or some other sectioning command is encountered.
See section \fn for anexample.21.63 \if <section-label>Starts a conditional documentation section. The section ends with a matching \endif command. A conditionalsection is disabled by default. To enable it you must put the section-label after the ENABLED_SECTIONS tag in theconfiguration file. Conditional blocks can be nested. A nested section is only enabled if all enclosing sections areenabled as well.Generated by Doxygen21.64 \ifnot <section-label>133Example:/*!************/Unconditionally shown documentation.\if Cond1Only included if Cond1 is set.\endif\if Cond2Only included if Cond2 is set.\if Cond3Only included if Cond2 and Cond3 are set.\endifMore text.\endifUnconditional text.You can also use conditional commands inside aliases. To document a class in two languages you could for instanceuse:Example 2:/*! \english* This is English.* \endenglish* \dutch* Dit is Nederlands.* \enddutch*/class Example{};Where the following aliases are defined in the configuration file:ALIASES= "english=\if english" \"endenglish=\endif" \"dutch=\if dutch" \"enddutch=\endif"and ENABLED_SECTIONS can be used to enable either english or dutch.See alsosections \endif, \ifnot, \else, and \elseif.21.64\ifnot <section-label>Starts a conditional documentation section.
The section ends with a matching \endif command. This conditionalsection is enabled by default. To disable it you must put the section-label after the ENABLED_SECTIONS tag in theconfiguration file.See alsosections \endif, \if, \else, and \elseif.21.65\invariant { description of invariant }Starts a paragraph where the invariant of an entity can be described. The paragraph will be indented. The text of theparagraph has no special internal structure.
![](https://s.studizba.com/z.php?f=/templates/si/i/noavatar.png&w=100&h=100&t=1"){kind=avatar}
