doxygen_manual-1.8.1 (1035109), страница 32
Текст из файла (страница 32)
The arguments areequal to the arguments of the \class command.See alsosection \class.21.21 \internalThis command starts a documentation fragment that is meant for internal use only. The fragment naturally endsat the end of the comment block. You can also force the internal section to end earlier by using the \endinternalcommand.If the \internal command is put inside a section (see for example \section) all subsections after the command areconsidered to be internal as well. Only a new section at the same level will end the fragment that is consideredinternal.You can use INTERNAL_DOCS in the config file to show (YES) or hide (NO) the internal documentation.See alsosection \endinternal.21.22 \mainpage [(title)]If the \mainpage command is placed in a comment block the block is used to customize the index page (in HTML)or the first chapter (in LATEX).The title argument is optional and replaces the default title that doxygen normally generates.
If you do not want anytitle you can specify notitle as the argument of \mainpage.Here is an example:/*! \mainpage My Personal Index Page** \section intro_sec Introduction** This is the introduction.** \section install_sec Installation** \subsection step1 Step 1: Opening the box** etc...*/You can refer to the main page using \ref index.See alsosection \section, section \subsection, and section \page.21.23 \memberof <name>This command makes a function a member of a class in a similar way as \relates does, only with this command thefunction is represented as a real member of the class. This can be useful when the programming language doesnot support the concept of member functions natively (e.g.
C).Generated by Doxygen124Special CommandsIt is also possible to use this command together with \public, \protected or \private.The file manual.c in the example directory shows how to use this command.See alsosections \extends, \implements, \public, \protected and \private.21.24 \name [(header)]This command turns a comment block into a header definition of a member group.
The comment block should befollowed by a //@{ ... //@} block containing the members of the group.See section Member Groups for an example.21.25 \namespace <name>Indicates that a comment block contains documentation for a namespace with name <name>.21.26 \nosubgroupingThis command can be put in the documentation of a class. It can be used in combination with member grouping toavoid that doxygen puts a member group as a subgroup of a Public/Protected/Private/...
section.See alsosections \publicsection, \protectedsection and \privatesection.21.27 \overload [(function declaration)]This command can be used to generate the following standard text for an overloaded member function:This is an overloaded member function, provided for convenience. It differs from the above functiononly in what argument(s) it accepts.If the documentation for the overloaded member function is not located in front of the function declaration or definition, the optional argument should be used to specify the correct function.Any other documentation that is inside the documentation block will by appended after the generated message.Note 1:You are responsible that there is indeed an earlier documented member that is overloaded by this one.
Toprevent that document reorders the documentation you should set SORT_MEMBER_DOCS to NO in this case.Note 2:The \overload command does not work inside a one-line comment.Example:class Test{public:void drawRect(int,int,int,int);void drawRect(const Rect &r);Generated by Doxygen21.28 \package <name>125};void Test::drawRect(int x,int y,int w,int h) {}void Test::drawRect(const Rect &r) {}/*! \class Test* \brief A short description.** More text.*//*! \fn void Test::drawRect(int x,int y,int w,int h)* This command draws a rectangle with a left upper corner at ( \a x , \a y ),* width \a w and height \a h.*//*!* \overload void Test::drawRect(const Rect &r)*/21.28 \package <name>Indicates that a comment block contains documentation for a Java package with name <name>.21.29 \page <name> (title)Indicates that a comment block contains a piece of documentation that is not directly related to one specific class,file or member.
The HTML generator creates a page containing the documentation. The LATEX generator starts anew section in the chapter ’Page documentation’.Example:/*! \page page1 A documentation page\tableofcontentsLeading text.\section sec An example sectionThis page contains the subsections \ref subsection1 and \ref subsection2.For more info see page \ref page2.\subsection subsection1 The first subsectionText.\subsection subsection2 The second subsectionMore text.*//*! \page page2 Another pageEven more info.*/Note:The <name> argument consists of a combination of letters and number digits. If you wish to use upper caseletters (e.g. MYPAGE1), or mixed case letters (e.g.
MyPage1) in the <name> argument, you should setCASE_SENSE_NAMES to YES. However, this is advisable only if your file system is case sensitive. Otherwise(and for better portability) you should use all lower case letters (e.g. mypage1) for <name> in all referencesto the page.See alsosection \section, section \subsection, and section \ref.Generated by Doxygen126Special Commands21.30 \privateIndicates that the member documented in the comment block is private, i.e., should only be accessed by othermembers in the same class.Note that Doxygen automatically detects the protection level of members in object-oriented languages.
This command is intended for use only when the language does not support the concept of protection level natively (e.g. C,PHP 4).For starting a section of private members, in a way similar to the "private:" class marker in C++, use \privatesection.See alsosections \memberof, \public, \protected and \privatesection.21.31 \privatesectionStarting a section of private members, in a way similar to the "private:" class marker in C++. Indicates that themember documented in the comment block is private, i.e., should only be accessed by other members in the sameclass.See alsosections \memberof, \public, \protected and \private.21.32 \property (qualified property name)Indicates that a comment block contains documentation for a property (either global or as a member of a class).This command is equivalent to \var, \typedef, and \fn.See alsosections \fn, \typedef, and \var.21.33 \protectedIndicates that the member documented in the comment block is protected, i.e., should only be accessed by othermembers in the same or derived classes.Note that Doxygen automatically detects the protection level of members in object-oriented languages.
This command is intended for use only when the language does not support the concept of protection level natively (e.g. C,PHP 4).For starting a section of protected members, in a way similar to the "protected:" class marker in C++, use \protectedsection.See alsosections \memberof, \public, \private and \protectedsection.21.34 \protectedsectionStarting a section of protected members, in a way similar to the "protected:" class marker in C++.
Indicates thatthe member documented in the comment block is protected, i.e., should only be accessed by other members in thesame or derived classes.Generated by Doxygen21.35 \protocol <name> [<header-file>] [<header-name>]127See alsosections \memberof, \public, \private and \protected.21.35 \protocol <name> [<header-file>] [<header-name>]Indicates that a comment block contains documentation for a protocol in Objective-C with name <name>. Thearguments are equal to the \class command.See alsosection \class.21.36 \publicIndicates that the member documented in the comment block is public, i.e., can be accessed by any other class orfunction.Note that Doxygen automatically detects the protection level of members in object-oriented languages.
This command is intended for use only when the language does not support the concept of protection level natively (e.g. C,PHP 4).For starting a section of public members, in a way similar to the "public:" class marker in C++, use \publicsection.See alsosections \memberof, \protected, \private and \publicsection.21.37 \publicsectionStarting a section of public members, in a way similar to the "public:" class marker in C++. Indicates that the memberdocumented in the comment block is public, i.e., can be accessed by any other class or function.See alsosections \memberof, \protected, \private and \public.21.38 \relates <name>This command can be used in the documentation of a non-member function <name>. It puts the function inside the’related function’ section of the class documentation.
This command is useful for documenting non-friend functionsthat are nevertheless strongly coupled to a certain class. It prevents the need of having to document a file, but onlyworks for functions.Example:/*!* A String class.*/class String{friend int strcmp(const String &,const String &);};/*!* Compares two strings.Generated by Doxygen128Special Commands*/int strcmp(const String &s1,const String &s2){}/*! \relates String* A string debug function.*/void stringDebug(){}21.39 \related <name>Equivalent to \relates21.40 \relatesalso <name>This command can be used in the documentation of a non-member function <name>. It puts the function bothinside the ’related function’ section of the class documentation as well as leaving it at its normal file documentationlocation. This command is useful for documenting non-friend functions that are nevertheless strongly coupled to acertain class.
It only works for functions.21.41 \relatedalso <name>Equivalent to \relatesalso21.42 \showinitializerBy default the value of a define and the initializer of a variable are only displayed if they are less than 30 lines long.By putting this command in a comment block of a define or variable, the initializer is shown unconditionally. Themaximum number of initialization lines can be changed by means of the configuration parameter MAX_INITIALIZER_LINES, the default value is 30.See alsosection \hideinitializer.21.43 \struct <name> [<header-file>] [<header-name>]Indicates that a comment block contains documentation for a struct with name <name>. The arguments are equalto the arguments of the \class command.See alsosection \class.21.44 \typedef (typedef declaration)Indicates that a comment block contains documentation for a typedef (either global or as a member of a class).
![](https://s.studizba.com/z.php?f=/templates/si/i/noavatar.png&w=100&h=100&t=1"){kind=avatar}
