doxygen_manual-1.8.1 (1035109), страница 25
Текст из файла (страница 25)
For LaTeX the style of the bibliography can be controlled using LATEX_BIB_STYLE. See also\cite for info how to create references.20.4Options related to warning and progress messagesQUIET The QUIET tag can be used to turn on/off the messages that are generated to standard output by doxygen.Possible values are YES and NO, where YES implies that the messages are off. If left blank NO is used.WARNINGS The WARNINGS tag can be used to turn on/off the warning messages that are generated to standarderror by doxygen. Possible values are YES and NO, where YES implies that the warnings are on.
If left blankNO is used.Tip: Turn warnings on while writing the documentation.WARN_IF_UNDOCUMENTED If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warningsfor undocumented members. If EXTRACT_ALL is set to YES then this flag will automatically be disabled.WARN_IF_DOC_ERROR If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for potential errors in the documentation, such as not documenting some parameters in a documented function, ordocumenting parameters that don’t exist or using markup commands wrongly.WARN_NO_PARAMDOC This WARN_NO_PARAMDOC option can be enabled to get warnings for functions thatare documented, but have no documentation for their parameters or return value.
If set to NO (the default)doxygen will only warn about wrong or incomplete parameter documentation, but not about the absence ofdocumentation.WARN_FORMAT The WARN_FORMAT tag determines the format of the warning messages that doxygen can produce. The string should contain the $file, $line, and $text tags, which will be replaced by the file andline number from which the warning originated and the warning text.WARN_LOGFILE The WARN_LOGFILE tag can be used to specify a file to which warning and error messagesshould be written. If left blank the output is written to stderr.20.5Input related optionsINPUT The INPUT tag is used to specify the files and/or directories that contain documented source files.
Youmay enter file names like myfile.cpp or directories like /usr/src/myproject. Separate the files ordirectories with spaces.Note: If this tag is empty the current directory is searched.Generated by Doxygen100ConfigurationINPUT_ENCODING This tag can be used to specify the character encoding of the source files that doxygenparses. Internally doxygen uses the UTF-8 encoding, which is also the default input encoding. Doxygen useslibiconv (or the iconv built into libc) for the transcoding. See the libiconv documentation for thelist of possible encodings.FILE_PATTERNS If the value of the INPUT tag contains directories, you can use the FILE_PATTERNS tag tospecify one or more wildcard patterns (like ∗.cpp and ∗.h ) to filter out the source-files in the directories. If leftblank the following patterns are tested: .c ∗.cc ∗.cxx ∗.cpp ∗.c++ ∗.d ∗.java ∗.ii ∗.ixx∗.ipp ∗.i++ ∗.inl ∗.h ∗.hh .hxx ∗.hpp ∗.h++ ∗.idl ∗.odl ∗.cs ∗.php ∗.php3∗.inc ∗.m ∗.markdown ∗.md .mm ∗.dox ∗.py ∗.f90 ∗.f ∗.vhd ∗.vhdlRECURSIVE The RECURSIVE tag can be used to specify whether or not subdirectories should be searched forinput files as well.
Possible values are YES and NO. If left blank NO is used.EXCLUDE The EXCLUDE tag can be used to specify files and/or directories that should be excluded from the INPUT source files. This way you can easily exclude a subdirectory from a directory tree whose root is specifiedwith the INPUT tag. Note that relative paths are relative to the directory from which doxygen is run.EXCLUDE_SYMLINKS The EXCLUDE_SYMLINKS tag can be used to select whether or not files or directoriesthat are symbolic links (a Unix file system feature) are excluded from the input.EXCLUDE_PATTERNS If the value of the INPUT tag contains directories, you can use the EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude certain files from those directories.EXCLUDE_SYMBOLS The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names (namespaces, classes, functions, etc.) that should be excluded from the output.
The symbol name can be a fullyqualified name, a word, or if the wildcard ∗ is used, a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::∗TestNote that the wildcards are matched against the file with absolute path, so to exclude all test directories usethe pattern ∗/test/∗EXAMPLE_PATH The EXAMPLE_PATH tag can be used to specify one or more files or directories that containexample code fragments that are included (see the \include command in section \include).EXAMPLE_RECURSIVE If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be searched forinput files to be used with the \include or \dontinclude commands irrespective of the value of the RECURSIVEtag. Possible values are YES and NO.
If left blank NO is used.EXAMPLE_PATTERNS If the value of the EXAMPLE_PATH tag contains directories, you can use the EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like ∗.cpp and ∗.h) to filter out the source-filesin the directories.
If left blank all files are included.IMAGE_PATH The IMAGE_PATH tag can be used to specify one or more files or directories that contain imagesthat are to be included in the documentation (see the \image command).INPUT_FILTER The INPUT_FILTER tag can be used to specify a program that doxygen should invoke to filterfor each input file.
Doxygen will invoke the filter program by executing (via popen()) the command:<filter> <input-file>where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the name of an input file. Doxygen will then use the output that the filter program writes to standard output.FILTER_PATTERNS The FILTER_PATTERNS tag can be used to specify filters on a per file pattern basis.Doxygen will compare the file name with each pattern and apply the filter if there is a match. The filtersare a list of the form: pattern=filter (like ∗.cpp=my_cpp_filter). See INPUT_FILTER for further infoon how filters are used.
If FILTER_PATTERNS is empty or if none of the patterns match the file name,INPUT_FILTER is applied.FILTER_SOURCE_FILES If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using INPUT_FILTER ) will also be used to filter the input files that are used for producing the source files to browse(i.e.
when SOURCE_BROWSER is set to YES).Generated by Doxygen20.6 Source browsing related options101FILTER_SOURCE_PATTERNS The FILTER_SOURCE_PATTERNS tag can be used to specify source filtersper file pattern. A pattern will override the setting for FILTER_PATTERN (if any) and it is also possible todisable source filtering for a specific pattern using ∗.ext= (so without naming a filter). This option only haseffect when FILTER_SOURCE_FILES is enabled.20.6Source browsing related optionsSOURCE_BROWSER If the SOURCE_BROWSER tag is set to YES then a list of source files will be generated.Documented entities will be cross-referenced with these sources.
Note: To get rid of all source code in thegenerated output, make sure also VERBATIM_HEADERS is set to NO.INLINE_SOURCES Setting the INLINE_SOURCES tag to YES will include the body of functions, classes andenums directly into the documentation.STRIP_CODE_COMMENTS Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct doxygento hide any special comment blocks from generated source code fragments. Normal C and C++ commentswill always remain visible.REFERENCED_BY_RELATION If the REFERENCED_BY_RELATION tag is set to YES then for each documented function all documented functions referencing it will be listed.REFERENCES_RELATION If the REFERENCES_RELATION tag is set to YES then for each documented function all documented entities called/used by that function will be listed.REFERENCES_LINK_SOURCE If the REFERENCES_LINK_SOURCE tag is set to YES (the default) and SOURCE_BROWSER tag is set to YES, then the hyperlinks from functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will link to the source code.
Otherwise they will link to the documentation.VERBATIM_HEADERS If the VERBATIM_HEADERS tag is set the YES (the default) then doxygen will generatea verbatim copy of the header file for each class for which an include is specified. Set to NO to disable this.See alsoSection \class.USE_HTAGS If the USE_HTAGS tag is set to YES then the references to source code will point to the HTMLgenerated by the htags(1) tool instead of doxygen built-in source browser. The htags tool is part of GNU’sglobal source tagging system (see http://www.gnu.org/software/global/global.html).
Touse it do the following:1. Install the latest version of global (i.e. 4.8.6 or better)2. Enable SOURCE_BROWSER and USE_HTAGS in the config file3. Make sure the INPUT points to the root of the source tree4. Run doxygen as normalDoxygen will invoke htags (and that will in turn invoke gtags), so these tools must be available from thecommand line (i.e. in the search path).The result: instead of the source browser generated by doxygen, the links to source code will now point tothe output of htags.20.7Alphabetical index optionsALPHABETICAL_INDEX If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all compounds will be generated.
Enable this if the project contains a lot of classes, structs, unions or interfaces.COLS_IN_ALPHA_INDEX If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in which this list will be split (canbe a number in the range [1..20])Generated by Doxygen102ConfigurationIGNORE_PREFIX In case all classes in a project start with a common prefix, all classes will be put under thesame header in the alphabetical index. The IGNORE_PREFIX tag can be used to specify a prefix (or a listof prefixes) that should be ignored while generating the index headers.20.8HTML related optionsGENERATE_HTML If the GENERATE_HTML tag is set to YES (the default) doxygen will generate HTML outputHTML_OUTPUT The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
If a relative pathis entered the value of OUTPUT_DIRECTORY will be put in front of it. If left blank ’html’ will be used as thedefault path.HTML_FILE_EXTENSION The HTML_FILE_EXTENSION tag can be used to specify the file extension foreach generated HTML page (for example: .htm, .php, .asp). If it is left blank doxygen will generate files with.html extension.HTML_HEADER The HTML_HEADER tag can be used to specify a user-defined HTML header file for each generated HTML page. If the tag is left blank doxygen will generate a standard header.To get valid HTML the header file that includes any scripts and style sheets that doxygen needs, it is highlyrecommended to start with a default header usingdoxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFileand then modify the file new_header.html.The following markers have a special meaning inside the header and footer:$title will be replaced with the title of the page.$datetime will be replaced with current the date and time.$date will be replaced with the current date.$year will be replaces with the current year.$doxygenversion will be replaced with the version of doxygen$projectname will be replaced with the name of the project (see PROJECT_NAME)$projectnumber will be replaced with the project number (see PROJECT_NUMBER)$projectbrief will be replaced with the project brief description (see PROJECT_BRIEF)$projectlogo will be replaced with the project logo (see PROJECT_LOGO)$treeview will be replaced with links to the javascript and style sheets needed for the navigation tree (oran empty string when GENERATE_TREEVIEW is disabled).$search will be replaced with a links to the javascript and style sheets needed for the search engine (or anempty string when SEARCHENGINE is disabled).$mathjax will be replaced with a links to the javascript and style sheets needed for the MathJax feature(or an empty string when USE_MATHJAX is disabled).$relpath$ If CREATE_SUBDIRS is enabled, the command $relpath$ can be used to produce arelative path to the root of the HTML output directory, e.g.
![](https://s.studizba.com/z.php?f=/templates/si/i/noavatar.png&w=100&h=100&t=1"){kind=avatar}
