doxygen_manual-1.8.1 (1035109), страница 26
Текст из файла (страница 26)
use $relpath$doxygen.css, to refer to thestandard style sheet.To cope with differences in the layout of the header and footer that depend on configuration settings, theheader can also contain special blocks that will be copied to the output or skipped depending on the configuration. Such blocks have the following form:<!--BEGIN BLOCKNAME-->Some context copied when condition BLOCKNAME holds<!--END BLOCKNAME--><!--BEGIN !BLOCKNAME-->Some context copied when condition BLOCKNAME does not hold<!--END !BLOCKNAME-->The following block names are supported:Generated by Doxygen20.8 HTML related options103DISABLE_INDEX Content within this block is copied to the output when the DISABLE_INDEX option isenabled (so when the index is disabled).GENERATE_TREEVIEW Content within this block is copied to the output when the GENERATE_TREEVIEW option is enabled.SEARCHENGINE Content within this block is copied to the output when the SEARCHENGINE option isenabled.PROJECT_NAME Content within the block is copied to the output when the PROJECT_NAME option is notempty.PROJECT_NUMBER Content within the block is copied to the output when the PROJECT_NUMBER optionis not empty.PROJECT_BRIEF Content within the block is copied to the output when the PROJECT_BRIEF option isnot empty.PROJECT_LOGO Content within the block is copied to the output when the PROJECT_LOGO option is notempty.TITLEAREA Content within this block is copied to the output when a title is visible at the top of each page.This is the case if either PROJECT_NAME, PROJECT_BRIEF, PROJECT_LOGO is filled in or if bothDISABLE_INDEX and SEARCHENGINE are enabled.See also section Doxygen usage for information on how to generate the default header that doxygen normallyuses.NoteThe header is subject to change so you typically have to regenerate the default header when upgradingto a newer version of doxygen.HTML_FOOTER The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each generatedHTML page.
If the tag is left blank doxygen will generate a standard footer.See HTML_HEADER for more information on how to generate a default footer and what special commandscan be used inside the footer.See also section Doxygen usage for information on how to generate the default footer that doxygen normallyuses.HTML_STYLESHEET The HTML_STYLESHEET tag can be used to specify a user-defined cascading style sheetthat is used by each HTML page.
It can be used to fine-tune the look of the HTML output. If the tag is leftblank doxygen will generate a default style sheet.See also section Doxygen usage for information on how to generate the style sheet that doxygen normallyuses.HTML_EXTRA_FILES The HTML_EXTRA_FILES tag can be used to specify one or more extra images orother source files which should be copied to the HTML output directory.
Note that these files will be copiedto the base HTML output directory. Use the $relpath$ marker in the HTML_HEADER and/or HTML_FOOTERfiles to load these files. In the HTML_STYLESHEET file, use the file name only. Also note that the files willbe copied as-is; there are no commands or markers available.HTML_COLORSTYLE_HUE The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygenwill adjust the colors in the stylesheet and background images according to this color.
Hue is specified asan angle on a colorwheel, see http://en.wikipedia.org/wiki/Hue for more information. Forinstance the value 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 purple, and 360is red again. The allowed range is 0 to 359.HTML_COLORSTYLE_SAT The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colorsin the HTML output. For a value of 0 the output will use grayscales only. A value of 255 will produce the mostvivid colors.HTML_COLORSTYLE_GAMMA The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied tothe luminance component of the colors in the HTML output. Values below 100 gradually make the outputlighter, whereas values above 100 make the output darker.
The value divided by 100 is the actual gammaapplied, so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does notchange the gamma.Generated by Doxygen104ConfigurationHTML_TIMESTAMP If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML pagewill contain the date and time when the page was generated.
Setting this to NO can help when comparingthe output of multiple runs.HTML_ALIGN_MEMBERS If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, files ornamespaces will be aligned in HTML using tables. If set to NO a bullet list will be used.Note: Setting this tag to NO will become obsolete in the future, since I only intent to support and test thealigned representation.HTML_DYNAMIC_SECTIONS If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTMLdocumentation will contain sections that can be hidden and shown after the page has loaded.HTML_NUM_INDEX_ENTRIES With HTML_INDEX_NUM_ENTRIES one can control the preferred number ofentries shown in the various tree structured indices initially; the user can expand and collapse entries dynamically later on.
Doxygen will expand the tree to such a level that at most the specified number of entries arevisible (unless a fully collapsed tree already exceeds this amount). So setting the number of entries 1 willproduce a full collapsed tree by default. 0 is a special value representing an infinite number of entries and willresult in a full expanded tree by default.GENERATE_DOCSET If the GENERATE_DOCSET tag is set to YES, additional index files will be generated thatcan be used as input for Apple’s Xcode 3 integrated development environment, introduced with OSX 10.5 (Leopard).
To create a documentation set, doxygen will generate a Makefile in the HTMLoutput directory. Running make will produce the docset in that directory and running make install willinstall the docset in ∼/Library/Developer/Shared/Documentation/DocSets so that Xcodewill find it at startup. See this article for more information.DOCSET_FEEDNAME When GENERATE_DOCSET tag is set to YES, this tag determines the name of the feed.A documentation feed provides an umbrella under which multiple documentation sets from a single provider(such as a company or product suite) can be grouped.DOCSET_BUNDLE_ID When GENERATE_DOCSET tag is set to YES, this tag specifies a string that shoulduniquely identify the documentation set bundle. This should be a reverse domain-name style string, e.g.com.mycompany.MyDocSet.
Doxygen will append .docset to the name.DOCSET_PUBLISHER_ID When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify the documentation publisher. This should be a reverse domain-name style string, e.g. com.mycompany.MyDocSet.documentation.DOCSET_PUBLISHER_NAME The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.GENERATE_HTMLHELP If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three additional HTML index files: index.hhp, index.hhc, and index.hhk. The index.hhp is a project filethat can be read by Microsoft’s HTML Help Workshop on Windows.The HTML Help Workshop contains a compiler that can convert all HTML output generated by doxygen intoa single compiled HTML file (.chm).
Compiled HTML files are now used as the Windows 98 help format, andwill replace the old Windows help format (.hlp) on all Windows platforms in the future. Compressed HTMLfiles also contain an index, a table of contents, and you can search for words in the documentation. TheHTML workshop also contains a viewer for compressed HTML files.CHM_FILE If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can be used to specify the filename of the resulting .chm file. You can add a path in front of the file if the result should not be written to thehtml output directory.HHC_LOCATION If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can be used tospecify the location (absolute path including file name) of the HTML help compiler (hhc.exe).
If non-emptydoxygen will try to run the HTML help compiler on the generated index.hhp.GENERATE_CHI If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag controls if a separate .chi index file is generated (YES) or that it should be included in the master .chm file (NO).CHM_INDEX_ENCODING If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING isused to encode HtmlHelp index (hhk), content (hhc) and project file content.Generated by Doxygen20.8 HTML related options105BINARY_TOC If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag controls whether a binarytable of contents is generated (YES) or a normal table of contents (NO) in the .chm file.TOC_EXPAND The TOC_EXPAND flag can be set to YES to add extra items for group members to the table ofcontents of the HTML help documentation and to the tree view.GENERATE_QHP If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that can be used as input for Qt’s qhelpgeneratorto generate a Qt Compressed Help (.qch) of the generated HTML documentation.QCH_FILE If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify the file name ofthe resulting .qch file.
The path specified is relative to the HTML output folder.QHP_NAMESPACE The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help Projectoutput. For more information please see Qt Help Project / Namespace.QHP_VIRTUAL_FOLDER The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generatingQt Help Project output. For more information please see Qt Help Project / Virtual Folders.QHP_CUST_FILTER_NAME If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.For more information please see Qt Help Project / Custom Filters.QHP_CUST_FILTER_ATTRS The QHP_CUST_FILTER_ATTRIBUTES tag specifies the list of the attributes ofthe custom filter to add.
![](https://s.studizba.com/z.php?f=/templates/si/i/noavatar.png&w=100&h=100&t=1"){kind=avatar}
