Commit e2d288165f09a6bbecff9a37de2d3fb081f3b1d7

Authored by David Graeff
1 parent 39632733

Update doxygen file

openhantek/Doxyfile
1   -# Doxyfile 1.6.1
  1 +# Doxyfile 1.8.9.1
2 2  
3 3 # This file describes the settings to be used by the documentation system
4   -# doxygen (www.doxygen.org) for a project
  4 +# doxygen (www.doxygen.org) for a project.
5 5 #
6   -# All text after a hash (#) is considered a comment and will be ignored
  6 +# All text after a double hash (##) is considered a comment and is placed in
  7 +# front of the TAG it is preceding.
  8 +#
  9 +# All text after a single hash (#) is considered a comment and will be ignored.
7 10 # The format is:
8   -# TAG = value [value, ...]
9   -# For lists items can also be appended using:
10   -# TAG += value [value, ...]
11   -# Values that contain spaces should be placed between quotes (" ")
  11 +# TAG = value [value, ...]
  12 +# For lists, items can also be appended using:
  13 +# TAG += value [value, ...]
  14 +# Values that contain spaces should be placed between quotes (\" \").
12 15  
13 16 #---------------------------------------------------------------------------
14 17 # Project related configuration options
15 18 #---------------------------------------------------------------------------
16 19  
17 20 # This tag specifies the encoding used for all characters in the config file
18   -# that follow. The default is UTF-8 which is also the encoding used for all
19   -# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20   -# iconv built into libc) for the transcoding. See
21   -# http://www.gnu.org/software/libiconv for the list of possible encodings.
  21 +# that follow. The default is UTF-8 which is also the encoding used for all text
  22 +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
  23 +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
  24 +# for the list of possible encodings.
  25 +# The default value is: UTF-8.
22 26  
23 27 DOXYFILE_ENCODING = UTF-8
24 28  
25   -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26   -# by quotes) that should identify the project.
  29 +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
  30 +# double-quotes, unless you are using Doxywizard) that should identify the
  31 +# project for which the documentation is generated. This name is used in the
  32 +# title of most generated pages and in a few other places.
  33 +# The default value is: My Project.
27 34  
28 35 PROJECT_NAME = OpenHantek
29 36  
30   -# The PROJECT_NUMBER tag can be used to enter a project or revision number.
31   -# This could be handy for archiving the generated documentation or
32   -# if some version control system is used.
  37 +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
  38 +# could be handy for archiving the generated documentation or if some version
  39 +# control system is used.
33 40  
34 41 PROJECT_NUMBER =
35 42  
36   -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37   -# base path where the generated documentation will be put.
38   -# If a relative path is entered, it will be relative to the location
39   -# where doxygen was started. If left blank the current directory will be used.
  43 +# Using the PROJECT_BRIEF tag one can provide an optional one line description
  44 +# for a project that appears at the top of each page and should give viewer a
  45 +# quick idea about the purpose of the project. Keep the description short.
  46 +
  47 +PROJECT_BRIEF =
  48 +
  49 +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
  50 +# in the documentation. The maximum height of the logo should not exceed 55
  51 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
  52 +# the logo to the output directory.
  53 +
  54 +PROJECT_LOGO =
  55 +
  56 +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
  57 +# into which the generated documentation will be written. If a relative path is
  58 +# entered, it will be relative to the location where doxygen was started. If
  59 +# left blank the current directory will be used.
40 60  
41 61 OUTPUT_DIRECTORY = ./doc/
42 62  
43   -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44   -# 4096 sub-directories (in 2 levels) under the output directory of each output
45   -# format and will distribute the generated files over these directories.
46   -# Enabling this option can be useful when feeding doxygen a huge amount of
47   -# source files, where putting all generated files in the same directory would
48   -# otherwise cause performance problems for the file system.
  63 +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
  64 +# directories (in 2 levels) under the output directory of each output format and
  65 +# will distribute the generated files over these directories. Enabling this
  66 +# option can be useful when feeding doxygen a huge amount of source files, where
  67 +# putting all generated files in the same directory would otherwise causes
  68 +# performance problems for the file system.
  69 +# The default value is: NO.
49 70  
50 71 CREATE_SUBDIRS = NO
51 72  
  73 +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
  74 +# characters to appear in the names of generated files. If set to NO, non-ASCII
  75 +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
  76 +# U+3044.
  77 +# The default value is: NO.
  78 +
  79 +ALLOW_UNICODE_NAMES = NO
  80 +
52 81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
53 82 # documentation generated by doxygen is written. Doxygen will use this
54 83 # information to generate all constant output in the proper language.
55   -# The default language is English, other supported languages are:
56   -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57   -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
58   -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59   -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60   -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61   -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
  84 +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
  85 +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
  86 +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
  87 +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
  88 +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
  89 +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
  90 +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
  91 +# Ukrainian and Vietnamese.
  92 +# The default value is: English.
62 93  
63 94 OUTPUT_LANGUAGE = English
64 95  
65   -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66   -# include brief member descriptions after the members that are listed in
67   -# the file and class documentation (similar to JavaDoc).
68   -# Set to NO to disable this.
  96 +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
  97 +# descriptions after the members that are listed in the file and class
  98 +# documentation (similar to Javadoc). Set to NO to disable this.
  99 +# The default value is: YES.
69 100  
70 101 BRIEF_MEMBER_DESC = YES
71 102  
72   -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73   -# the brief description of a member or function before the detailed description.
74   -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  103 +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
  104 +# description of a member or function before the detailed description
  105 +#
  106 +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75 107 # brief descriptions will be completely suppressed.
  108 +# The default value is: YES.
76 109  
77 110 REPEAT_BRIEF = YES
78 111  
79   -# This tag implements a quasi-intelligent brief description abbreviator
80   -# that is used to form the text in various listings. Each string
81   -# in this list, if found as the leading text of the brief description, will be
82   -# stripped from the text and the result after processing the whole list, is
83   -# used as the annotated text. Otherwise, the brief description is used as-is.
84   -# If left blank, the following values are used ("$name" is automatically
85   -# replaced with the name of the entity): "The $name class" "The $name widget"
86   -# "The $name file" "is" "provides" "specifies" "contains"
87   -# "represents" "a" "an" "the"
  112 +# This tag implements a quasi-intelligent brief description abbreviator that is
  113 +# used to form the text in various listings. Each string in this list, if found
  114 +# as the leading text of the brief description, will be stripped from the text
  115 +# and the result, after processing the whole list, is used as the annotated
  116 +# text. Otherwise, the brief description is used as-is. If left blank, the
  117 +# following values are used ($name is automatically replaced with the name of
  118 +# the entity):The $name class, The $name widget, The $name file, is, provides,
  119 +# specifies, contains, represents, a, an and the.
88 120  
89 121 ABBREVIATE_BRIEF =
90 122  
91 123 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92   -# Doxygen will generate a detailed section even if there is only a brief
  124 +# doxygen will generate a detailed section even if there is only a brief
93 125 # description.
  126 +# The default value is: NO.
94 127  
95 128 ALWAYS_DETAILED_SEC = NO
96 129  
... ... @@ -98,518 +131,684 @@ ALWAYS_DETAILED_SEC = NO
98 131 # inherited members of a class in the documentation of that class as if those
99 132 # members were ordinary class members. Constructors, destructors and assignment
100 133 # operators of the base classes will not be shown.
  134 +# The default value is: NO.
101 135  
102 136 INLINE_INHERITED_MEMB = NO
103 137  
104   -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105   -# path before files name in the file list and in the header files. If set
106   -# to NO the shortest path that makes the file name unique will be used.
  138 +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
  139 +# before files name in the file list and in the header files. If set to NO the
  140 +# shortest path that makes the file name unique will be used
  141 +# The default value is: YES.
107 142  
108 143 FULL_PATH_NAMES = YES
109 144  
110   -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
111   -# can be used to strip a user-defined part of the path. Stripping is
112   -# only done if one of the specified strings matches the left-hand part of
113   -# the path. The tag can be used to show relative paths in the file list.
114   -# If left blank the directory from which doxygen is run is used as the
115   -# path to strip.
  145 +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
  146 +# Stripping is only done if one of the specified strings matches the left-hand
  147 +# part of the path. The tag can be used to show relative paths in the file list.
  148 +# If left blank the directory from which doxygen is run is used as the path to
  149 +# strip.
  150 +#
  151 +# Note that you can specify absolute paths here, but also relative paths, which
  152 +# will be relative from the directory where doxygen is started.
  153 +# This tag requires that the tag FULL_PATH_NAMES is set to YES.
116 154  
117 155 STRIP_FROM_PATH = src/
118 156  
119   -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
120   -# the path mentioned in the documentation of a class, which tells
121   -# the reader which header file to include in order to use a class.
122   -# If left blank only the name of the header file containing the class
123   -# definition is used. Otherwise one should specify the include paths that
124   -# are normally passed to the compiler using the -I flag.
  157 +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
  158 +# path mentioned in the documentation of a class, which tells the reader which
  159 +# header file to include in order to use a class. If left blank only the name of
  160 +# the header file containing the class definition is used. Otherwise one should
  161 +# specify the list of include paths that are normally passed to the compiler
  162 +# using the -I flag.
125 163  
126 164 STRIP_FROM_INC_PATH =
127 165  
128   -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
129   -# (but less readable) file names. This can be useful is your file systems
130   -# doesn't support long names like on DOS, Mac, or CD-ROM.
  166 +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
  167 +# less readable) file names. This can be useful is your file systems doesn't
  168 +# support long names like on DOS, Mac, or CD-ROM.
  169 +# The default value is: NO.
131 170  
132 171 SHORT_NAMES = NO
133 172  
134   -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
135   -# will interpret the first line (until the first dot) of a JavaDoc-style
136   -# comment as the brief description. If set to NO, the JavaDoc
137   -# comments will behave just like regular Qt-style comments
138   -# (thus requiring an explicit @brief command for a brief description.)
  173 +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
  174 +# first line (until the first dot) of a Javadoc-style comment as the brief
  175 +# description. If set to NO, the Javadoc-style will behave just like regular Qt-
  176 +# style comments (thus requiring an explicit @brief command for a brief
  177 +# description.)
  178 +# The default value is: NO.
139 179  
140 180 JAVADOC_AUTOBRIEF = NO
141 181  
142   -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143   -# interpret the first line (until the first dot) of a Qt-style
144   -# comment as the brief description. If set to NO, the comments
145   -# will behave just like regular Qt-style comments (thus requiring
146   -# an explicit \brief command for a brief description.)
  182 +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
  183 +# line (until the first dot) of a Qt-style comment as the brief description. If
  184 +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
  185 +# requiring an explicit \brief command for a brief description.)
  186 +# The default value is: NO.
147 187  
148 188 QT_AUTOBRIEF = NO
149 189  
150   -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
151   -# treat a multi-line C++ special comment block (i.e. a block of //! or ///
152   -# comments) as a brief description. This used to be the default behaviour.
153   -# The new default is to treat a multi-line C++ comment block as a detailed
154   -# description. Set this tag to YES if you prefer the old behaviour instead.
  190 +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
  191 +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
  192 +# a brief description. This used to be the default behavior. The new default is
  193 +# to treat a multi-line C++ comment block as a detailed description. Set this
  194 +# tag to YES if you prefer the old behavior instead.
  195 +#
  196 +# Note that setting this tag to YES also means that rational rose comments are
  197 +# not recognized any more.
  198 +# The default value is: NO.
155 199  
156 200 MULTILINE_CPP_IS_BRIEF = NO
157 201  
158   -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
159   -# member inherits the documentation from any documented member that it
160   -# re-implements.
  202 +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
  203 +# documentation from any documented member that it re-implements.
  204 +# The default value is: YES.
161 205  
162 206 INHERIT_DOCS = YES
163 207  
164   -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
165   -# a new page for each member. If set to NO, the documentation of a member will
166   -# be part of the file/class/namespace that contains it.
  208 +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
  209 +# page for each member. If set to NO, the documentation of a member will be part
  210 +# of the file/class/namespace that contains it.
  211 +# The default value is: NO.
167 212  
168 213 SEPARATE_MEMBER_PAGES = NO
169 214  
170   -# The TAB_SIZE tag can be used to set the number of spaces in a tab.
171   -# Doxygen uses this value to replace tabs by spaces in code fragments.
  215 +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
  216 +# uses this value to replace tabs by spaces in code fragments.
  217 +# Minimum value: 1, maximum value: 16, default value: 4.
172 218  
173 219 TAB_SIZE = 2
174 220  
175   -# This tag can be used to specify a number of aliases that acts
176   -# as commands in the documentation. An alias has the form "name=value".
177   -# For example adding "sideeffect=\par Side Effects:\n" will allow you to
178   -# put the command \sideeffect (or @sideeffect) in the documentation, which
179   -# will result in a user-defined paragraph with heading "Side Effects:".
180   -# You can put \n's in the value part of an alias to insert newlines.
  221 +# This tag can be used to specify a number of aliases that act as commands in
  222 +# the documentation. An alias has the form:
  223 +# name=value
  224 +# For example adding
  225 +# "sideeffect=@par Side Effects:\n"
  226 +# will allow you to put the command \sideeffect (or @sideeffect) in the
  227 +# documentation, which will result in a user-defined paragraph with heading
  228 +# "Side Effects:". You can put \n's in the value part of an alias to insert
  229 +# newlines.
181 230  
182 231 ALIASES =
183 232  
184   -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
185   -# sources only. Doxygen will then generate output that is more tailored for C.
186   -# For instance, some of the names that are used will be different. The list
187   -# of all members will be omitted, etc.
  233 +# This tag can be used to specify a number of word-keyword mappings (TCL only).
  234 +# A mapping has the form "name=value". For example adding "class=itcl::class"
  235 +# will allow you to use the command class in the itcl::class meaning.
  236 +
  237 +TCL_SUBST =
  238 +
  239 +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
  240 +# only. Doxygen will then generate output that is more tailored for C. For
  241 +# instance, some of the names that are used will be different. The list of all
  242 +# members will be omitted, etc.
  243 +# The default value is: NO.
188 244  
189 245 OPTIMIZE_OUTPUT_FOR_C = YES
190 246  
191   -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
192   -# sources only. Doxygen will then generate output that is more tailored for
193   -# Java. For instance, namespaces will be presented as packages, qualified
194   -# scopes will look different, etc.
  247 +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
  248 +# Python sources only. Doxygen will then generate output that is more tailored
  249 +# for that language. For instance, namespaces will be presented as packages,
  250 +# qualified scopes will look different, etc.
  251 +# The default value is: NO.
195 252  
196 253 OPTIMIZE_OUTPUT_JAVA = NO
197 254  
198 255 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
199   -# sources only. Doxygen will then generate output that is more tailored for
200   -# Fortran.
  256 +# sources. Doxygen will then generate output that is tailored for Fortran.
  257 +# The default value is: NO.
201 258  
202 259 OPTIMIZE_FOR_FORTRAN = NO
203 260  
204 261 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
205   -# sources. Doxygen will then generate output that is tailored for
206   -# VHDL.
  262 +# sources. Doxygen will then generate output that is tailored for VHDL.
  263 +# The default value is: NO.
207 264  
208 265 OPTIMIZE_OUTPUT_VHDL = NO
209 266  
210   -# Doxygen selects the parser to use depending on the extension of the files it parses.
211   -# With this tag you can assign which parser to use for a given extension.
212   -# Doxygen has a built-in mapping, but you can override or extend it using this tag.
213   -# The format is ext=language, where ext is a file extension, and language is one of
214   -# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
215   -# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
216   -# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
217   -# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
  267 +# Doxygen selects the parser to use depending on the extension of the files it
  268 +# parses. With this tag you can assign which parser to use for a given
  269 +# extension. Doxygen has a built-in mapping, but you can override or extend it
  270 +# using this tag. The format is ext=language, where ext is a file extension, and
  271 +# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
  272 +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
  273 +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
  274 +# Fortran. In the later case the parser tries to guess whether the code is fixed
  275 +# or free formatted code, this is the default for Fortran type files), VHDL. For
  276 +# instance to make doxygen treat .inc files as Fortran files (default is PHP),
  277 +# and .f files as C (default is Fortran), use: inc=Fortran f=C.
  278 +#
  279 +# Note: For files without extension you can use no_extension as a placeholder.
  280 +#
  281 +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
  282 +# the files are not read by doxygen.
218 283  
219 284 EXTENSION_MAPPING =
220 285  
  286 +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
  287 +# according to the Markdown format, which allows for more readable
  288 +# documentation. See http://daringfireball.net/projects/markdown/ for details.
  289 +# The output of markdown processing is further processed by doxygen, so you can
  290 +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
  291 +# case of backward compatibilities issues.
  292 +# The default value is: YES.
  293 +
  294 +MARKDOWN_SUPPORT = YES
  295 +
  296 +# When enabled doxygen tries to link words that correspond to documented
  297 +# classes, or namespaces to their corresponding documentation. Such a link can
  298 +# be prevented in individual cases by putting a % sign in front of the word or
  299 +# globally by setting AUTOLINK_SUPPORT to NO.
  300 +# The default value is: YES.
  301 +
  302 +AUTOLINK_SUPPORT = YES
  303 +
221 304 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
222   -# to include (a tag file for) the STL sources as input, then you should
223   -# set this tag to YES in order to let doxygen match functions declarations and
224   -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
225   -# func(std::string) {}). This also make the inheritance and collaboration
  305 +# to include (a tag file for) the STL sources as input, then you should set this
  306 +# tag to YES in order to let doxygen match functions declarations and
  307 +# definitions whose arguments contain STL classes (e.g. func(std::string);
  308 +# versus func(std::string) {}). This also make the inheritance and collaboration
226 309 # diagrams that involve STL classes more complete and accurate.
  310 +# The default value is: NO.
227 311  
228 312 BUILTIN_STL_SUPPORT = NO
229 313  
230 314 # If you use Microsoft's C++/CLI language, you should set this option to YES to
231 315 # enable parsing support.
  316 +# The default value is: NO.
232 317  
233 318 CPP_CLI_SUPPORT = NO
234 319  
235   -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
236   -# Doxygen will parse them like normal C++ but will assume all classes use public
237   -# instead of private inheritance when no explicit protection keyword is present.
  320 +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
  321 +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
  322 +# will parse them like normal C++ but will assume all classes use public instead
  323 +# of private inheritance when no explicit protection keyword is present.
  324 +# The default value is: NO.
238 325  
239 326 SIP_SUPPORT = NO
240 327  
241   -# For Microsoft's IDL there are propget and propput attributes to indicate getter
242   -# and setter methods for a property. Setting this option to YES (the default)
243   -# will make doxygen to replace the get and set methods by a property in the
244   -# documentation. This will only work if the methods are indeed getting or
245   -# setting a simple type. If this is not the case, or you want to show the
246   -# methods anyway, you should set this option to NO.
  328 +# For Microsoft's IDL there are propget and propput attributes to indicate
  329 +# getter and setter methods for a property. Setting this option to YES will make
  330 +# doxygen to replace the get and set methods by a property in the documentation.
  331 +# This will only work if the methods are indeed getting or setting a simple
  332 +# type. If this is not the case, or you want to show the methods anyway, you
  333 +# should set this option to NO.
  334 +# The default value is: YES.
247 335  
248 336 IDL_PROPERTY_SUPPORT = YES
249 337  
250 338 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
251   -# tag is set to YES, then doxygen will reuse the documentation of the first
  339 +# tag is set to YES then doxygen will reuse the documentation of the first
252 340 # member in the group (if any) for the other members of the group. By default
253 341 # all members of a group must be documented explicitly.
  342 +# The default value is: NO.
254 343  
255 344 DISTRIBUTE_GROUP_DOC = NO
256 345  
257   -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
258   -# the same type (for instance a group of public functions) to be put as a
259   -# subgroup of that type (e.g. under the Public Functions section). Set it to
260   -# NO to prevent subgrouping. Alternatively, this can be done per class using
261   -# the \nosubgrouping command.
  346 +# Set the SUBGROUPING tag to YES to allow class member groups of the same type
  347 +# (for instance a group of public functions) to be put as a subgroup of that
  348 +# type (e.g. under the Public Functions section). Set it to NO to prevent
  349 +# subgrouping. Alternatively, this can be done per class using the
  350 +# \nosubgrouping command.
  351 +# The default value is: YES.
262 352  
263 353 SUBGROUPING = YES
264 354  
265   -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
266   -# is documented as struct, union, or enum with the name of the typedef. So
  355 +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
  356 +# are shown inside the group in which they are included (e.g. using \ingroup)
  357 +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
  358 +# and RTF).
  359 +#
  360 +# Note that this feature does not work in combination with
  361 +# SEPARATE_MEMBER_PAGES.
  362 +# The default value is: NO.
  363 +
  364 +INLINE_GROUPED_CLASSES = NO
  365 +
  366 +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
  367 +# with only public data fields or simple typedef fields will be shown inline in
  368 +# the documentation of the scope in which they are defined (i.e. file,
  369 +# namespace, or group documentation), provided this scope is documented. If set
  370 +# to NO, structs, classes, and unions are shown on a separate page (for HTML and
  371 +# Man pages) or section (for LaTeX and RTF).
  372 +# The default value is: NO.
  373 +
  374 +INLINE_SIMPLE_STRUCTS = NO
  375 +
  376 +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
  377 +# enum is documented as struct, union, or enum with the name of the typedef. So
267 378 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
268 379 # with name TypeT. When disabled the typedef will appear as a member of a file,
269   -# namespace, or class. And the struct will be named TypeS. This can typically
270   -# be useful for C code in case the coding convention dictates that all compound
  380 +# namespace, or class. And the struct will be named TypeS. This can typically be
  381 +# useful for C code in case the coding convention dictates that all compound
271 382 # types are typedef'ed and only the typedef is referenced, never the tag name.
  383 +# The default value is: NO.
272 384  
273 385 TYPEDEF_HIDES_STRUCT = NO
274 386  
275   -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
276   -# determine which symbols to keep in memory and which to flush to disk.
277   -# When the cache is full, less often used symbols will be written to disk.
278   -# For small to medium size projects (<1000 input files) the default value is
279   -# probably good enough. For larger projects a too small cache size can cause
280   -# doxygen to be busy swapping symbols to and from disk most of the time
281   -# causing a significant performance penality.
282   -# If the system has enough physical memory increasing the cache will improve the
283   -# performance by keeping more symbols in memory. Note that the value works on
284   -# a logarithmic scale so increasing the size by one will rougly double the
285   -# memory usage. The cache size is given by this formula:
286   -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
287   -# corresponding to a cache size of 2^16 = 65536 symbols
288   -
289   -SYMBOL_CACHE_SIZE = 0
  387 +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
  388 +# cache is used to resolve symbols given their name and scope. Since this can be
  389 +# an expensive process and often the same symbol appears multiple times in the
  390 +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
  391 +# doxygen will become slower. If the cache is too large, memory is wasted. The
  392 +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
  393 +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
  394 +# symbols. At the end of a run doxygen will report the cache usage and suggest
  395 +# the optimal cache size from a speed point of view.
  396 +# Minimum value: 0, maximum value: 9, default value: 0.
  397 +
  398 +LOOKUP_CACHE_SIZE = 0
290 399  
291 400 #---------------------------------------------------------------------------
292 401 # Build related configuration options
293 402 #---------------------------------------------------------------------------
294 403  
295   -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
296   -# documentation are documented, even if no documentation was available.
297   -# Private class members and static file members will be hidden unless
298   -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
  404 +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
  405 +# documentation are documented, even if no documentation was available. Private
  406 +# class members and static file members will be hidden unless the
  407 +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
  408 +# Note: This will also disable the warnings about undocumented members that are
  409 +# normally produced when WARNINGS is set to YES.
  410 +# The default value is: NO.
299 411  
300 412 EXTRACT_ALL = NO
301 413  
302   -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
303   -# will be included in the documentation.
  414 +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
  415 +# be included in the documentation.
  416 +# The default value is: NO.
304 417  
305 418 EXTRACT_PRIVATE = NO
306 419  
307   -# If the EXTRACT_STATIC tag is set to YES all static members of a file
308   -# will be included in the documentation.
  420 +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
  421 +# scope will be included in the documentation.
  422 +# The default value is: NO.
  423 +
  424 +EXTRACT_PACKAGE = NO
  425 +
  426 +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
  427 +# included in the documentation.
  428 +# The default value is: NO.
309 429  
310 430 EXTRACT_STATIC = NO
311 431  
312   -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
313   -# defined locally in source files will be included in the documentation.
314   -# If set to NO only classes defined in header files are included.
  432 +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
  433 +# locally in source files will be included in the documentation. If set to NO,
  434 +# only classes defined in header files are included. Does not have any effect
  435 +# for Java sources.
  436 +# The default value is: YES.
315 437  
316 438 EXTRACT_LOCAL_CLASSES = YES
317 439  
318   -# This flag is only useful for Objective-C code. When set to YES local
319   -# methods, which are defined in the implementation section but not in
320   -# the interface are included in the documentation.
321   -# If set to NO (the default) only methods in the interface are included.
  440 +# This flag is only useful for Objective-C code. If set to YES, local methods,
  441 +# which are defined in the implementation section but not in the interface are
  442 +# included in the documentation. If set to NO, only methods in the interface are
  443 +# included.
  444 +# The default value is: NO.
322 445  
323 446 EXTRACT_LOCAL_METHODS = NO
324 447  
325 448 # If this flag is set to YES, the members of anonymous namespaces will be
326 449 # extracted and appear in the documentation as a namespace called
327   -# 'anonymous_namespace{file}', where file will be replaced with the base
328   -# name of the file that contains the anonymous namespace. By default
329   -# anonymous namespace are hidden.
  450 +# 'anonymous_namespace{file}', where file will be replaced with the base name of
  451 +# the file that contains the anonymous namespace. By default anonymous namespace
  452 +# are hidden.
  453 +# The default value is: NO.
330 454  
331 455 EXTRACT_ANON_NSPACES = NO
332 456  
333   -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
334   -# undocumented members of documented classes, files or namespaces.
335   -# If set to NO (the default) these members will be included in the
336   -# various overviews, but no documentation section is generated.
337   -# This option has no effect if EXTRACT_ALL is enabled.
  457 +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
  458 +# undocumented members inside documented classes or files. If set to NO these
  459 +# members will be included in the various overviews, but no documentation
  460 +# section is generated. This option has no effect if EXTRACT_ALL is enabled.
  461 +# The default value is: NO.
338 462  
339 463 HIDE_UNDOC_MEMBERS = NO
340 464  
341   -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
342   -# undocumented classes that are normally visible in the class hierarchy.
343   -# If set to NO (the default) these classes will be included in the various
344   -# overviews. This option has no effect if EXTRACT_ALL is enabled.
  465 +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
  466 +# undocumented classes that are normally visible in the class hierarchy. If set
  467 +# to NO, these classes will be included in the various overviews. This option
  468 +# has no effect if EXTRACT_ALL is enabled.
  469 +# The default value is: NO.
345 470  
346 471 HIDE_UNDOC_CLASSES = NO
347 472  
348   -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
349   -# friend (class|struct|union) declarations.
350   -# If set to NO (the default) these declarations will be included in the
351   -# documentation.
  473 +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
  474 +# (class|struct|union) declarations. If set to NO, these declarations will be
  475 +# included in the documentation.
  476 +# The default value is: NO.
352 477  
353 478 HIDE_FRIEND_COMPOUNDS = NO
354 479  
355   -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
356   -# documentation blocks found inside the body of a function.
357   -# If set to NO (the default) these blocks will be appended to the
358   -# function's detailed documentation block.
  480 +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
  481 +# documentation blocks found inside the body of a function. If set to NO, these
  482 +# blocks will be appended to the function's detailed documentation block.
  483 +# The default value is: NO.
359 484  
360 485 HIDE_IN_BODY_DOCS = NO
361 486  
362   -# The INTERNAL_DOCS tag determines if documentation
363   -# that is typed after a \internal command is included. If the tag is set
364   -# to NO (the default) then the documentation will be excluded.
365   -# Set it to YES to include the internal documentation.
  487 +# The INTERNAL_DOCS tag determines if documentation that is typed after a
  488 +# \internal command is included. If the tag is set to NO then the documentation
  489 +# will be excluded. Set it to YES to include the internal documentation.
  490 +# The default value is: NO.
366 491  
367 492 INTERNAL_DOCS = NO
368 493  
369   -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
370   -# file names in lower-case letters. If set to YES upper-case letters are also
  494 +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
  495 +# names in lower-case letters. If set to YES, upper-case letters are also
371 496 # allowed. This is useful if you have classes or files whose names only differ
372 497 # in case and if your file system supports case sensitive file names. Windows
373 498 # and Mac users are advised to set this option to NO.
  499 +# The default value is: system dependent.
374 500  
375 501 CASE_SENSE_NAMES = YES
376 502  
377   -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
378   -# will show members with their full class and namespace scopes in the
379   -# documentation. If set to YES the scope will be hidden.
  503 +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
  504 +# their full class and namespace scopes in the documentation. If set to YES, the
  505 +# scope will be hidden.
  506 +# The default value is: NO.
380 507  
381 508 HIDE_SCOPE_NAMES = NO
382 509  
383   -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
384   -# will put a list of the files that are included by a file in the documentation
385   -# of that file.
  510 +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
  511 +# append additional text to a page's title, such as Class Reference. If set to
  512 +# YES the compound reference will be hidden.
  513 +# The default value is: NO.
  514 +
  515 +HIDE_COMPOUND_REFERENCE= NO
  516 +
  517 +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
  518 +# the files that are included by a file in the documentation of that file.
  519 +# The default value is: YES.
386 520  
387 521 SHOW_INCLUDE_FILES = YES
388 522  
389   -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
390   -# is inserted in the documentation for inline members.
  523 +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
  524 +# grouped member an include statement to the documentation, telling the reader
  525 +# which file to include in order to use the member.
  526 +# The default value is: NO.
  527 +
  528 +SHOW_GROUPED_MEMB_INC = NO
  529 +
  530 +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
  531 +# files with double quotes in the documentation rather than with sharp brackets.
  532 +# The default value is: NO.
  533 +
  534 +FORCE_LOCAL_INCLUDES = NO
  535 +
  536 +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
  537 +# documentation for inline members.
  538 +# The default value is: YES.
391 539  
392 540 INLINE_INFO = YES
393 541  
394   -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
395   -# will sort the (detailed) documentation of file and class members
396   -# alphabetically by member name. If set to NO the members will appear in
397   -# declaration order.
  542 +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
  543 +# (detailed) documentation of file and class members alphabetically by member
  544 +# name. If set to NO, the members will appear in declaration order.
  545 +# The default value is: YES.
398 546  
399 547 SORT_MEMBER_DOCS = YES
400 548  
401   -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
402   -# brief documentation of file, namespace and class members alphabetically
403   -# by member name. If set to NO (the default) the members will appear in
404   -# declaration order.
  549 +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
  550 +# descriptions of file, namespace and class members alphabetically by member
  551 +# name. If set to NO, the members will appear in declaration order. Note that
  552 +# this will also influence the order of the classes in the class list.
  553 +# The default value is: NO.
405 554  
406 555 SORT_BRIEF_DOCS = NO
407 556  
408   -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
  557 +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
  558 +# (brief and detailed) documentation of class members so that constructors and
  559 +# destructors are listed first. If set to NO the constructors will appear in the
  560 +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
  561 +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
  562 +# member documentation.
  563 +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
  564 +# detailed member documentation.
  565 +# The default value is: NO.
409 566  
410 567 SORT_MEMBERS_CTORS_1ST = NO
411 568  
412   -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
413   -# hierarchy of group names into alphabetical order. If set to NO (the default)
414   -# the group names will appear in their defined order.
  569 +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
  570 +# of group names into alphabetical order. If set to NO the group names will
  571 +# appear in their defined order.
  572 +# The default value is: NO.
415 573  
416 574 SORT_GROUP_NAMES = NO
417 575  
418   -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
419   -# sorted by fully-qualified names, including namespaces. If set to
420   -# NO (the default), the class list will be sorted only by class name,
421   -# not including the namespace part.
  576 +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
  577 +# fully-qualified names, including namespaces. If set to NO, the class list will
  578 +# be sorted only by class name, not including the namespace part.
422 579 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
423   -# Note: This option applies only to the class list, not to the
424   -# alphabetical list.
  580 +# Note: This option applies only to the class list, not to the alphabetical
  581 +# list.
  582 +# The default value is: NO.
425 583  
426 584 SORT_BY_SCOPE_NAME = NO
427 585  
428   -# The GENERATE_TODOLIST tag can be used to enable (YES) or
429   -# disable (NO) the todo list. This list is created by putting \todo
430   -# commands in the documentation.
  586 +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
  587 +# type resolution of all parameters of a function it will reject a match between
  588 +# the prototype and the implementation of a member function even if there is
  589 +# only one candidate or it is obvious which candidate to choose by doing a
  590 +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
  591 +# accept a match between prototype and implementation in such cases.
  592 +# The default value is: NO.
  593 +
  594 +STRICT_PROTO_MATCHING = NO
  595 +
  596 +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
  597 +# list. This list is created by putting \todo commands in the documentation.
  598 +# The default value is: YES.
431 599  
432 600 GENERATE_TODOLIST = YES
433 601  
434   -# The GENERATE_TESTLIST tag can be used to enable (YES) or
435   -# disable (NO) the test list. This list is created by putting \test
436   -# commands in the documentation.
  602 +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
  603 +# list. This list is created by putting \test commands in the documentation.
  604 +# The default value is: YES.
437 605  
438 606 GENERATE_TESTLIST = YES
439 607  
440   -# The GENERATE_BUGLIST tag can be used to enable (YES) or
441   -# disable (NO) the bug list. This list is created by putting \bug
442   -# commands in the documentation.
  608 +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
  609 +# list. This list is created by putting \bug commands in the documentation.
  610 +# The default value is: YES.
443 611  
444 612 GENERATE_BUGLIST = YES
445 613  
446   -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
447   -# disable (NO) the deprecated list. This list is created by putting
448   -# \deprecated commands in the documentation.
  614 +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
  615 +# the deprecated list. This list is created by putting \deprecated commands in
  616 +# the documentation.
  617 +# The default value is: YES.
449 618  
450 619 GENERATE_DEPRECATEDLIST= YES
451 620  
452   -# The ENABLED_SECTIONS tag can be used to enable conditional
453   -# documentation sections, marked by \if sectionname ... \endif.
  621 +# The ENABLED_SECTIONS tag can be used to enable conditional documentation
  622 +# sections, marked by \if <section_label> ... \endif and \cond <section_label>
  623 +# ... \endcond blocks.
454 624  
455 625 ENABLED_SECTIONS =
456 626  
457   -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
458   -# the initial value of a variable or define consists of for it to appear in
459   -# the documentation. If the initializer consists of more lines than specified
460   -# here it will be hidden. Use a value of 0 to hide initializers completely.
461   -# The appearance of the initializer of individual variables and defines in the
462   -# documentation can be controlled using \showinitializer or \hideinitializer
463   -# command in the documentation regardless of this setting.
  627 +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
  628 +# initial value of a variable or macro / define can have for it to appear in the
  629 +# documentation. If the initializer consists of more lines than specified here
  630 +# it will be hidden. Use a value of 0 to hide initializers completely. The
  631 +# appearance of the value of individual variables and macros / defines can be
  632 +# controlled using \showinitializer or \hideinitializer command in the
  633 +# documentation regardless of this setting.
  634 +# Minimum value: 0, maximum value: 10000, default value: 30.
464 635  
465 636 MAX_INITIALIZER_LINES = 30
466 637  
467   -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
468   -# at the bottom of the documentation of classes and structs. If set to YES the
  638 +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
  639 +# the bottom of the documentation of classes and structs. If set to YES, the
469 640 # list will mention the files that were used to generate the documentation.
  641 +# The default value is: YES.
470 642  
471 643 SHOW_USED_FILES = YES
472 644  
473   -# If the sources in your project are distributed over multiple directories
474   -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
475   -# in the documentation. The default is NO.
476   -
477   -SHOW_DIRECTORIES = NO
478   -
479   -# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
480   -# This will remove the Files entry from the Quick Index and from the
481   -# Folder Tree View (if specified). The default is YES.
  645 +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
  646 +# will remove the Files entry from the Quick Index and from the Folder Tree View
  647 +# (if specified).
  648 +# The default value is: YES.
482 649  
483 650 SHOW_FILES = YES
484 651  
485   -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
486   -# Namespaces page.
487   -# This will remove the Namespaces entry from the Quick Index
488   -# and from the Folder Tree View (if specified). The default is YES.
  652 +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
  653 +# page. This will remove the Namespaces entry from the Quick Index and from the
  654 +# Folder Tree View (if specified).
  655 +# The default value is: YES.
489 656  
490 657 SHOW_NAMESPACES = YES
491 658  
492 659 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
493 660 # doxygen should invoke to get the current version for each file (typically from
494 661 # the version control system). Doxygen will invoke the program by executing (via
495   -# popen()) the command <command> <input-file>, where <command> is the value of
496   -# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
497   -# provided by doxygen. Whatever the program writes to standard output
498   -# is used as the file version. See the manual for examples.
  662 +# popen()) the command command input-file, where command is the value of the
  663 +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
  664 +# by doxygen. Whatever the program writes to standard output is used as the file
  665 +# version. For an example see the documentation.
499 666  
500 667 FILE_VERSION_FILTER =
501 668  
502   -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
503   -# doxygen. The layout file controls the global structure of the generated output files
504   -# in an output format independent way. The create the layout file that represents
505   -# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
506   -# file name after the option, if omitted DoxygenLayout.xml will be used as the name
507   -# of the layout file.
  669 +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
  670 +# by doxygen. The layout file controls the global structure of the generated
  671 +# output files in an output format independent way. To create the layout file
  672 +# that represents doxygen's defaults, run doxygen with the -l option. You can
  673 +# optionally specify a file name after the option, if omitted DoxygenLayout.xml
  674 +# will be used as the name of the layout file.
  675 +#
  676 +# Note that if you run doxygen from a directory containing a file called
  677 +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
  678 +# tag is left empty.
508 679  
509 680 LAYOUT_FILE =
510 681  
  682 +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
  683 +# the reference definitions. This must be a list of .bib files. The .bib
  684 +# extension is automatically appended if omitted. This requires the bibtex tool
  685 +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
  686 +# For LaTeX the style of the bibliography can be controlled using
  687 +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
  688 +# search path. See also \cite for info how to create references.
  689 +
  690 +CITE_BIB_FILES =
  691 +
511 692 #---------------------------------------------------------------------------
512   -# configuration options related to warning and progress messages
  693 +# Configuration options related to warning and progress messages
513 694 #---------------------------------------------------------------------------
514 695  
515   -# The QUIET tag can be used to turn on/off the messages that are generated
516   -# by doxygen. Possible values are YES and NO. If left blank NO is used.
  696 +# The QUIET tag can be used to turn on/off the messages that are generated to
  697 +# standard output by doxygen. If QUIET is set to YES this implies that the
  698 +# messages are off.
  699 +# The default value is: NO.
517 700  
518 701 QUIET = NO
519 702  
520 703 # The WARNINGS tag can be used to turn on/off the warning messages that are
521   -# generated by doxygen. Possible values are YES and NO. If left blank
522   -# NO is used.
  704 +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
  705 +# this implies that the warnings are on.
  706 +#
  707 +# Tip: Turn warnings on while writing the documentation.
  708 +# The default value is: YES.
523 709  
524 710 WARNINGS = YES
525 711  
526   -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
527   -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
528   -# automatically be disabled.
  712 +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
  713 +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
  714 +# will automatically be disabled.
  715 +# The default value is: YES.
529 716  
530 717 WARN_IF_UNDOCUMENTED = YES
531 718  
532   -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
533   -# potential errors in the documentation, such as not documenting some
534   -# parameters in a documented function, or documenting parameters that
535   -# don't exist or using markup commands wrongly.
  719 +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
  720 +# potential errors in the documentation, such as not documenting some parameters
  721 +# in a documented function, or documenting parameters that don't exist or using
  722 +# markup commands wrongly.
  723 +# The default value is: YES.
536 724  
537 725 WARN_IF_DOC_ERROR = YES
538 726  
539   -# This WARN_NO_PARAMDOC option can be abled to get warnings for
540   -# functions that are documented, but have no documentation for their parameters
541   -# or return value. If set to NO (the default) doxygen will only warn about
542   -# wrong or incomplete parameter documentation, but not about the absence of
543   -# documentation.
  727 +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
  728 +# are documented, but have no documentation for their parameters or return
  729 +# value. If set to NO, doxygen will only warn about wrong or incomplete
  730 +# parameter documentation, but not about the absence of documentation.
  731 +# The default value is: NO.
544 732  
545 733 WARN_NO_PARAMDOC = NO
546 734  
547   -# The WARN_FORMAT tag determines the format of the warning messages that
548   -# doxygen can produce. The string should contain the $file, $line, and $text
549   -# tags, which will be replaced by the file and line number from which the
550   -# warning originated and the warning text. Optionally the format may contain
551   -# $version, which will be replaced by the version of the file (if it could
552   -# be obtained via FILE_VERSION_FILTER)
  735 +# The WARN_FORMAT tag determines the format of the warning messages that doxygen
  736 +# can produce. The string should contain the $file, $line, and $text tags, which
  737 +# will be replaced by the file and line number from which the warning originated
  738 +# and the warning text. Optionally the format may contain $version, which will
  739 +# be replaced by the version of the file (if it could be obtained via
  740 +# FILE_VERSION_FILTER)
  741 +# The default value is: $file:$line: $text.
553 742  
554 743 WARN_FORMAT = "$file:$line: $text"
555 744  
556   -# The WARN_LOGFILE tag can be used to specify a file to which warning
557   -# and error messages should be written. If left blank the output is written
558   -# to stderr.
  745 +# The WARN_LOGFILE tag can be used to specify a file to which warning and error
  746 +# messages should be written. If left blank the output is written to standard
  747 +# error (stderr).
559 748  
560 749 WARN_LOGFILE =
561 750  
562 751 #---------------------------------------------------------------------------
563   -# configuration options related to the input files
  752 +# Configuration options related to the input files
564 753 #---------------------------------------------------------------------------
565 754  
566   -# The INPUT tag can be used to specify the files and/or directories that contain
567   -# documented source files. You may enter file names like "myfile.cpp" or
568   -# directories like "/usr/src/myproject". Separate the files or directories
569   -# with spaces.
  755 +# The INPUT tag is used to specify the files and/or directories that contain
  756 +# documented source files. You may enter file names like myfile.cpp or
  757 +# directories like /usr/src/myproject. Separate the files or directories with
  758 +# spaces.
  759 +# Note: If this tag is empty the current directory is searched.
570 760  
571   -INPUT = src/ mainpage.dox roadmap.dox
  761 +INPUT = src/ \
  762 + readme.md
572 763  
573 764 # This tag can be used to specify the character encoding of the source files
574   -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
575   -# also the default input encoding. Doxygen uses libiconv (or the iconv built
576   -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
577   -# the list of possible encodings.
  765 +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
  766 +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
  767 +# documentation (see: http://www.gnu.org/software/libiconv) for the list of
  768 +# possible encodings.
  769 +# The default value is: UTF-8.
578 770  
579 771 INPUT_ENCODING = UTF-8
580 772  
581 773 # If the value of the INPUT tag contains directories, you can use the
582   -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
583   -# and *.h) to filter out the source-files in the directories. If left
584   -# blank the following patterns are tested:
585   -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
586   -# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
  774 +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
  775 +# *.h) to filter out the source-files in the directories. If left blank the
  776 +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
  777 +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
  778 +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
  779 +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
  780 +# *.qsf, *.as and *.js.
587 781  
588 782 FILE_PATTERNS =
589 783  
590   -# The RECURSIVE tag can be used to turn specify whether or not subdirectories
591   -# should be searched for input files as well. Possible values are YES and NO.
592   -# If left blank NO is used.
  784 +# The RECURSIVE tag can be used to specify whether or not subdirectories should
  785 +# be searched for input files as well.
  786 +# The default value is: NO.
593 787  
594 788 RECURSIVE = YES
595 789  
596   -# The EXCLUDE tag can be used to specify files and/or directories that should
  790 +# The EXCLUDE tag can be used to specify files and/or directories that should be
597 791 # excluded from the INPUT source files. This way you can easily exclude a
598 792 # subdirectory from a directory tree whose root is specified with the INPUT tag.
  793 +#
  794 +# Note that relative paths are relative to the directory from which doxygen is
  795 +# run.
599 796  
600 797 EXCLUDE =
601 798  
602   -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
603   -# directories that are symbolic links (a Unix filesystem feature) are excluded
  799 +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
  800 +# directories that are symbolic links (a Unix file system feature) are excluded
604 801 # from the input.
  802 +# The default value is: NO.
605 803  
606 804 EXCLUDE_SYMLINKS = NO
607 805  
608 806 # If the value of the INPUT tag contains directories, you can use the
609 807 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
610   -# certain files from those directories. Note that the wildcards are matched
611   -# against the file with absolute path, so to exclude all test directories
612   -# for example use the pattern */test/*
  808 +# certain files from those directories.
  809 +#
  810 +# Note that the wildcards are matched against the file with absolute path, so to
  811 +# exclude all test directories for example use the pattern */test/*
613 812  
614 813 EXCLUDE_PATTERNS = */.svn*
615 814  
... ... @@ -618,593 +817,1110 @@ EXCLUDE_PATTERNS = */.svn*
618 817 # output. The symbol name can be a fully qualified name, a word, or if the
619 818 # wildcard * is used, a substring. Examples: ANamespace, AClass,
620 819 # AClass::ANamespace, ANamespace::*Test
  820 +#
  821 +# Note that the wildcards are matched against the file with absolute path, so to
  822 +# exclude all test directories use the pattern */test/*
621 823  
622 824 EXCLUDE_SYMBOLS =
623 825  
624   -# The EXAMPLE_PATH tag can be used to specify one or more files or
625   -# directories that contain example code fragments that are included (see
626   -# the \include command).
  826 +# The EXAMPLE_PATH tag can be used to specify one or more files or directories
  827 +# that contain example code fragments that are included (see the \include
  828 +# command).
627 829  
628 830 EXAMPLE_PATH =
629 831  
630 832 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
631   -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
632   -# and *.h) to filter out the source-files in the directories. If left
633   -# blank all files are included.
  833 +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
  834 +# *.h) to filter out the source-files in the directories. If left blank all
  835 +# files are included.
634 836  
635 837 EXAMPLE_PATTERNS =
636 838  
637 839 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
638   -# searched for input files to be used with the \include or \dontinclude
639   -# commands irrespective of the value of the RECURSIVE tag.
640   -# Possible values are YES and NO. If left blank NO is used.
  840 +# searched for input files to be used with the \include or \dontinclude commands
  841 +# irrespective of the value of the RECURSIVE tag.
  842 +# The default value is: NO.
641 843  
642 844 EXAMPLE_RECURSIVE = NO
643 845  
644   -# The IMAGE_PATH tag can be used to specify one or more files or
645   -# directories that contain image that are included in the documentation (see
646   -# the \image command).
  846 +# The IMAGE_PATH tag can be used to specify one or more files or directories
  847 +# that contain images that are to be included in the documentation (see the
  848 +# \image command).
647 849  
648 850 IMAGE_PATH =
649 851  
650 852 # The INPUT_FILTER tag can be used to specify a program that doxygen should
651 853 # invoke to filter for each input file. Doxygen will invoke the filter program
652   -# by executing (via popen()) the command <filter> <input-file>, where <filter>
653   -# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
654   -# input file. Doxygen will then use the output that the filter program writes
655   -# to standard output.
656   -# If FILTER_PATTERNS is specified, this tag will be
657   -# ignored.
  854 +# by executing (via popen()) the command:
  855 +#
  856 +# <filter> <input-file>
  857 +#
  858 +# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
  859 +# name of an input file. Doxygen will then use the output that the filter
  860 +# program writes to standard output. If FILTER_PATTERNS is specified, this tag
  861 +# will be ignored.
  862 +#
  863 +# Note that the filter must not add or remove lines; it is applied before the
  864 +# code is scanned, but not when the output code is generated. If lines are added
  865 +# or removed, the anchors will not be placed correctly.
658 866  
659 867 INPUT_FILTER =
660 868  
661 869 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
662   -# basis.
663   -# Doxygen will compare the file name with each pattern and apply the
664   -# filter if there is a match.
665   -# The filters are a list of the form:
666   -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
667   -# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
668   -# is applied to all files.
  870 +# basis. Doxygen will compare the file name with each pattern and apply the
  871 +# filter if there is a match. The filters are a list of the form: pattern=filter
  872 +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
  873 +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
  874 +# patterns match the file name, INPUT_FILTER is applied.
669 875  
670 876 FILTER_PATTERNS =
671 877  
672 878 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
673   -# INPUT_FILTER) will be used to filter the input files when producing source
674   -# files to browse (i.e. when SOURCE_BROWSER is set to YES).
  879 +# INPUT_FILTER) will also be used to filter the input files that are used for
  880 +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
  881 +# The default value is: NO.
675 882  
676 883 FILTER_SOURCE_FILES = NO
677 884  
  885 +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
  886 +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
  887 +# it is also possible to disable source filtering for a specific pattern using
  888 +# *.ext= (so without naming a filter).
  889 +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
  890 +
  891 +FILTER_SOURCE_PATTERNS =
  892 +
  893 +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
  894 +# is part of the input, its contents will be placed on the main page
  895 +# (index.html). This can be useful if you have a project on for instance GitHub
  896 +# and want to reuse the introduction page also for the doxygen output.
  897 +
  898 +USE_MDFILE_AS_MAINPAGE =
  899 +
678 900 #---------------------------------------------------------------------------
679   -# configuration options related to source browsing
  901 +# Configuration options related to source browsing
680 902 #---------------------------------------------------------------------------
681 903  
682   -# If the SOURCE_BROWSER tag is set to YES then a list of source files will
683   -# be generated. Documented entities will be cross-referenced with these sources.
684   -# Note: To get rid of all source code in the generated output, make sure also
685   -# VERBATIM_HEADERS is set to NO.
  904 +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
  905 +# generated. Documented entities will be cross-referenced with these sources.
  906 +#
  907 +# Note: To get rid of all source code in the generated output, make sure that
  908 +# also VERBATIM_HEADERS is set to NO.
  909 +# The default value is: NO.
686 910  
687 911 SOURCE_BROWSER = NO
688 912  
689   -# Setting the INLINE_SOURCES tag to YES will include the body
690   -# of functions and classes directly in the documentation.
  913 +# Setting the INLINE_SOURCES tag to YES will include the body of functions,
  914 +# classes and enums directly into the documentation.
  915 +# The default value is: NO.
691 916  
692 917 INLINE_SOURCES = NO
693 918  
694   -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
695   -# doxygen to hide any special comment blocks from generated source code
696   -# fragments. Normal C and C++ comments will always remain visible.
  919 +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
  920 +# special comment blocks from generated source code fragments. Normal C, C++ and
  921 +# Fortran comments will always remain visible.
  922 +# The default value is: YES.
697 923  
698 924 STRIP_CODE_COMMENTS = YES
699 925  
700   -# If the REFERENCED_BY_RELATION tag is set to YES
701   -# then for each documented function all documented
702   -# functions referencing it will be listed.
  926 +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
  927 +# function all documented functions referencing it will be listed.
  928 +# The default value is: NO.
703 929  
704 930 REFERENCED_BY_RELATION = NO
705 931  
706   -# If the REFERENCES_RELATION tag is set to YES
707   -# then for each documented function all documented entities
708   -# called/used by that function will be listed.
  932 +# If the REFERENCES_RELATION tag is set to YES then for each documented function
  933 +# all documented entities called/used by that function will be listed.
  934 +# The default value is: NO.
709 935  
710 936 REFERENCES_RELATION = NO
711 937  
712   -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
713   -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
714   -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
715   -# link to the source code.
716   -# Otherwise they will link to the documentation.
  938 +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
  939 +# to YES then the hyperlinks from functions in REFERENCES_RELATION and
  940 +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
  941 +# link to the documentation.
  942 +# The default value is: YES.
717 943  
718 944 REFERENCES_LINK_SOURCE = YES
719 945  
720   -# If the USE_HTAGS tag is set to YES then the references to source code
721   -# will point to the HTML generated by the htags(1) tool instead of doxygen
722   -# built-in source browser. The htags tool is part of GNU's global source
723   -# tagging system (see http://www.gnu.org/software/global/global.html). You
724   -# will need version 4.8.6 or higher.
  946 +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
  947 +# source code will show a tooltip with additional information such as prototype,
  948 +# brief description and links to the definition and documentation. Since this
  949 +# will make the HTML file larger and loading of large files a bit slower, you
  950 +# can opt to disable this feature.
  951 +# The default value is: YES.
  952 +# This tag requires that the tag SOURCE_BROWSER is set to YES.
  953 +
  954 +SOURCE_TOOLTIPS = YES
  955 +
  956 +# If the USE_HTAGS tag is set to YES then the references to source code will
  957 +# point to the HTML generated by the htags(1) tool instead of doxygen built-in
  958 +# source browser. The htags tool is part of GNU's global source tagging system
  959 +# (see http://www.gnu.org/software/global/global.html). You will need version
  960 +# 4.8.6 or higher.
  961 +#
  962 +# To use it do the following:
  963 +# - Install the latest version of global
  964 +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
  965 +# - Make sure the INPUT points to the root of the source tree
  966 +# - Run doxygen as normal
  967 +#
  968 +# Doxygen will invoke htags (and that will in turn invoke gtags), so these
  969 +# tools must be available from the command line (i.e. in the search path).
  970 +#
  971 +# The result: instead of the source browser generated by doxygen, the links to
  972 +# source code will now point to the output of htags.
  973 +# The default value is: NO.
  974 +# This tag requires that the tag SOURCE_BROWSER is set to YES.
725 975  
726 976 USE_HTAGS = NO
727 977  
728   -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
729   -# will generate a verbatim copy of the header file for each class for
730   -# which an include is specified. Set to NO to disable this.
  978 +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
  979 +# verbatim copy of the header file for each class for which an include is
  980 +# specified. Set to NO to disable this.
  981 +# See also: Section \class.
  982 +# The default value is: YES.
731 983  
732 984 VERBATIM_HEADERS = YES
733 985  
734 986 #---------------------------------------------------------------------------
735   -# configuration options related to the alphabetical class index
  987 +# Configuration options related to the alphabetical class index
736 988 #---------------------------------------------------------------------------
737 989  
738   -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
739   -# of all compounds will be generated. Enable this if the project
740   -# contains a lot of classes, structs, unions or interfaces.
  990 +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
  991 +# compounds will be generated. Enable this if the project contains a lot of
  992 +# classes, structs, unions or interfaces.
  993 +# The default value is: YES.
741 994  
742 995 ALPHABETICAL_INDEX = NO
743 996  
744   -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
745   -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
746   -# in which this list will be split (can be a number in the range [1..20])
  997 +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
  998 +# which the alphabetical index list will be split.
  999 +# Minimum value: 1, maximum value: 20, default value: 5.
  1000 +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
747 1001  
748 1002 COLS_IN_ALPHA_INDEX = 5
749 1003  
750   -# In case all classes in a project start with a common prefix, all
751   -# classes will be put under the same header in the alphabetical index.
752   -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
753   -# should be ignored while generating the index headers.
  1004 +# In case all classes in a project start with a common prefix, all classes will
  1005 +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
  1006 +# can be used to specify a prefix (or a list of prefixes) that should be ignored
  1007 +# while generating the index headers.
  1008 +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
754 1009  
755 1010 IGNORE_PREFIX =
756 1011  
757 1012 #---------------------------------------------------------------------------
758   -# configuration options related to the HTML output
  1013 +# Configuration options related to the HTML output
759 1014 #---------------------------------------------------------------------------
760 1015  
761   -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
762   -# generate HTML output.
  1016 +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
  1017 +# The default value is: NO.
763 1018  
764 1019 GENERATE_HTML = YES
765 1020  
766   -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
767   -# If a relative path is entered the value of OUTPUT_DIRECTORY will be
768   -# put in front of it. If left blank `html' will be used as the default path.
  1021 +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
  1022 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1023 +# it.
  1024 +# The default directory is: html.
  1025 +# This tag requires that the tag GENERATE_HTML is set to YES.
769 1026  
770 1027 HTML_OUTPUT = html
771 1028  
772   -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
773   -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
774   -# doxygen will generate files with .html extension.
  1029 +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
  1030 +# generated HTML page (for example: .htm, .php, .asp).
  1031 +# The default value is: .html.
  1032 +# This tag requires that the tag GENERATE_HTML is set to YES.
775 1033  
776 1034 HTML_FILE_EXTENSION = .html
777 1035  
778   -# The HTML_HEADER tag can be used to specify a personal HTML header for
779   -# each generated HTML page. If it is left blank doxygen will generate a
  1036 +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
  1037 +# each generated HTML page. If the tag is left blank doxygen will generate a
780 1038 # standard header.
  1039 +#
  1040 +# To get valid HTML the header file that includes any scripts and style sheets
  1041 +# that doxygen needs, which is dependent on the configuration options used (e.g.
  1042 +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
  1043 +# default header using
  1044 +# doxygen -w html new_header.html new_footer.html new_stylesheet.css
  1045 +# YourConfigFile
  1046 +# and then modify the file new_header.html. See also section "Doxygen usage"
  1047 +# for information on how to generate the default header that doxygen normally
  1048 +# uses.
  1049 +# Note: The header is subject to change so you typically have to regenerate the
  1050 +# default header when upgrading to a newer version of doxygen. For a description
  1051 +# of the possible markers and block names see the documentation.
  1052 +# This tag requires that the tag GENERATE_HTML is set to YES.
781 1053  
782 1054 HTML_HEADER =
783 1055  
784   -# The HTML_FOOTER tag can be used to specify a personal HTML footer for
785   -# each generated HTML page. If it is left blank doxygen will generate a
786   -# standard footer.
  1056 +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
  1057 +# generated HTML page. If the tag is left blank doxygen will generate a standard
  1058 +# footer. See HTML_HEADER for more information on how to generate a default
  1059 +# footer and what special commands can be used inside the footer. See also
  1060 +# section "Doxygen usage" for information on how to generate the default footer
  1061 +# that doxygen normally uses.
  1062 +# This tag requires that the tag GENERATE_HTML is set to YES.
787 1063  
788 1064 HTML_FOOTER =
789 1065  
790   -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
791   -# style sheet that is used by each HTML page. It can be used to
792   -# fine-tune the look of the HTML output. If the tag is left blank doxygen
793   -# will generate a default style sheet. Note that doxygen will try to copy
794   -# the style sheet file to the HTML output directory, so don't put your own
795   -# stylesheet in the HTML output directory as well, or it will be erased!
  1066 +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
  1067 +# sheet that is used by each HTML page. It can be used to fine-tune the look of
  1068 +# the HTML output. If left blank doxygen will generate a default style sheet.
  1069 +# See also section "Doxygen usage" for information on how to generate the style
  1070 +# sheet that doxygen normally uses.
  1071 +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
  1072 +# it is more robust and this tag (HTML_STYLESHEET) will in the future become
  1073 +# obsolete.
  1074 +# This tag requires that the tag GENERATE_HTML is set to YES.
796 1075  
797 1076 HTML_STYLESHEET =
798 1077  
799   -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
800   -# files or namespaces will be aligned in HTML using tables. If set to
801   -# NO a bullet list will be used.
802   -
803   -HTML_ALIGN_MEMBERS = YES
  1078 +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
  1079 +# cascading style sheets that are included after the standard style sheets
  1080 +# created by doxygen. Using this option one can overrule certain style aspects.
  1081 +# This is preferred over using HTML_STYLESHEET since it does not replace the
  1082 +# standard style sheet and is therefore more robust against future updates.
  1083 +# Doxygen will copy the style sheet files to the output directory.
  1084 +# Note: The order of the extra style sheet files is of importance (e.g. the last
  1085 +# style sheet in the list overrules the setting of the previous ones in the
  1086 +# list). For an example see the documentation.
  1087 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1088 +
  1089 +HTML_EXTRA_STYLESHEET =
  1090 +
  1091 +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
  1092 +# other source files which should be copied to the HTML output directory. Note
  1093 +# that these files will be copied to the base HTML output directory. Use the
  1094 +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
  1095 +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
  1096 +# files will be copied as-is; there are no commands or markers available.
  1097 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1098 +
  1099 +HTML_EXTRA_FILES =
  1100 +
  1101 +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
  1102 +# will adjust the colors in the style sheet and background images according to
  1103 +# this color. Hue is specified as an angle on a colorwheel, see
  1104 +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
  1105 +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
  1106 +# purple, and 360 is red again.
  1107 +# Minimum value: 0, maximum value: 359, default value: 220.
  1108 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1109 +
  1110 +HTML_COLORSTYLE_HUE = 220
  1111 +
  1112 +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
  1113 +# in the HTML output. For a value of 0 the output will use grayscales only. A
  1114 +# value of 255 will produce the most vivid colors.
  1115 +# Minimum value: 0, maximum value: 255, default value: 100.
  1116 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1117 +
  1118 +HTML_COLORSTYLE_SAT = 100
  1119 +
  1120 +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
  1121 +# luminance component of the colors in the HTML output. Values below 100
  1122 +# gradually make the output lighter, whereas values above 100 make the output
  1123 +# darker. The value divided by 100 is the actual gamma applied, so 80 represents
  1124 +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
  1125 +# change the gamma.
  1126 +# Minimum value: 40, maximum value: 240, default value: 80.
  1127 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1128 +
  1129 +HTML_COLORSTYLE_GAMMA = 80
  1130 +
  1131 +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
  1132 +# page will contain the date and time when the page was generated. Setting this
  1133 +# to NO can help when comparing the output of multiple runs.
  1134 +# The default value is: NO.
  1135 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1136 +
  1137 +HTML_TIMESTAMP = NO
804 1138  
805 1139 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
806 1140 # documentation will contain sections that can be hidden and shown after the
807   -# page has loaded. For this to work a browser that supports
808   -# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
809   -# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
  1141 +# page has loaded.
  1142 +# The default value is: NO.
  1143 +# This tag requires that the tag GENERATE_HTML is set to YES.
810 1144  
811 1145 HTML_DYNAMIC_SECTIONS = NO
812 1146  
813   -# If the GENERATE_DOCSET tag is set to YES, additional index files
814   -# will be generated that can be used as input for Apple's Xcode 3
815   -# integrated development environment, introduced with OSX 10.5 (Leopard).
816   -# To create a documentation set, doxygen will generate a Makefile in the
817   -# HTML output directory. Running make will produce the docset in that
818   -# directory and running "make install" will install the docset in
819   -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
820   -# it at startup.
821   -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
  1147 +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
  1148 +# shown in the various tree structured indices initially; the user can expand
  1149 +# and collapse entries dynamically later on. Doxygen will expand the tree to
  1150 +# such a level that at most the specified number of entries are visible (unless
  1151 +# a fully collapsed tree already exceeds this amount). So setting the number of
  1152 +# entries 1 will produce a full collapsed tree by default. 0 is a special value
  1153 +# representing an infinite number of entries and will result in a full expanded
  1154 +# tree by default.
  1155 +# Minimum value: 0, maximum value: 9999, default value: 100.
  1156 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1157 +
  1158 +HTML_INDEX_NUM_ENTRIES = 100
  1159 +
  1160 +# If the GENERATE_DOCSET tag is set to YES, additional index files will be
  1161 +# generated that can be used as input for Apple's Xcode 3 integrated development
  1162 +# environment (see: http://developer.apple.com/tools/xcode/), introduced with
  1163 +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
  1164 +# Makefile in the HTML output directory. Running make will produce the docset in
  1165 +# that directory and running make install will install the docset in
  1166 +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
  1167 +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
  1168 +# for more information.
  1169 +# The default value is: NO.
  1170 +# This tag requires that the tag GENERATE_HTML is set to YES.
822 1171  
823 1172 GENERATE_DOCSET = NO
824 1173  
825   -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
826   -# feed. A documentation feed provides an umbrella under which multiple
827   -# documentation sets from a single provider (such as a company or product suite)
828   -# can be grouped.
  1174 +# This tag determines the name of the docset feed. A documentation feed provides
  1175 +# an umbrella under which multiple documentation sets from a single provider
  1176 +# (such as a company or product suite) can be grouped.
  1177 +# The default value is: Doxygen generated docs.
  1178 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
829 1179  
830 1180 DOCSET_FEEDNAME = "Doxygen generated docs"
831 1181  
832   -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
833   -# should uniquely identify the documentation set bundle. This should be a
834   -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
835   -# will append .docset to the name.
  1182 +# This tag specifies a string that should uniquely identify the documentation
  1183 +# set bundle. This should be a reverse domain-name style string, e.g.
  1184 +# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
  1185 +# The default value is: org.doxygen.Project.
  1186 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
836 1187  
837 1188 DOCSET_BUNDLE_ID = org.doxygen.Project
838 1189  
839   -# If the GENERATE_HTMLHELP tag is set to YES, additional index files
840   -# will be generated that can be used as input for tools like the
841   -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
842   -# of the generated HTML documentation.
  1190 +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
  1191 +# the documentation publisher. This should be a reverse domain-name style
  1192 +# string, e.g. com.mycompany.MyDocSet.documentation.
  1193 +# The default value is: org.doxygen.Publisher.
  1194 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
  1195 +
  1196 +DOCSET_PUBLISHER_ID = org.doxygen.Publisher
  1197 +
  1198 +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
  1199 +# The default value is: Publisher.
  1200 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
  1201 +
  1202 +DOCSET_PUBLISHER_NAME = Publisher
  1203 +
  1204 +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
  1205 +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
  1206 +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
  1207 +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
  1208 +# Windows.
  1209 +#
  1210 +# The HTML Help Workshop contains a compiler that can convert all HTML output
  1211 +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
  1212 +# files are now used as the Windows 98 help format, and will replace the old
  1213 +# Windows help format (.hlp) on all Windows platforms in the future. Compressed
  1214 +# HTML files also contain an index, a table of contents, and you can search for
  1215 +# words in the documentation. The HTML workshop also contains a viewer for
  1216 +# compressed HTML files.
  1217 +# The default value is: NO.
  1218 +# This tag requires that the tag GENERATE_HTML is set to YES.
843 1219  
844 1220 GENERATE_HTMLHELP = NO
845 1221  
846   -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
847   -# be used to specify the file name of the resulting .chm file. You
848   -# can add a path in front of the file if the result should not be
  1222 +# The CHM_FILE tag can be used to specify the file name of the resulting .chm
  1223 +# file. You can add a path in front of the file if the result should not be
849 1224 # written to the html output directory.
  1225 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
850 1226  
851 1227 CHM_FILE =
852 1228  
853   -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
854   -# be used to specify the location (absolute path including file name) of
855   -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
856   -# the HTML help compiler on the generated index.hhp.
  1229 +# The HHC_LOCATION tag can be used to specify the location (absolute path
  1230 +# including file name) of the HTML help compiler (hhc.exe). If non-empty,
  1231 +# doxygen will try to run the HTML help compiler on the generated index.hhp.
  1232 +# The file has to be specified with full path.
  1233 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
857 1234  
858 1235 HHC_LOCATION =
859 1236  
860   -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
861   -# controls if a separate .chi index file is generated (YES) or that
862   -# it should be included in the master .chm file (NO).
  1237 +# The GENERATE_CHI flag controls if a separate .chi index file is generated
  1238 +# (YES) or that it should be included in the master .chm file (NO).
  1239 +# The default value is: NO.
  1240 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
863 1241  
864 1242 GENERATE_CHI = NO
865 1243  
866   -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
867   -# is used to encode HtmlHelp index (hhk), content (hhc) and project file
868   -# content.
  1244 +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
  1245 +# and project file content.
  1246 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
869 1247  
870 1248 CHM_INDEX_ENCODING =
871 1249  
872   -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
873   -# controls whether a binary table of contents is generated (YES) or a
874   -# normal table of contents (NO) in the .chm file.
  1250 +# The BINARY_TOC flag controls whether a binary table of contents is generated
  1251 +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
  1252 +# enables the Previous and Next buttons.
  1253 +# The default value is: NO.
  1254 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
875 1255  
876 1256 BINARY_TOC = NO
877 1257  
878   -# The TOC_EXPAND flag can be set to YES to add extra items for group members
879   -# to the contents of the HTML help documentation and to the tree view.
  1258 +# The TOC_EXPAND flag can be set to YES to add extra items for group members to
  1259 +# the table of contents of the HTML help documentation and to the tree view.
  1260 +# The default value is: NO.
  1261 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
880 1262  
881 1263 TOC_EXPAND = NO
882 1264  
883   -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
884   -# are set, an additional index file will be generated that can be used as input for
885   -# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
886   -# HTML documentation.
  1265 +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
  1266 +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
  1267 +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
  1268 +# (.qch) of the generated HTML documentation.
  1269 +# The default value is: NO.
  1270 +# This tag requires that the tag GENERATE_HTML is set to YES.
887 1271  
888 1272 GENERATE_QHP = NO
889 1273  
890   -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
891   -# be used to specify the file name of the resulting .qch file.
892   -# The path specified is relative to the HTML output folder.
  1274 +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
  1275 +# the file name of the resulting .qch file. The path specified is relative to
  1276 +# the HTML output folder.
  1277 +# This tag requires that the tag GENERATE_QHP is set to YES.
893 1278  
894 1279 QCH_FILE =
895 1280  
896   -# The QHP_NAMESPACE tag specifies the namespace to use when generating
897   -# Qt Help Project output. For more information please see
898   -# http://doc.trolltech.com/qthelpproject.html#namespace
  1281 +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
  1282 +# Project output. For more information please see Qt Help Project / Namespace
  1283 +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
  1284 +# The default value is: org.doxygen.Project.
  1285 +# This tag requires that the tag GENERATE_QHP is set to YES.
899 1286  
900 1287 QHP_NAMESPACE =
901 1288  
902   -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
903   -# Qt Help Project output. For more information please see
904   -# http://doc.trolltech.com/qthelpproject.html#virtual-folders
  1289 +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
  1290 +# Help Project output. For more information please see Qt Help Project / Virtual
  1291 +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
  1292 +# folders).
  1293 +# The default value is: doc.
  1294 +# This tag requires that the tag GENERATE_QHP is set to YES.
905 1295  
906 1296 QHP_VIRTUAL_FOLDER = doc
907 1297  
908   -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
909   -# For more information please see
910   -# http://doc.trolltech.com/qthelpproject.html#custom-filters
  1298 +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
  1299 +# filter to add. For more information please see Qt Help Project / Custom
  1300 +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  1301 +# filters).
  1302 +# This tag requires that the tag GENERATE_QHP is set to YES.
911 1303  
912 1304 QHP_CUST_FILTER_NAME =
913 1305  
914   -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
915   -# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
  1306 +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
  1307 +# custom filter to add. For more information please see Qt Help Project / Custom
  1308 +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  1309 +# filters).
  1310 +# This tag requires that the tag GENERATE_QHP is set to YES.
916 1311  
917 1312 QHP_CUST_FILTER_ATTRS =
918 1313  
919   -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
920   -# filter section matches.
921   -# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
  1314 +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
  1315 +# project's filter section matches. Qt Help Project / Filter Attributes (see:
  1316 +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
  1317 +# This tag requires that the tag GENERATE_QHP is set to YES.
922 1318  
923 1319 QHP_SECT_FILTER_ATTRS =
924 1320  
925   -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
926   -# be used to specify the location of Qt's qhelpgenerator.
927   -# If non-empty doxygen will try to run qhelpgenerator on the generated
928   -# .qhp file.
  1321 +# The QHG_LOCATION tag can be used to specify the location of Qt's
  1322 +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
  1323 +# generated .qhp file.
  1324 +# This tag requires that the tag GENERATE_QHP is set to YES.
929 1325  
930 1326 QHG_LOCATION =
931 1327  
932   -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
933   -# top of each HTML page. The value NO (the default) enables the index and
934   -# the value YES disables it.
  1328 +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
  1329 +# generated, together with the HTML files, they form an Eclipse help plugin. To
  1330 +# install this plugin and make it available under the help contents menu in
  1331 +# Eclipse, the contents of the directory containing the HTML and XML files needs
  1332 +# to be copied into the plugins directory of eclipse. The name of the directory
  1333 +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
  1334 +# After copying Eclipse needs to be restarted before the help appears.
  1335 +# The default value is: NO.
  1336 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1337 +
  1338 +GENERATE_ECLIPSEHELP = NO
  1339 +
  1340 +# A unique identifier for the Eclipse help plugin. When installing the plugin
  1341 +# the directory name containing the HTML and XML files should also have this
  1342 +# name. Each documentation set should have its own identifier.
  1343 +# The default value is: org.doxygen.Project.
  1344 +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
  1345 +
  1346 +ECLIPSE_DOC_ID = org.doxygen.Project
  1347 +
  1348 +# If you want full control over the layout of the generated HTML pages it might
  1349 +# be necessary to disable the index and replace it with your own. The
  1350 +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
  1351 +# of each HTML page. A value of NO enables the index and the value YES disables
  1352 +# it. Since the tabs in the index contain the same information as the navigation
  1353 +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
  1354 +# The default value is: NO.
  1355 +# This tag requires that the tag GENERATE_HTML is set to YES.
935 1356  
936 1357 DISABLE_INDEX = NO
937 1358  
938   -# This tag can be used to set the number of enum values (range [1..20])
939   -# that doxygen will group on one line in the generated HTML documentation.
940   -
941   -ENUM_VALUES_PER_LINE = 4
942   -
943 1359 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
944   -# structure should be generated to display hierarchical information.
945   -# If the tag value is set to YES, a side panel will be generated
946   -# containing a tree-like index structure (just like the one that
947   -# is generated for HTML Help). For this to work a browser that supports
948   -# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
949   -# Windows users are probably better off using the HTML help feature.
  1360 +# structure should be generated to display hierarchical information. If the tag
  1361 +# value is set to YES, a side panel will be generated containing a tree-like
  1362 +# index structure (just like the one that is generated for HTML Help). For this
  1363 +# to work a browser that supports JavaScript, DHTML, CSS and frames is required
  1364 +# (i.e. any modern browser). Windows users are probably better off using the
  1365 +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
  1366 +# further fine-tune the look of the index. As an example, the default style
  1367 +# sheet generated by doxygen has an example that shows how to put an image at
  1368 +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
  1369 +# the same information as the tab index, you could consider setting
  1370 +# DISABLE_INDEX to YES when enabling this option.
  1371 +# The default value is: NO.
  1372 +# This tag requires that the tag GENERATE_HTML is set to YES.
950 1373  
951 1374 GENERATE_TREEVIEW = NO
952 1375  
953   -# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
954   -# and Class Hierarchy pages using a tree view instead of an ordered list.
  1376 +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
  1377 +# doxygen will group on one line in the generated HTML documentation.
  1378 +#
  1379 +# Note that a value of 0 will completely suppress the enum values from appearing
  1380 +# in the overview section.
  1381 +# Minimum value: 0, maximum value: 20, default value: 4.
  1382 +# This tag requires that the tag GENERATE_HTML is set to YES.
955 1383  
956   -USE_INLINE_TREES = NO
  1384 +ENUM_VALUES_PER_LINE = 4
957 1385  
958   -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
959   -# used to set the initial width (in pixels) of the frame in which the tree
960   -# is shown.
  1386 +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
  1387 +# to set the initial width (in pixels) of the frame in which the tree is shown.
  1388 +# Minimum value: 0, maximum value: 1500, default value: 250.
  1389 +# This tag requires that the tag GENERATE_HTML is set to YES.
961 1390  
962 1391 TREEVIEW_WIDTH = 250
963 1392  
964   -# Use this tag to change the font size of Latex formulas included
965   -# as images in the HTML documentation. The default is 10. Note that
966   -# when you change the font size after a successful doxygen run you need
967   -# to manually remove any form_*.png images from the HTML output directory
968   -# to force them to be regenerated.
  1393 +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
  1394 +# external symbols imported via tag files in a separate window.
  1395 +# The default value is: NO.
  1396 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1397 +
  1398 +EXT_LINKS_IN_WINDOW = NO
  1399 +
  1400 +# Use this tag to change the font size of LaTeX formulas included as images in
  1401 +# the HTML documentation. When you change the font size after a successful
  1402 +# doxygen run you need to manually remove any form_*.png images from the HTML
  1403 +# output directory to force them to be regenerated.
  1404 +# Minimum value: 8, maximum value: 50, default value: 10.
  1405 +# This tag requires that the tag GENERATE_HTML is set to YES.
969 1406  
970 1407 FORMULA_FONTSIZE = 10
971 1408  
972   -# When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
973   -# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
974   -# there is already a search function so this one should typically
975   -# be disabled.
  1409 +# Use the FORMULA_TRANPARENT tag to determine whether or not the images
  1410 +# generated for formulas are transparent PNGs. Transparent PNGs are not
  1411 +# supported properly for IE 6.0, but are supported on all modern browsers.
  1412 +#
  1413 +# Note that when changing this option you need to delete any form_*.png files in
  1414 +# the HTML output directory before the changes have effect.
  1415 +# The default value is: YES.
  1416 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1417 +
  1418 +FORMULA_TRANSPARENT = YES
  1419 +
  1420 +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
  1421 +# http://www.mathjax.org) which uses client side Javascript for the rendering
  1422 +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
  1423 +# installed or if you want to formulas look prettier in the HTML output. When
  1424 +# enabled you may also need to install MathJax separately and configure the path
  1425 +# to it using the MATHJAX_RELPATH option.
  1426 +# The default value is: NO.
  1427 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1428 +
  1429 +USE_MATHJAX = NO
  1430 +
  1431 +# When MathJax is enabled you can set the default output format to be used for
  1432 +# the MathJax output. See the MathJax site (see:
  1433 +# http://docs.mathjax.org/en/latest/output.html) for more details.
  1434 +# Possible values are: HTML-CSS (which is slower, but has the best
  1435 +# compatibility), NativeMML (i.e. MathML) and SVG.
  1436 +# The default value is: HTML-CSS.
  1437 +# This tag requires that the tag USE_MATHJAX is set to YES.
  1438 +
  1439 +MATHJAX_FORMAT = HTML-CSS
  1440 +
  1441 +# When MathJax is enabled you need to specify the location relative to the HTML
  1442 +# output directory using the MATHJAX_RELPATH option. The destination directory
  1443 +# should contain the MathJax.js script. For instance, if the mathjax directory
  1444 +# is located at the same level as the HTML output directory, then
  1445 +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
  1446 +# Content Delivery Network so you can quickly see the result without installing
  1447 +# MathJax. However, it is strongly recommended to install a local copy of
  1448 +# MathJax from http://www.mathjax.org before deployment.
  1449 +# The default value is: http://cdn.mathjax.org/mathjax/latest.
  1450 +# This tag requires that the tag USE_MATHJAX is set to YES.
  1451 +
  1452 +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
  1453 +
  1454 +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
  1455 +# extension names that should be enabled during MathJax rendering. For example
  1456 +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
  1457 +# This tag requires that the tag USE_MATHJAX is set to YES.
  1458 +
  1459 +MATHJAX_EXTENSIONS =
  1460 +
  1461 +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
  1462 +# of code that will be used on startup of the MathJax code. See the MathJax site
  1463 +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
  1464 +# example see the documentation.
  1465 +# This tag requires that the tag USE_MATHJAX is set to YES.
  1466 +
  1467 +MATHJAX_CODEFILE =
  1468 +
  1469 +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
  1470 +# the HTML output. The underlying search engine uses javascript and DHTML and
  1471 +# should work on any modern browser. Note that when using HTML help
  1472 +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
  1473 +# there is already a search function so this one should typically be disabled.
  1474 +# For large projects the javascript based search engine can be slow, then
  1475 +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
  1476 +# search using the keyboard; to jump to the search box use <access key> + S
  1477 +# (what the <access key> is depends on the OS and browser, but it is typically
  1478 +# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
  1479 +# key> to jump into the search results window, the results can be navigated
  1480 +# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
  1481 +# the search. The filter options can be selected when the cursor is inside the
  1482 +# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
  1483 +# to select a filter and <Enter> or <escape> to activate or cancel the filter
  1484 +# option.
  1485 +# The default value is: YES.
  1486 +# This tag requires that the tag GENERATE_HTML is set to YES.
976 1487  
977 1488 SEARCHENGINE = YES
978 1489  
  1490 +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
  1491 +# implemented using a web server instead of a web client using Javascript. There
  1492 +# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
  1493 +# setting. When disabled, doxygen will generate a PHP script for searching and
  1494 +# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
  1495 +# and searching needs to be provided by external tools. See the section
  1496 +# "External Indexing and Searching" for details.
  1497 +# The default value is: NO.
  1498 +# This tag requires that the tag SEARCHENGINE is set to YES.
  1499 +
  1500 +SERVER_BASED_SEARCH = NO
  1501 +
  1502 +# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
  1503 +# script for searching. Instead the search results are written to an XML file
  1504 +# which needs to be processed by an external indexer. Doxygen will invoke an
  1505 +# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
  1506 +# search results.
  1507 +#
  1508 +# Doxygen ships with an example indexer (doxyindexer) and search engine
  1509 +# (doxysearch.cgi) which are based on the open source search engine library
  1510 +# Xapian (see: http://xapian.org/).
  1511 +#
  1512 +# See the section "External Indexing and Searching" for details.
  1513 +# The default value is: NO.
  1514 +# This tag requires that the tag SEARCHENGINE is set to YES.
  1515 +
  1516 +EXTERNAL_SEARCH = NO
  1517 +
  1518 +# The SEARCHENGINE_URL should point to a search engine hosted by a web server
  1519 +# which will return the search results when EXTERNAL_SEARCH is enabled.
  1520 +#
  1521 +# Doxygen ships with an example indexer (doxyindexer) and search engine
  1522 +# (doxysearch.cgi) which are based on the open source search engine library
  1523 +# Xapian (see: http://xapian.org/). See the section "External Indexing and
  1524 +# Searching" for details.
  1525 +# This tag requires that the tag SEARCHENGINE is set to YES.
  1526 +
  1527 +SEARCHENGINE_URL =
  1528 +
  1529 +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
  1530 +# search data is written to a file for indexing by an external tool. With the
  1531 +# SEARCHDATA_FILE tag the name of this file can be specified.
  1532 +# The default file is: searchdata.xml.
  1533 +# This tag requires that the tag SEARCHENGINE is set to YES.
  1534 +
  1535 +SEARCHDATA_FILE = searchdata.xml
  1536 +
  1537 +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
  1538 +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
  1539 +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
  1540 +# projects and redirect the results back to the right project.
  1541 +# This tag requires that the tag SEARCHENGINE is set to YES.
  1542 +
  1543 +EXTERNAL_SEARCH_ID =
  1544 +
  1545 +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
  1546 +# projects other than the one defined by this configuration file, but that are
  1547 +# all added to the same external search index. Each project needs to have a
  1548 +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
  1549 +# to a relative location where the documentation can be found. The format is:
  1550 +# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
  1551 +# This tag requires that the tag SEARCHENGINE is set to YES.
  1552 +
  1553 +EXTRA_SEARCH_MAPPINGS =
  1554 +
979 1555 #---------------------------------------------------------------------------
980   -# configuration options related to the LaTeX output
  1556 +# Configuration options related to the LaTeX output
981 1557 #---------------------------------------------------------------------------
982 1558  
983   -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
984   -# generate Latex output.
  1559 +# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
  1560 +# The default value is: YES.
985 1561  
986 1562 GENERATE_LATEX = YES
987 1563  
988   -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
989   -# If a relative path is entered the value of OUTPUT_DIRECTORY will be
990   -# put in front of it. If left blank `latex' will be used as the default path.
  1564 +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
  1565 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1566 +# it.
  1567 +# The default directory is: latex.
  1568 +# This tag requires that the tag GENERATE_LATEX is set to YES.
991 1569  
992 1570 LATEX_OUTPUT = latex
993 1571  
994 1572 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
995   -# invoked. If left blank `latex' will be used as the default command name.
  1573 +# invoked.
  1574 +#
  1575 +# Note that when enabling USE_PDFLATEX this option is only used for generating
  1576 +# bitmaps for formulas in the HTML output, but not in the Makefile that is
  1577 +# written to the output directory.
  1578 +# The default file is: latex.
  1579 +# This tag requires that the tag GENERATE_LATEX is set to YES.
996 1580  
997 1581 LATEX_CMD_NAME = latex
998 1582  
999   -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1000   -# generate index for LaTeX. If left blank `makeindex' will be used as the
1001   -# default command name.
  1583 +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
  1584 +# index for LaTeX.
  1585 +# The default file is: makeindex.
  1586 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1002 1587  
1003 1588 MAKEINDEX_CMD_NAME = makeindex
1004 1589  
1005   -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1006   -# LaTeX documents. This may be useful for small projects and may help to
1007   -# save some trees in general.
  1590 +# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
  1591 +# documents. This may be useful for small projects and may help to save some
  1592 +# trees in general.
  1593 +# The default value is: NO.
  1594 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1008 1595  
1009 1596 COMPACT_LATEX = NO
1010 1597  
1011   -# The PAPER_TYPE tag can be used to set the paper type that is used
1012   -# by the printer. Possible values are: a4, a4wide, letter, legal and
1013   -# executive. If left blank a4wide will be used.
  1598 +# The PAPER_TYPE tag can be used to set the paper type that is used by the
  1599 +# printer.
  1600 +# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
  1601 +# 14 inches) and executive (7.25 x 10.5 inches).
  1602 +# The default value is: a4.
  1603 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1014 1604  
1015 1605 PAPER_TYPE = a4wide
1016 1606  
1017   -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1018   -# packages that should be included in the LaTeX output.
  1607 +# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
  1608 +# that should be included in the LaTeX output. To get the times font for
  1609 +# instance you can specify
  1610 +# EXTRA_PACKAGES=times
  1611 +# If left blank no extra packages will be included.
  1612 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1019 1613  
1020 1614 EXTRA_PACKAGES =
1021 1615  
1022   -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1023   -# the generated latex document. The header should contain everything until
1024   -# the first chapter. If it is left blank doxygen will generate a
1025   -# standard header. Notice: only use this tag if you know what you are doing!
  1616 +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
  1617 +# generated LaTeX document. The header should contain everything until the first
  1618 +# chapter. If it is left blank doxygen will generate a standard header. See
  1619 +# section "Doxygen usage" for information on how to let doxygen write the
  1620 +# default header to a separate file.
  1621 +#
  1622 +# Note: Only use a user-defined header if you know what you are doing! The
  1623 +# following commands have a special meaning inside the header: $title,
  1624 +# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
  1625 +# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
  1626 +# string, for the replacement values of the other commands the user is referred
  1627 +# to HTML_HEADER.
  1628 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1026 1629  
1027 1630 LATEX_HEADER =
1028 1631  
1029   -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1030   -# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1031   -# contain links (just like the HTML output) instead of page references
1032   -# This makes the output suitable for online browsing using a pdf viewer.
  1632 +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
  1633 +# generated LaTeX document. The footer should contain everything after the last
  1634 +# chapter. If it is left blank doxygen will generate a standard footer. See
  1635 +# LATEX_HEADER for more information on how to generate a default footer and what
  1636 +# special commands can be used inside the footer.
  1637 +#
  1638 +# Note: Only use a user-defined footer if you know what you are doing!
  1639 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1640 +
  1641 +LATEX_FOOTER =
  1642 +
  1643 +# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
  1644 +# LaTeX style sheets that are included after the standard style sheets created
  1645 +# by doxygen. Using this option one can overrule certain style aspects. Doxygen
  1646 +# will copy the style sheet files to the output directory.
  1647 +# Note: The order of the extra style sheet files is of importance (e.g. the last
  1648 +# style sheet in the list overrules the setting of the previous ones in the
  1649 +# list).
  1650 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1651 +
  1652 +LATEX_EXTRA_STYLESHEET =
  1653 +
  1654 +# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
  1655 +# other source files which should be copied to the LATEX_OUTPUT output
  1656 +# directory. Note that the files will be copied as-is; there are no commands or
  1657 +# markers available.
  1658 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1659 +
  1660 +LATEX_EXTRA_FILES =
  1661 +
  1662 +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
  1663 +# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
  1664 +# contain links (just like the HTML output) instead of page references. This
  1665 +# makes the output suitable for online browsing using a PDF viewer.
  1666 +# The default value is: YES.
  1667 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1033 1668  
1034 1669 PDF_HYPERLINKS = YES
1035 1670  
1036   -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1037   -# plain latex in the generated Makefile. Set this option to YES to get a
  1671 +# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
  1672 +# the PDF file directly from the LaTeX files. Set this option to YES, to get a
1038 1673 # higher quality PDF documentation.
  1674 +# The default value is: YES.
  1675 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1039 1676  
1040 1677 USE_PDFLATEX = YES
1041 1678  
1042   -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1043   -# command to the generated LaTeX files. This will instruct LaTeX to keep
1044   -# running if errors occur, instead of asking the user for help.
1045   -# This option is also used when generating formulas in HTML.
  1679 +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
  1680 +# command to the generated LaTeX files. This will instruct LaTeX to keep running
  1681 +# if errors occur, instead of asking the user for help. This option is also used
  1682 +# when generating formulas in HTML.
  1683 +# The default value is: NO.
  1684 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1046 1685  
1047 1686 LATEX_BATCHMODE = NO
1048 1687  
1049   -# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1050   -# include the index chapters (such as File Index, Compound Index, etc.)
1051   -# in the output.
  1688 +# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
  1689 +# index chapters (such as File Index, Compound Index, etc.) in the output.
  1690 +# The default value is: NO.
  1691 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1052 1692  
1053 1693 LATEX_HIDE_INDICES = NO
1054 1694  
1055   -# If LATEX_SOURCE_CODE 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.
  1695 +# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
  1696 +# code with syntax highlighting in the LaTeX output.
  1697 +#
  1698 +# Note that which sources are shown also depends on other settings such as
  1699 +# SOURCE_BROWSER.
  1700 +# The default value is: NO.
  1701 +# This tag requires that the tag GENERATE_LATEX is set to YES.
1056 1702  
1057 1703 LATEX_SOURCE_CODE = NO
1058 1704  
  1705 +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
  1706 +# bibliography, e.g. plainnat, or ieeetr. See
  1707 +# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
  1708 +# The default value is: plain.
  1709 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1710 +
  1711 +LATEX_BIB_STYLE = plain
  1712 +
1059 1713 #---------------------------------------------------------------------------
1060   -# configuration options related to the RTF output
  1714 +# Configuration options related to the RTF output
1061 1715 #---------------------------------------------------------------------------
1062 1716  
1063   -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1064   -# The RTF output is optimized for Word 97 and may not look very pretty with
1065   -# other RTF readers or editors.
  1717 +# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
  1718 +# RTF output is optimized for Word 97 and may not look too pretty with other RTF
  1719 +# readers/editors.
  1720 +# The default value is: NO.
1066 1721  
1067 1722 GENERATE_RTF = NO
1068 1723  
1069   -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1070   -# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1071   -# put in front of it. If left blank `rtf' will be used as the default path.
  1724 +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
  1725 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1726 +# it.
  1727 +# The default directory is: rtf.
  1728 +# This tag requires that the tag GENERATE_RTF is set to YES.
1072 1729  
1073 1730 RTF_OUTPUT = rtf
1074 1731  
1075   -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1076   -# RTF documents. This may be useful for small projects and may help to
1077   -# save some trees in general.
  1732 +# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
  1733 +# documents. This may be useful for small projects and may help to save some
  1734 +# trees in general.
  1735 +# The default value is: NO.
  1736 +# This tag requires that the tag GENERATE_RTF is set to YES.
1078 1737  
1079 1738 COMPACT_RTF = NO
1080 1739  
1081   -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1082   -# will contain hyperlink fields. The RTF file will
1083   -# contain links (just like the HTML output) instead of page references.
1084   -# This makes the output suitable for online browsing using WORD or other
1085   -# programs which support those fields.
1086   -# Note: wordpad (write) and others do not support links.
  1740 +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
  1741 +# contain hyperlink fields. The RTF file will contain links (just like the HTML
  1742 +# output) instead of page references. This makes the output suitable for online
  1743 +# browsing using Word or some other Word compatible readers that support those
  1744 +# fields.
  1745 +#
  1746 +# Note: WordPad (write) and others do not support links.
  1747 +# The default value is: NO.
  1748 +# This tag requires that the tag GENERATE_RTF is set to YES.
1087 1749  
1088 1750 RTF_HYPERLINKS = NO
1089 1751  
1090   -# Load stylesheet definitions from file. Syntax is similar to doxygen's
1091   -# config file, i.e. a series of assignments. You only have to provide
1092   -# replacements, missing definitions are set to their default value.
  1752 +# Load stylesheet definitions from file. Syntax is similar to doxygen's config
  1753 +# file, i.e. a series of assignments. You only have to provide replacements,
  1754 +# missing definitions are set to their default value.
  1755 +#
  1756 +# See also section "Doxygen usage" for information on how to generate the
  1757 +# default style sheet that doxygen normally uses.
  1758 +# This tag requires that the tag GENERATE_RTF is set to YES.
1093 1759  
1094 1760 RTF_STYLESHEET_FILE =
1095 1761  
1096   -# Set optional variables used in the generation of an rtf document.
1097   -# Syntax is similar to doxygen's config file.
  1762 +# Set optional variables used in the generation of an RTF document. Syntax is
  1763 +# similar to doxygen's config file. A template extensions file can be generated
  1764 +# using doxygen -e rtf extensionFile.
  1765 +# This tag requires that the tag GENERATE_RTF is set to YES.
1098 1766  
1099 1767 RTF_EXTENSIONS_FILE =
1100 1768  
  1769 +# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
  1770 +# with syntax highlighting in the RTF output.
  1771 +#
  1772 +# Note that which sources are shown also depends on other settings such as
  1773 +# SOURCE_BROWSER.
  1774 +# The default value is: NO.
  1775 +# This tag requires that the tag GENERATE_RTF is set to YES.
  1776 +
  1777 +RTF_SOURCE_CODE = NO
  1778 +
1101 1779 #---------------------------------------------------------------------------
1102   -# configuration options related to the man page output
  1780 +# Configuration options related to the man page output
1103 1781 #---------------------------------------------------------------------------
1104 1782  
1105   -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1106   -# generate man pages
  1783 +# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
  1784 +# classes and files.
  1785 +# The default value is: NO.
1107 1786  
1108 1787 GENERATE_MAN = NO
1109 1788  
1110   -# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1111   -# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1112   -# put in front of it. If left blank `man' will be used as the default path.
  1789 +# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
  1790 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1791 +# it. A directory man3 will be created inside the directory specified by
  1792 +# MAN_OUTPUT.
  1793 +# The default directory is: man.
  1794 +# This tag requires that the tag GENERATE_MAN is set to YES.
1113 1795  
1114 1796 MAN_OUTPUT = man
1115 1797  
1116   -# The MAN_EXTENSION tag determines the extension that is added to
1117   -# the generated man pages (default is the subroutine's section .3)
  1798 +# The MAN_EXTENSION tag determines the extension that is added to the generated
  1799 +# man pages. In case the manual section does not start with a number, the number
  1800 +# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
  1801 +# optional.
  1802 +# The default value is: .3.
  1803 +# This tag requires that the tag GENERATE_MAN is set to YES.
1118 1804  
1119 1805 MAN_EXTENSION = .3
1120 1806  
1121   -# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1122   -# then it will generate one additional man file for each entity
1123   -# documented in the real man page(s). These additional files
1124   -# only source the real man page, but without them the man command
1125   -# would be unable to find the correct page. The default is NO.
  1807 +# The MAN_SUBDIR tag determines the name of the directory created within
  1808 +# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
  1809 +# MAN_EXTENSION with the initial . removed.
  1810 +# This tag requires that the tag GENERATE_MAN is set to YES.
  1811 +
  1812 +MAN_SUBDIR =
  1813 +
  1814 +# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
  1815 +# will generate one additional man file for each entity documented in the real
  1816 +# man page(s). These additional files only source the real man page, but without
  1817 +# them the man command would be unable to find the correct page.
  1818 +# The default value is: NO.
  1819 +# This tag requires that the tag GENERATE_MAN is set to YES.
1126 1820  
1127 1821 MAN_LINKS = NO
1128 1822  
1129 1823 #---------------------------------------------------------------------------
1130   -# configuration options related to the XML output
  1824 +# Configuration options related to the XML output
1131 1825 #---------------------------------------------------------------------------
1132 1826  
1133   -# If the GENERATE_XML tag is set to YES Doxygen will
1134   -# generate an XML file that captures the structure of
1135   -# the code including all documentation.
  1827 +# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
  1828 +# captures the structure of the code including all documentation.
  1829 +# The default value is: NO.
1136 1830  
1137 1831 GENERATE_XML = NO
1138 1832  
1139   -# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1140   -# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1141   -# put in front of it. If left blank `xml' will be used as the default path.
  1833 +# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
  1834 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1835 +# it.
  1836 +# The default directory is: xml.
  1837 +# This tag requires that the tag GENERATE_XML is set to YES.
1142 1838  
1143 1839 XML_OUTPUT = xml
1144 1840  
1145   -# The XML_SCHEMA tag can be used to specify an XML schema,
1146   -# which can be used by a validating XML parser to check the
1147   -# syntax of the XML files.
  1841 +# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
  1842 +# listings (including syntax highlighting and cross-referencing information) to
  1843 +# the XML output. Note that enabling this will significantly increase the size
  1844 +# of the XML output.
  1845 +# The default value is: YES.
  1846 +# This tag requires that the tag GENERATE_XML is set to YES.
  1847 +
  1848 +XML_PROGRAMLISTING = YES
1148 1849  
1149   -XML_SCHEMA =
  1850 +#---------------------------------------------------------------------------
  1851 +# Configuration options related to the DOCBOOK output
  1852 +#---------------------------------------------------------------------------
1150 1853  
1151   -# The XML_DTD tag can be used to specify an XML DTD,
1152   -# which can be used by a validating XML parser to check the
1153   -# syntax of the XML files.
  1854 +# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
  1855 +# that can be used to generate PDF.
  1856 +# The default value is: NO.
1154 1857  
1155   -XML_DTD =
  1858 +GENERATE_DOCBOOK = NO
1156 1859  
1157   -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1158   -# dump the program listings (including syntax highlighting
1159   -# and cross-referencing information) to the XML output. Note that
1160   -# enabling this will significantly increase the size of the XML output.
  1860 +# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
  1861 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
  1862 +# front of it.
  1863 +# The default directory is: docbook.
  1864 +# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1161 1865  
1162   -XML_PROGRAMLISTING = YES
  1866 +DOCBOOK_OUTPUT = docbook
  1867 +
  1868 +# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
  1869 +# program listings (including syntax highlighting and cross-referencing
  1870 +# information) to the DOCBOOK output. Note that enabling this will significantly
  1871 +# increase the size of the DOCBOOK output.
  1872 +# The default value is: NO.
  1873 +# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
  1874 +
  1875 +DOCBOOK_PROGRAMLISTING = NO
1163 1876  
1164 1877 #---------------------------------------------------------------------------
1165   -# configuration options for the AutoGen Definitions output
  1878 +# Configuration options for the AutoGen Definitions output
1166 1879 #---------------------------------------------------------------------------
1167 1880  
1168   -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1169   -# generate an AutoGen Definitions (see autogen.sf.net) file
1170   -# that captures the structure of the code including all
1171   -# documentation. Note that this feature is still experimental
1172   -# and incomplete at the moment.
  1881 +# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
  1882 +# AutoGen Definitions (see http://autogen.sf.net) file that captures the
  1883 +# structure of the code including all documentation. Note that this feature is
  1884 +# still experimental and incomplete at the moment.
  1885 +# The default value is: NO.
1173 1886  
1174 1887 GENERATE_AUTOGEN_DEF = NO
1175 1888  
1176 1889 #---------------------------------------------------------------------------
1177   -# configuration options related to the Perl module output
  1890 +# Configuration options related to the Perl module output
1178 1891 #---------------------------------------------------------------------------
1179 1892  
1180   -# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1181   -# generate a Perl module file that captures the structure of
1182   -# the code including all documentation. Note that this
1183   -# feature is still experimental and incomplete at the
1184   -# moment.
  1893 +# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
  1894 +# file that captures the structure of the code including all documentation.
  1895 +#
  1896 +# Note that this feature is still experimental and incomplete at the moment.
  1897 +# The default value is: NO.
1185 1898  
1186 1899 GENERATE_PERLMOD = NO
1187 1900  
1188   -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1189   -# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1190   -# to generate PDF and DVI output from the Perl module output.
  1901 +# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
  1902 +# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
  1903 +# output from the Perl module output.
  1904 +# The default value is: NO.
  1905 +# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1191 1906  
1192 1907 PERLMOD_LATEX = NO
1193 1908  
1194   -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1195   -# nicely formatted so it can be parsed by a human reader.
1196   -# This is useful
1197   -# if you want to understand what is going on.
1198   -# On the other hand, if this
1199   -# tag is set to NO the size of the Perl module output will be much smaller
1200   -# and Perl will parse it just the same.
  1909 +# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
  1910 +# formatted so it can be parsed by a human reader. This is useful if you want to
  1911 +# understand what is going on. On the other hand, if this tag is set to NO, the
  1912 +# size of the Perl module output will be much smaller and Perl will parse it
  1913 +# just the same.
  1914 +# The default value is: YES.
  1915 +# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1201 1916  
1202 1917 PERLMOD_PRETTY = YES
1203 1918  
1204   -# The names of the make variables in the generated doxyrules.make file
1205   -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1206   -# This is useful so different doxyrules.make files included by the same
1207   -# Makefile don't overwrite each other's variables.
  1919 +# The names of the make variables in the generated doxyrules.make file are
  1920 +# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
  1921 +# so different doxyrules.make files included by the same Makefile don't
  1922 +# overwrite each other's variables.
  1923 +# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1208 1924  
1209 1925 PERLMOD_MAKEVAR_PREFIX =
1210 1926  
... ... @@ -1212,110 +1928,129 @@ PERLMOD_MAKEVAR_PREFIX =
1212 1928 # Configuration options related to the preprocessor
1213 1929 #---------------------------------------------------------------------------
1214 1930  
1215   -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1216   -# evaluate all C-preprocessor directives found in the sources and include
1217   -# files.
  1931 +# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
  1932 +# C-preprocessor directives found in the sources and include files.
  1933 +# The default value is: YES.
1218 1934  
1219 1935 ENABLE_PREPROCESSING = YES
1220 1936  
1221   -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1222   -# names in the source code. If set to NO (the default) only conditional
1223   -# compilation will be performed. Macro expansion can be done in a controlled
1224   -# way by setting EXPAND_ONLY_PREDEF to YES.
  1937 +# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
  1938 +# in the source code. If set to NO, only conditional compilation will be
  1939 +# performed. Macro expansion can be done in a controlled way by setting
  1940 +# EXPAND_ONLY_PREDEF to YES.
  1941 +# The default value is: NO.
  1942 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1225 1943  
1226 1944 MACRO_EXPANSION = NO
1227 1945  
1228   -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1229   -# then the macro expansion is limited to the macros specified with the
1230   -# PREDEFINED and EXPAND_AS_DEFINED tags.
  1946 +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
  1947 +# the macro expansion is limited to the macros specified with the PREDEFINED and
  1948 +# EXPAND_AS_DEFINED tags.
  1949 +# The default value is: NO.
  1950 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1231 1951  
1232 1952 EXPAND_ONLY_PREDEF = NO
1233 1953  
1234   -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1235   -# in the INCLUDE_PATH (see below) will be search if a #include is found.
  1954 +# If the SEARCH_INCLUDES tag is set to YES, the include files in the
  1955 +# INCLUDE_PATH will be searched if a #include is found.
  1956 +# The default value is: YES.
  1957 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1236 1958  
1237 1959 SEARCH_INCLUDES = YES
1238 1960  
1239 1961 # The INCLUDE_PATH tag can be used to specify one or more directories that
1240   -# contain include files that are not input files but should be processed by
1241   -# the preprocessor.
  1962 +# contain include files that are not input files but should be processed by the
  1963 +# preprocessor.
  1964 +# This tag requires that the tag SEARCH_INCLUDES is set to YES.
1242 1965  
1243 1966 INCLUDE_PATH =
1244 1967  
1245 1968 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1246 1969 # patterns (like *.h and *.hpp) to filter out the header-files in the
1247   -# directories. If left blank, the patterns specified with FILE_PATTERNS will
1248   -# be used.
  1970 +# directories. If left blank, the patterns specified with FILE_PATTERNS will be
  1971 +# used.
  1972 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1249 1973  
1250 1974 INCLUDE_FILE_PATTERNS =
1251 1975  
1252   -# The PREDEFINED tag can be used to specify one or more macro names that
1253   -# are defined before the preprocessor is started (similar to the -D option of
1254   -# gcc). The argument of the tag is a list of macros of the form: name
1255   -# or name=definition (no spaces). If the definition and the = are
1256   -# omitted =1 is assumed. To prevent a macro definition from being
1257   -# undefined via #undef or recursively expanded use the := operator
1258   -# instead of the = operator.
  1976 +# The PREDEFINED tag can be used to specify one or more macro names that are
  1977 +# defined before the preprocessor is started (similar to the -D option of e.g.
  1978 +# gcc). The argument of the tag is a list of macros of the form: name or
  1979 +# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
  1980 +# is assumed. To prevent a macro definition from being undefined via #undef or
  1981 +# recursively expanded use the := operator instead of the = operator.
  1982 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1259 1983  
1260 1984 PREDEFINED = $(DEFINES)
1261 1985  
1262   -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1263   -# this tag can be used to specify a list of macro names that should be expanded.
1264   -# The macro definition that is found in the sources will be used.
1265   -# Use the PREDEFINED tag if you want to use a different macro definition.
  1986 +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
  1987 +# tag can be used to specify a list of macro names that should be expanded. The
  1988 +# macro definition that is found in the sources will be used. Use the PREDEFINED
  1989 +# tag if you want to use a different macro definition that overrules the
  1990 +# definition found in the source code.
  1991 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1266 1992  
1267 1993 EXPAND_AS_DEFINED =
1268 1994  
1269   -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1270   -# doxygen's preprocessor will remove all function-like macros that are alone
1271   -# on a line, have an all uppercase name, and do not end with a semicolon. Such
1272   -# function macros are typically used for boiler-plate code, and will confuse
1273   -# the parser if not removed.
  1995 +# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
  1996 +# remove all references to function-like macros that are alone on a line, have
  1997 +# an all uppercase name, and do not end with a semicolon. Such function macros
  1998 +# are typically used for boiler-plate code, and will confuse the parser if not
  1999 +# removed.
  2000 +# The default value is: YES.
  2001 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1274 2002  
1275 2003 SKIP_FUNCTION_MACROS = YES
1276 2004  
1277 2005 #---------------------------------------------------------------------------
1278   -# Configuration::additions related to external references
  2006 +# Configuration options related to external references
1279 2007 #---------------------------------------------------------------------------
1280 2008  
1281   -# The TAGFILES option can be used to specify one or more tagfiles.
1282   -# Optionally an initial location of the external documentation
1283   -# can be added for each tagfile. The format of a tag file without
1284   -# this location is as follows:
1285   -#
  2009 +# The TAGFILES tag can be used to specify one or more tag files. For each tag
  2010 +# file the location of the external documentation should be added. The format of
  2011 +# a tag file without this location is as follows:
1286 2012 # TAGFILES = file1 file2 ...
1287 2013 # Adding location for the tag files is done as follows:
1288   -#
1289 2014 # TAGFILES = file1=loc1 "file2 = loc2" ...
1290   -# where "loc1" and "loc2" can be relative or absolute paths or
1291   -# URLs. If a location is present for each tag, the installdox tool
1292   -# does not have to be run to correct the links.
1293   -# Note that each tag file must have a unique name
1294   -# (where the name does NOT include the path)
1295   -# If a tag file is not located in the directory in which doxygen
1296   -# is run, you must also specify the path to the tagfile here.
  2015 +# where loc1 and loc2 can be relative or absolute paths or URLs. See the
  2016 +# section "Linking to external documentation" for more information about the use
  2017 +# of tag files.
  2018 +# Note: Each tag file must have a unique name (where the name does NOT include
  2019 +# the path). If a tag file is not located in the directory in which doxygen is
  2020 +# run, you must also specify the path to the tagfile here.
1297 2021  
1298 2022 TAGFILES =
1299 2023  
1300   -# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1301   -# a tag file that is based on the input files it reads.
  2024 +# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
  2025 +# tag file that is based on the input files it reads. See section "Linking to
  2026 +# external documentation" for more information about the usage of tag files.
1302 2027  
1303 2028 GENERATE_TAGFILE =
1304 2029  
1305   -# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1306   -# in the class index. If set to NO only the inherited external classes
1307   -# will be listed.
  2030 +# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
  2031 +# the class index. If set to NO, only the inherited external classes will be
  2032 +# listed.
  2033 +# The default value is: NO.
1308 2034  
1309 2035 ALLEXTERNALS = NO
1310 2036  
1311   -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1312   -# in the modules index. If set to NO, only the current project's groups will
1313   -# be listed.
  2037 +# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
  2038 +# in the modules index. If set to NO, only the current project's groups will be
  2039 +# listed.
  2040 +# The default value is: YES.
1314 2041  
1315 2042 EXTERNAL_GROUPS = YES
1316 2043  
  2044 +# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
  2045 +# the related pages index. If set to NO, only the current project's pages will
  2046 +# be listed.
  2047 +# The default value is: YES.
  2048 +
  2049 +EXTERNAL_PAGES = YES
  2050 +
1317 2051 # The PERL_PATH should be the absolute path and name of the perl script
1318   -# interpreter (i.e. the result of `which perl').
  2052 +# interpreter (i.e. the result of 'which perl').
  2053 +# The default file (with absolute path) is: /usr/bin/perl.
1319 2054  
1320 2055 PERL_PATH = /usr/bin/perl
1321 2056  
... ... @@ -1323,192 +2058,306 @@ PERL_PATH = /usr/bin/perl
1323 2058 # Configuration options related to the dot tool
1324 2059 #---------------------------------------------------------------------------
1325 2060  
1326   -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1327   -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1328   -# or super classes. Setting the tag to NO turns the diagrams off. Note that
1329   -# this option is superseded by the HAVE_DOT option below. This is only a
1330   -# fallback. It is recommended to install and use dot, since it yields more
  2061 +# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
  2062 +# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
  2063 +# NO turns the diagrams off. Note that this option also works with HAVE_DOT
  2064 +# disabled, but it is recommended to install and use dot, since it yields more
1331 2065 # powerful graphs.
  2066 +# The default value is: YES.
1332 2067  
1333 2068 CLASS_DIAGRAMS = YES
1334 2069  
1335 2070 # You can define message sequence charts within doxygen comments using the \msc
1336   -# command. Doxygen will then run the mscgen tool (see
1337   -# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
  2071 +# command. Doxygen will then run the mscgen tool (see:
  2072 +# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
1338 2073 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1339 2074 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1340 2075 # default search path.
1341 2076  
1342 2077 MSCGEN_PATH =
1343 2078  
1344   -# If set to YES, the inheritance and collaboration graphs will hide
1345   -# inheritance and usage relations if the target is undocumented
1346   -# or is not a class.
  2079 +# You can include diagrams made with dia in doxygen documentation. Doxygen will
  2080 +# then run dia to produce the diagram and insert it in the documentation. The
  2081 +# DIA_PATH tag allows you to specify the directory where the dia binary resides.
  2082 +# If left empty dia is assumed to be found in the default search path.
  2083 +
  2084 +DIA_PATH =
  2085 +
  2086 +# If set to YES the inheritance and collaboration graphs will hide inheritance
  2087 +# and usage relations if the target is undocumented or is not a class.
  2088 +# The default value is: YES.
1347 2089  
1348 2090 HIDE_UNDOC_RELATIONS = YES
1349 2091  
1350 2092 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1351   -# available from the path. This tool is part of Graphviz, a graph visualization
1352   -# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1353   -# have no effect if this option is set to NO (the default)
  2093 +# available from the path. This tool is part of Graphviz (see:
  2094 +# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
  2095 +# Bell Labs. The other options in this section have no effect if this option is
  2096 +# set to NO
  2097 +# The default value is: NO.
1354 2098  
1355 2099 HAVE_DOT = NO
1356 2100  
1357   -# By default doxygen will write a font called FreeSans.ttf to the output
1358   -# directory and reference it in all dot files that doxygen generates. This
1359   -# font does not include all possible unicode characters however, so when you need
1360   -# these (or just want a differently looking font) you can specify the font name
1361   -# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1362   -# which can be done by putting it in a standard location or by setting the
1363   -# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1364   -# containing the font.
  2101 +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
  2102 +# to run in parallel. When set to 0 doxygen will base this on the number of
  2103 +# processors available in the system. You can set it explicitly to a value
  2104 +# larger than 0 to get control over the balance between CPU load and processing
  2105 +# speed.
  2106 +# Minimum value: 0, maximum value: 32, default value: 0.
  2107 +# This tag requires that the tag HAVE_DOT is set to YES.
  2108 +
  2109 +DOT_NUM_THREADS = 0
  2110 +
  2111 +# When you want a differently looking font in the dot files that doxygen
  2112 +# generates you can specify the font name using DOT_FONTNAME. You need to make
  2113 +# sure dot is able to find the font, which can be done by putting it in a
  2114 +# standard location or by setting the DOTFONTPATH environment variable or by
  2115 +# setting DOT_FONTPATH to the directory containing the font.
  2116 +# The default value is: Helvetica.
  2117 +# This tag requires that the tag HAVE_DOT is set to YES.
1365 2118  
1366 2119 DOT_FONTNAME = FreeSans
1367 2120  
1368   -# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1369   -# The default size is 10pt.
  2121 +# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
  2122 +# dot graphs.
  2123 +# Minimum value: 4, maximum value: 24, default value: 10.
  2124 +# This tag requires that the tag HAVE_DOT is set to YES.
1370 2125  
1371 2126 DOT_FONTSIZE = 10
1372 2127  
1373   -# By default doxygen will tell dot to use the output directory to look for the
1374   -# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1375   -# different font using DOT_FONTNAME you can set the path where dot
1376   -# can find it using this tag.
  2128 +# By default doxygen will tell dot to use the default font as specified with
  2129 +# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
  2130 +# the path where dot can find it using this tag.
  2131 +# This tag requires that the tag HAVE_DOT is set to YES.
1377 2132  
1378 2133 DOT_FONTPATH =
1379 2134  
1380   -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1381   -# will generate a graph for each documented class showing the direct and
1382   -# indirect inheritance relations. Setting this tag to YES will force the
1383   -# the CLASS_DIAGRAMS tag to NO.
  2135 +# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
  2136 +# each documented class showing the direct and indirect inheritance relations.
  2137 +# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
  2138 +# The default value is: YES.
  2139 +# This tag requires that the tag HAVE_DOT is set to YES.
1384 2140  
1385 2141 CLASS_GRAPH = YES
1386 2142  
1387   -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1388   -# will generate a graph for each documented class showing the direct and
1389   -# indirect implementation dependencies (inheritance, containment, and
1390   -# class references variables) of the class with other documented classes.
  2143 +# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
  2144 +# graph for each documented class showing the direct and indirect implementation
  2145 +# dependencies (inheritance, containment, and class references variables) of the
  2146 +# class with other documented classes.
  2147 +# The default value is: YES.
  2148 +# This tag requires that the tag HAVE_DOT is set to YES.
1391 2149  
1392 2150 COLLABORATION_GRAPH = YES
1393 2151  
1394   -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1395   -# will generate a graph for groups, showing the direct groups dependencies
  2152 +# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
  2153 +# groups, showing the direct groups dependencies.
  2154 +# The default value is: YES.
  2155 +# This tag requires that the tag HAVE_DOT is set to YES.
1396 2156  
1397 2157 GROUP_GRAPHS = YES
1398 2158  
1399   -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
  2159 +# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
1400 2160 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1401 2161 # Language.
  2162 +# The default value is: NO.
  2163 +# This tag requires that the tag HAVE_DOT is set to YES.
1402 2164  
1403 2165 UML_LOOK = NO
1404 2166  
1405   -# If set to YES, the inheritance and collaboration graphs will show the
1406   -# relations between templates and their instances.
  2167 +# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
  2168 +# class node. If there are many fields or methods and many nodes the graph may
  2169 +# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
  2170 +# number of items for each type to make the size more manageable. Set this to 0
  2171 +# for no limit. Note that the threshold may be exceeded by 50% before the limit
  2172 +# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
  2173 +# but if the number exceeds 15, the total amount of fields shown is limited to
  2174 +# 10.
  2175 +# Minimum value: 0, maximum value: 100, default value: 10.
  2176 +# This tag requires that the tag HAVE_DOT is set to YES.
  2177 +
  2178 +UML_LIMIT_NUM_FIELDS = 10
  2179 +
  2180 +# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
  2181 +# collaboration graphs will show the relations between templates and their
  2182 +# instances.
  2183 +# The default value is: NO.
  2184 +# This tag requires that the tag HAVE_DOT is set to YES.
1407 2185  
1408 2186 TEMPLATE_RELATIONS = NO
1409 2187  
1410   -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1411   -# tags are set to YES then doxygen will generate a graph for each documented
1412   -# file showing the direct and indirect include dependencies of the file with
1413   -# other documented files.
  2188 +# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
  2189 +# YES then doxygen will generate a graph for each documented file showing the
  2190 +# direct and indirect include dependencies of the file with other documented
  2191 +# files.
  2192 +# The default value is: YES.
  2193 +# This tag requires that the tag HAVE_DOT is set to YES.
1414 2194  
1415 2195 INCLUDE_GRAPH = YES
1416 2196  
1417   -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1418   -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1419   -# documented header file showing the documented files that directly or
1420   -# indirectly include this file.
  2197 +# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
  2198 +# set to YES then doxygen will generate a graph for each documented file showing
  2199 +# the direct and indirect include dependencies of the file with other documented
  2200 +# files.
  2201 +# The default value is: YES.
  2202 +# This tag requires that the tag HAVE_DOT is set to YES.
1421 2203  
1422 2204 INCLUDED_BY_GRAPH = YES
1423 2205  
1424   -# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1425   -# doxygen will generate a call dependency graph for every global function
1426   -# or class method. Note that enabling this option will significantly increase
1427   -# the time of a run. So in most cases it will be better to enable call graphs
1428   -# for selected functions only using the \callgraph command.
  2206 +# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
  2207 +# dependency graph for every global function or class method.
  2208 +#
  2209 +# Note that enabling this option will significantly increase the time of a run.
  2210 +# So in most cases it will be better to enable call graphs for selected
  2211 +# functions only using the \callgraph command.
  2212 +# The default value is: NO.
  2213 +# This tag requires that the tag HAVE_DOT is set to YES.
1429 2214  
1430 2215 CALL_GRAPH = NO
1431 2216  
1432   -# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1433   -# doxygen will generate a caller dependency graph for every global function
1434   -# or class method. Note that enabling this option will significantly increase
1435   -# the time of a run. So in most cases it will be better to enable caller
1436   -# graphs for selected functions only using the \callergraph command.
  2217 +# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
  2218 +# dependency graph for every global function or class method.
  2219 +#
  2220 +# Note that enabling this option will significantly increase the time of a run.
  2221 +# So in most cases it will be better to enable caller graphs for selected
  2222 +# functions only using the \callergraph command.
  2223 +# The default value is: NO.
  2224 +# This tag requires that the tag HAVE_DOT is set to YES.
1437 2225  
1438 2226 CALLER_GRAPH = NO
1439 2227  
1440   -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1441   -# will graphical hierarchy of all classes instead of a textual one.
  2228 +# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
  2229 +# hierarchy of all classes instead of a textual one.
  2230 +# The default value is: YES.
  2231 +# This tag requires that the tag HAVE_DOT is set to YES.
1442 2232  
1443 2233 GRAPHICAL_HIERARCHY = YES
1444 2234  
1445   -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1446   -# then doxygen will show the dependencies a directory has on other directories
1447   -# in a graphical way. The dependency relations are determined by the #include
1448   -# relations between the files in the directories.
  2235 +# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
  2236 +# dependencies a directory has on other directories in a graphical way. The
  2237 +# dependency relations are determined by the #include relations between the
  2238 +# files in the directories.
  2239 +# The default value is: YES.
  2240 +# This tag requires that the tag HAVE_DOT is set to YES.
1449 2241  
1450 2242 DIRECTORY_GRAPH = YES
1451 2243  
1452 2244 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1453   -# generated by dot. Possible values are png, jpg, or gif
1454   -# If left blank png will be used.
  2245 +# generated by dot.
  2246 +# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
  2247 +# to make the SVG files visible in IE 9+ (other browsers do not have this
  2248 +# requirement).
  2249 +# Possible values are: png, jpg, gif and svg.
  2250 +# The default value is: png.
  2251 +# This tag requires that the tag HAVE_DOT is set to YES.
1455 2252  
1456 2253 DOT_IMAGE_FORMAT = png
1457 2254  
1458   -# The tag DOT_PATH can be used to specify the path where the dot tool can be
  2255 +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
  2256 +# enable generation of interactive SVG images that allow zooming and panning.
  2257 +#
  2258 +# Note that this requires a modern browser other than Internet Explorer. Tested
  2259 +# and working are Firefox, Chrome, Safari, and Opera.
  2260 +# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
  2261 +# the SVG files visible. Older versions of IE do not have SVG support.
  2262 +# The default value is: NO.
  2263 +# This tag requires that the tag HAVE_DOT is set to YES.
  2264 +
  2265 +INTERACTIVE_SVG = NO
  2266 +
  2267 +# The DOT_PATH tag can be used to specify the path where the dot tool can be
1459 2268 # found. If left blank, it is assumed the dot tool can be found in the path.
  2269 +# This tag requires that the tag HAVE_DOT is set to YES.
1460 2270  
1461 2271 DOT_PATH =
1462 2272  
1463 2273 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1464   -# contain dot files that are included in the documentation (see the
1465   -# \dotfile command).
  2274 +# contain dot files that are included in the documentation (see the \dotfile
  2275 +# command).
  2276 +# This tag requires that the tag HAVE_DOT is set to YES.
1466 2277  
1467 2278 DOTFILE_DIRS =
1468 2279  
1469   -# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1470   -# nodes that will be shown in the graph. If the number of nodes in a graph
1471   -# becomes larger than this value, doxygen will truncate the graph, which is
1472   -# visualized by representing a node as a red box. Note that doxygen if the
1473   -# number of direct children of the root node in a graph is already larger than
1474   -# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1475   -# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  2280 +# The MSCFILE_DIRS tag can be used to specify one or more directories that
  2281 +# contain msc files that are included in the documentation (see the \mscfile
  2282 +# command).
  2283 +
  2284 +MSCFILE_DIRS =
  2285 +
  2286 +# The DIAFILE_DIRS tag can be used to specify one or more directories that
  2287 +# contain dia files that are included in the documentation (see the \diafile
  2288 +# command).
  2289 +
  2290 +DIAFILE_DIRS =
  2291 +
  2292 +# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
  2293 +# path where java can find the plantuml.jar file. If left blank, it is assumed
  2294 +# PlantUML is not used or called during a preprocessing step. Doxygen will
  2295 +# generate a warning when it encounters a \startuml command in this case and
  2296 +# will not generate output for the diagram.
  2297 +
  2298 +PLANTUML_JAR_PATH =
  2299 +
  2300 +# When using plantuml, the specified paths are searched for files specified by
  2301 +# the !include statement in a plantuml block.
  2302 +
  2303 +PLANTUML_INCLUDE_PATH =
  2304 +
  2305 +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
  2306 +# that will be shown in the graph. If the number of nodes in a graph becomes
  2307 +# larger than this value, doxygen will truncate the graph, which is visualized
  2308 +# by representing a node as a red box. Note that doxygen if the number of direct
  2309 +# children of the root node in a graph is already larger than
  2310 +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
  2311 +# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  2312 +# Minimum value: 0, maximum value: 10000, default value: 50.
  2313 +# This tag requires that the tag HAVE_DOT is set to YES.
1476 2314  
1477 2315 DOT_GRAPH_MAX_NODES = 50
1478 2316  
1479   -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1480   -# graphs generated by dot. A depth value of 3 means that only nodes reachable
1481   -# from the root by following a path via at most 3 edges will be shown. Nodes
1482   -# that lay further from the root node will be omitted. Note that setting this
1483   -# option to 1 or 2 may greatly reduce the computation time needed for large
1484   -# code bases. Also note that the size of a graph can be further restricted by
  2317 +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
  2318 +# generated by dot. A depth value of 3 means that only nodes reachable from the
  2319 +# root by following a path via at most 3 edges will be shown. Nodes that lay
  2320 +# further from the root node will be omitted. Note that setting this option to 1
  2321 +# or 2 may greatly reduce the computation time needed for large code bases. Also
  2322 +# note that the size of a graph can be further restricted by
1485 2323 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
  2324 +# Minimum value: 0, maximum value: 1000, default value: 0.
  2325 +# This tag requires that the tag HAVE_DOT is set to YES.
1486 2326  
1487 2327 MAX_DOT_GRAPH_DEPTH = 0
1488 2328  
1489 2329 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1490   -# background. This is disabled by default, because dot on Windows does not
1491   -# seem to support this out of the box. Warning: Depending on the platform used,
1492   -# enabling this option may lead to badly anti-aliased labels on the edges of
1493   -# a graph (i.e. they become hard to read).
  2330 +# background. This is disabled by default, because dot on Windows does not seem
  2331 +# to support this out of the box.
  2332 +#
  2333 +# Warning: Depending on the platform used, enabling this option may lead to
  2334 +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
  2335 +# read).
  2336 +# The default value is: NO.
  2337 +# This tag requires that the tag HAVE_DOT is set to YES.
1494 2338  
1495 2339 DOT_TRANSPARENT = NO
1496 2340  
1497   -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
  2341 +# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
1498 2342 # files in one run (i.e. multiple -o and -T options on the command line). This
1499   -# makes dot run faster, but since only newer versions of dot (>1.8.10)
1500   -# support this, this feature is disabled by default.
  2343 +# makes dot run faster, but since only newer versions of dot (>1.8.10) support
  2344 +# this, this feature is disabled by default.
  2345 +# The default value is: NO.
  2346 +# This tag requires that the tag HAVE_DOT is set to YES.
1501 2347  
1502 2348 DOT_MULTI_TARGETS = YES
1503 2349  
1504   -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1505   -# generate a legend page explaining the meaning of the various boxes and
1506   -# arrows in the dot generated graphs.
  2350 +# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
  2351 +# explaining the meaning of the various boxes and arrows in the dot generated
  2352 +# graphs.
  2353 +# The default value is: YES.
  2354 +# This tag requires that the tag HAVE_DOT is set to YES.
1507 2355  
1508 2356 GENERATE_LEGEND = YES
1509 2357  
1510   -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1511   -# remove the intermediate dot files that are used to generate
1512   -# the various graphs.
  2358 +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
  2359 +# files that are used to generate the various graphs.
  2360 +# The default value is: YES.
  2361 +# This tag requires that the tag HAVE_DOT is set to YES.
1513 2362  
1514 2363 DOT_CLEANUP = YES
... ...
openhantek/Doxyfile.bak 0 โ†’ 100644
  1 +# Doxyfile 1.6.1
  2 +
  3 +# This file describes the settings to be used by the documentation system
  4 +# doxygen (www.doxygen.org) for a project
  5 +#
  6 +# All text after a hash (#) is considered a comment and will be ignored
  7 +# The format is:
  8 +# TAG = value [value, ...]
  9 +# For lists items can also be appended using:
  10 +# TAG += value [value, ...]
  11 +# Values that contain spaces should be placed between quotes (" ")
  12 +
  13 +#---------------------------------------------------------------------------
  14 +# Project related configuration options
  15 +#---------------------------------------------------------------------------
  16 +
  17 +# This tag specifies the encoding used for all characters in the config file
  18 +# that follow. The default is UTF-8 which is also the encoding used for all
  19 +# text before the first occurrence of this tag. Doxygen uses libiconv (or the
  20 +# iconv built into libc) for the transcoding. See
  21 +# http://www.gnu.org/software/libiconv for the list of possible encodings.
  22 +
  23 +DOXYFILE_ENCODING = UTF-8
  24 +
  25 +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
  26 +# by quotes) that should identify the project.
  27 +
  28 +PROJECT_NAME = OpenHantek
  29 +
  30 +# The PROJECT_NUMBER tag can be used to enter a project or revision number.
  31 +# This could be handy for archiving the generated documentation or
  32 +# if some version control system is used.
  33 +
  34 +PROJECT_NUMBER =
  35 +
  36 +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
  37 +# base path where the generated documentation will be put.
  38 +# If a relative path is entered, it will be relative to the location
  39 +# where doxygen was started. If left blank the current directory will be used.
  40 +
  41 +OUTPUT_DIRECTORY = ./doc/
  42 +
  43 +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
  44 +# 4096 sub-directories (in 2 levels) under the output directory of each output
  45 +# format and will distribute the generated files over these directories.
  46 +# Enabling this option can be useful when feeding doxygen a huge amount of
  47 +# source files, where putting all generated files in the same directory would
  48 +# otherwise cause performance problems for the file system.
  49 +
  50 +CREATE_SUBDIRS = NO
  51 +
  52 +# The OUTPUT_LANGUAGE tag is used to specify the language in which all
  53 +# documentation generated by doxygen is written. Doxygen will use this
  54 +# information to generate all constant output in the proper language.
  55 +# The default language is English, other supported languages are:
  56 +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
  57 +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
  58 +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
  59 +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
  60 +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
  61 +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
  62 +
  63 +OUTPUT_LANGUAGE = English
  64 +
  65 +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
  66 +# include brief member descriptions after the members that are listed in
  67 +# the file and class documentation (similar to JavaDoc).
  68 +# Set to NO to disable this.
  69 +
  70 +BRIEF_MEMBER_DESC = YES
  71 +
  72 +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
  73 +# the brief description of a member or function before the detailed description.
  74 +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  75 +# brief descriptions will be completely suppressed.
  76 +
  77 +REPEAT_BRIEF = YES
  78 +
  79 +# This tag implements a quasi-intelligent brief description abbreviator
  80 +# that is used to form the text in various listings. Each string
  81 +# in this list, if found as the leading text of the brief description, will be
  82 +# stripped from the text and the result after processing the whole list, is
  83 +# used as the annotated text. Otherwise, the brief description is used as-is.
  84 +# If left blank, the following values are used ("$name" is automatically
  85 +# replaced with the name of the entity): "The $name class" "The $name widget"
  86 +# "The $name file" "is" "provides" "specifies" "contains"
  87 +# "represents" "a" "an" "the"
  88 +
  89 +ABBREVIATE_BRIEF =
  90 +
  91 +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  92 +# Doxygen will generate a detailed section even if there is only a brief
  93 +# description.
  94 +
  95 +ALWAYS_DETAILED_SEC = NO
  96 +
  97 +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
  98 +# inherited members of a class in the documentation of that class as if those
  99 +# members were ordinary class members. Constructors, destructors and assignment
  100 +# operators of the base classes will not be shown.
  101 +
  102 +INLINE_INHERITED_MEMB = NO
  103 +
  104 +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
  105 +# path before files name in the file list and in the header files. If set
  106 +# to NO the shortest path that makes the file name unique will be used.
  107 +
  108 +FULL_PATH_NAMES = YES
  109 +
  110 +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
  111 +# can be used to strip a user-defined part of the path. Stripping is
  112 +# only done if one of the specified strings matches the left-hand part of
  113 +# the path. The tag can be used to show relative paths in the file list.
  114 +# If left blank the directory from which doxygen is run is used as the
  115 +# path to strip.
  116 +
  117 +STRIP_FROM_PATH = src/
  118 +
  119 +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
  120 +# the path mentioned in the documentation of a class, which tells
  121 +# the reader which header file to include in order to use a class.
  122 +# If left blank only the name of the header file containing the class
  123 +# definition is used. Otherwise one should specify the include paths that
  124 +# are normally passed to the compiler using the -I flag.
  125 +
  126 +STRIP_FROM_INC_PATH =
  127 +
  128 +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
  129 +# (but less readable) file names. This can be useful is your file systems
  130 +# doesn't support long names like on DOS, Mac, or CD-ROM.
  131 +
  132 +SHORT_NAMES = NO
  133 +
  134 +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
  135 +# will interpret the first line (until the first dot) of a JavaDoc-style
  136 +# comment as the brief description. If set to NO, the JavaDoc
  137 +# comments will behave just like regular Qt-style comments
  138 +# (thus requiring an explicit @brief command for a brief description.)
  139 +
  140 +JAVADOC_AUTOBRIEF = NO
  141 +
  142 +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
  143 +# interpret the first line (until the first dot) of a Qt-style
  144 +# comment as the brief description. If set to NO, the comments
  145 +# will behave just like regular Qt-style comments (thus requiring
  146 +# an explicit \brief command for a brief description.)
  147 +
  148 +QT_AUTOBRIEF = NO
  149 +
  150 +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
  151 +# treat a multi-line C++ special comment block (i.e. a block of //! or ///
  152 +# comments) as a brief description. This used to be the default behaviour.
  153 +# The new default is to treat a multi-line C++ comment block as a detailed
  154 +# description. Set this tag to YES if you prefer the old behaviour instead.
  155 +
  156 +MULTILINE_CPP_IS_BRIEF = NO
  157 +
  158 +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
  159 +# member inherits the documentation from any documented member that it
  160 +# re-implements.
  161 +
  162 +INHERIT_DOCS = YES
  163 +
  164 +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
  165 +# a new page for each member. If set to NO, the documentation of a member will
  166 +# be part of the file/class/namespace that contains it.
  167 +
  168 +SEPARATE_MEMBER_PAGES = NO
  169 +
  170 +# The TAB_SIZE tag can be used to set the number of spaces in a tab.
  171 +# Doxygen uses this value to replace tabs by spaces in code fragments.
  172 +
  173 +TAB_SIZE = 2
  174 +
  175 +# This tag can be used to specify a number of aliases that acts
  176 +# as commands in the documentation. An alias has the form "name=value".
  177 +# For example adding "sideeffect=\par Side Effects:\n" will allow you to
  178 +# put the command \sideeffect (or @sideeffect) in the documentation, which
  179 +# will result in a user-defined paragraph with heading "Side Effects:".
  180 +# You can put \n's in the value part of an alias to insert newlines.
  181 +
  182 +ALIASES =
  183 +
  184 +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
  185 +# sources only. Doxygen will then generate output that is more tailored for C.
  186 +# For instance, some of the names that are used will be different. The list
  187 +# of all members will be omitted, etc.
  188 +
  189 +OPTIMIZE_OUTPUT_FOR_C = YES
  190 +
  191 +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
  192 +# sources only. Doxygen will then generate output that is more tailored for
  193 +# Java. For instance, namespaces will be presented as packages, qualified
  194 +# scopes will look different, etc.
  195 +
  196 +OPTIMIZE_OUTPUT_JAVA = NO
  197 +
  198 +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
  199 +# sources only. Doxygen will then generate output that is more tailored for
  200 +# Fortran.
  201 +
  202 +OPTIMIZE_FOR_FORTRAN = NO
  203 +
  204 +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
  205 +# sources. Doxygen will then generate output that is tailored for
  206 +# VHDL.
  207 +
  208 +OPTIMIZE_OUTPUT_VHDL = NO
  209 +
  210 +# Doxygen selects the parser to use depending on the extension of the files it parses.
  211 +# With this tag you can assign which parser to use for a given extension.
  212 +# Doxygen has a built-in mapping, but you can override or extend it using this tag.
  213 +# The format is ext=language, where ext is a file extension, and language is one of
  214 +# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
  215 +# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
  216 +# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
  217 +# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
  218 +
  219 +EXTENSION_MAPPING =
  220 +
  221 +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
  222 +# to include (a tag file for) the STL sources as input, then you should
  223 +# set this tag to YES in order to let doxygen match functions declarations and
  224 +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
  225 +# func(std::string) {}). This also make the inheritance and collaboration
  226 +# diagrams that involve STL classes more complete and accurate.
  227 +
  228 +BUILTIN_STL_SUPPORT = NO
  229 +
  230 +# If you use Microsoft's C++/CLI language, you should set this option to YES to
  231 +# enable parsing support.
  232 +
  233 +CPP_CLI_SUPPORT = NO
  234 +
  235 +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
  236 +# Doxygen will parse them like normal C++ but will assume all classes use public
  237 +# instead of private inheritance when no explicit protection keyword is present.
  238 +
  239 +SIP_SUPPORT = NO
  240 +
  241 +# For Microsoft's IDL there are propget and propput attributes to indicate getter
  242 +# and setter methods for a property. Setting this option to YES (the default)
  243 +# will make doxygen to replace the get and set methods by a property in the
  244 +# documentation. This will only work if the methods are indeed getting or
  245 +# setting a simple type. If this is not the case, or you want to show the
  246 +# methods anyway, you should set this option to NO.
  247 +
  248 +IDL_PROPERTY_SUPPORT = YES
  249 +
  250 +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  251 +# tag is set to YES, then doxygen will reuse the documentation of the first
  252 +# member in the group (if any) for the other members of the group. By default
  253 +# all members of a group must be documented explicitly.
  254 +
  255 +DISTRIBUTE_GROUP_DOC = NO
  256 +
  257 +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
  258 +# the same type (for instance a group of public functions) to be put as a
  259 +# subgroup of that type (e.g. under the Public Functions section). Set it to
  260 +# NO to prevent subgrouping. Alternatively, this can be done per class using
  261 +# the \nosubgrouping command.
  262 +
  263 +SUBGROUPING = YES
  264 +
  265 +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
  266 +# is documented as struct, union, or enum with the name of the typedef. So
  267 +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
  268 +# with name TypeT. When disabled the typedef will appear as a member of a file,
  269 +# namespace, or class. And the struct will be named TypeS. This can typically
  270 +# be useful for C code in case the coding convention dictates that all compound
  271 +# types are typedef'ed and only the typedef is referenced, never the tag name.
  272 +
  273 +TYPEDEF_HIDES_STRUCT = NO
  274 +
  275 +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
  276 +# determine which symbols to keep in memory and which to flush to disk.
  277 +# When the cache is full, less often used symbols will be written to disk.
  278 +# For small to medium size projects (<1000 input files) the default value is
  279 +# probably good enough. For larger projects a too small cache size can cause
  280 +# doxygen to be busy swapping symbols to and from disk most of the time
  281 +# causing a significant performance penality.
  282 +# If the system has enough physical memory increasing the cache will improve the
  283 +# performance by keeping more symbols in memory. Note that the value works on
  284 +# a logarithmic scale so increasing the size by one will rougly double the
  285 +# memory usage. The cache size is given by this formula:
  286 +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
  287 +# corresponding to a cache size of 2^16 = 65536 symbols
  288 +
  289 +SYMBOL_CACHE_SIZE = 0
  290 +
  291 +#---------------------------------------------------------------------------
  292 +# Build related configuration options
  293 +#---------------------------------------------------------------------------
  294 +
  295 +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
  296 +# documentation are documented, even if no documentation was available.
  297 +# Private class members and static file members will be hidden unless
  298 +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
  299 +
  300 +EXTRACT_ALL = NO
  301 +
  302 +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
  303 +# will be included in the documentation.
  304 +
  305 +EXTRACT_PRIVATE = NO
  306 +
  307 +# If the EXTRACT_STATIC tag is set to YES all static members of a file
  308 +# will be included in the documentation.
  309 +
  310 +EXTRACT_STATIC = NO
  311 +
  312 +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
  313 +# defined locally in source files will be included in the documentation.
  314 +# If set to NO only classes defined in header files are included.
  315 +
  316 +EXTRACT_LOCAL_CLASSES = YES
  317 +
  318 +# This flag is only useful for Objective-C code. When set to YES local
  319 +# methods, which are defined in the implementation section but not in
  320 +# the interface are included in the documentation.
  321 +# If set to NO (the default) only methods in the interface are included.
  322 +
  323 +EXTRACT_LOCAL_METHODS = NO
  324 +
  325 +# If this flag is set to YES, the members of anonymous namespaces will be
  326 +# extracted and appear in the documentation as a namespace called
  327 +# 'anonymous_namespace{file}', where file will be replaced with the base
  328 +# name of the file that contains the anonymous namespace. By default
  329 +# anonymous namespace are hidden.
  330 +
  331 +EXTRACT_ANON_NSPACES = NO
  332 +
  333 +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
  334 +# undocumented members of documented classes, files or namespaces.
  335 +# If set to NO (the default) these members will be included in the
  336 +# various overviews, but no documentation section is generated.
  337 +# This option has no effect if EXTRACT_ALL is enabled.
  338 +
  339 +HIDE_UNDOC_MEMBERS = NO
  340 +
  341 +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
  342 +# undocumented classes that are normally visible in the class hierarchy.
  343 +# If set to NO (the default) these classes will be included in the various
  344 +# overviews. This option has no effect if EXTRACT_ALL is enabled.
  345 +
  346 +HIDE_UNDOC_CLASSES = NO
  347 +
  348 +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
  349 +# friend (class|struct|union) declarations.
  350 +# If set to NO (the default) these declarations will be included in the
  351 +# documentation.
  352 +
  353 +HIDE_FRIEND_COMPOUNDS = NO
  354 +
  355 +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
  356 +# documentation blocks found inside the body of a function.
  357 +# If set to NO (the default) these blocks will be appended to the
  358 +# function's detailed documentation block.
  359 +
  360 +HIDE_IN_BODY_DOCS = NO
  361 +
  362 +# The INTERNAL_DOCS tag determines if documentation
  363 +# that is typed after a \internal command is included. If the tag is set
  364 +# to NO (the default) then the documentation will be excluded.
  365 +# Set it to YES to include the internal documentation.
  366 +
  367 +INTERNAL_DOCS = NO
  368 +
  369 +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
  370 +# file names in lower-case letters. If set to YES upper-case letters are also
  371 +# allowed. This is useful if you have classes or files whose names only differ
  372 +# in case and if your file system supports case sensitive file names. Windows
  373 +# and Mac users are advised to set this option to NO.
  374 +
  375 +CASE_SENSE_NAMES = YES
  376 +
  377 +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
  378 +# will show members with their full class and namespace scopes in the
  379 +# documentation. If set to YES the scope will be hidden.
  380 +
  381 +HIDE_SCOPE_NAMES = NO
  382 +
  383 +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
  384 +# will put a list of the files that are included by a file in the documentation
  385 +# of that file.
  386 +
  387 +SHOW_INCLUDE_FILES = YES
  388 +
  389 +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
  390 +# is inserted in the documentation for inline members.
  391 +
  392 +INLINE_INFO = YES
  393 +
  394 +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
  395 +# will sort the (detailed) documentation of file and class members
  396 +# alphabetically by member name. If set to NO the members will appear in
  397 +# declaration order.
  398 +
  399 +SORT_MEMBER_DOCS = YES
  400 +
  401 +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
  402 +# brief documentation of file, namespace and class members alphabetically
  403 +# by member name. If set to NO (the default) the members will appear in
  404 +# declaration order.
  405 +
  406 +SORT_BRIEF_DOCS = NO
  407 +
  408 +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
  409 +
  410 +SORT_MEMBERS_CTORS_1ST = NO
  411 +
  412 +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
  413 +# hierarchy of group names into alphabetical order. If set to NO (the default)
  414 +# the group names will appear in their defined order.
  415 +
  416 +SORT_GROUP_NAMES = NO
  417 +
  418 +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
  419 +# sorted by fully-qualified names, including namespaces. If set to
  420 +# NO (the default), the class list will be sorted only by class name,
  421 +# not including the namespace part.
  422 +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
  423 +# Note: This option applies only to the class list, not to the
  424 +# alphabetical list.
  425 +
  426 +SORT_BY_SCOPE_NAME = NO
  427 +
  428 +# The GENERATE_TODOLIST tag can be used to enable (YES) or
  429 +# disable (NO) the todo list. This list is created by putting \todo
  430 +# commands in the documentation.
  431 +
  432 +GENERATE_TODOLIST = YES
  433 +
  434 +# The GENERATE_TESTLIST tag can be used to enable (YES) or
  435 +# disable (NO) the test list. This list is created by putting \test
  436 +# commands in the documentation.
  437 +
  438 +GENERATE_TESTLIST = YES
  439 +
  440 +# The GENERATE_BUGLIST tag can be used to enable (YES) or
  441 +# disable (NO) the bug list. This list is created by putting \bug
  442 +# commands in the documentation.
  443 +
  444 +GENERATE_BUGLIST = YES
  445 +
  446 +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
  447 +# disable (NO) the deprecated list. This list is created by putting
  448 +# \deprecated commands in the documentation.
  449 +
  450 +GENERATE_DEPRECATEDLIST= YES
  451 +
  452 +# The ENABLED_SECTIONS tag can be used to enable conditional
  453 +# documentation sections, marked by \if sectionname ... \endif.
  454 +
  455 +ENABLED_SECTIONS =
  456 +
  457 +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
  458 +# the initial value of a variable or define consists of for it to appear in
  459 +# the documentation. If the initializer consists of more lines than specified
  460 +# here it will be hidden. Use a value of 0 to hide initializers completely.
  461 +# The appearance of the initializer of individual variables and defines in the
  462 +# documentation can be controlled using \showinitializer or \hideinitializer
  463 +# command in the documentation regardless of this setting.
  464 +
  465 +MAX_INITIALIZER_LINES = 30
  466 +
  467 +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
  468 +# at the bottom of the documentation of classes and structs. If set to YES the
  469 +# list will mention the files that were used to generate the documentation.
  470 +
  471 +SHOW_USED_FILES = YES
  472 +
  473 +# If the sources in your project are distributed over multiple directories
  474 +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
  475 +# in the documentation. The default is NO.
  476 +
  477 +SHOW_DIRECTORIES = NO
  478 +
  479 +# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
  480 +# This will remove the Files entry from the Quick Index and from the
  481 +# Folder Tree View (if specified). The default is YES.
  482 +
  483 +SHOW_FILES = YES
  484 +
  485 +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
  486 +# Namespaces page.
  487 +# This will remove the Namespaces entry from the Quick Index
  488 +# and from the Folder Tree View (if specified). The default is YES.
  489 +
  490 +SHOW_NAMESPACES = YES
  491 +
  492 +# The FILE_VERSION_FILTER tag can be used to specify a program or script that
  493 +# doxygen should invoke to get the current version for each file (typically from
  494 +# the version control system). Doxygen will invoke the program by executing (via
  495 +# popen()) the command <command> <input-file>, where <command> is the value of
  496 +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
  497 +# provided by doxygen. Whatever the program writes to standard output
  498 +# is used as the file version. See the manual for examples.
  499 +
  500 +FILE_VERSION_FILTER =
  501 +
  502 +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
  503 +# doxygen. The layout file controls the global structure of the generated output files
  504 +# in an output format independent way. The create the layout file that represents
  505 +# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
  506 +# file name after the option, if omitted DoxygenLayout.xml will be used as the name
  507 +# of the layout file.
  508 +
  509 +LAYOUT_FILE =
  510 +
  511 +#---------------------------------------------------------------------------
  512 +# configuration options related to warning and progress messages
  513 +#---------------------------------------------------------------------------
  514 +
  515 +# The QUIET tag can be used to turn on/off the messages that are generated
  516 +# by doxygen. Possible values are YES and NO. If left blank NO is used.
  517 +
  518 +QUIET = NO
  519 +
  520 +# The WARNINGS tag can be used to turn on/off the warning messages that are
  521 +# generated by doxygen. Possible values are YES and NO. If left blank
  522 +# NO is used.
  523 +
  524 +WARNINGS = YES
  525 +
  526 +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
  527 +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
  528 +# automatically be disabled.
  529 +
  530 +WARN_IF_UNDOCUMENTED = YES
  531 +
  532 +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
  533 +# potential errors in the documentation, such as not documenting some
  534 +# parameters in a documented function, or documenting parameters that
  535 +# don't exist or using markup commands wrongly.
  536 +
  537 +WARN_IF_DOC_ERROR = YES
  538 +
  539 +# This WARN_NO_PARAMDOC option can be abled to get warnings for
  540 +# functions that are documented, but have no documentation for their parameters
  541 +# or return value. If set to NO (the default) doxygen will only warn about
  542 +# wrong or incomplete parameter documentation, but not about the absence of
  543 +# documentation.
  544 +
  545 +WARN_NO_PARAMDOC = NO
  546 +
  547 +# The WARN_FORMAT tag determines the format of the warning messages that
  548 +# doxygen can produce. The string should contain the $file, $line, and $text
  549 +# tags, which will be replaced by the file and line number from which the
  550 +# warning originated and the warning text. Optionally the format may contain
  551 +# $version, which will be replaced by the version of the file (if it could
  552 +# be obtained via FILE_VERSION_FILTER)
  553 +
  554 +WARN_FORMAT = "$file:$line: $text"
  555 +
  556 +# The WARN_LOGFILE tag can be used to specify a file to which warning
  557 +# and error messages should be written. If left blank the output is written
  558 +# to stderr.
  559 +
  560 +WARN_LOGFILE =
  561 +
  562 +#---------------------------------------------------------------------------
  563 +# configuration options related to the input files
  564 +#---------------------------------------------------------------------------
  565 +
  566 +# The INPUT tag can be used to specify the files and/or directories that contain
  567 +# documented source files. You may enter file names like "myfile.cpp" or
  568 +# directories like "/usr/src/myproject". Separate the files or directories
  569 +# with spaces.
  570 +
  571 +INPUT = src/ readme.md
  572 +
  573 +# This tag can be used to specify the character encoding of the source files
  574 +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
  575 +# also the default input encoding. Doxygen uses libiconv (or the iconv built
  576 +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
  577 +# the list of possible encodings.
  578 +
  579 +INPUT_ENCODING = UTF-8
  580 +
  581 +# If the value of the INPUT tag contains directories, you can use the
  582 +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  583 +# and *.h) to filter out the source-files in the directories. If left
  584 +# blank the following patterns are tested:
  585 +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
  586 +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
  587 +
  588 +FILE_PATTERNS =
  589 +
  590 +# The RECURSIVE tag can be used to turn specify whether or not subdirectories
  591 +# should be searched for input files as well. Possible values are YES and NO.
  592 +# If left blank NO is used.
  593 +
  594 +RECURSIVE = YES
  595 +
  596 +# The EXCLUDE tag can be used to specify files and/or directories that should
  597 +# excluded from the INPUT source files. This way you can easily exclude a
  598 +# subdirectory from a directory tree whose root is specified with the INPUT tag.
  599 +
  600 +EXCLUDE =
  601 +
  602 +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
  603 +# directories that are symbolic links (a Unix filesystem feature) are excluded
  604 +# from the input.
  605 +
  606 +EXCLUDE_SYMLINKS = NO
  607 +
  608 +# If the value of the INPUT tag contains directories, you can use the
  609 +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  610 +# certain files from those directories. Note that the wildcards are matched
  611 +# against the file with absolute path, so to exclude all test directories
  612 +# for example use the pattern */test/*
  613 +
  614 +EXCLUDE_PATTERNS = */.svn*
  615 +
  616 +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
  617 +# (namespaces, classes, functions, etc.) that should be excluded from the
  618 +# output. The symbol name can be a fully qualified name, a word, or if the
  619 +# wildcard * is used, a substring. Examples: ANamespace, AClass,
  620 +# AClass::ANamespace, ANamespace::*Test
  621 +
  622 +EXCLUDE_SYMBOLS =
  623 +
  624 +# The EXAMPLE_PATH tag can be used to specify one or more files or
  625 +# directories that contain example code fragments that are included (see
  626 +# the \include command).
  627 +
  628 +EXAMPLE_PATH =
  629 +
  630 +# If the value of the EXAMPLE_PATH tag contains directories, you can use the
  631 +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  632 +# and *.h) to filter out the source-files in the directories. If left
  633 +# blank all files are included.
  634 +
  635 +EXAMPLE_PATTERNS =
  636 +
  637 +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
  638 +# searched for input files to be used with the \include or \dontinclude
  639 +# commands irrespective of the value of the RECURSIVE tag.
  640 +# Possible values are YES and NO. If left blank NO is used.
  641 +
  642 +EXAMPLE_RECURSIVE = NO
  643 +
  644 +# The IMAGE_PATH tag can be used to specify one or more files or
  645 +# directories that contain image that are included in the documentation (see
  646 +# the \image command).
  647 +
  648 +IMAGE_PATH =
  649 +
  650 +# The INPUT_FILTER tag can be used to specify a program that doxygen should
  651 +# invoke to filter for each input file. Doxygen will invoke the filter program
  652 +# by executing (via popen()) the command <filter> <input-file>, where <filter>
  653 +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
  654 +# input file. Doxygen will then use the output that the filter program writes
  655 +# to standard output.
  656 +# If FILTER_PATTERNS is specified, this tag will be
  657 +# ignored.
  658 +
  659 +INPUT_FILTER =
  660 +
  661 +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
  662 +# basis.
  663 +# Doxygen will compare the file name with each pattern and apply the
  664 +# filter if there is a match.
  665 +# The filters are a list of the form:
  666 +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
  667 +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
  668 +# is applied to all files.
  669 +
  670 +FILTER_PATTERNS =
  671 +
  672 +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  673 +# INPUT_FILTER) will be used to filter the input files when producing source
  674 +# files to browse (i.e. when SOURCE_BROWSER is set to YES).
  675 +
  676 +FILTER_SOURCE_FILES = NO
  677 +
  678 +#---------------------------------------------------------------------------
  679 +# configuration options related to source browsing
  680 +#---------------------------------------------------------------------------
  681 +
  682 +# If the SOURCE_BROWSER tag is set to YES then a list of source files will
  683 +# be generated. Documented entities will be cross-referenced with these sources.
  684 +# Note: To get rid of all source code in the generated output, make sure also
  685 +# VERBATIM_HEADERS is set to NO.
  686 +
  687 +SOURCE_BROWSER = NO
  688 +
  689 +# Setting the INLINE_SOURCES tag to YES will include the body
  690 +# of functions and classes directly in the documentation.
  691 +
  692 +INLINE_SOURCES = NO
  693 +
  694 +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
  695 +# doxygen to hide any special comment blocks from generated source code
  696 +# fragments. Normal C and C++ comments will always remain visible.
  697 +
  698 +STRIP_CODE_COMMENTS = YES
  699 +
  700 +# If the REFERENCED_BY_RELATION tag is set to YES
  701 +# then for each documented function all documented
  702 +# functions referencing it will be listed.
  703 +
  704 +REFERENCED_BY_RELATION = NO
  705 +
  706 +# If the REFERENCES_RELATION tag is set to YES
  707 +# then for each documented function all documented entities
  708 +# called/used by that function will be listed.
  709 +
  710 +REFERENCES_RELATION = NO
  711 +
  712 +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
  713 +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
  714 +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
  715 +# link to the source code.
  716 +# Otherwise they will link to the documentation.
  717 +
  718 +REFERENCES_LINK_SOURCE = YES
  719 +
  720 +# If the USE_HTAGS tag is set to YES then the references to source code
  721 +# will point to the HTML generated by the htags(1) tool instead of doxygen
  722 +# built-in source browser. The htags tool is part of GNU's global source
  723 +# tagging system (see http://www.gnu.org/software/global/global.html). You
  724 +# will need version 4.8.6 or higher.
  725 +
  726 +USE_HTAGS = NO
  727 +
  728 +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
  729 +# will generate a verbatim copy of the header file for each class for
  730 +# which an include is specified. Set to NO to disable this.
  731 +
  732 +VERBATIM_HEADERS = YES
  733 +
  734 +#---------------------------------------------------------------------------
  735 +# configuration options related to the alphabetical class index
  736 +#---------------------------------------------------------------------------
  737 +
  738 +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
  739 +# of all compounds will be generated. Enable this if the project
  740 +# contains a lot of classes, structs, unions or interfaces.
  741 +
  742 +ALPHABETICAL_INDEX = NO
  743 +
  744 +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
  745 +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
  746 +# in which this list will be split (can be a number in the range [1..20])
  747 +
  748 +COLS_IN_ALPHA_INDEX = 5
  749 +
  750 +# In case all classes in a project start with a common prefix, all
  751 +# classes will be put under the same header in the alphabetical index.
  752 +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
  753 +# should be ignored while generating the index headers.
  754 +
  755 +IGNORE_PREFIX =
  756 +
  757 +#---------------------------------------------------------------------------
  758 +# configuration options related to the HTML output
  759 +#---------------------------------------------------------------------------
  760 +
  761 +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
  762 +# generate HTML output.
  763 +
  764 +GENERATE_HTML = YES
  765 +
  766 +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
  767 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
  768 +# put in front of it. If left blank `html' will be used as the default path.
  769 +
  770 +HTML_OUTPUT = html
  771 +
  772 +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
  773 +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
  774 +# doxygen will generate files with .html extension.
  775 +
  776 +HTML_FILE_EXTENSION = .html
  777 +
  778 +# The HTML_HEADER tag can be used to specify a personal HTML header for
  779 +# each generated HTML page. If it is left blank doxygen will generate a
  780 +# standard header.
  781 +
  782 +HTML_HEADER =
  783 +
  784 +# The HTML_FOOTER tag can be used to specify a personal HTML footer for
  785 +# each generated HTML page. If it is left blank doxygen will generate a
  786 +# standard footer.
  787 +
  788 +HTML_FOOTER =
  789 +
  790 +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
  791 +# style sheet that is used by each HTML page. It can be used to
  792 +# fine-tune the look of the HTML output. If the tag is left blank doxygen
  793 +# will generate a default style sheet. Note that doxygen will try to copy
  794 +# the style sheet file to the HTML output directory, so don't put your own
  795 +# stylesheet in the HTML output directory as well, or it will be erased!
  796 +
  797 +HTML_STYLESHEET =
  798 +
  799 +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
  800 +# files or namespaces will be aligned in HTML using tables. If set to
  801 +# NO a bullet list will be used.
  802 +
  803 +HTML_ALIGN_MEMBERS = YES
  804 +
  805 +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
  806 +# documentation will contain sections that can be hidden and shown after the
  807 +# page has loaded. For this to work a browser that supports
  808 +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
  809 +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
  810 +
  811 +HTML_DYNAMIC_SECTIONS = NO
  812 +
  813 +# If the GENERATE_DOCSET tag is set to YES, additional index files
  814 +# will be generated that can be used as input for Apple's Xcode 3
  815 +# integrated development environment, introduced with OSX 10.5 (Leopard).
  816 +# To create a documentation set, doxygen will generate a Makefile in the
  817 +# HTML output directory. Running make will produce the docset in that
  818 +# directory and running "make install" will install the docset in
  819 +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
  820 +# it at startup.
  821 +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
  822 +
  823 +GENERATE_DOCSET = NO
  824 +
  825 +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
  826 +# feed. A documentation feed provides an umbrella under which multiple
  827 +# documentation sets from a single provider (such as a company or product suite)
  828 +# can be grouped.
  829 +
  830 +DOCSET_FEEDNAME = "Doxygen generated docs"
  831 +
  832 +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
  833 +# should uniquely identify the documentation set bundle. This should be a
  834 +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
  835 +# will append .docset to the name.
  836 +
  837 +DOCSET_BUNDLE_ID = org.doxygen.Project
  838 +
  839 +# If the GENERATE_HTMLHELP tag is set to YES, additional index files
  840 +# will be generated that can be used as input for tools like the
  841 +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
  842 +# of the generated HTML documentation.
  843 +
  844 +GENERATE_HTMLHELP = NO
  845 +
  846 +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
  847 +# be used to specify the file name of the resulting .chm file. You
  848 +# can add a path in front of the file if the result should not be
  849 +# written to the html output directory.
  850 +
  851 +CHM_FILE =
  852 +
  853 +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
  854 +# be used to specify the location (absolute path including file name) of
  855 +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
  856 +# the HTML help compiler on the generated index.hhp.
  857 +
  858 +HHC_LOCATION =
  859 +
  860 +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
  861 +# controls if a separate .chi index file is generated (YES) or that
  862 +# it should be included in the master .chm file (NO).
  863 +
  864 +GENERATE_CHI = NO
  865 +
  866 +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
  867 +# is used to encode HtmlHelp index (hhk), content (hhc) and project file
  868 +# content.
  869 +
  870 +CHM_INDEX_ENCODING =
  871 +
  872 +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
  873 +# controls whether a binary table of contents is generated (YES) or a
  874 +# normal table of contents (NO) in the .chm file.
  875 +
  876 +BINARY_TOC = NO
  877 +
  878 +# The TOC_EXPAND flag can be set to YES to add extra items for group members
  879 +# to the contents of the HTML help documentation and to the tree view.
  880 +
  881 +TOC_EXPAND = NO
  882 +
  883 +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
  884 +# are set, an additional index file will be generated that can be used as input for
  885 +# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
  886 +# HTML documentation.
  887 +
  888 +GENERATE_QHP = NO
  889 +
  890 +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
  891 +# be used to specify the file name of the resulting .qch file.
  892 +# The path specified is relative to the HTML output folder.
  893 +
  894 +QCH_FILE =
  895 +
  896 +# The QHP_NAMESPACE tag specifies the namespace to use when generating
  897 +# Qt Help Project output. For more information please see
  898 +# http://doc.trolltech.com/qthelpproject.html#namespace
  899 +
  900 +QHP_NAMESPACE =
  901 +
  902 +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
  903 +# Qt Help Project output. For more information please see
  904 +# http://doc.trolltech.com/qthelpproject.html#virtual-folders
  905 +
  906 +QHP_VIRTUAL_FOLDER = doc
  907 +
  908 +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
  909 +# For more information please see
  910 +# http://doc.trolltech.com/qthelpproject.html#custom-filters
  911 +
  912 +QHP_CUST_FILTER_NAME =
  913 +
  914 +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
  915 +# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
  916 +
  917 +QHP_CUST_FILTER_ATTRS =
  918 +
  919 +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
  920 +# filter section matches.
  921 +# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
  922 +
  923 +QHP_SECT_FILTER_ATTRS =
  924 +
  925 +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
  926 +# be used to specify the location of Qt's qhelpgenerator.
  927 +# If non-empty doxygen will try to run qhelpgenerator on the generated
  928 +# .qhp file.
  929 +
  930 +QHG_LOCATION =
  931 +
  932 +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
  933 +# top of each HTML page. The value NO (the default) enables the index and
  934 +# the value YES disables it.
  935 +
  936 +DISABLE_INDEX = NO
  937 +
  938 +# This tag can be used to set the number of enum values (range [1..20])
  939 +# that doxygen will group on one line in the generated HTML documentation.
  940 +
  941 +ENUM_VALUES_PER_LINE = 4
  942 +
  943 +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
  944 +# structure should be generated to display hierarchical information.
  945 +# If the tag value is set to YES, a side panel will be generated
  946 +# containing a tree-like index structure (just like the one that
  947 +# is generated for HTML Help). For this to work a browser that supports
  948 +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
  949 +# Windows users are probably better off using the HTML help feature.
  950 +
  951 +GENERATE_TREEVIEW = NO
  952 +
  953 +# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
  954 +# and Class Hierarchy pages using a tree view instead of an ordered list.
  955 +
  956 +USE_INLINE_TREES = NO
  957 +
  958 +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
  959 +# used to set the initial width (in pixels) of the frame in which the tree
  960 +# is shown.
  961 +
  962 +TREEVIEW_WIDTH = 250
  963 +
  964 +# Use this tag to change the font size of Latex formulas included
  965 +# as images in the HTML documentation. The default is 10. Note that
  966 +# when you change the font size after a successful doxygen run you need
  967 +# to manually remove any form_*.png images from the HTML output directory
  968 +# to force them to be regenerated.
  969 +
  970 +FORMULA_FONTSIZE = 10
  971 +
  972 +# When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
  973 +# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
  974 +# there is already a search function so this one should typically
  975 +# be disabled.
  976 +
  977 +SEARCHENGINE = YES
  978 +
  979 +#---------------------------------------------------------------------------
  980 +# configuration options related to the LaTeX output
  981 +#---------------------------------------------------------------------------
  982 +
  983 +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
  984 +# generate Latex output.
  985 +
  986 +GENERATE_LATEX = YES
  987 +
  988 +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
  989 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
  990 +# put in front of it. If left blank `latex' will be used as the default path.
  991 +
  992 +LATEX_OUTPUT = latex
  993 +
  994 +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  995 +# invoked. If left blank `latex' will be used as the default command name.
  996 +
  997 +LATEX_CMD_NAME = latex
  998 +
  999 +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
  1000 +# generate index for LaTeX. If left blank `makeindex' will be used as the
  1001 +# default command name.
  1002 +
  1003 +MAKEINDEX_CMD_NAME = makeindex
  1004 +
  1005 +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
  1006 +# LaTeX documents. This may be useful for small projects and may help to
  1007 +# save some trees in general.
  1008 +
  1009 +COMPACT_LATEX = NO
  1010 +
  1011 +# The PAPER_TYPE tag can be used to set the paper type that is used
  1012 +# by the printer. Possible values are: a4, a4wide, letter, legal and
  1013 +# executive. If left blank a4wide will be used.
  1014 +
  1015 +PAPER_TYPE = a4wide
  1016 +
  1017 +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
  1018 +# packages that should be included in the LaTeX output.
  1019 +
  1020 +EXTRA_PACKAGES =
  1021 +
  1022 +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
  1023 +# the generated latex document. The header should contain everything until
  1024 +# the first chapter. If it is left blank doxygen will generate a
  1025 +# standard header. Notice: only use this tag if you know what you are doing!
  1026 +
  1027 +LATEX_HEADER =
  1028 +
  1029 +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
  1030 +# is prepared for conversion to pdf (using ps2pdf). The pdf file will
  1031 +# contain links (just like the HTML output) instead of page references
  1032 +# This makes the output suitable for online browsing using a pdf viewer.
  1033 +
  1034 +PDF_HYPERLINKS = YES
  1035 +
  1036 +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
  1037 +# plain latex in the generated Makefile. Set this option to YES to get a
  1038 +# higher quality PDF documentation.
  1039 +
  1040 +USE_PDFLATEX = YES
  1041 +
  1042 +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
  1043 +# command to the generated LaTeX files. This will instruct LaTeX to keep
  1044 +# running if errors occur, instead of asking the user for help.
  1045 +# This option is also used when generating formulas in HTML.
  1046 +
  1047 +LATEX_BATCHMODE = NO
  1048 +
  1049 +# If LATEX_HIDE_INDICES is set to YES then doxygen will not
  1050 +# include the index chapters (such as File Index, Compound Index, etc.)
  1051 +# in the output.
  1052 +
  1053 +LATEX_HIDE_INDICES = NO
  1054 +
  1055 +# If LATEX_SOURCE_CODE 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.
  1056 +
  1057 +LATEX_SOURCE_CODE = NO
  1058 +
  1059 +#---------------------------------------------------------------------------
  1060 +# configuration options related to the RTF output
  1061 +#---------------------------------------------------------------------------
  1062 +
  1063 +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
  1064 +# The RTF output is optimized for Word 97 and may not look very pretty with
  1065 +# other RTF readers or editors.
  1066 +
  1067 +GENERATE_RTF = NO
  1068 +
  1069 +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
  1070 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
  1071 +# put in front of it. If left blank `rtf' will be used as the default path.
  1072 +
  1073 +RTF_OUTPUT = rtf
  1074 +
  1075 +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
  1076 +# RTF documents. This may be useful for small projects and may help to
  1077 +# save some trees in general.
  1078 +
  1079 +COMPACT_RTF = NO
  1080 +
  1081 +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
  1082 +# will contain hyperlink fields. The RTF file will
  1083 +# contain links (just like the HTML output) instead of page references.
  1084 +# This makes the output suitable for online browsing using WORD or other
  1085 +# programs which support those fields.
  1086 +# Note: wordpad (write) and others do not support links.
  1087 +
  1088 +RTF_HYPERLINKS = NO
  1089 +
  1090 +# Load stylesheet definitions from file. Syntax is similar to doxygen's
  1091 +# config file, i.e. a series of assignments. You only have to provide
  1092 +# replacements, missing definitions are set to their default value.
  1093 +
  1094 +RTF_STYLESHEET_FILE =
  1095 +
  1096 +# Set optional variables used in the generation of an rtf document.
  1097 +# Syntax is similar to doxygen's config file.
  1098 +
  1099 +RTF_EXTENSIONS_FILE =
  1100 +
  1101 +#---------------------------------------------------------------------------
  1102 +# configuration options related to the man page output
  1103 +#---------------------------------------------------------------------------
  1104 +
  1105 +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
  1106 +# generate man pages
  1107 +
  1108 +GENERATE_MAN = NO
  1109 +
  1110 +# The MAN_OUTPUT tag is used to specify where the man pages will be put.
  1111 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
  1112 +# put in front of it. If left blank `man' will be used as the default path.
  1113 +
  1114 +MAN_OUTPUT = man
  1115 +
  1116 +# The MAN_EXTENSION tag determines the extension that is added to
  1117 +# the generated man pages (default is the subroutine's section .3)
  1118 +
  1119 +MAN_EXTENSION = .3
  1120 +
  1121 +# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
  1122 +# then it will generate one additional man file for each entity
  1123 +# documented in the real man page(s). These additional files
  1124 +# only source the real man page, but without them the man command
  1125 +# would be unable to find the correct page. The default is NO.
  1126 +
  1127 +MAN_LINKS = NO
  1128 +
  1129 +#---------------------------------------------------------------------------
  1130 +# configuration options related to the XML output
  1131 +#---------------------------------------------------------------------------
  1132 +
  1133 +# If the GENERATE_XML tag is set to YES Doxygen will
  1134 +# generate an XML file that captures the structure of
  1135 +# the code including all documentation.
  1136 +
  1137 +GENERATE_XML = NO
  1138 +
  1139 +# The XML_OUTPUT tag is used to specify where the XML pages will be put.
  1140 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
  1141 +# put in front of it. If left blank `xml' will be used as the default path.
  1142 +
  1143 +XML_OUTPUT = xml
  1144 +
  1145 +# The XML_SCHEMA tag can be used to specify an XML schema,
  1146 +# which can be used by a validating XML parser to check the
  1147 +# syntax of the XML files.
  1148 +
  1149 +XML_SCHEMA =
  1150 +
  1151 +# The XML_DTD tag can be used to specify an XML DTD,
  1152 +# which can be used by a validating XML parser to check the
  1153 +# syntax of the XML files.
  1154 +
  1155 +XML_DTD =
  1156 +
  1157 +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
  1158 +# dump the program listings (including syntax highlighting
  1159 +# and cross-referencing information) to the XML output. Note that
  1160 +# enabling this will significantly increase the size of the XML output.
  1161 +
  1162 +XML_PROGRAMLISTING = YES
  1163 +
  1164 +#---------------------------------------------------------------------------
  1165 +# configuration options for the AutoGen Definitions output
  1166 +#---------------------------------------------------------------------------
  1167 +
  1168 +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
  1169 +# generate an AutoGen Definitions (see autogen.sf.net) file
  1170 +# that captures the structure of the code including all
  1171 +# documentation. Note that this feature is still experimental
  1172 +# and incomplete at the moment.
  1173 +
  1174 +GENERATE_AUTOGEN_DEF = NO
  1175 +
  1176 +#---------------------------------------------------------------------------
  1177 +# configuration options related to the Perl module output
  1178 +#---------------------------------------------------------------------------
  1179 +
  1180 +# If the GENERATE_PERLMOD tag is set to YES Doxygen will
  1181 +# generate a Perl module file that captures the structure of
  1182 +# the code including all documentation. Note that this
  1183 +# feature is still experimental and incomplete at the
  1184 +# moment.
  1185 +
  1186 +GENERATE_PERLMOD = NO
  1187 +
  1188 +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
  1189 +# the necessary Makefile rules, Perl scripts and LaTeX code to be able
  1190 +# to generate PDF and DVI output from the Perl module output.
  1191 +
  1192 +PERLMOD_LATEX = NO
  1193 +
  1194 +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
  1195 +# nicely formatted so it can be parsed by a human reader.
  1196 +# This is useful
  1197 +# if you want to understand what is going on.
  1198 +# On the other hand, if this
  1199 +# tag is set to NO the size of the Perl module output will be much smaller
  1200 +# and Perl will parse it just the same.
  1201 +
  1202 +PERLMOD_PRETTY = YES
  1203 +
  1204 +# The names of the make variables in the generated doxyrules.make file
  1205 +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
  1206 +# This is useful so different doxyrules.make files included by the same
  1207 +# Makefile don't overwrite each other's variables.
  1208 +
  1209 +PERLMOD_MAKEVAR_PREFIX =
  1210 +
  1211 +#---------------------------------------------------------------------------
  1212 +# Configuration options related to the preprocessor
  1213 +#---------------------------------------------------------------------------
  1214 +
  1215 +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
  1216 +# evaluate all C-preprocessor directives found in the sources and include
  1217 +# files.
  1218 +
  1219 +ENABLE_PREPROCESSING = YES
  1220 +
  1221 +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
  1222 +# names in the source code. If set to NO (the default) only conditional
  1223 +# compilation will be performed. Macro expansion can be done in a controlled
  1224 +# way by setting EXPAND_ONLY_PREDEF to YES.
  1225 +
  1226 +MACRO_EXPANSION = NO
  1227 +
  1228 +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
  1229 +# then the macro expansion is limited to the macros specified with the
  1230 +# PREDEFINED and EXPAND_AS_DEFINED tags.
  1231 +
  1232 +EXPAND_ONLY_PREDEF = NO
  1233 +
  1234 +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
  1235 +# in the INCLUDE_PATH (see below) will be search if a #include is found.
  1236 +
  1237 +SEARCH_INCLUDES = YES
  1238 +
  1239 +# The INCLUDE_PATH tag can be used to specify one or more directories that
  1240 +# contain include files that are not input files but should be processed by
  1241 +# the preprocessor.
  1242 +
  1243 +INCLUDE_PATH =
  1244 +
  1245 +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  1246 +# patterns (like *.h and *.hpp) to filter out the header-files in the
  1247 +# directories. If left blank, the patterns specified with FILE_PATTERNS will
  1248 +# be used.
  1249 +
  1250 +INCLUDE_FILE_PATTERNS =
  1251 +
  1252 +# The PREDEFINED tag can be used to specify one or more macro names that
  1253 +# are defined before the preprocessor is started (similar to the -D option of
  1254 +# gcc). The argument of the tag is a list of macros of the form: name
  1255 +# or name=definition (no spaces). If the definition and the = are
  1256 +# omitted =1 is assumed. To prevent a macro definition from being
  1257 +# undefined via #undef or recursively expanded use the := operator
  1258 +# instead of the = operator.
  1259 +
  1260 +PREDEFINED = $(DEFINES)
  1261 +
  1262 +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
  1263 +# this tag can be used to specify a list of macro names that should be expanded.
  1264 +# The macro definition that is found in the sources will be used.
  1265 +# Use the PREDEFINED tag if you want to use a different macro definition.
  1266 +
  1267 +EXPAND_AS_DEFINED =
  1268 +
  1269 +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
  1270 +# doxygen's preprocessor will remove all function-like macros that are alone
  1271 +# on a line, have an all uppercase name, and do not end with a semicolon. Such
  1272 +# function macros are typically used for boiler-plate code, and will confuse
  1273 +# the parser if not removed.
  1274 +
  1275 +SKIP_FUNCTION_MACROS = YES
  1276 +
  1277 +#---------------------------------------------------------------------------
  1278 +# Configuration::additions related to external references
  1279 +#---------------------------------------------------------------------------
  1280 +
  1281 +# The TAGFILES option can be used to specify one or more tagfiles.
  1282 +# Optionally an initial location of the external documentation
  1283 +# can be added for each tagfile. The format of a tag file without
  1284 +# this location is as follows:
  1285 +#
  1286 +# TAGFILES = file1 file2 ...
  1287 +# Adding location for the tag files is done as follows:
  1288 +#
  1289 +# TAGFILES = file1=loc1 "file2 = loc2" ...
  1290 +# where "loc1" and "loc2" can be relative or absolute paths or
  1291 +# URLs. If a location is present for each tag, the installdox tool
  1292 +# does not have to be run to correct the links.
  1293 +# Note that each tag file must have a unique name
  1294 +# (where the name does NOT include the path)
  1295 +# If a tag file is not located in the directory in which doxygen
  1296 +# is run, you must also specify the path to the tagfile here.
  1297 +
  1298 +TAGFILES =
  1299 +
  1300 +# When a file name is specified after GENERATE_TAGFILE, doxygen will create
  1301 +# a tag file that is based on the input files it reads.
  1302 +
  1303 +GENERATE_TAGFILE =
  1304 +
  1305 +# If the ALLEXTERNALS tag is set to YES all external classes will be listed
  1306 +# in the class index. If set to NO only the inherited external classes
  1307 +# will be listed.
  1308 +
  1309 +ALLEXTERNALS = NO
  1310 +
  1311 +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
  1312 +# in the modules index. If set to NO, only the current project's groups will
  1313 +# be listed.
  1314 +
  1315 +EXTERNAL_GROUPS = YES
  1316 +
  1317 +# The PERL_PATH should be the absolute path and name of the perl script
  1318 +# interpreter (i.e. the result of `which perl').
  1319 +
  1320 +PERL_PATH = /usr/bin/perl
  1321 +
  1322 +#---------------------------------------------------------------------------
  1323 +# Configuration options related to the dot tool
  1324 +#---------------------------------------------------------------------------
  1325 +
  1326 +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
  1327 +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
  1328 +# or super classes. Setting the tag to NO turns the diagrams off. Note that
  1329 +# this option is superseded by the HAVE_DOT option below. This is only a
  1330 +# fallback. It is recommended to install and use dot, since it yields more
  1331 +# powerful graphs.
  1332 +
  1333 +CLASS_DIAGRAMS = YES
  1334 +
  1335 +# You can define message sequence charts within doxygen comments using the \msc
  1336 +# command. Doxygen will then run the mscgen tool (see
  1337 +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
  1338 +# documentation. The MSCGEN_PATH tag allows you to specify the directory where
  1339 +# the mscgen tool resides. If left empty the tool is assumed to be found in the
  1340 +# default search path.
  1341 +
  1342 +MSCGEN_PATH =
  1343 +
  1344 +# If set to YES, the inheritance and collaboration graphs will hide
  1345 +# inheritance and usage relations if the target is undocumented
  1346 +# or is not a class.
  1347 +
  1348 +HIDE_UNDOC_RELATIONS = YES
  1349 +
  1350 +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  1351 +# available from the path. This tool is part of Graphviz, a graph visualization
  1352 +# toolkit from AT&T and Lucent Bell Labs. The other options in this section
  1353 +# have no effect if this option is set to NO (the default)
  1354 +
  1355 +HAVE_DOT = NO
  1356 +
  1357 +# By default doxygen will write a font called FreeSans.ttf to the output
  1358 +# directory and reference it in all dot files that doxygen generates. This
  1359 +# font does not include all possible unicode characters however, so when you need
  1360 +# these (or just want a differently looking font) you can specify the font name
  1361 +# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
  1362 +# which can be done by putting it in a standard location or by setting the
  1363 +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
  1364 +# containing the font.
  1365 +
  1366 +DOT_FONTNAME = FreeSans
  1367 +
  1368 +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
  1369 +# The default size is 10pt.
  1370 +
  1371 +DOT_FONTSIZE = 10
  1372 +
  1373 +# By default doxygen will tell dot to use the output directory to look for the
  1374 +# FreeSans.ttf font (which doxygen will put there itself). If you specify a
  1375 +# different font using DOT_FONTNAME you can set the path where dot
  1376 +# can find it using this tag.
  1377 +
  1378 +DOT_FONTPATH =
  1379 +
  1380 +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
  1381 +# will generate a graph for each documented class showing the direct and
  1382 +# indirect inheritance relations. Setting this tag to YES will force the
  1383 +# the CLASS_DIAGRAMS tag to NO.
  1384 +
  1385 +CLASS_GRAPH = YES
  1386 +
  1387 +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
  1388 +# will generate a graph for each documented class showing the direct and
  1389 +# indirect implementation dependencies (inheritance, containment, and
  1390 +# class references variables) of the class with other documented classes.
  1391 +
  1392 +COLLABORATION_GRAPH = YES
  1393 +
  1394 +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
  1395 +# will generate a graph for groups, showing the direct groups dependencies
  1396 +
  1397 +GROUP_GRAPHS = YES
  1398 +
  1399 +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
  1400 +# collaboration diagrams in a style similar to the OMG's Unified Modeling
  1401 +# Language.
  1402 +
  1403 +UML_LOOK = NO
  1404 +
  1405 +# If set to YES, the inheritance and collaboration graphs will show the
  1406 +# relations between templates and their instances.
  1407 +
  1408 +TEMPLATE_RELATIONS = NO
  1409 +
  1410 +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
  1411 +# tags are set to YES then doxygen will generate a graph for each documented
  1412 +# file showing the direct and indirect include dependencies of the file with
  1413 +# other documented files.
  1414 +
  1415 +INCLUDE_GRAPH = YES
  1416 +
  1417 +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
  1418 +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
  1419 +# documented header file showing the documented files that directly or
  1420 +# indirectly include this file.
  1421 +
  1422 +INCLUDED_BY_GRAPH = YES
  1423 +
  1424 +# If the CALL_GRAPH and HAVE_DOT options are set to YES then
  1425 +# doxygen will generate a call dependency graph for every global function
  1426 +# or class method. Note that enabling this option will significantly increase
  1427 +# the time of a run. So in most cases it will be better to enable call graphs
  1428 +# for selected functions only using the \callgraph command.
  1429 +
  1430 +CALL_GRAPH = NO
  1431 +
  1432 +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
  1433 +# doxygen will generate a caller dependency graph for every global function
  1434 +# or class method. Note that enabling this option will significantly increase
  1435 +# the time of a run. So in most cases it will be better to enable caller
  1436 +# graphs for selected functions only using the \callergraph command.
  1437 +
  1438 +CALLER_GRAPH = NO
  1439 +
  1440 +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
  1441 +# will graphical hierarchy of all classes instead of a textual one.
  1442 +
  1443 +GRAPHICAL_HIERARCHY = YES
  1444 +
  1445 +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
  1446 +# then doxygen will show the dependencies a directory has on other directories
  1447 +# in a graphical way. The dependency relations are determined by the #include
  1448 +# relations between the files in the directories.
  1449 +
  1450 +DIRECTORY_GRAPH = YES
  1451 +
  1452 +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  1453 +# generated by dot. Possible values are png, jpg, or gif
  1454 +# If left blank png will be used.
  1455 +
  1456 +DOT_IMAGE_FORMAT = png
  1457 +
  1458 +# The tag DOT_PATH can be used to specify the path where the dot tool can be
  1459 +# found. If left blank, it is assumed the dot tool can be found in the path.
  1460 +
  1461 +DOT_PATH =
  1462 +
  1463 +# The DOTFILE_DIRS tag can be used to specify one or more directories that
  1464 +# contain dot files that are included in the documentation (see the
  1465 +# \dotfile command).
  1466 +
  1467 +DOTFILE_DIRS =
  1468 +
  1469 +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
  1470 +# nodes that will be shown in the graph. If the number of nodes in a graph
  1471 +# becomes larger than this value, doxygen will truncate the graph, which is
  1472 +# visualized by representing a node as a red box. Note that doxygen if the
  1473 +# number of direct children of the root node in a graph is already larger than
  1474 +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
  1475 +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  1476 +
  1477 +DOT_GRAPH_MAX_NODES = 50
  1478 +
  1479 +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
  1480 +# graphs generated by dot. A depth value of 3 means that only nodes reachable
  1481 +# from the root by following a path via at most 3 edges will be shown. Nodes
  1482 +# that lay further from the root node will be omitted. Note that setting this
  1483 +# option to 1 or 2 may greatly reduce the computation time needed for large
  1484 +# code bases. Also note that the size of a graph can be further restricted by
  1485 +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
  1486 +
  1487 +MAX_DOT_GRAPH_DEPTH = 0
  1488 +
  1489 +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  1490 +# background. This is disabled by default, because dot on Windows does not
  1491 +# seem to support this out of the box. Warning: Depending on the platform used,
  1492 +# enabling this option may lead to badly anti-aliased labels on the edges of
  1493 +# a graph (i.e. they become hard to read).
  1494 +
  1495 +DOT_TRANSPARENT = NO
  1496 +
  1497 +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
  1498 +# files in one run (i.e. multiple -o and -T options on the command line). This
  1499 +# makes dot run faster, but since only newer versions of dot (>1.8.10)
  1500 +# support this, this feature is disabled by default.
  1501 +
  1502 +DOT_MULTI_TARGETS = YES
  1503 +
  1504 +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
  1505 +# generate a legend page explaining the meaning of the various boxes and
  1506 +# arrows in the dot generated graphs.
  1507 +
  1508 +GENERATE_LEGEND = YES
  1509 +
  1510 +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
  1511 +# remove the intermediate dot files that are used to generate
  1512 +# the various graphs.
  1513 +
  1514 +DOT_CLEANUP = YES
... ...