doxygen_manual-1.8.1 (1035109), страница 28
Текст из файла (страница 28)
Note that which sources are shown also depends on other settingssuch as SOURCE_BROWSER.Generated by Doxygen108Configuration20.10RTF related optionsGENERATE_RTF If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The RTF output isoptimized for Word 97 and may not look too pretty with other readers/editors.RTF_OUTPUT The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a relative path isentered the value of OUTPUT_DIRECTORY will be put in front of it.
If left blank rtf will be used as thedefault path.COMPACT_RTF If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF documents. Thismay be useful for small projects and may help to save some trees in general.RTF_HYPERLINKS If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will contain hyperlinkfields.
The RTF file will contain links (just like the HTML output) instead of page references. This makesthe output suitable for online browsing using Word or some other Word compatible reader that support thosefields.note:WordPad (write) and others do not support links.RTF_STYLESHEET_FILE Load stylesheet definitions from file. Syntax is similar to doxygen’s config file, i.e.a series of assignments. You only have to provide replacements, missing definitions are set to their defaultvalue.See also section Doxygen usage for information on how to generate the default style sheet that doxygennormally uses.RTF_EXTENSIONS_FILE Set optional variables used in the generation of an RTF document.
Syntax issimilar to doxygen’s config file. A template extensions file can be generated using doxygen -e rtfextensionFile.20.11Man page related optionsGENERATE_MAN If the GENERATE_MAN tag is set to YES (the default) doxygen will generate man pages forclasses and files.MAN_OUTPUT The MAN_OUTPUT tag is used to specify where the man pages will be put. If a relative path isentered the value of OUTPUT_DIRECTORY will be put in front of it. If left blank ’man’ will be used as thedefault path. A directory man3 will be created inside the directory specified by MAN_OUTPUT.MAN_EXTENSION The MAN_EXTENSION tag determines the extension that is added to the generated manpages (default is the subroutine’s section .3)MAN_LINKS If the MAN_LINKS tag is set to YES and doxygen generates man output, then it will generate oneadditional man file for each entity documented in the real man page(s).
These additional files only source thereal man page, but without them the man command would be unable to find the correct page. The default isNO.20.12XML related optionsGENERATE_XML If the GENERATE_XML tag is set to YES Doxygen will generate an XML file that captures thestructure of the code including all documentation.XML_OUTPUT The XML_OUTPUT tag is used to specify where the XML pages will be put.
If a relative path isentered the value of OUTPUT_DIRECTORY will be put in front of it. If left blank xml will be used as thedefault path.XML_SCHEMA The XML_SCHEMA tag can be used to specify an XML schema, which can be used by a validatingXML parser to check the syntax of the XML files.Generated by Doxygen20.13 AUTOGEN_DEF related options109XML_DTD The XML_DTD tag can be used to specify an XML DTD, which can be used by a validating XML parserto check the syntax of the XML files.XML_PROGRAMLISTING If the XML_PROGRAMLISTING tag is set to YES Doxygen will dump the programlistings (including syntax highlighting and cross-referencing information) to the XML output.
Note that enablingthis will significantly increase the size of the XML output.20.13AUTOGEN DEF related optionsGENERATE_AUTOGEN_DEF If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will generate anAutoGen Definitions (see http://autogen.sf.net) file that captures the structure of the code including all documentation. Note that this feature is still experimental and incomplete at the moment.20.14PERLMOD related optionsGENERATE_PERLMOD If the GENERATE_PERLMOD tag is set to YES Doxygen will generate a Perl module filethat captures the structure of the code including all documentation.
Note that this feature is still experimentaland incomplete at the moment.PERLMOD_LATEX If the PERLMOD_LATEX tag is set to YES Doxygen will generate the necessary Makefilerules, Perl scripts and LaTeX code to be able to generate PDF and DVI output from the Perl module output.PERLMOD_PRETTY If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely formattedso it can be parsed by a human reader. This is useful if you want to understand what is going on. On theother hand, if this tag is set to NO the size of the Perl module output will be much smaller and Perl will parseit just the same.PERLMOD_MAKEVAR_PREFIX The names of the make variables in the generated doxyrules.make file are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful so different doxyrules.makefiles included by the same Makefile don’t overwrite each other’s variables.20.15Preprocessor related optionsENABLE_PREPROCESSING If the ENABLE_PREPROCESSING tag is set to YES (the default) doxygen willevaluate all C-preprocessor directives found in the sources and include files.MACRO_EXPANSION If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names in thesource code.
If set to NO (the default) only conditional compilation will be performed. Macro expansion canbe done in a controlled way by setting EXPAND_ONLY_PREDEF to YES.EXPAND_ONLY_PREDEF If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YESthen the macro expansion is limited to the macros specified with the PREDEFINED and EXPAND_AS_DEFINED tags.SEARCH_INCLUDES If the SEARCH_INCLUDES tag is set to YES (the default) the includes files in the INCLUDE_PATH (see below) will be searched if a #include is found.INCLUDE_PATH The INCLUDE_PATH tag can be used to specify one or more directories that contain includefiles that are not input files but should be processed by the preprocessor.INCLUDE_FILE_PATTERNS You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard patterns (like ∗.h and ∗.hpp) to filter out the header-files in the directories. If left blank, the patternsspecified with FILE_PATTERNS will be used.PREDEFINED The PREDEFINED tag can be used to specify one or more macro names that are defined beforethe preprocessor is started (similar to the -D option of gcc).
The argument of the tag is a list of macros of theform: name or name=definition (no spaces). If the definition and the "=" are omitted, "=1" is assumed.Generated by Doxygen110ConfigurationTo prevent a macro definition from being undefined via #undef or recursively expanded use the := operatorinstead of the = operator.EXPAND_AS_DEFINED If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES thenthis tag can be used to specify a list of macro names that should be expanded. The macro definition that isfound in the sources will be used.
Use the PREDEFINED tag if you want to use a different macro definition.SKIP_FUNCTION_MACROS If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then doxygen’spreprocessor will remove all function-like macros that are alone on a line, have an all uppercase name, anddo not end with a semicolon. Such function macros are typically used for boiler-plate code, and will confusethe parser if not removed.20.16External reference optionsTAGFILES The TAGFILES tag can be used to specify one or more tag files.See Linking to external documentation for more information about the use of tag files.NoteEach tag file must have a unique name (where the name does not include the path).
If a tag file is notlocated in the directory in which doxygen is run, you must also specify the path to the tagfile here.GENERATE_TAGFILE When a file name is specified after GENERATE_TAGFILE, doxygen will create a tag filethat is based on the input files it reads. See section Linking to external documentation for more informationabout the usage of tag files.ALLEXTERNALS If the ALLEXTERNALS tag is set to YES all external class will be listed in the class index. Ifset to NO only the inherited external classes will be listed.EXTERNAL_GROUPS If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in the modules index. If set to NO, only the current project’s groups will be listed.PERL_PATH The PERL_PATH should be the absolute path and name of the perl script interpreter (i.e.
the resultof ’which perl’).20.17Dot optionsCLASS_DIAGRAMS If the CLASS_DIAGRAMS tag is set to YES (the default) doxygen will generate a classdiagram (in HTML and LATEX) for classes with base or super classes. Setting the tag to NO turns the diagramsoff. Note that this option also works with HAVE_DOT disabled, but it is recommended to install and use dot,since it yields more powerful graphs.MSCGEN_PATH You can define message sequence charts within doxygen comments using the \msc command.Doxygen will then run the mscgen tool) to produce the chart and insert it in the documentation. TheMSCGEN_PATH tag allows you to specify the directory where the mscgen tool resides.
If left empty the toolis assumed to be found in the default search path.HAVE_DOT If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is available from the path.This tool is part of Graphviz, a graph visualization toolkit from AT&T and Lucent Bell Labs. The otheroptions in this section have no effect if this option is set to NO (the default)DOT_NUM_THREADS The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed torun in parallel. When set to 0 (the default) doxygen will base this on the number of processors available inthe system. You can set it explicitly to a value larger than 0 to get control over the balance between CPU loadand processing speed.DOT_FONTNAME By default doxygen will use the Helvetica font for all dot files that doxygen generates.
Whenyou want a differently looking font you can specify the font name using DOT_FONTNAME. You need to makesure dot is able to find the font, which can be done by putting it in a standard location or by setting theDOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory containing the font.Generated by Doxygen20.17 Dot options111DOT_FONTSIZE The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. The default sizeis 10pt.DOT_FONTPATH By default doxygen will tell dot to use the output directory to look for the FreeSans.ttf font(which doxygen will put there itself).
If you specify a different font using DOT_FONTNAME you can set thepath where dot can find it using this tag.CLASS_GRAPH If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen will generate a graphfor each documented class showing the direct and indirect inheritance relations. Setting this tag to YES willforce the CLASS_DIAGRAMS tag to NO.COLLABORATION_GRAPH If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen will generate a graph for each documented class showing the direct and indirect implementation dependencies (inheritance, containment, and class references variables) of the class with other documentedclasses.GROUP_GRAPHS If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen will generate agraph for groups, showing the direct groups dependencies.UML_LOOK If the UML_LOOK tag is set to YES doxygen will generate inheritance and collaboration diagrams ina style similar to the OMG’s Unified Modeling Language.UML_LIMIT_NUM_FIELDS If the UML_LOOK tag is enabled, the fields and methods are shown inside theclass node.
![](https://s.studizba.com/z.php?f=/templates/si/i/noavatar.png&w=100&h=100&t=1"){kind=avatar}
