diff options
Diffstat (limited to 'src/config.xml')
| -rw-r--r-- | src/config.xml | 50 |
1 files changed, 38 insertions, 12 deletions
diff --git a/src/config.xml b/src/config.xml index 9f081c4..f9bd11c 100644 --- a/src/config.xml +++ b/src/config.xml @@ -8,8 +8,9 @@ iconv built into libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of possible encodings. ' defval='UTF-8'/> <option type='string' id='PROJECT_NAME' format='string' docs=' -The PROJECT_NAME tag is a single word (or a sequence of words surrounded -by quotes) that should identify the project. ' defval=''/> +The PROJECT_NAME tag is a single word (or sequence of words) that should +identify the project. Note that if you do not use Doxywizard you need +to put quotes around the project name if it contains spaces.' defval=''/> <option type='string' id='PROJECT_NUMBER' format='string' docs=' The PROJECT_NUMBER tag can be used to enter a project or revision number. This could be handy for archiving the generated documentation or @@ -288,6 +289,13 @@ unions are shown inside the group in which they are included (e.g. using @ingroup) instead of on a separate page (for HTML and Man pages) or section (for LaTeX and RTF). ' defval='0'/> + <option type='bool' id='INLINE_SIMPLE_STRUCTS' docs=' +When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and +unions with only public data fields will be shown inline in the documentation +of the scope in which they are defined (i.e. file, namespace, or group +documentation), provided this scope is documented. If set to NO (the default), +structs, classes, and unions are shown on a separate page (for HTML and Man +pages) or section (for LaTeX and RTF).' defval='0'/> <option type='bool' id='TYPEDEF_HIDES_STRUCT' docs=' When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum is documented as struct, union, or enum with the name of the typedef. So @@ -516,6 +524,14 @@ that represents doxygen's defaults, run doxygen with the -l option. You can optionally specify a file name after the option, if omitted DoxygenLayout.xml will be used as the name of the layout file. ' defval=''/> + <option type='list' id='CITE_BIB_FILES' format='file' docs=' +The CITE_BIB_FILES tag can be used to specify one or more bib files +containing the references data. This must be a list of .bib files. The +.bib extension is automatically appended if omitted. Using this command +requires the bibtex tool to be installed. See also +http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style +of the bibliography can be controlled using LATEX_BIB_STYLE. +' defval=''/> </group> <group name='Messages' docs='configuration options related to warning and progress messages'> <option type='bool' id='QUIET' docs=' @@ -789,13 +805,13 @@ doxygen will generate files with .html extension. <option type='string' id='HTML_HEADER' format='file' docs=' The HTML_HEADER tag can be used to specify a personal HTML header for each generated HTML page. If it is left blank doxygen will generate a -standard header. Note that when using a custom header you are responsible +standard header. Note that when using a custom header you are responsible for the proper inclusion of any scripts and style sheets that doxygen needs, which is dependent on the configuration options used. It is adviced to generate a default header using "doxygen -w html header.html footer.html stylesheet.css YourConfigFile" and then modify that header. Note that the header is subject to change so you typically -have to redo this when upgrading to a newer version of doxygen or when +have to redo this when upgrading to a newer version of doxygen or when changing the value of configuration settings such as GENERATE_TREEVIEW! ' defval='' depends='GENERATE_HTML'/> <option type='string' id='HTML_FOOTER' format='file' docs=' @@ -1052,6 +1068,11 @@ mathjax.org site, so you can quickly see the result without installing MathJax, but it is strongly recommended to install a local copy of MathJax before deployment. ' defval='http://www.mathjax.org/mathjax'/> + <option type='list' id='MATHJAX_EXTENSIONS' format='string' docs=' +The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension +names that should be enabled during MathJax rendering. +' depends='USE_MATHJAX'> + </option> <option type='bool' id='SEARCHENGINE' docs=' When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript @@ -1154,6 +1175,11 @@ source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER. ' defval='0' depends='GENERATE_LATEX'/> + <option type='string' id='LATEX_BIB_STYLE' format='string' docs=' +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 for more info. +' defval='plain'/> </group> <group name='RTF' docs='configuration options related to the RTF output'> <option type='bool' id='GENERATE_RTF' docs=' @@ -1405,7 +1431,7 @@ explicitly to a value larger than 0 to get control over the balance between CPU load and processing speed. ' defval='0' minval='0' maxval='32'/> <option type='string' id='DOT_FONTNAME' format='string' docs=' -By default doxygen will use the Helvetica font for all dot files that +By default doxygen will use the Helvetica font for all dot files that doxygen generates. When you want a differently looking font you can specify the font name using DOT_FONTNAME. You need to make sure dot is able to find the font, which can be done by putting it in a standard location or by setting @@ -1418,7 +1444,7 @@ The default size is 10pt. ' minval='4' maxval='24' defval='10' depends='HAVE_DOT'/> <option type='string' id='DOT_FONTPATH' format='string' docs=' By default doxygen will tell dot to use the Helvetica font. -If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to +If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to set the path where dot can find it. ' defval='' depends='HAVE_DOT'/> <option type='bool' id='CLASS_GRAPH' docs=' @@ -1486,7 +1512,7 @@ relations between the files in the directories. The DOT_IMAGE_FORMAT tag can be used to set the image format of the images generated by dot. Possible values are svg, png, jpg, or gif. If left blank png will be used. If you choose svg you need to set -HTML_FILE_EXTENSION to xhtml in order to make the SVG files +HTML_FILE_EXTENSION to xhtml in order to make the SVG files visible in IE 9+ (other browsers do not have this requirement). ' depends='HAVE_DOT'> <value name='png'/> @@ -1494,13 +1520,13 @@ visible in IE 9+ (other browsers do not have this requirement). <value name='gif'/> <value name='svg'/> </option> - <option type='bool' id='INTERACTIVE_SVG' doc=' -If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to + <option type='bool' id='INTERACTIVE_SVG' docs=' +If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to enable generation of interactive SVG images that allow zooming and panning. Note that this requires a modern browser other than Internet Explorer. -Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you -need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files -visible. Older versions of IE do not have SVG support. +Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you +need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files +visible. Older versions of IE do not have SVG support. ' defval='0' depends='HAVE_DOT'/> <option type='string' id='DOT_PATH' format='dir' docs=' The tag DOT_PATH can be used to specify the path where the dot tool can be |