doxygen_manual-1.8.1 (1035109), страница 24
Текст из файла (страница 24)
If set to NO only classes defined in headerfiles are included. Does not have any effect for Java sources.EXTRACT_ANON_NSPACES If this flag is set to YES, the members of anonymous namespaces will be extractedand appear in the documentation as a namespace called ’anonymous_namespace{file}’, where file will bereplaced with the base name of the file that contains the anonymous namespace.
By default anonymousnamespace are hidden.Generated by Doxygen20.3 Build related options97EXTRACT_LOCAL_METHODS This flag is only useful for Objective-C code. When set to YES local methods,which are defined in the implementation section but not in the interface are included in the documentation. Ifset to NO (the default) only methods in the interface are included.HIDE_UNDOC_MEMBERS If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all undocumentedmembers inside documented classes or files.
If set to NO (the default) these members will be included in thevarious overviews, but no documentation section is generated. This option has no effect if EXTRACT_ALLis enabled.HIDE_UNDOC_CLASSES If the HIDE_UNDOC_CLASSESS tag is set to YES, doxygen will hide all undocumented classes.
If set to NO (the default) these classes will be included in the various overviews. This optionhas no effect if EXTRACT_ALL is enabled.HIDE_FRIEND_COMPOUNDS If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide allfriend (class|struct|union) declarations. If set to NO (the default) these declarations will be included in thedocumentation.HIDE_IN_BODY_DOCS If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any documentationblocks found inside the body of a function. If set to NO (the default) these blocks will be appended to thefunction’s detailed documentation block.INTERNAL_DOCS The INTERNAL_DOCS tag determines if documentation that is typed after a \internal command is included.
If the tag is set to NO (the default) then the documentation will be excluded. Set it to YESto include the internal documentation.CASE_SENSE_NAMES If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file namesin lower-case letters. If set to YES upper-case letters are also allowed. This is useful if you have classes orfiles whose names only differ in case and if your file system supports case sensitive file names. Windowsusers are advised to set this option to NO.HIDE_SCOPE_NAMES If the HIDE_SCOPE_NAMES tag is set to NO (the default) then doxygen will show members with their full class and namespace scopes in the documentation. If set to YES the scope will be hidden.SHOW_INCLUDE_FILES If the SHOW_INCLUDE_FILES tag is set to YES (the default) then doxygen will put alist of the files that are included by a file in the documentation of that file.FORCE_LOCAL_INCLUDES If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen will list includefiles with double quotes in the documentation rather than with sharp brackets.INLINE_INFO If the INLINE_INFO tag is set to YES (the default) then a tag [inline] is inserted in the documentation for inline members.SORT_MEMBER_DOCS If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen will sort the(detailed) documentation of file and class members alphabetically by member name.
If set to NO the memberswill appear in declaration order.SORT_BRIEF_DOCS If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief descriptionsof file, namespace and class members alphabetically by member name. If set to NO (the default) the memberswill appear in declaration order.SORT_GROUP_NAMES If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy ofgroup names into alphabetical order. If set to NO (the default) the group names will appear in their definedorder.SORT_BY_SCOPE_NAME If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by fullyqualified names, including namespaces. If set to NO (the default), the class list will be sorted only by classname, not including the namespace part.Generated by Doxygen98ConfigurationNoteThis option is not very useful if HIDE_SCOPE_NAMES is set to YES.This option applies only to the class list, not to the alphabetical list.SORT_MEMBERS_CTORS_1ST If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sortthe (brief and detailed) documentation of class members so that constructors and destructors are listed first.If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.NoteIf SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief member documentation.If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting detailed member documentation.GENERATE_DEPRECATEDLIST The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) the deprecated list.
This list is created by putting \deprecated commands in the documentation.STRICT_PROTO_MATCHING If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to doproper type resolution of all parameters of a function it will reject a match between the prototype and theimplementation of a member function even if there is only one candidate or it is obvious which candidate tochoose by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still accepta match between prototype and implementation in such cases.GENERATE_TODOLIST The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todolist. This list is created by putting \todo commands in the documentation.GENERATE_TESTLIST The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the testlist.
This list is created by putting \test commands in the documentation.GENERATE_BUGLIST The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug list.This list is created by putting \bug commands in the documentation.ENABLED_SECTIONS The ENABLED_SECTIONS tag can be used to enable conditional documentation sections, marked by \if <section-label> ... \endif and \cond <section-label> ... \endcond blocks.MAX_INITIALIZER_LINES The MAX_INITIALIZER_LINES tag determines the maximum number oflines that the initial value of a variable or define can be.
If the initializer consists of more lines than specified here it will be hidden. Use a value of 0 to hide initializers completely. The appearance of the valueof individual variables and defines can be controlled using \showinitializer or \hideinitializer command in thedocumentation.SHOW_USED_FILES Set the SHOW_USED_FILES tag to NO to disable the list of files generated at the bottomof the documentation of classes and structs.
If set to YES the list will mention the files that were used togenerate the documentation.SHOW_FILES Set the SHOW_FILES tag to NO to disable the generation of the Files page. This will remove theFiles entry from the Quick Index and from the Folder Tree View (if specified). The default is YES.SHOW_NAMESPACES Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespacespage.
This will remove the Namespaces entry from the Quick Index and from the Folder Tree View (if specified). The default is YES.FILE_VERSION_FILTER The FILE_VERSION_FILTER tag can be used to specify a program or script thatdoxygen should invoke to get the current version for each file (typically from the version control system).Doxygen will invoke the program by executing (via popen()) the command command input-file, wherecommand is the value of the FILE_VERSION_FILTER tag, and input-file is the name of an inputfile provided by doxygen.
Whatever the program writes to standard output is used as the file version.Example of using a shell script as a filter for Unix:FILE_VERSION_FILTER = "/bin/sh versionfilter.sh"Example shell script for CVS:Generated by Doxygen20.4 Options related to warning and progress messages99#!/bin/shcvs status $1 | sed -n ’s/^[ \]*Working revision:[ \t]*\([0-9][0-9\.]*\).*/\1/p’Example shell script for Subversion:#!/bin/shsvn stat -v $1 | sed -n ’s/^[ A-Z?\*|!]\{1,15\}/r/;s/ \{1,15\}/\/r/;s/ .*//p’Example filter for ClearCase:FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"LAYOUT_FILE The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by doxygen.The layout file controls the global structure of the generated output files in an output format independent way.The create the layout file that represents doxygen’s defaults, run doxygen with the -l option.
You can optionallyspecify a file name after the option, if omitted DoxygenLayout.xml will be used as the name of the layout file.Note that if you run doxygen from a directory containing a file called DoxygenLayout.xml, doxygen will parseit automatically even if the LAYOUT_FILE tag is left empty.CITE_BIB_FILES The CITE_BIB_FILES tag can be used to specify one or more bib files containing thereference definitions. This must be a list of .bib files. The .bib extension is automatically appended if omitted.This requires the bibtex tool to be installed. See also http://en.wikipedia.org/wiki/BibTeXfor more info.
![](https://s.studizba.com/z.php?f=/templates/si/i/noavatar.png&w=100&h=100&t=1"){kind=avatar}
