|
|
@@ -1,11 +1,11 @@
|
|
|
-# Doxyfile 1.8.5
|
|
|
+# Doxyfile 1.8.8
|
|
|
|
|
|
# This file describes the settings to be used by the documentation system
|
|
|
# doxygen (www.doxygen.org) for a project.
|
|
|
-#
|
|
|
+#
|
|
|
# All text after a double hash (##) is considered a comment and is placed in
|
|
|
# front of the TAG it is preceding.
|
|
|
-#
|
|
|
+#
|
|
|
# All text after a single hash (#) is considered a comment and will be ignored.
|
|
|
# The format is:
|
|
|
# TAG = value [value, ...]
|
|
|
@@ -32,13 +32,13 @@ DOXYFILE_ENCODING = UTF-8
|
|
|
# title of most generated pages and in a few other places.
|
|
|
# The default value is: My Project.
|
|
|
|
|
|
-PROJECT_NAME = GLM
|
|
|
+PROJECT_NAME = 0.9.6
|
|
|
|
|
|
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
|
|
|
# could be handy for archiving the generated documentation or if some version
|
|
|
# control system is used.
|
|
|
|
|
|
-PROJECT_NUMBER = 0.9.5
|
|
|
+PROJECT_NUMBER =
|
|
|
|
|
|
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
|
|
# for a project that appears at the top of each page and should give viewer a
|
|
|
@@ -51,7 +51,7 @@ PROJECT_BRIEF =
|
|
|
# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
|
|
|
# to the output directory.
|
|
|
|
|
|
-PROJECT_LOGO = G:/Repository/glm/doc/logo.png
|
|
|
+PROJECT_LOGO = E:/Source/G-Truc/glm/doc/logo.png
|
|
|
|
|
|
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
|
|
|
# into which the generated documentation will be written. If a relative path is
|
|
|
@@ -70,15 +70,25 @@ OUTPUT_DIRECTORY = .
|
|
|
|
|
|
CREATE_SUBDIRS = NO
|
|
|
|
|
|
+# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
|
|
|
+# characters to appear in the names of generated files. If set to NO, non-ASCII
|
|
|
+# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
|
|
|
+# U+3044.
|
|
|
+# The default value is: NO.
|
|
|
+
|
|
|
+ALLOW_UNICODE_NAMES = NO
|
|
|
+
|
|
|
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
|
|
|
# documentation generated by doxygen is written. Doxygen will use this
|
|
|
# information to generate all constant output in the proper language.
|
|
|
-# Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-
|
|
|
-# Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi,
|
|
|
-# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en,
|
|
|
-# Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish,
|
|
|
-# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
|
|
|
-# Turkish, Ukrainian and Vietnamese.
|
|
|
+# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
|
|
|
+# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
|
|
|
+# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
|
|
|
+# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
|
|
|
+# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
|
|
|
+# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
|
|
|
+# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
|
|
|
+# Ukrainian and Vietnamese.
|
|
|
# The default value is: English.
|
|
|
|
|
|
OUTPUT_LANGUAGE = English
|
|
|
@@ -92,7 +102,7 @@ BRIEF_MEMBER_DESC = NO
|
|
|
|
|
|
# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
|
|
|
# description of a member or function before the detailed description
|
|
|
-#
|
|
|
+#
|
|
|
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
|
|
|
# brief descriptions will be completely suppressed.
|
|
|
# The default value is: YES.
|
|
|
@@ -147,7 +157,7 @@ FULL_PATH_NAMES = NO
|
|
|
# part of the path. The tag can be used to show relative paths in the file list.
|
|
|
# If left blank the directory from which doxygen is run is used as the path to
|
|
|
# strip.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that you can specify absolute paths here, but also relative paths, which
|
|
|
# will be relative from the directory where doxygen is started.
|
|
|
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
|
|
|
@@ -192,7 +202,7 @@ QT_AUTOBRIEF = NO
|
|
|
# a brief description. This used to be the default behavior. The new default is
|
|
|
# to treat a multi-line C++ comment block as a detailed description. Set this
|
|
|
# tag to YES if you prefer the old behavior instead.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that setting this tag to YES also means that rational rose comments are
|
|
|
# not recognized any more.
|
|
|
# The default value is: NO.
|
|
|
@@ -269,12 +279,15 @@ OPTIMIZE_OUTPUT_VHDL = NO
|
|
|
# extension. Doxygen has a built-in mapping, but you can override or extend it
|
|
|
# using this tag. The format is ext=language, where ext is a file extension, and
|
|
|
# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
|
|
|
-# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
|
|
|
-# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
|
|
|
-# (default is Fortran), use: inc=Fortran f=C.
|
|
|
-#
|
|
|
+# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
|
|
|
+# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
|
|
|
+# Fortran. In the later case the parser tries to guess whether the code is fixed
|
|
|
+# or free formatted code, this is the default for Fortran type files), VHDL. For
|
|
|
+# instance to make doxygen treat .inc files as Fortran files (default is PHP),
|
|
|
+# and .f files as C (default is Fortran), use: inc=Fortran f=C.
|
|
|
+#
|
|
|
# Note For files without extension you can use no_extension as a placeholder.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
|
|
|
# the files are not read by doxygen.
|
|
|
|
|
|
@@ -353,7 +366,7 @@ SUBGROUPING = NO
|
|
|
# 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).
|
|
|
-#
|
|
|
+#
|
|
|
# Note that this feature does not work in combination with
|
|
|
# SEPARATE_MEMBER_PAGES.
|
|
|
# The default value is: NO.
|
|
|
@@ -510,6 +523,13 @@ HIDE_SCOPE_NAMES = YES
|
|
|
|
|
|
SHOW_INCLUDE_FILES = NO
|
|
|
|
|
|
+# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
|
|
|
+# grouped member an include statement to the documentation, telling the reader
|
|
|
+# which file to include in order to use the member.
|
|
|
+# The default value is: NO.
|
|
|
+
|
|
|
+SHOW_GROUPED_MEMB_INC = NO
|
|
|
+
|
|
|
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
|
|
|
# files with double quotes in the documentation rather than with sharp brackets.
|
|
|
# The default value is: NO.
|
|
|
@@ -531,7 +551,8 @@ SORT_MEMBER_DOCS = YES
|
|
|
|
|
|
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
|
|
|
# descriptions of file, namespace and class members alphabetically by member
|
|
|
-# name. If set to NO the members will appear in declaration order.
|
|
|
+# name. If set to NO the members will appear in declaration order. Note that
|
|
|
+# this will also influence the order of the classes in the class list.
|
|
|
# The default value is: NO.
|
|
|
|
|
|
SORT_BRIEF_DOCS = YES
|
|
|
@@ -656,7 +677,7 @@ FILE_VERSION_FILTER =
|
|
|
# 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.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that if you run doxygen from a directory containing a file called
|
|
|
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
|
|
|
# tag is left empty.
|
|
|
@@ -669,8 +690,7 @@ LAYOUT_FILE =
|
|
|
# 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. To use this feature you need bibtex and perl available in the
|
|
|
-# search path. Do not use file names with spaces, bibtex cannot handle them. See
|
|
|
-# also \cite for info how to create references.
|
|
|
+# search path. See also \cite for info how to create references.
|
|
|
|
|
|
CITE_BIB_FILES =
|
|
|
|
|
|
@@ -688,7 +708,7 @@ QUIET = NO
|
|
|
# The WARNINGS tag can be used to turn on/off the warning messages that are
|
|
|
# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
|
|
|
# this implies that the warnings are on.
|
|
|
-#
|
|
|
+#
|
|
|
# Tip: Turn warnings on while writing the documentation.
|
|
|
# The default value is: YES.
|
|
|
|
|
|
@@ -776,7 +796,7 @@ RECURSIVE = YES
|
|
|
# The EXCLUDE tag can be used to specify files and/or directories that should be
|
|
|
# excluded from the INPUT source files. This way you can easily exclude a
|
|
|
# subdirectory from a directory tree whose root is specified with the INPUT tag.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that relative paths are relative to the directory from which doxygen is
|
|
|
# run.
|
|
|
|
|
|
@@ -792,7 +812,7 @@ EXCLUDE_SYMLINKS = NO
|
|
|
# If the value of the INPUT tag contains directories, you can use the
|
|
|
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
|
|
|
# certain files from those directories.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that the wildcards are matched against the file with absolute path, so to
|
|
|
# exclude all test directories for example use the pattern */test/*
|
|
|
|
|
|
@@ -803,7 +823,7 @@ EXCLUDE_PATTERNS =
|
|
|
# output. The symbol name can be a fully qualified name, a word, or if the
|
|
|
# wildcard * is used, a substring. Examples: ANamespace, AClass,
|
|
|
# AClass::ANamespace, ANamespace::*Test
|
|
|
-#
|
|
|
+#
|
|
|
# Note that the wildcards are matched against the file with absolute path, so to
|
|
|
# exclude all test directories use the pattern */test/*
|
|
|
|
|
|
@@ -838,14 +858,14 @@ IMAGE_PATH =
|
|
|
# The INPUT_FILTER tag can be used to specify a program that doxygen should
|
|
|
# invoke to filter for each input file. Doxygen will invoke the filter program
|
|
|
# by executing (via popen()) the command:
|
|
|
-#
|
|
|
+#
|
|
|
# <filter> <input-file>
|
|
|
-#
|
|
|
+#
|
|
|
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
|
|
|
# name of an input file. Doxygen will then use the output that the filter
|
|
|
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
|
|
|
# will be ignored.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that the filter must not add or remove lines; it is applied before the
|
|
|
# code is scanned, but not when the output code is generated. If lines are added
|
|
|
# or removed, the anchors will not be placed correctly.
|
|
|
@@ -889,7 +909,7 @@ USE_MDFILE_AS_MAINPAGE =
|
|
|
|
|
|
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
|
|
|
# generated. Documented entities will be cross-referenced with these sources.
|
|
|
-#
|
|
|
+#
|
|
|
# Note: To get rid of all source code in the generated output, make sure that
|
|
|
# also VERBATIM_HEADERS is set to NO.
|
|
|
# The default value is: NO.
|
|
|
@@ -944,16 +964,16 @@ SOURCE_TOOLTIPS = YES
|
|
|
# source browser. The htags tool is part of GNU's global source tagging system
|
|
|
# (see http://www.gnu.org/software/global/global.html). You will need version
|
|
|
# 4.8.6 or higher.
|
|
|
-#
|
|
|
+#
|
|
|
# To use it do the following:
|
|
|
# - Install the latest version of global
|
|
|
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
|
|
|
# - Make sure the INPUT points to the root of the source tree
|
|
|
# - Run doxygen as normal
|
|
|
-#
|
|
|
+#
|
|
|
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
|
|
|
# tools must be available from the command line (i.e. in the search path).
|
|
|
-#
|
|
|
+#
|
|
|
# The result: instead of the source browser generated by doxygen, the links to
|
|
|
# source code will now point to the output of htags.
|
|
|
# The default value is: NO.
|
|
|
@@ -970,7 +990,7 @@ USE_HTAGS = NO
|
|
|
VERBATIM_HEADERS = YES
|
|
|
|
|
|
# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the
|
|
|
-# clang parser (see: http://clang.llvm.org/) for more acurate parsing at the
|
|
|
+# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
|
|
|
# cost of reduced performance. This can be particularly helpful with template
|
|
|
# rich C++ code for which doxygen's built-in parser lacks the necessary type
|
|
|
# information.
|
|
|
@@ -1041,7 +1061,7 @@ HTML_FILE_EXTENSION = .html
|
|
|
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
|
|
|
# each generated HTML page. If the tag is left blank doxygen will generate a
|
|
|
# standard header.
|
|
|
-#
|
|
|
+#
|
|
|
# To get valid HTML the header file that includes any scripts and style sheets
|
|
|
# that doxygen needs, which is dependent on the configuration options used (e.g.
|
|
|
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
|
|
|
@@ -1080,13 +1100,15 @@ HTML_FOOTER =
|
|
|
|
|
|
HTML_STYLESHEET =
|
|
|
|
|
|
-# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
|
|
|
-# defined cascading style sheet that is included after the standard style sheets
|
|
|
+# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
|
|
|
+# cascading style sheets that are included after the standard style sheets
|
|
|
# created by doxygen. Using this option one can overrule certain style aspects.
|
|
|
# This is preferred over using HTML_STYLESHEET since it does not replace the
|
|
|
# standard style sheet and is therefor more robust against future updates.
|
|
|
-# Doxygen will copy the style sheet file to the output directory. For an example
|
|
|
-# see the documentation.
|
|
|
+# Doxygen will copy the style sheet files to the output directory.
|
|
|
+# Note: The order of the extra stylesheet files is of importance (e.g. the last
|
|
|
+# stylesheet in the list overrules the setting of the previous ones in the
|
|
|
+# list). For an example see the documentation.
|
|
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
|
|
|
|
HTML_EXTRA_STYLESHEET =
|
|
|
@@ -1209,7 +1231,7 @@ DOCSET_PUBLISHER_NAME = Publisher
|
|
|
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
|
|
|
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
|
|
|
# Windows.
|
|
|
-#
|
|
|
+#
|
|
|
# The HTML Help Workshop contains a compiler that can convert all HTML output
|
|
|
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
|
|
|
# files are now used as the Windows 98 help format, and will replace the old
|
|
|
@@ -1251,7 +1273,8 @@ GENERATE_CHI = NO
|
|
|
CHM_INDEX_ENCODING =
|
|
|
|
|
|
# The BINARY_TOC flag controls whether a binary table of contents is generated (
|
|
|
-# YES) or a normal table of contents ( NO) in the .chm file.
|
|
|
+# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
|
|
|
+# enables the Previous and Next buttons.
|
|
|
# The default value is: NO.
|
|
|
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
|
|
|
|
|
@@ -1377,7 +1400,7 @@ GENERATE_TREEVIEW = NO
|
|
|
|
|
|
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
|
|
|
# doxygen will group on one line in the generated HTML documentation.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that a value of 0 will completely suppress the enum values from appearing
|
|
|
# in the overview section.
|
|
|
# Minimum value: 0, maximum value: 20, default value: 4.
|
|
|
@@ -1411,7 +1434,7 @@ FORMULA_FONTSIZE = 10
|
|
|
# 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 are supported on all modern browsers.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that when changing this option you need to delete any form_*.png files in
|
|
|
# the HTML output directory before the changes have effect.
|
|
|
# The default value is: YES.
|
|
|
@@ -1491,11 +1514,11 @@ SEARCHENGINE = NO
|
|
|
|
|
|
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
|
|
|
# implemented using a web server instead of a web client using Javascript. There
|
|
|
-# are two flavours of web server based searching depending on the
|
|
|
-# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
|
|
|
-# searching and an index file used by the script. When EXTERNAL_SEARCH is
|
|
|
-# enabled the indexing and searching needs to be provided by external tools. See
|
|
|
-# the section "External Indexing and Searching" for details.
|
|
|
+# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
|
|
|
+# setting. When disabled, doxygen will generate a PHP script for searching and
|
|
|
+# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
|
|
|
+# and searching needs to be provided by external tools. See the section
|
|
|
+# "External Indexing and Searching" for details.
|
|
|
# The default value is: NO.
|
|
|
# This tag requires that the tag SEARCHENGINE is set to YES.
|
|
|
|
|
|
@@ -1506,11 +1529,11 @@ SERVER_BASED_SEARCH = NO
|
|
|
# which needs to be processed by an external indexer. Doxygen will invoke an
|
|
|
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
|
|
|
# search results.
|
|
|
-#
|
|
|
+#
|
|
|
# Doxygen ships with an example indexer ( doxyindexer) and search engine
|
|
|
# (doxysearch.cgi) which are based on the open source search engine library
|
|
|
# Xapian (see: http://xapian.org/).
|
|
|
-#
|
|
|
+#
|
|
|
# See the section "External Indexing and Searching" for details.
|
|
|
# The default value is: NO.
|
|
|
# This tag requires that the tag SEARCHENGINE is set to YES.
|
|
|
@@ -1519,7 +1542,7 @@ EXTERNAL_SEARCH = NO
|
|
|
|
|
|
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
|
|
|
# which will return the search results when EXTERNAL_SEARCH is enabled.
|
|
|
-#
|
|
|
+#
|
|
|
# Doxygen ships with an example indexer ( doxyindexer) and search engine
|
|
|
# (doxysearch.cgi) which are based on the open source search engine library
|
|
|
# Xapian (see: http://xapian.org/). See the section "External Indexing and
|
|
|
@@ -1573,7 +1596,7 @@ LATEX_OUTPUT = latex
|
|
|
|
|
|
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
|
|
|
# invoked.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that when enabling USE_PDFLATEX this option is only used for generating
|
|
|
# bitmaps for formulas in the HTML output, but not in the Makefile that is
|
|
|
# written to the output directory.
|
|
|
@@ -1620,21 +1643,23 @@ EXTRA_PACKAGES =
|
|
|
# chapter. If it is left blank doxygen will generate a standard header. See
|
|
|
# section "Doxygen usage" for information on how to 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 respectively the title of the page, the current date and time,
|
|
|
-# only the current date, the version number of doxygen, the project name (see
|
|
|
-# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
|
|
|
+# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
|
|
|
+# $projectbrief, $projectlogo. Doxygen will replace $title with the empy string,
|
|
|
+# for the replacement values of the other commands the user is refered to
|
|
|
+# HTML_HEADER.
|
|
|
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
|
|
|
|
|
LATEX_HEADER =
|
|
|
|
|
|
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
|
|
|
# generated LaTeX document. The footer should contain everything after the last
|
|
|
-# chapter. If it is left blank doxygen will generate a standard footer.
|
|
|
-#
|
|
|
+# chapter. If it is left blank doxygen will generate a standard footer. See
|
|
|
+# LATEX_HEADER for more information on how to generate a default footer and what
|
|
|
+# special commands can be used inside the footer.
|
|
|
+#
|
|
|
# Note: Only use a user-defined footer if you know what you are doing!
|
|
|
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
|
|
|
|
|
@@ -1657,7 +1682,7 @@ LATEX_EXTRA_FILES =
|
|
|
|
|
|
PDF_HYPERLINKS = NO
|
|
|
|
|
|
-# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
|
|
|
+# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
|
|
|
# the PDF file directly from the LaTeX files. Set this option to YES to get a
|
|
|
# higher quality PDF documentation.
|
|
|
# The default value is: YES.
|
|
|
@@ -1683,7 +1708,7 @@ LATEX_HIDE_INDICES = NO
|
|
|
|
|
|
# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
|
|
|
# code with syntax highlighting in the LaTeX output.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that which sources are shown also depends on other settings such as
|
|
|
# SOURCE_BROWSER.
|
|
|
# The default value is: NO.
|
|
|
@@ -1731,7 +1756,7 @@ COMPACT_RTF = NO
|
|
|
# output) instead of page references. This makes the output suitable for online
|
|
|
# browsing using Word or some other Word compatible readers that support those
|
|
|
# fields.
|
|
|
-#
|
|
|
+#
|
|
|
# Note: WordPad (write) and others do not support links.
|
|
|
# The default value is: NO.
|
|
|
# This tag requires that the tag GENERATE_RTF is set to YES.
|
|
|
@@ -1741,7 +1766,7 @@ RTF_HYPERLINKS = YES
|
|
|
# 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 default value.
|
|
|
-#
|
|
|
+#
|
|
|
# See also section "Doxygen usage" for information on how to generate the
|
|
|
# default style sheet that doxygen normally uses.
|
|
|
# This tag requires that the tag GENERATE_RTF is set to YES.
|
|
|
@@ -1783,6 +1808,13 @@ MAN_OUTPUT = man
|
|
|
|
|
|
MAN_EXTENSION = .3
|
|
|
|
|
|
+# The MAN_SUBDIR tag determines the name of the directory created within
|
|
|
+# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
|
|
|
+# MAN_EXTENSION with the initial . removed.
|
|
|
+# This tag requires that the tag GENERATE_MAN is set to YES.
|
|
|
+
|
|
|
+MAN_SUBDIR =
|
|
|
+
|
|
|
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
|
|
|
# will generate one additional man file for each entity documented in the real
|
|
|
# man page(s). These additional files only source the real man page, but without
|
|
|
@@ -1810,18 +1842,6 @@ GENERATE_XML = NO
|
|
|
|
|
|
XML_OUTPUT = xml
|
|
|
|
|
|
-# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
|
|
|
-# validating XML parser to check the syntax of the XML files.
|
|
|
-# This tag requires that the tag GENERATE_XML is set to YES.
|
|
|
-
|
|
|
-XML_SCHEMA =
|
|
|
-
|
|
|
-# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
|
|
|
-# validating XML parser to check the syntax of the XML files.
|
|
|
-# This tag requires that the tag GENERATE_XML is set to YES.
|
|
|
-
|
|
|
-XML_DTD =
|
|
|
-
|
|
|
# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
|
|
|
# listings (including syntax highlighting and cross-referencing information) to
|
|
|
# the XML output. Note that enabling this will significantly increase the size
|
|
|
@@ -1849,6 +1869,15 @@ GENERATE_DOCBOOK = NO
|
|
|
|
|
|
DOCBOOK_OUTPUT = docbook
|
|
|
|
|
|
+# If the DOCBOOK_PROGRAMLISTING tag is set to YES doxygen will include the
|
|
|
+# program listings (including syntax highlighting and cross-referencing
|
|
|
+# information) to the DOCBOOK output. Note that enabling this will significantly
|
|
|
+# increase the size of the DOCBOOK output.
|
|
|
+# The default value is: NO.
|
|
|
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
|
|
|
+
|
|
|
+DOCBOOK_PROGRAMLISTING = NO
|
|
|
+
|
|
|
#---------------------------------------------------------------------------
|
|
|
# Configuration options for the AutoGen Definitions output
|
|
|
#---------------------------------------------------------------------------
|
|
|
@@ -1867,7 +1896,7 @@ GENERATE_AUTOGEN_DEF = NO
|
|
|
|
|
|
# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
|
|
|
# file that captures the structure of the code including all documentation.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that this feature is still experimental and incomplete at the moment.
|
|
|
# The default value is: NO.
|
|
|
|
|
|
@@ -1968,9 +1997,9 @@ PREDEFINED =
|
|
|
EXPAND_AS_DEFINED =
|
|
|
|
|
|
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
|
|
|
-# remove all refrences to function-like macros that are alone on a line, have an
|
|
|
-# all uppercase name, and do not end with a semicolon. Such function macros are
|
|
|
-# typically used for boiler-plate code, and will confuse the parser if not
|
|
|
+# remove all references to function-like macros that are alone on a line, have
|
|
|
+# an all uppercase name, and do not end with a semicolon. Such function macros
|
|
|
+# are typically used for boiler-plate code, and will confuse the parser if not
|
|
|
# removed.
|
|
|
# The default value is: YES.
|
|
|
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
|
|
@@ -1990,7 +2019,7 @@ SKIP_FUNCTION_MACROS = YES
|
|
|
# where loc1 and loc2 can be relative or absolute paths or URLs. See the
|
|
|
# section "Linking to external documentation" for more information about the use
|
|
|
# of tag files.
|
|
|
-# Note: Each tag file must have an unique name (where the name does NOT include
|
|
|
+# Note: Each tag file must have a unique name (where the name does NOT include
|
|
|
# the path). If a tag file is not located in the directory in which doxygen is
|
|
|
# run, you must also specify the path to the tagfile here.
|
|
|
|
|
|
@@ -2050,6 +2079,13 @@ CLASS_DIAGRAMS = YES
|
|
|
|
|
|
MSCGEN_PATH =
|
|
|
|
|
|
+# You can include diagrams made with dia in doxygen documentation. Doxygen will
|
|
|
+# then run dia to produce the diagram and insert it in the documentation. The
|
|
|
+# DIA_PATH tag allows you to specify the directory where the dia binary resides.
|
|
|
+# If left empty dia is assumed to be found in the default search path.
|
|
|
+
|
|
|
+DIA_PATH =
|
|
|
+
|
|
|
# If set to YES, the inheritance and collaboration graphs will hide inheritance
|
|
|
# and usage relations if the target is undocumented or is not a class.
|
|
|
# The default value is: YES.
|
|
|
@@ -2075,7 +2111,7 @@ HAVE_DOT = NO
|
|
|
|
|
|
DOT_NUM_THREADS = 0
|
|
|
|
|
|
-# When you want a differently looking font n the dot files that doxygen
|
|
|
+# When you want a differently looking font in the dot files that doxygen
|
|
|
# generates 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 the DOTFONTPATH environment variable or by
|
|
|
@@ -2172,7 +2208,7 @@ INCLUDED_BY_GRAPH = YES
|
|
|
|
|
|
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
|
|
|
# dependency graph for every global function or class method.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that enabling this option will significantly increase the time of a run.
|
|
|
# So in most cases it will be better to enable call graphs for selected
|
|
|
# functions only using the \callgraph command.
|
|
|
@@ -2183,7 +2219,7 @@ CALL_GRAPH = YES
|
|
|
|
|
|
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
|
|
|
# dependency graph for every global function or class method.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that enabling this option will significantly increase the time of a run.
|
|
|
# So in most cases it will be better to enable caller graphs for selected
|
|
|
# functions only using the \callergraph command.
|
|
|
@@ -2221,7 +2257,7 @@ DOT_IMAGE_FORMAT = png
|
|
|
|
|
|
# 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.
|
|
|
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
|
|
|
@@ -2250,6 +2286,21 @@ DOTFILE_DIRS =
|
|
|
|
|
|
MSCFILE_DIRS =
|
|
|
|
|
|
+# The DIAFILE_DIRS tag can be used to specify one or more directories that
|
|
|
+# contain dia files that are included in the documentation (see the \diafile
|
|
|
+# command).
|
|
|
+
|
|
|
+DIAFILE_DIRS =
|
|
|
+
|
|
|
+# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
|
|
|
+# path where java can find the plantuml.jar file. If left blank, it is assumed
|
|
|
+# PlantUML is not used or called during a preprocessing step. Doxygen will
|
|
|
+# generate a warning when it encounters a \startuml command in this case and
|
|
|
+# will not generate output for the diagram.
|
|
|
+# This tag requires that the tag HAVE_DOT is set to YES.
|
|
|
+
|
|
|
+PLANTUML_JAR_PATH =
|
|
|
+
|
|
|
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
|
|
|
# that will be shown in the graph. If the number of nodes in a graph becomes
|
|
|
# larger than this value, doxygen will truncate the graph, which is visualized
|
|
|
@@ -2277,7 +2328,7 @@ MAX_DOT_GRAPH_DEPTH = 1000
|
|
|
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
|
|
|
# background. This is disabled by default, because dot on Windows does not seem
|
|
|
# to support this out of the box.
|
|
|
-#
|
|
|
+#
|
|
|
# Warning: Depending on the platform used, enabling this option may lead to
|
|
|
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
|
|
|
# read).
|
Christophe Riccio