diff options
Diffstat (limited to 'src/config.xml')
| -rw-r--r-- | src/config.xml | 75 |
1 files changed, 52 insertions, 23 deletions
diff --git a/src/config.xml b/src/config.xml index 483eff1..8426787 100644 --- a/src/config.xml +++ b/src/config.xml @@ -215,7 +215,7 @@ Go to the <a href="commands.html">next</a> section or return to the This tag specifies the encoding used for all characters in the config file that follow. The default is UTF-8 which is also the encoding used for all text before the first occurrence of this tag. Doxygen uses \c libiconv (or the iconv built into - \c libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of + \c libc) for the transcoding. See https://www.gnu.org/software/libiconv/ for the list of possible encodings. ]]> </docs> @@ -532,7 +532,10 @@ Go to the <a href="commands.html">next</a> section or return to the will allow you to put the command \c \\sideeffect (or \c \@sideeffect) in the documentation, which will result in a user-defined paragraph with heading "Side Effects:". - You can put \ref cmdn "\\n"'s in the value part of an alias to insert newlines. + You can put \ref cmdn "\\n"'s in the value part of an alias to insert newlines + (in the resulting output). + You can put `^^` in the value part of an alias to insert a newline as if + a physical newline was in the original file. ]]> </docs> </option> @@ -661,7 +664,7 @@ Go to the <a href="commands.html">next</a> section or return to the <docs> <![CDATA[ Set the \c SIP_SUPPORT tag to \c YES if your project consists - of <a href="http://www.riverbankcomputing.co.uk/software/sip/intro">sip</a> sources only. + of <a href="https://www.riverbankcomputing.com/software/sip/intro">sip</a> sources only. Doxygen will parse them like normal C++ but will assume all classes use public instead of private inheritance when no explicit protection keyword is present. ]]> @@ -747,7 +750,7 @@ Go to the <a href="commands.html">next</a> section or return to the </docs> </option> <option type='int' id='LOOKUP_CACHE_SIZE' minval='0' maxval='9' defval='0'> - <!-- be carefull when changing these formulas as they are hard coded in the conversion script --> + <!-- be careful when changing these formulas as they are hard coded in the conversion script --> <docs> <![CDATA[ The size of the symbol lookup cache can be @@ -1172,7 +1175,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" The \c CITE_BIB_FILES tag can be used to specify one or more \c bib files containing the reference definitions. This must be a list of <code>.bib</code> files. The <code>.bib</code> extension is automatically appended if omitted. This requires the - \c bibtex tool to be installed. See also http://en.wikipedia.org/wiki/BibTeX for + \c bibtex tool to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. For \f$\mbox{\LaTeX}\f$ the style of the bibliography can be controlled using \ref cfg_latex_bib_style "LATEX_BIB_STYLE". To use this feature you need \c bibtex and \c perl available in the search path. @@ -1285,7 +1288,7 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" This tag can be used to specify the character encoding of the source files that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses `libiconv` (or the `iconv` built into `libc`) for the transcoding. - See <a href="http://www.gnu.org/software/libiconv">the libiconv documentation</a> for + See <a href="https://www.gnu.org/software/libiconv/">the libiconv documentation</a> for the list of possible encodings. ]]> </docs> @@ -1585,7 +1588,7 @@ to disable this feature. If the \c USE_HTAGS tag is set to \c YES then the references to source code will point to the HTML generated by the \c htags(1) tool instead of doxygen built-in source browser. The \c htags tool is part of GNU's global source - tagging system (see http://www.gnu.org/software/global/global.html). You + tagging system (see https://www.gnu.org/software/global/global.html). You will need version 4.8.6 or higher. <br> To use it do the following: @@ -1637,6 +1640,20 @@ to disable this feature. ]]> </docs> </option> + <option type='string' id='CLANG_COMPILATION_DATABASE_PATH' setting='USE_LIBCLANG' defval='0'> + <docs> +<![CDATA[ + If clang assisted parsing is enabled you can provide the clang parser with the + path to the <a href="http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html"> + compilation database</a> used when the files were built. This is equivalent to + specifying the "-p" option to a clang tool, such as clang-check. These options + will then be passed to the parser. + + @note The availability of this option depends on whether or not doxygen + was generated with the `-Duse-libclang=ON` option for CMake. + ]]> + </docs> + </option> </group> <group name='Index' docs='Configuration options related to the alphabetical class index'> <option type='bool' id='ALPHABETICAL_INDEX' defval='1'> @@ -1904,7 +1921,7 @@ hr.footer { The \c HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen will adjust the colors in the style sheet and background images according to this color. Hue is specified as an angle on a colorwheel, - see http://en.wikipedia.org/wiki/Hue for more information. + see https://en.wikipedia.org/wiki/Hue for more information. For instance the value 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 purple, and 360 is red again. ]]> @@ -1941,6 +1958,18 @@ hr.footer { ]]> </docs> </option> + <option type='bool' id='HTML_DYNAMIC_MENUS' defval='1' depends='GENERATE_HTML'> + <docs> +<![CDATA[ + If the \c HTML_DYNAMIC_MENUS tag is set to \c YES then the generated HTML + documentation will contain a main index with vertical navigation menus that + are dynamically created via Javascript. If disabled, the navigation index will consists of + multiple levels of tabs that are statically embedded in every HTML page. + Disable this option to support browsers that do not have Javascript, like + the Qt help browser. +]]> + </docs> + </option> <option type='bool' id='HTML_DYNAMIC_SECTIONS' defval='0' depends='GENERATE_HTML'> <docs> <![CDATA[ @@ -1969,14 +1998,14 @@ hr.footer { <![CDATA[ If the \c GENERATE_DOCSET tag is set to \c YES, additional index files will be generated that can be used as input for - <a href="http://developer.apple.com/tools/xcode/">Apple's Xcode 3 + <a href="https://developer.apple.com/tools/xcode/">Apple's Xcode 3 integrated development environment</a>, introduced with OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a Makefile in the HTML output directory. Running \c make will produce the docset in that directory and running <code>make install</code> will install the docset in <code>~/Library/Developer/Shared/Documentation/DocSets</code> so that Xcode will find it at startup. See - http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for + https://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. ]]> </docs> @@ -2121,7 +2150,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. <![CDATA[ The \c QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help Project output. For more information please see - <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace">Qt Help Project / Namespace</a>. + <a href="http://doc.qt.io/qt-4.8/qthelpproject.html#namespace">Qt Help Project / Namespace</a>. ]]> </docs> </option> @@ -2130,7 +2159,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. <![CDATA[ The \c QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt Help Project output. For more information please see - <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>. + <a href="http://doc.qt.io/qt-4.8/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>. ]]> </docs> </option> @@ -2138,7 +2167,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. <docs> <![CDATA[ If the \c QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom filter to add. For more information please see - <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. + <a href="http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. ]]> </docs> </option> @@ -2147,7 +2176,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. <![CDATA[ The \c QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the custom filter to add. For more information please see - <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. + <a href="http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. ]]> </docs> </option> @@ -2155,7 +2184,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. <docs> <![CDATA[ The \c QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's filter section matches. - <a href="http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. + <a href="http://doc.qt.io/qt-4.8/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. ]]> </docs> </option> @@ -2271,7 +2300,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. <option type='bool' id='FORMULA_TRANSPARENT' defval='1' depends='GENERATE_HTML'> <docs> <![CDATA[ - Use the \c FORMULA_TRANPARENT tag to determine whether or not the images + Use the \c FORMULA_TRANSPARENT 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 are supported on all modern browsers. <br>Note that when changing this option you need to delete any `form_*.png` files @@ -2283,7 +2312,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. <docs> <![CDATA[ Enable the \c USE_MATHJAX option to render \f$\mbox{\LaTeX}\f$ formulas using MathJax - (see http://www.mathjax.org) which uses client side Javascript for the + (see https://www.mathjax.org) which uses client side Javascript for the rendering instead of using pre-rendered bitmaps. Use this if you do not have \f$\mbox{\LaTeX}\f$ installed or if you want to formulas look prettier in the HTML output. When enabled you may also need to install MathJax separately and @@ -2305,7 +2334,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. <value name="NativeMML" desc="(i.e. MathML)"/> <value name="SVG"/> </option> - <option type='string' id='MATHJAX_RELPATH' format='string' defval='http://cdn.mathjax.org/mathjax/latest' depends='USE_MATHJAX'> + <option type='string' id='MATHJAX_RELPATH' format='string' defval='https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/' depends='USE_MATHJAX'> <docs> <![CDATA[ When MathJax is enabled you need to specify the location relative to the @@ -2315,7 +2344,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. \c MATHJAX_RELPATH should be <code>../mathjax</code>. The default value points to the MathJax Content Delivery Network so you can quickly see the result without installing MathJax. However, it is strongly recommended to install a local - copy of MathJax from http://www.mathjax.org before deployment. + copy of MathJax from https://www.mathjax.org before deployment. ]]> </docs> </option> @@ -2415,7 +2444,7 @@ See the section \ref extsearch for details. the search results. <br>Doxygen ships with an example indexer (\c doxyindexer) and search engine (<code>doxysearch.cgi</code>) which are based on the open source search - engine library <a href="http://xapian.org/">Xapian</a>. + engine library <a href="https://xapian.org/">Xapian</a>. <br>See the section \ref extsearch for details. ]]> </docs> @@ -2428,7 +2457,7 @@ See the section \ref extsearch for details. is enabled. <br>Doxygen ships with an example indexer (\c doxyindexer) and search engine (<code>doxysearch.cgi</code>) which are based on the open source search - engine library <a href="http://xapian.org/">Xapian</a>. + engine library <a href="https://xapian.org/">Xapian</a>. See the section \ref extsearch for details. ]]> </docs> @@ -2669,7 +2698,7 @@ or <![CDATA[ The \c LATEX_BIB_STYLE tag can be used to specify the style to use for the bibliography, e.g. \c plainnat, or \c ieeetr. - See http://en.wikipedia.org/wiki/BibTeX and \ref cmdcite "\\cite" + See https://en.wikipedia.org/wiki/BibTeX and \ref cmdcite "\\cite" for more info. ]]> </docs> @@ -2874,7 +2903,7 @@ front of it. <docs> <![CDATA[ If the \c GENERATE_AUTOGEN_DEF tag is set to \c YES, doxygen will - generate an AutoGen Definitions (see http://autogen.sf.net) file + generate an AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures the structure of the code including all documentation. Note that this feature is still experimental and incomplete at the moment. |