doxygen_manual-1.8.1 (1035109), страница 27
Текст из файла (страница 27)
For more information please see Qt Help Project / Custom Filters.QHP_SECT_FILTER_ATTRS The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes thisproject’s filter section matches. Qt Help Project / Filter Attributes.QHG_LOCATION If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can be used to specify thelocation of Qt’s qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the generated .qhpfile.GENERATE_ECLIPSEHELP If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will begenerated, which together with the HTML files, form an Eclipse help plugin.To install this plugin and make it available under the help contents menu in Eclipse, the contents of thedirectory containing the HTML and XML files needs to be copied into the plugins directory of eclipse.
Thename of the directory within the plugins directory should be the same as the ECLIPSE_DOC_ID value.After copying Eclipse needs to be restarted before the help appears.ECLIPSE_DOC_ID A unique identifier for the eclipse help plugin. When installing the plugin the directory namecontaining the HTML and XML files should also have this name. Each documentation set should have its ownidentifier.SEARCHENGINE When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTMLoutput. The underlying search engine uses javascript and DHTML and should work on any modern browser.Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should typically be disabled.
For largeprojects the javascript based search engine can be slow, then enabling SERVER_BASED_SEARCH mayprovide a better solution.It is possible to search using the keyboard; to jump to the search box use access key + S (what the accesskey is depends on the OS and browser, but it is typically CTRL, ALT/option, or both). Inside the search boxuse the cursor down key to jump into the search results window, the results can be navigated using the cursorkeys.
Press Enter to select an item or escape to cancel the search. The filter options can be selected whenthe cursor is inside the search box by pressing Shift+cursor down. Also here use the cursor keys to select afilter and enter or escape to activate or cancel the filter option.SERVER_BASED_SEARCH When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen willgenerate the search PHP script and index file to put on the web server. The advantage of the server basedapproach is that it scales better to large projects and also allows full text search.
The disadvantages are thatit is more difficult to setup and does not have live searching capabilities.Generated by Doxygen106ConfigurationDISABLE_INDEX If you want full control over the layout of the generated HTML pages it might be necessaryto disable the index and replace it with your own. The DISABLE_INDEX tag can be used to turn on/offthe condensed index at top of each page.
A value of NO (the default) enables the index and the value YESdisables it. Since the tabs have the same information as the navigation tree you can set this option to NO ifyou already set GENERATE_TREEVIEW to YES.ENUM_VALUES_PER_LINE This tag can be used to set the number of enum values (range [0,1..20]) that doxygen will group on one line in the generated HTML documentation. Note that a value of 0 will completelysuppress the enum values from appearing in the overview section.GENERATE_TREEVIEW The GENERATE_TREEVIEW tag is used to specify whether a tree-like index structureshould be generated to display hierarchical information.
If the tag value is set to YES, a side panel will begenerated containing a tree-like index structure (just like the one that is generated for HTML Help). For thisto work a browser that supports JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).Windows users are probably better off using the HTML help feature.Via custom stylesheets (see HTML_STYLESHEET) one can further fine-tune the look of the index.
As anexample, the default style sheet generated by doxygen has an example that shows how to put an image atthe root of the tree instead of the project name.TREEVIEW_WIDTH If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used to setthe initial width (in pixels) of the frame in which the tree is shown.EXT_LINKS_IN_WINDOW When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open linksto external symbols imported via tag files in a separate window.FORMULA_FONTSIZE Use this tag to change the font size of Latex formulas included as images in the HTMLdocumentation.
The default is 10. when you change the font size after a successful doxygen run you need tomanually remove any form_∗.png images from the HTML output directory to force them to be regenerated.FORMULA_TRANSPARENT Use the FORMULA_TRANPARENT tag to determine whether or not the images generated for formulas are transparent PNGs. Transparent PNGs are not supported properly for IE 6.0, but aresupported on all modern browsers.
Note that when changing this option you need to delete any form_∗.png files in the HTML output before the changes have effect.USE_MATHJAX Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see http://www.mathjax.org) which uses client side Javascript for the rendering instead of using prerenderedbitmaps. Use this if you do not have LaTeX installed or if you want to formulas look prettier in the HTMLoutput.
When enabled you may also need to install MathJax separately and configure the path to it using theMATHJAX_RELPATH option.MATHJAX_RELPATH When MathJax is enabled you need to specify the location relative to the HTML outputdirectory using the MATHJAX_RELPATH option. The destination directory should contain the MathJax.jsscript. For instance, if the mathjax directory is located at the same level as the HTML output directory, thenMATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax Content DeliveryNetwork so you can quickly see the result without installing MathJax. However, it is strongly recommended toinstall a local copy of MathJax from http://www.mathjax.org before deployment.MATHJAX_EXTENSIONS The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extensionnames that should be enabled during MathJax rendering.
For exampleMATHJAX_EXTENSIONS20.9= TeX/AMSmath TeX/AMSsymbolsLaTeX related optionsGENERATE_LATEX If the GENERATE_LATEX tag is set to YES (the default) doxygen will generate LATEX output.LATEX_OUTPUT The LATEX_OUTPUT tag is used to specify where the LATEX docs will be put. If a relative pathis entered the value of OUTPUT_DIRECTORY will be put in front of it. If left blank ’latex’ will be used as thedefault path.Generated by Doxygen20.9 LaTeX related options107LATEX_CMD_NAME The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked.
If left blank ’latex’ will be used as the default command name. Note that when enabling USE_PDFLATEX this option is only used for generating bitmaps for formulas in the HTML output, but not in the Makefilethat is written to the output directory.MAKEINDEX_CMD_NAME The MAKEINDEX_CMD_NAME tag can be used to specify the command name togenerate index for LaTeX. If left blank ’makeindex’ will be used as the default command name.COMPACT_LATEX If the COMPACT_LATEX tag is set to YES doxygen generates more compact LATEX documents. This may be useful for small projects and may help to save some trees in general.PAPER_TYPE The PAPER_TYPE tag can be used to set the paper type that is used by the printer.
Possiblevalues are:• a4 (210 x 297 mm).• letter (8.5 x 11 inches).• legal (8.5 x 14 inches).• executive (7.25 x 10.5 inches)If left blank a4 will be used.EXTRA_PACKAGES The EXTRA_PACKAGES tag can be used to specify one or more LATEX package names thatshould be included in the LATEX output. To get the times font for instance you can specifyEXTRA_PACKAGES = timesIf left blank no extra packages will be included.LATEX_HEADER The LATEX_HEADER tag can be used to specify a personal LATEX header for the generatedLATEX document. The header should contain everything until the first chapter.If it is left blank doxygen will generate a standard header. See section Doxygen usage for information on howto let doxygen write the default header to a separate file.Note:Only use a user-defined header if you know what you are doing!The following commands have a special meaning inside the header: $title, $datetime, $date,$doxygenversion, $projectname, $projectnumber.
Doxygen will replace them by respectivelythe title of the page, the current date and time, only the current date, the version number of doxygen, theproject name (see PROJECT_NAME), or the project number (see PROJECT_NUMBER).LATEX_FOOTER The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the generatedlatex document. The footer should contain everything after the last chapter. If it is left blank doxygen willgenerate a standard footer.
Notice: only use this tag if you know what you are doing!PDF_HYPERLINKS If the PDF_HYPERLINKS tag is set to YES, the LATEX that is generated is prepared forconversion to PDF (using ps2pdf or pdflatex). The PDF file will contain links (just like the HTML output)instead of page references. This makes the output suitable for online browsing using a PDF viewer.USE_PDFLATEX If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate the PDF filedirectly from the LATEX files.LATEX_BATCHMODE If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode.
commandto the generated LATEX files. This will instruct LATEX to keep running if errors occur, instead of asking the userfor help. This option is also used when generating formulas in HTML.LATEX_BIB_STYLE The LATEX_BIB_STYLE tag can be used to specify the style to use for the bibliography,e.g. plainnat, or ieeetr.
The default style is plain. See http://en.wikipedia.org/wiki/BibTeX and \cite for more info.LATEX_HIDE_INDICES If LATEX_HIDE_INDICES is set to YES then doxygen will not include the indexchapters (such as File Index, Compound Index, etc.) in the output.LATEX_SOURCE_CODE If LATEX_SOURCE_CODE is set to YES then doxygen will include source code withsyntax highlighting in the LaTeX output.
![](https://s.studizba.com/z.php?f=/templates/si/i/noavatar.png&w=100&h=100&t=1"){kind=avatar}
