![]() If more than one source file is needed for the example, the \include command can be used. If itself is not unique for the set of example files specified by the EXAMPLE_PATH tag, you can include part of the absolute path to disambiguate it. Source files or directories can be specified using the EXAMPLE_PATH tag of doxygen's configuration file. If any are found, the names are cross-referenced with the documentation. The source code is scanned for documented members and classes. The text of this file will be included in the documentation, just after the documentation contained in the comment block. Indicates that a comment block contains documentation for a source code example. Note: The type of an anonymous enum cannot be documented, but the values of an anonymous enum can. If a comment block is located directly in front of an enum declaration, the \enum comment may be omitted. If the enum is a member of a class and the documentation block is located outside the class definition, the scope of the class should be specified as well. Indicates that a comment block contains documentation for an enumeration, with name. The STRIP_FROM_PATH option determines what is stripped from the full path before it appears in the output. The "path fragment" argument should include the directory name and enough of the path to be unique with respect to the other directories in the project. Indicates that a comment block contains documentation for a directory. See Also page Grouping, sections \ingroup, \addtogroup, and \weakgroup. The argument should be a single-word identifier. You can also use groups as members of other groups, thus building a hierarchy of groups. This can be used to categorize classes, files or namespaces, and document those categories. Indicates that a comment block contains documentation for a group of classes, files or namespaces. This is to test the documentation of defines.Ĭomputes the absolute value of its argument \a x. Indicates that a comment block contains documentation for a #define macro. Example: /* A dummy class */įor the corresponding HTML documentation that is generated by doxygen. Note that the last two arguments can also be specified using the \headerfile command. Sharp brackets are used if just the name is given. With the argument you can also specify how the include statement should look like, by adding either quotes or sharp brackets around the name. This can be useful if the include name is not located on the default include path (like ). ![]() ![]() The argument can be used to overwrite the name of the link that is used in the class documentation to something other than. If the header-file is specified, a link to a verbatim copy of the header will be included in the HTML documentation. Optionally a header file and a header name can be specified. Indicates that a comment block contains documentation for a class with name. The arguments are equal to the \class command. See Also section \callgraph.įor Objective-C only: Indicates that a comment block contains documentation for a class category with name. Note The completeness (and correctness) of the caller graph depends on the doxygen code parser which is not perfect. The caller graph will be generated regardless of the value of CALLER_GRAPH. When this command is put in a comment block of a function or method and HAVE_DOT is set to YES, then doxygen will generate a caller graph for that function (provided the implementation of the function or method calls other documented functions). Note The completeness (and correctness) of the call graph depends on the doxygen code parser which is not perfect. The call graph will be generated regardless of the value of CALL_GRAPH. When this command is put in a comment block of a function or method and HAVE_DOT is set to YES, then doxygen will generate a call graph for that function (provided the implementation of the function or method calls other documented functions). See Also page Grouping, sections \defgroup, \ingroup, and \weakgroup. * Additional documentation for group 'mygrp' The title is optional, so this command can also be used to add a number of entities to an existing group using and like this: /*! \addtogroup mygrp Structural indicators -ĭefines a group just like \defgroup, but in contrast to that command using the same more than once will not result in a warning, but rather one group with a merged documentation and the first title found in any of the commands. Unrecognized commands are treated as normal text. The following subsections provide a list of all commands that are recognized by doxygen.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |