ViewVC Help

View File | Revision Log | Show Annotations | View Changeset | Root Listing

root/svn/ircd-hybrid/branches/8.2.x/doc/Doxyfile

Comparing:
ircd-hybrid-7.3/doc/doxygen.conf (file contents), Revision 1029 by michael, Sun Nov 8 13:10:50 2009 UTC vs.
ircd-hybrid/branches/8.2.x/doc/Doxyfile (file contents), Revision 3377 by michael, Thu Apr 24 16:15:51 2014 UTC

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

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines (old)
>	Changed lines (new)