|
|
@@ -1,4 +1,4 @@
|
|
|
-# Doxyfile 1.7.1
|
|
|
+# Doxyfile 1.7.6.1
|
|
|
|
|
|
# This file describes the settings to be used by the documentation system
|
|
|
# doxygen (www.doxygen.org) for a project
|
|
|
@@ -22,8 +22,9 @@
|
|
|
|
|
|
DOXYFILE_ENCODING = UTF-8
|
|
|
|
|
|
-# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
|
|
|
-# by quotes) that should identify the project.
|
|
|
+# 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.
|
|
|
|
|
|
PROJECT_NAME = Urho3D
|
|
|
|
|
|
@@ -33,6 +34,19 @@ PROJECT_NAME = Urho3D
|
|
|
|
|
|
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 quick idea about the purpose of the project. Keep the description short.
|
|
|
+
|
|
|
+PROJECT_BRIEF =
|
|
|
+
|
|
|
+# With the PROJECT_LOGO tag one can specify an logo or icon that is
|
|
|
+# included in the documentation. The maximum height of the logo should not
|
|
|
+# exceed 55 pixels and the maximum width should not exceed 200 pixels.
|
|
|
+# Doxygen will copy the logo to the output directory.
|
|
|
+
|
|
|
+PROJECT_LOGO =
|
|
|
+
|
|
|
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
|
|
|
# base path where the generated documentation will be put.
|
|
|
# If a relative path is entered, it will be relative to the location
|
|
|
@@ -57,7 +71,7 @@ CREATE_SUBDIRS = NO
|
|
|
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
|
|
|
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
|
|
|
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
|
|
|
-# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
|
|
|
+# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
|
|
|
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
|
|
|
|
|
|
OUTPUT_LANGUAGE = English
|
|
|
@@ -136,7 +150,7 @@ STRIP_FROM_PATH = C:/Windows/System32/
|
|
|
STRIP_FROM_INC_PATH =
|
|
|
|
|
|
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
|
|
|
-# (but less readable) file names. This can be useful is your file systems
|
|
|
+# (but less readable) file names. This can be useful if your file system
|
|
|
# doesn't support long names like on DOS, Mac, or CD-ROM.
|
|
|
|
|
|
SHORT_NAMES = YES
|
|
|
@@ -191,6 +205,13 @@ TAB_SIZE = 8
|
|
|
|
|
|
ALIASES =
|
|
|
|
|
|
+# This tag can be used to specify a number of word-keyword mappings (TCL only).
|
|
|
+# A mapping has the form "name=value". For example adding
|
|
|
+# "class=itcl::class" will allow you to use the command class in the
|
|
|
+# itcl::class meaning.
|
|
|
+
|
|
|
+TCL_SUBST =
|
|
|
+
|
|
|
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
|
|
|
# sources only. Doxygen will then generate output that is more tailored for C.
|
|
|
# For instance, some of the names that are used will be different. The list
|
|
|
@@ -233,7 +254,7 @@ EXTENSION_MAPPING =
|
|
|
# to include (a tag file for) the STL sources as input, then you should
|
|
|
# set this tag to YES in order to let doxygen match functions declarations and
|
|
|
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
|
|
|
-# func(std::string) {}). This also make the inheritance and collaboration
|
|
|
+# func(std::string) {}). This also makes the inheritance and collaboration
|
|
|
# diagrams that involve STL classes more complete and accurate.
|
|
|
|
|
|
BUILTIN_STL_SUPPORT = NO
|
|
|
@@ -251,7 +272,7 @@ SIP_SUPPORT = NO
|
|
|
|
|
|
# For Microsoft's IDL there are propget and propput attributes to indicate getter
|
|
|
# and setter methods for a property. Setting this option to YES (the default)
|
|
|
-# will make doxygen to replace the get and set methods by a property in the
|
|
|
+# will make doxygen replace the get and set methods by a property in the
|
|
|
# documentation. This will only work if the methods are indeed getting or
|
|
|
# setting a simple type. If this is not the case, or you want to show the
|
|
|
# methods anyway, you should set this option to NO.
|
|
|
@@ -273,6 +294,22 @@ DISTRIBUTE_GROUP_DOC = NO
|
|
|
|
|
|
SUBGROUPING = YES
|
|
|
|
|
|
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
|
|
|
+# 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).
|
|
|
+
|
|
|
+INLINE_GROUPED_CLASSES = NO
|
|
|
+
|
|
|
+# 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).
|
|
|
+
|
|
|
+INLINE_SIMPLE_STRUCTS = NO
|
|
|
+
|
|
|
# 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
|
|
|
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
|
|
|
@@ -289,16 +326,27 @@ TYPEDEF_HIDES_STRUCT = NO
|
|
|
# For small to medium size projects (<1000 input files) the default value is
|
|
|
# probably good enough. For larger projects a too small cache size can cause
|
|
|
# doxygen to be busy swapping symbols to and from disk most of the time
|
|
|
-# causing a significant performance penality.
|
|
|
+# causing a significant performance penalty.
|
|
|
# If the system has enough physical memory increasing the cache will improve the
|
|
|
# performance by keeping more symbols in memory. Note that the value works on
|
|
|
-# a logarithmic scale so increasing the size by one will rougly double the
|
|
|
+# a logarithmic scale so increasing the size by one will roughly double the
|
|
|
# memory usage. The cache size is given by this formula:
|
|
|
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
|
|
|
-# corresponding to a cache size of 2^16 = 65536 symbols
|
|
|
+# corresponding to a cache size of 2^16 = 65536 symbols.
|
|
|
|
|
|
SYMBOL_CACHE_SIZE = 0
|
|
|
|
|
|
+# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
|
|
|
+# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
|
|
|
+# their name and scope. Since this can be an expensive process and often the
|
|
|
+# same symbol appear multiple times in the code, doxygen keeps a cache of
|
|
|
+# pre-resolved symbols. If the cache is too small doxygen will become slower.
|
|
|
+# If the cache is too large, memory is wasted. The cache size is given by this
|
|
|
+# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
|
|
|
+# corresponding to a cache size of 2^16 = 65536 symbols.
|
|
|
+
|
|
|
+LOOKUP_CACHE_SIZE = 0
|
|
|
+
|
|
|
#---------------------------------------------------------------------------
|
|
|
# Build related configuration options
|
|
|
#---------------------------------------------------------------------------
|
|
|
@@ -337,7 +385,7 @@ EXTRACT_LOCAL_METHODS = NO
|
|
|
# extracted and appear in the documentation as a namespace called
|
|
|
# 'anonymous_namespace{file}', where file will be replaced with the base
|
|
|
# name of the file that contains the anonymous namespace. By default
|
|
|
-# anonymous namespace are hidden.
|
|
|
+# anonymous namespaces are hidden.
|
|
|
|
|
|
EXTRACT_ANON_NSPACES = NO
|
|
|
|
|
|
@@ -448,6 +496,15 @@ SORT_GROUP_NAMES = NO
|
|
|
|
|
|
SORT_BY_SCOPE_NAME = NO
|
|
|
|
|
|
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
|
|
|
+# do proper type resolution of all parameters of a function it will reject a
|
|
|
+# match between the prototype and the implementation of a member function even
|
|
|
+# if there is only one candidate or it is obvious which candidate to choose
|
|
|
+# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
|
|
|
+# will still accept a match between prototype and implementation in such cases.
|
|
|
+
|
|
|
+STRICT_PROTO_MATCHING = NO
|
|
|
+
|
|
|
# The GENERATE_TODOLIST tag can be used to enable (YES) or
|
|
|
# disable (NO) the todo list. This list is created by putting \todo
|
|
|
# commands in the documentation.
|
|
|
@@ -478,10 +535,10 @@ GENERATE_DEPRECATEDLIST= YES
|
|
|
ENABLED_SECTIONS =
|
|
|
|
|
|
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
|
|
|
-# the initial value of a variable or define consists of for it to appear in
|
|
|
+# the initial value of a variable or macro consists of for it to appear in
|
|
|
# the documentation. If the initializer consists of more lines than specified
|
|
|
# here it will be hidden. Use a value of 0 to hide initializers completely.
|
|
|
-# The appearance of the initializer of individual variables and defines in the
|
|
|
+# The appearance of the initializer of individual variables and macros in the
|
|
|
# documentation can be controlled using \showinitializer or \hideinitializer
|
|
|
# command in the documentation regardless of this setting.
|
|
|
|
|
|
@@ -509,7 +566,7 @@ SHOW_FILES = YES
|
|
|
# Namespaces page. This will remove the Namespaces entry from the Quick Index
|
|
|
# and from the Folder Tree View (if specified). The default is YES.
|
|
|
|
|
|
-SHOW_NAMESPACES = YES
|
|
|
+SHOW_NAMESPACES = NO
|
|
|
|
|
|
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
|
|
|
# doxygen should invoke to get the current version for each file (typically from
|
|
|
@@ -530,6 +587,16 @@ FILE_VERSION_FILTER =
|
|
|
|
|
|
LAYOUT_FILE =
|
|
|
|
|
|
+# 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. To use this
|
|
|
+# feature you need bibtex and perl available in the search path.
|
|
|
+
|
|
|
+CITE_BIB_FILES =
|
|
|
+
|
|
|
#---------------------------------------------------------------------------
|
|
|
# configuration options related to warning and progress messages
|
|
|
#---------------------------------------------------------------------------
|
|
|
@@ -558,7 +625,7 @@ WARN_IF_UNDOCUMENTED = NO
|
|
|
|
|
|
WARN_IF_DOC_ERROR = NO
|
|
|
|
|
|
-# This WARN_NO_PARAMDOC option can be abled to get warnings for
|
|
|
+# The WARN_NO_PARAMDOC option can be enabled to get warnings for
|
|
|
# functions that are documented, but have no documentation for their parameters
|
|
|
# or return value. If set to NO (the default) doxygen will only warn about
|
|
|
# wrong or incomplete parameter documentation, but not about the absence of
|
|
|
@@ -605,8 +672,9 @@ INPUT_ENCODING = UTF-8
|
|
|
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
|
|
# and *.h) to filter out the source-files in the directories. If left
|
|
|
# blank the following patterns are tested:
|
|
|
-# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
|
|
|
-# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
|
|
|
+# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
|
|
|
+# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
|
|
|
+# *.f90 *.f *.for *.vhd *.vhdl
|
|
|
|
|
|
FILE_PATTERNS = *.cpp \
|
|
|
*.h \
|
|
|
@@ -618,14 +686,16 @@ FILE_PATTERNS = *.cpp \
|
|
|
|
|
|
RECURSIVE = YES
|
|
|
|
|
|
-# The EXCLUDE tag can be used to specify files and/or directories that should
|
|
|
+# 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.
|
|
|
+# 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.
|
|
|
|
|
|
EXCLUDE = html
|
|
|
|
|
|
-# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
|
|
|
-# directories that are symbolic links (a Unix filesystem feature) are excluded
|
|
|
+# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
|
|
|
+# directories that are symbolic links (a Unix file system feature) are excluded
|
|
|
# from the input.
|
|
|
|
|
|
EXCLUDE_SYMLINKS = NO
|
|
|
@@ -687,8 +757,8 @@ INPUT_FILTER =
|
|
|
# basis. Doxygen will compare the file name with each pattern and apply the
|
|
|
# filter if there is a match. The filters are a list of the form:
|
|
|
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
|
|
|
-# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
|
|
|
-# is applied to all files.
|
|
|
+# info on how filters are used. If FILTER_PATTERNS is empty or if
|
|
|
+# non of the patterns match the file name, INPUT_FILTER is applied.
|
|
|
|
|
|
FILTER_PATTERNS =
|
|
|
|
|
|
@@ -698,6 +768,14 @@ FILTER_PATTERNS =
|
|
|
|
|
|
FILTER_SOURCE_FILES = NO
|
|
|
|
|
|
+# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
|
|
|
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
|
|
|
+# and it is also possible to disable source filtering for a specific pattern
|
|
|
+# using *.ext= (so without naming a filter). This option only has effect when
|
|
|
+# FILTER_SOURCE_FILES is enabled.
|
|
|
+
|
|
|
+FILTER_SOURCE_PATTERNS =
|
|
|
+
|
|
|
#---------------------------------------------------------------------------
|
|
|
# configuration options related to source browsing
|
|
|
#---------------------------------------------------------------------------
|
|
|
@@ -799,7 +877,14 @@ HTML_FILE_EXTENSION = .html
|
|
|
|
|
|
# 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.
|
|
|
+# 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 advised 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
|
|
|
+# changing the value of configuration settings such as GENERATE_TREEVIEW!
|
|
|
|
|
|
HTML_HEADER =
|
|
|
|
|
|
@@ -814,12 +899,21 @@ HTML_FOOTER =
|
|
|
# fine-tune the look of the HTML output. If the tag is left blank doxygen
|
|
|
# will generate a default style sheet. Note that doxygen will try to copy
|
|
|
# the style sheet file to the HTML output directory, so don't put your own
|
|
|
-# stylesheet in the HTML output directory as well, or it will be erased!
|
|
|
+# style sheet in the HTML output directory as well, or it will be erased!
|
|
|
|
|
|
HTML_STYLESHEET =
|
|
|
|
|
|
+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
|
|
|
+# other source files which should be copied to the HTML output directory. Note
|
|
|
+# that these files will be copied to the base HTML output directory. Use the
|
|
|
+# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
|
|
|
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that
|
|
|
+# the files will be copied as-is; there are no commands or markers available.
|
|
|
+
|
|
|
+HTML_EXTRA_FILES =
|
|
|
+
|
|
|
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
|
|
|
-# Doxygen will adjust the colors in the stylesheet and background images
|
|
|
+# 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.
|
|
|
# For instance the value 0 represents red, 60 is yellow, 120 is green,
|
|
|
@@ -1014,27 +1108,33 @@ GENERATE_ECLIPSEHELP = NO
|
|
|
|
|
|
ECLIPSE_DOC_ID = org.doxygen.Project
|
|
|
|
|
|
-# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
|
|
|
-# top of each HTML page. The value NO (the default) enables the index and
|
|
|
-# the value YES disables it.
|
|
|
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
|
|
|
+# at top of each HTML page. The value NO (the default) enables the index and
|
|
|
+# the value YES disables it. Since the tabs have the same information as the
|
|
|
+# navigation tree you can set this option to NO if you already set
|
|
|
+# GENERATE_TREEVIEW to YES.
|
|
|
|
|
|
DISABLE_INDEX = NO
|
|
|
|
|
|
-# This tag can be used to set the number of enum values (range [1..20])
|
|
|
-# that doxygen will group on one line in the generated HTML documentation.
|
|
|
-
|
|
|
-ENUM_VALUES_PER_LINE = 4
|
|
|
-
|
|
|
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
|
|
|
# structure should be generated to display hierarchical information.
|
|
|
# If the tag value is set to YES, a side panel will be generated
|
|
|
# containing a tree-like index structure (just like the one that
|
|
|
# is generated for HTML Help). For this to 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.
|
|
|
+# Windows users are probably better off using the HTML help feature.
|
|
|
+# Since the tree basically has the same information as the tab index you
|
|
|
+# could consider to set DISABLE_INDEX to NO when enabling this option.
|
|
|
|
|
|
GENERATE_TREEVIEW = NO
|
|
|
|
|
|
+# The ENUM_VALUES_PER_LINE 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 completely suppress the enum
|
|
|
+# values from appearing in the overview section.
|
|
|
+
|
|
|
+ENUM_VALUES_PER_LINE = 4
|
|
|
+
|
|
|
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
|
|
|
# and Class Hierarchy pages using a tree view instead of an ordered list.
|
|
|
|
|
|
@@ -1067,6 +1167,31 @@ FORMULA_FONTSIZE = 10
|
|
|
|
|
|
FORMULA_TRANSPARENT = YES
|
|
|
|
|
|
+# 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 prerendered bitmaps. Use this if you do not
|
|
|
+# have LaTeX installed or if you want to formulas look prettier in the HTML
|
|
|
+# output. When enabled you also need to install MathJax separately and
|
|
|
+# configure the path to it using the MATHJAX_RELPATH option.
|
|
|
+
|
|
|
+USE_MATHJAX = NO
|
|
|
+
|
|
|
+# When MathJax is enabled you need to specify the location relative to the
|
|
|
+# HTML output directory using the MATHJAX_RELPATH option. The destination
|
|
|
+# directory should contain the MathJax.js script. For instance, if the mathjax
|
|
|
+# directory is located at the same level as the HTML output directory, then
|
|
|
+# MATHJAX_RELPATH should be ../mathjax. The default value points to the
|
|
|
+# 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.
|
|
|
+
|
|
|
+MATHJAX_RELPATH = http://www.mathjax.org/mathjax
|
|
|
+
|
|
|
+# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
|
|
|
+# names that should be enabled during MathJax rendering.
|
|
|
+
|
|
|
+MATHJAX_EXTENSIONS =
|
|
|
+
|
|
|
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
|
|
|
# for the HTML output. The underlying search engine uses javascript
|
|
|
# and DHTML and should work on any modern browser. Note that when using
|
|
|
@@ -1082,7 +1207,7 @@ SEARCHENGINE = NO
|
|
|
# using Javascript. Doxygen will generate the search PHP script and index
|
|
|
# file to put on the web server. The advantage of the server
|
|
|
# based approach is that it scales better to large projects and allows
|
|
|
-# full text search. The disadvances is that it is more difficult to setup
|
|
|
+# full text search. The disadvantages are that it is more difficult to setup
|
|
|
# and does not have live searching capabilities.
|
|
|
|
|
|
SERVER_BASED_SEARCH = NO
|
|
|
@@ -1123,7 +1248,7 @@ MAKEINDEX_CMD_NAME = makeindex
|
|
|
COMPACT_LATEX = NO
|
|
|
|
|
|
# The PAPER_TYPE tag can be used to set the paper type that is used
|
|
|
-# by the printer. Possible values are: a4, a4wide, letter, legal and
|
|
|
+# by the printer. Possible values are: a4, letter, legal and
|
|
|
# executive. If left blank a4wide will be used.
|
|
|
|
|
|
PAPER_TYPE = a4wide
|
|
|
@@ -1140,6 +1265,13 @@ EXTRA_PACKAGES =
|
|
|
|
|
|
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. Notice: only use this tag if you know what you are doing!
|
|
|
+
|
|
|
+LATEX_FOOTER =
|
|
|
+
|
|
|
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
|
|
|
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
|
|
|
# contain links (just like the HTML output) instead of page references
|
|
|
@@ -1173,6 +1305,12 @@ LATEX_HIDE_INDICES = NO
|
|
|
|
|
|
LATEX_SOURCE_CODE = NO
|
|
|
|
|
|
+# 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.
|
|
|
+
|
|
|
+LATEX_BIB_STYLE = plain
|
|
|
+
|
|
|
#---------------------------------------------------------------------------
|
|
|
# configuration options related to the RTF output
|
|
|
#---------------------------------------------------------------------------
|
|
|
@@ -1204,7 +1342,7 @@ COMPACT_RTF = NO
|
|
|
|
|
|
RTF_HYPERLINKS = NO
|
|
|
|
|
|
-# Load stylesheet definitions from file. Syntax is similar to doxygen's
|
|
|
+# Load style sheet 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.
|
|
|
|
|
|
@@ -1347,7 +1485,7 @@ MACRO_EXPANSION = NO
|
|
|
EXPAND_ONLY_PREDEF = NO
|
|
|
|
|
|
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
|
|
|
-# in the INCLUDE_PATH (see below) will be search if a #include is found.
|
|
|
+# pointed to by INCLUDE_PATH will be searched when a #include is found.
|
|
|
|
|
|
SEARCH_INCLUDES = YES
|
|
|
|
|
|
@@ -1377,15 +1515,15 @@ PREDEFINED = DOXYGEN_IGNORE
|
|
|
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
|
|
|
# this tag can be used to specify a list of macro names that should be expanded.
|
|
|
# The macro definition that is found in the sources will be used.
|
|
|
-# Use the PREDEFINED tag if you want to use a different macro definition.
|
|
|
+# Use the PREDEFINED tag if you want to use a different macro definition that
|
|
|
+# overrules the definition found in the source code.
|
|
|
|
|
|
EXPAND_AS_DEFINED =
|
|
|
|
|
|
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
|
|
|
-# doxygen's preprocessor will remove all 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.
|
|
|
+# doxygen's preprocessor will 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, because these will confuse the parser if not removed.
|
|
|
|
|
|
SKIP_FUNCTION_MACROS = YES
|
|
|
|
|
|
@@ -1439,9 +1577,8 @@ PERL_PATH = /usr/bin/perl
|
|
|
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
|
|
|
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
|
|
|
# or super classes. Setting the tag to NO turns the diagrams off. Note that
|
|
|
-# this option is superseded by the HAVE_DOT option below. This is only a
|
|
|
-# fallback. It is recommended to install and use dot, since it yields more
|
|
|
-# powerful graphs.
|
|
|
+# this option also works with HAVE_DOT disabled, but it is recommended to
|
|
|
+# install and use dot, since it yields more powerful graphs.
|
|
|
|
|
|
CLASS_DIAGRAMS = YES
|
|
|
|
|
|
@@ -1465,7 +1602,7 @@ HIDE_UNDOC_RELATIONS = YES
|
|
|
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
|
|
|
# have no effect if this option is set to NO (the default)
|
|
|
|
|
|
-HAVE_DOT = YES
|
|
|
+HAVE_DOT = NO
|
|
|
|
|
|
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
|
|
|
# allowed to run in parallel. When set to 0 (the default) doxygen will
|
|
|
@@ -1475,14 +1612,12 @@ HAVE_DOT = YES
|
|
|
|
|
|
DOT_NUM_THREADS = 0
|
|
|
|
|
|
-# By default doxygen will write a font called FreeSans.ttf to the output
|
|
|
-# directory and reference it in all dot files that doxygen generates. This
|
|
|
-# font does not include all possible unicode characters however, so when you need
|
|
|
-# these (or just want a differently looking font) you can specify the font name
|
|
|
-# using DOT_FONTNAME. You need 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 setting DOT_FONTPATH to the directory
|
|
|
-# containing the font.
|
|
|
+# 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
|
|
|
+# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
|
|
|
+# directory containing the font.
|
|
|
|
|
|
DOT_FONTNAME = FreeSans
|
|
|
|
|
|
@@ -1491,17 +1626,16 @@ DOT_FONTNAME = FreeSans
|
|
|
|
|
|
DOT_FONTSIZE = 10
|
|
|
|
|
|
-# By default doxygen will tell dot to use the output directory to look for the
|
|
|
-# FreeSans.ttf font (which doxygen will put there itself). If you specify a
|
|
|
-# different font using DOT_FONTNAME you can set the path where dot
|
|
|
-# can find it using this tag.
|
|
|
+# 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
|
|
|
+# set the path where dot can find it.
|
|
|
|
|
|
DOT_FONTPATH =
|
|
|
|
|
|
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
|
|
# will generate a graph for each documented class showing the direct and
|
|
|
# indirect inheritance relations. Setting this tag to YES will force the
|
|
|
-# the CLASS_DIAGRAMS tag to NO.
|
|
|
+# CLASS_DIAGRAMS tag to NO.
|
|
|
|
|
|
CLASS_GRAPH = YES
|
|
|
|
|
|
@@ -1559,7 +1693,7 @@ CALL_GRAPH = NO
|
|
|
CALLER_GRAPH = NO
|
|
|
|
|
|
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
|
|
|
-# will graphical hierarchy of all classes instead of a textual one.
|
|
|
+# will generate a graphical hierarchy of all classes instead of a textual one.
|
|
|
|
|
|
GRAPHICAL_HIERARCHY = YES
|
|
|
|
|
|
@@ -1571,11 +1705,22 @@ GRAPHICAL_HIERARCHY = YES
|
|
|
DIRECTORY_GRAPH = YES
|
|
|
|
|
|
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
|
|
|
-# generated by dot. Possible values are png, jpg, or gif
|
|
|
-# If left blank png will be used.
|
|
|
+# 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
|
|
|
+# visible in IE 9+ (other browsers do not have this requirement).
|
|
|
|
|
|
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. 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.
|
|
|
+
|
|
|
+INTERACTIVE_SVG = NO
|
|
|
+
|
|
|
# The tag DOT_PATH can be used to specify the path where the dot tool can be
|
|
|
# found. If left blank, it is assumed the dot tool can be found in the path.
|
|
|
|
|
|
@@ -1587,6 +1732,12 @@ DOT_PATH =
|
|
|
|
|
|
DOTFILE_DIRS =
|
|
|
|
|
|
+# The MSCFILE_DIRS tag can be used to specify one or more directories that
|
|
|
+# contain msc files that are included in the documentation (see the
|
|
|
+# \mscfile command).
|
|
|
+
|
|
|
+MSCFILE_DIRS =
|
|
|
+
|
|
|
# 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
|