doxygen_manual-1.8.1 (1035109), страница 23
Текст из файла (страница 23)
If set to NO the shortest path that makes the file name uniquewill be usedSTRIP_FROM_PATH If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag can beused to strip a user-defined part of the path. Stripping is only done if one of the specified strings matches theleft-hand part of the path. The tag can be used to show relative paths in the file list. If left blank the directoryfrom which doxygen is run is used as the path to strip.STRIP_FROM_INC_PATH The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of thepath mentioned in the documentation of a class, which tells the reader which header file to include in orderto use a class. If left blank only the name of the header file containing the class definition is used. Otherwiseone should specify the include paths that are normally passed to the compiler using the -I flag.SHORT_NAMES If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but less readable)file names.
This can be useful is your file systems doesn’t support long names like on DOS, Mac, or CD-ROM.JAVADOC_AUTOBRIEF If the JAVADOC_AUTOBRIEF is set to YES then doxygen will interpret the first line(until the first dot) of a JavaDoc-style comment as the brief description. If set to NO (the default), the Javadocstyle will behave just like regular Qt-style comments (thus requiring an explicit @brief command for a briefdescription.)QT_AUTOBRIEF If the QT_AUTOBRIEF is set to YES then doxygen will interpret the first line (until the first dot)of a Qt-style comment as the brief description.
If set to NO (the default), the Qt-style will behave just likeregular Qt-style comments (thus requiring an explicit \brief command for a brief description.)MARKDOWN_SUPPORT If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all comments according to the Markdown format, which allows for more readable documentation. See http://daringfireball.net/projects/markdown/ for details. The output of markdown processing is further processed by doxygen, so you can mix doxygen, HTML, and XML commands with Markdownformatting. Disable only in case of backward compatibilities issues.BUILTIN_STL_SUPPORT If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to include(a tag file for) the STL sources as input, then you should set this tag to YES in order to let doxygen matchfunctions declarations and definitions whose arguments contain STL classes (e.g.
func(std::string); versusfunc(std::string) {}). This also make the inheritance and collaboration diagrams that involve STL classes morecomplete and accurate.Generated by Doxygen20.2 Project related options95CPP_CLI_SUPPORT If you use Microsoft’s C++/CLI language, you should set this option to YES to enable parsing support.SIP_SUPPORT Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
Doxygen willparse them like normal C++ but will assume all classes use public instead of private inheritance when noexplicit protection keyword is present.IDL_PROPERTY_SUPPORT For Microsoft’s IDL there are propget and propput attributes to indicate getter andsetter methods for a property. Setting this option to YES (the default) will make doxygen to replace the getand set methods by a property in the documentation. This will only work if the methods are indeed getting orsetting a simple type.
If this is not the case, or you want to show the methods anyway, you should set thisoption to NO.DISTRIBUTE_GROUP_DOC If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC tag is set to YES, then doxygen will reuse the documentation of the first member in the group (if any)for the other members of the group. By default all members of a group must be documented explicitly.MULTILINE_CPP_IS_BRIEF The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen treata multi-line C++ special comment block (i.e. a block of //! or /// comments) as a brief description.
This used tobe the default behavior. The new default is to treat a multi-line C++ comment block as a detailed description.Set this tag to YES if you prefer the old behavior instead. Note that setting this tag to YES also means thatrational rose comments are not recognized any more.INHERIT_DOCS If the INHERIT_DOCS tag is set to YES (the default) then an undocumented member inheritsthe documentation from any documented member that it re-implements.SEPARATE_MEMBER_PAGES If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will producea new page for each member.
If set to NO, the documentation of a member will be part of the file/class/namespace that contains it.TAB_SIZE the TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen uses this value toreplace tabs by spaces in code fragments.ALIASES This tag can be used to specify a number of aliases that acts as commands in the documentation. Analias has the formname=valueFor example adding"sideeffect=\par Side Effects:\n"will allow you to put the command \sideeffect (or @sideeffect) in the documentation, which will result in auser-defined paragraph with heading "Side Effects:".
You can put \n’s in the value part of an alias to insertnewlines.OPTIMIZE_OUTPUT_FOR_C Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of Csources only. Doxygen will then generate output that is more tailored for C. For instance, some of the namesthat are used will be different. The list of all members will be omitted, etc.OPTIMIZE_OUTPUT_JAVA Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java orPython sources only. Doxygen will then generate output that is more tailored for that language. For instance,namespaces will be presented as packages, qualified scopes will look different, etc.OPTIMIZE_FOR_FORTRAN Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortransources. Doxygen will then generate output that is tailored for Fortran.OPTIMIZE_OUTPUT_VHDL Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDLsources.
Doxygen will then generate output that is tailored for VHDL.EXTENSION_MAPPING Doxygen selects the parser to use depending on the extension of the files it parses.With this tag you can assign which parser to use for a given extension. Doxygen has a built-in mapping, butyou can override or extend it using this tag. The format is ext=language, where ext is a file extension, andlanguage is one of the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, Objective-C,Python, Fortran, VHDL. For instance to make doxygen treat .inc files as Fortran files (default is PHP), and .ffiles as C (default is Fortran), use: inc=Fortran f=CGenerated by Doxygen96ConfigurationSUBGROUPING Set the SUBGROUPING tag to YES (the default) to allow class member groups of the sametype (for instance a group of public functions) to be put as a subgroup of that type (e.g.
under the PublicFunctions section). Set it to NO to prevent subgrouping. Alternatively, this can be done per class using the\nosubgrouping command.INLINE_GROUPED_CLASSES When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structsand unions are shown inside the group in which they are included (e.g. using @ingroup) instead of on aseparate page (for HTML and Man pages) or section (for LaTeX and RTF). Note that this feature does notwork in combination with SEPARATE_MEMBER_PAGES.TYPEDEF_HIDES_STRUCT When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, orenum is documented as struct, union, or enum with the name of the typedef.
So typedef structTypeS {} TypeT, will appear in the documentation as a struct with name TypeT. When disabled thetypedef will appear as a member of a file, namespace, or class. And the struct will be named TypeS.This can typically be useful for C code in case the coding convention dictates that all compound types aretypedef’ed and only the typedef is referenced, never the tag name.SYMBOL_CACHE_SIZE The SYMBOL_CACHE_SIZE determines the size of the internal cache use to determine which symbols to keep in memory and which to flush to disk. When the cache is full, less often usedsymbols will be written to disk.
For small to medium size projects (<1000 input files) the default value isprobably good enough. For larger projects a too small cache size can cause doxygen to be busy swappingsymbols to and from disk most of the time causing a significant performance penalty. If the system hasenough physical memory increasing the cache will improve the performance by keeping more symbols inmemory.
Note that the value works on a logarithmic scale so increasing the size by one will roughly doublethe memory usage. The cache size is given by this formula: 2(16+SYMBOL_CACHE_SIZE) . The valid rangeis 0..9, the default is 0, corresponding to a cache size of 216 = 65536 symbols.LOOKUP_CACHE_SIZE Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be setusing LOOKUP_CACHE_SIZE.
This cache is used to resolve symbols given their name and scope. Sincethis can be an expensive process and often the same symbol appear multiple times in the code, doxygenkeeps a cache of pre-resolved symbols. If the cache is too small doxygen will become slower. If the cache istoo large, memory is wasted. The cache size is given by this formula: 2(16+LOOKUP_CACHE_SIZE) . Thevalid range is 0..9, the default is 0, corresponding to a cache size of 216 = 65536 symbols.20.3Build related optionsEXTRACT_ALL If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in documentation aredocumented, even if no documentation was available. Private class members and static file members will behidden unless the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YESNote:This will also disable the warnings about undocumented members that are normally produced whenWARNINGS is set to YESEXTRACT_PRIVATE If the EXTRACT_PRIVATE tag is set to YES all private members of a class will be includedin the documentation.EXTRACT_STATIC If the EXTRACT_STATIC tag is set to YES all static members of a file will be included inthe documentation.EXTRACT_LOCAL_CLASSES If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined locally in source files will be included in the documentation.
![](https://s.studizba.com/z.php?f=/templates/si/i/noavatar.png&w=100&h=100&t=1"){kind=avatar}
