doxygen_manual-1.8.1 (1035109), страница 31
Текст из файла (страница 31)
The <header-name> argument can be used to overwrite the name ofthe link that is used in the class documentation to something other than <header-file>. This can be useful if theinclude name is not located on the default include path (like <X11/X.h>). With the <header-name> argument youcan also specify how the include statement should look like, by adding either quotes or sharp brackets around thename. Sharp brackets are used if just the name is given. Note that the last two arguments can also be specifiedusing the \headerfile command.Example:/* A dummy class */class Test{};/*! \class Test class.h "inc/class.h"* \brief This is a test class.** Some details about the Test class*/21.7 \def <name>Indicates that a comment block contains documentation for a #define macro.Example:/*! \file define.h\brief testing definesThis is to test the documentation of defines.*//*!\def MAX(x,y)Computes the maximum of \a x and \a y.*//*!Computes the absolute value of its argument \a x.*/#define ABS(x) (((x)>0)?(x):-(x))#define MAX(x,y) ((x)>(y)?(x):(y))#define MIN(x,y) ((x)>(y)?(y):(x))/*!< Computes the minimum of \a x and \a y.
*/21.8 \defgroup <name> (group title)Indicates that a comment block contains documentation for a group of classes, files or namespaces. This can beused to categorize classes, files or namespaces, and document those categories. You can also use groups asmembers of other groups, thus building a hierarchy of groups.The <name> argument should be a single-word identifier.See alsopage Grouping, sections \ingroup, \addtogroup, and \weakgroup.Generated by Doxygen21.9 \dir [<path fragment>]11921.9 \dir [<path fragment>]Indicates that a comment block contains documentation for a directory.
The "path fragment" argument shouldinclude the directory name and enough of the path to be unique with respect to the other directories in the project.The STRIP_FROM_PATH option determines what is stripped from the full path before it appears in the output.21.10 \enum <name>Indicates that a comment block contains documentation for an enumeration, with name <name>. If the enum is amember of a class and the documentation block is located outside the class definition, the scope of the class shouldbe specified as well.
If a comment block is located directly in front of an enum declaration, the \enum comment maybe omitted.Note:The type of an anonymous enum cannot be documented, but the values of an anonymous enum can.Example:class Test{public:enum TEnum { Val1, Val2 };/*! Another enum, with inline docs */enum AnotherEnum{V1, /*!< value 1 */V2 /*!< value 2 */};};/*! \class Test* The class description.*//*! \enum Test::TEnum* A description of the enum type.*//*! \var Test::TEnum Test::Val1* The description of the first enum value.*/21.11 \example <file-name>Indicates that a comment block contains documentation for a source code example. The name of the source file is<file-name>.
The text of this file will be included in the documentation, just after the documentation contained inthe comment block. All examples are placed in a list. The source code is scanned for documented members andclasses. If any are found, the names are cross-referenced with the documentation. Source files or directories canbe specified using the EXAMPLE_PATH tag of doxygen’s configuration file.If <file-name> itself is not unique for the set of example files specified by the EXAMPLE_PATH tag, you can includepart of the absolute path to disambiguate it.If more than one source file is needed for the example, the \include command can be used.Example:/** A Test class.* More details about this class.*/Generated by Doxygen120Special Commandsclass Test{public:/** An example member function.* More details about this function.*/void example();};void Test::example() {}/** \example example_test.cpp* This is an example of how to use the Test class.* More details about this example.*/Where the example file example_test.cpp looks as follows:void main(){Test t;t.example();}See alsosection \include.21.12 \endinternalThis command ends a documentation fragment that was started with a \internal command.
The text between\internal and \endinternal will only be visible if INTERNAL_DOCS is set to YES.21.13 \extends <name>This command can be used to manually indicate an inheritance relation, when the programming language does notsupport this concept natively (e.g. C).The file manual.c in the example directory shows how to use this command.See alsosection \implements and section \memberof21.14 \file [<name>]Indicates that a comment block contains documentation for a source or header file with name <name>.
The filename may include (part of) the path if the file-name alone is not unique. If the file name is omitted (i.e. the line after\file is left blank) then the documentation block that contains the \file command will belong to the file it is located in.Important:The documentation of global functions, variables, typedefs, and enums will only be included in the output if thefile they are in is documented as well.Example:/** \file file.h* A brief file description.* A more elaborated file description.Generated by Doxygen21.15 \fn (function declaration)121*//*** A global integer value.* More details about this value.*/extern int globalValue;NoteIn the above example JAVADOC_AUTOBRIEF has been set to YES in the configuration file.21.15 \fn (function declaration)Indicates that a comment block contains documentation for a function (either global or as a member of a class).
Thiscommand is only needed if a comment block is not placed in front (or behind) the function declaration or definition.If your comment block is in front of the function declaration or definition this command can (and to avoid redundancyshould) be omitted.A full function declaration including arguments should be specified after the \fn command on a single line, since theargument ends at the end of the line!This command is equivalent to \var, \typedef, and \property.WarningDo not use this command if it is not absolutely needed, since it will lead to duplication of information and thusto errors.Example:class Test{public:const char *member(char,int) throw(std::out_of_range);};const char *Test::member(char c,int n) throw(std::out_of_range) {}/*! \class Test* \brief Test class.** Details about Test.*//*!******/\fn const char *Test::member(char c,int n)\brief A member function.\param c a character.\param n an integer.\exception std::out_of_range parameter is out of range.\return a character pointer.See alsosections \var, \property, and \typedef.21.16 \headerfile <header-file> [<header-name>]Intended to be used for class, struct, or union documentation, where the documentation is in front of the definition.The arguments of this command are the same as the second and third argument of \class.
The <header-file> nameGenerated by Doxygen122Special Commandsrefers to the file that should be included by the application to obtain the definition of the class, struct, or union. The<header-name> argument can be used to overwrite the name of the link that is used in the class documentationto something other than <header-file>. This can be useful if the include name is not located on the default includepath (like <X11/X.h>).With the <header-name> argument you can also specify how the include statement should look like, by addingeither double quotes or sharp brackets around the name. By default sharp brackets are used if just the name isgiven.If a pair of double quotes is given for either the <header-file> or <header-name> argument, the current file (inwhich the command was found) will be used but with quotes.
So for a comment block with a \headerfile commandinside a file test.h, the following three commands are equivalent:\headerfile test.h "test.h"\headerfile test.h ""\headerfile ""To get sharp brackets you do not need to specify anything, but if you want to be explicit you could use any of thefollowing:\headerfile test.h <test.h>\headerfile test.h <>\headerfile <>To globally reverse the default include representation to local includes you can set FORCE_LOCAL_INCLUDES toYES.To disable the include information altogether set SHOW_INCLUDE_FILES to NO.21.17 \hideinitializerBy default the value of a define and the initializer of a variable are displayed unless they are longer than 30 lines.By putting this command in a comment block of a define or variable, the initializer is always hidden.
The maximumnumber of initialization lines can be changed by means of the configuration parameter MAX_INITIALIZER_LINES,the default value is 30.See alsosection \showinitializer.21.18 \implements <name>This command can be used to manually indicate an inheritance relation, when the programming language does notsupport this concept natively (e.g. C).The file manual.c in the example directory shows how to use this command.See alsosection \extends and section \memberof21.19 \ingroup (<groupname> [<groupname> <groupname>])If the \ingroup command is placed in a comment block of a class, file or namespace, then it will be added to thegroup or groups identified by <groupname>.See alsopage Grouping, sections \defgroup, \addtogroup, and \weakgroupGenerated by Doxygen21.20 \interface <name> [<header-file>] [<header-name>]12321.20 \interface <name> [<header-file>] [<header-name>]Indicates that a comment block contains documentation for an interface with name <name>.
![](https://s.studizba.com/z.php?f=/templates/si/i/noavatar.png&w=100&h=100&t=1"){kind=avatar}
