ElementaryUtils.doxyfile 105 KB
Newer Older
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# Doxyfile 1.8.13

# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
#
# All text after a double hash (##) is considered a comment and is placed in
# front of the TAG it is preceding.
#
# All text after a single hash (#) is considered a comment and will be ignored.
# The format is:
# TAG = value [value, ...]
# For lists, items can also be appended using:
# TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (\" \").

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------

# This tag specifies the encoding used for all characters in the config file
# that follow. The default is UTF-8 which is also the encoding used for all text
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
# for the list of possible encodings.
# The default value is: UTF-8.

Nabil Chouika's avatar
Nabil Chouika committed
27
DOXYFILE_ENCODING      = UTF-8
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
28
29
30
31
32
33
34

# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
# double-quotes, unless you are using Doxywizard) that should identify the
# project for which the documentation is generated. This name is used in the
# title of most generated pages and in a few other places.
# The default value is: My Project.

Nabil Chouika's avatar
Nabil Chouika committed
35
PROJECT_NAME           = ElementaryUtils
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
36
37
38
39
40

# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
# control system is used.

Nabil Chouika's avatar
Nabil Chouika committed
41
PROJECT_NUMBER         = 1.0
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
42
43
44
45
46

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.

Nabil Chouika's avatar
Nabil Chouika committed
47
PROJECT_BRIEF          =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
48
49
50
51
52
53

# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.

Nabil Chouika's avatar
Nabil Chouika committed
54
PROJECT_LOGO           =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
55
56
57
58
59
60

# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.

Nabil Chouika's avatar
Nabil Chouika committed
61
OUTPUT_DIRECTORY       = doc
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
62
63
64
65
66
67
68
69
70

# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
# will distribute the generated files over these directories. Enabling this
# option can be useful when feeding doxygen a huge amount of source files, where
# putting all generated files in the same directory would otherwise causes
# performance problems for the file system.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
71
CREATE_SUBDIRS         = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
72
73
74
75
76
77
78

# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
# characters to appear in the names of generated files. If set to NO, non-ASCII
# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
# U+3044.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
79
ALLOW_UNICODE_NAMES    = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
80
81
82
83
84
85
86
87
88
89
90
91
92
93

# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
# Ukrainian and Vietnamese.
# The default value is: English.

Nabil Chouika's avatar
Nabil Chouika committed
94
OUTPUT_LANGUAGE        = English
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
95
96
97
98
99
100

# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
# descriptions after the members that are listed in the file and class
# documentation (similar to Javadoc). Set to NO to disable this.
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
101
BRIEF_MEMBER_DESC      = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
102
103
104
105
106
107
108
109

# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
# description of a member or function before the detailed description
#
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
110
REPEAT_BRIEF           = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
111
112
113
114
115
116
117
118
119
120

# This tag implements a quasi-intelligent brief description abbreviator that is
# used to form the text in various listings. Each string in this list, if found
# as the leading text of the brief description, will be stripped from the text
# and the result, after processing the whole list, is used as the annotated
# text. Otherwise, the brief description is used as-is. If left blank, the
# following values are used ($name is automatically replaced with the name of
# the entity):The $name class, The $name widget, The $name file, is, provides,
# specifies, contains, represents, a, an and the.

Nabil Chouika's avatar
Nabil Chouika committed
121
122
123
124
125
126
127
128
129
130
131
ABBREVIATE_BRIEF       = "The $name class" \
                         "The $name widget" \
                         "The $name file" \
                         is \
                         provides \
                         specifies \
                         contains \
                         represents \
                         a \
                         an \
                         the
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
132
133
134
135
136
137

# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# doxygen will generate a detailed section even if there is only a brief
# description.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
138
ALWAYS_DETAILED_SEC    = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
139
140
141
142
143
144
145

# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
# operators of the base classes will not be shown.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
146
INLINE_INHERITED_MEMB  = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
147
148
149
150
151
152

# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
# before files name in the file list and in the header files. If set to NO the
# shortest path that makes the file name unique will be used
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
153
FULL_PATH_NAMES        = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
154
155
156
157
158
159
160
161
162
163
164

# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
# Stripping is only done if one of the specified strings matches the left-hand
# part of the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the path to
# strip.
#
# Note that you can specify absolute paths here, but also relative paths, which
# will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.

Nabil Chouika's avatar
Nabil Chouika committed
165
STRIP_FROM_PATH        =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
166
167
168
169
170
171
172
173

# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
# path mentioned in the documentation of a class, which tells the reader which
# header file to include in order to use a class. If left blank only the name of
# the header file containing the class definition is used. Otherwise one should
# specify the list of include paths that are normally passed to the compiler
# using the -I flag.

Nabil Chouika's avatar
Nabil Chouika committed
174
STRIP_FROM_INC_PATH    =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
175
176
177
178
179
180

# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
# less readable) file names. This can be useful is your file systems doesn't
# support long names like on DOS, Mac, or CD-ROM.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
181
SHORT_NAMES            = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
182
183
184
185
186
187
188
189

# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
# first line (until the first dot) of a Javadoc-style comment as the brief
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
# style comments (thus requiring an explicit @brief command for a brief
# description.)
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
190
JAVADOC_AUTOBRIEF      = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
191
192
193
194
195
196
197

# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
# line (until the first dot) of a Qt-style comment as the brief description. If
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
# requiring an explicit \brief command for a brief description.)
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
198
QT_AUTOBRIEF           = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215

# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
# a brief description. This used to be the default behavior. The new default is
# to treat a multi-line C++ comment block as a detailed description. Set this
# tag to YES if you prefer the old behavior instead.
#
# Note that setting this tag to YES also means that rational rose comments are
# not recognized any more.
# The default value is: NO.

MULTILINE_CPP_IS_BRIEF = NO

# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
# documentation from any documented member that it re-implements.
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
216
INHERIT_DOCS           = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
217
218
219
220
221
222

# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
# page for each member. If set to NO, the documentation of a member will be part
# of the file/class/namespace that contains it.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
223
SEPARATE_MEMBER_PAGES  = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
224
225
226
227
228

# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
# uses this value to replace tabs by spaces in code fragments.
# Minimum value: 1, maximum value: 16, default value: 4.

Nabil Chouika's avatar
Nabil Chouika committed
229
TAB_SIZE               = 4
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
230
231
232
233
234
235
236
237
238
239
240

# This tag can be used to specify a number of aliases that act as commands in
# the documentation. An alias has the form:
# name=value
# For example adding
# "sideeffect=@par Side Effects:\n"
# will allow you to put the command \sideeffect (or @sideeffect) in the
# documentation, which will result in a user-defined paragraph with heading
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines.

Nabil Chouika's avatar
Nabil Chouika committed
241
ALIASES                =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
242
243
244
245
246

# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"
# will allow you to use the command class in the itcl::class meaning.

Nabil Chouika's avatar
Nabil Chouika committed
247
TCL_SUBST              =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
248
249
250
251
252
253
254

# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
# instance, some of the names that are used will be different. The list of all
# members will be omitted, etc.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
255
OPTIMIZE_OUTPUT_FOR_C  = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
256
257
258
259
260
261
262

# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
# Python sources only. Doxygen will then generate output that is more tailored
# for that language. For instance, namespaces will be presented as packages,
# qualified scopes will look different, etc.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
263
OPTIMIZE_OUTPUT_JAVA   = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
264
265
266
267
268

# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources. Doxygen will then generate output that is tailored for Fortran.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
269
OPTIMIZE_FOR_FORTRAN   = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
270
271
272
273
274

# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for VHDL.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
275
OPTIMIZE_OUTPUT_VHDL   = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293

# Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given
# extension. Doxygen has a built-in mapping, but you can override or extend it
# using this tag. The format is ext=language, where ext is a file extension, and
# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
# Fortran. In the later case the parser tries to guess whether the code is fixed
# or free formatted code, this is the default for Fortran type files), VHDL. For
# instance to make doxygen treat .inc files as Fortran files (default is PHP),
# and .f files as C (default is Fortran), use: inc=Fortran f=C.
#
# Note: For files without extension you can use no_extension as a placeholder.
#
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
# the files are not read by doxygen.

Nabil Chouika's avatar
Nabil Chouika committed
294
EXTENSION_MAPPING      =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
295
296
297
298
299
300
301
302
303

# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
# documentation. See http://daringfireball.net/projects/markdown/ for details.
# The output of markdown processing is further processed by doxygen, so you can
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
# case of backward compatibilities issues.
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
304
MARKDOWN_SUPPORT       = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
305
306
307
308
309
310
311
312

# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
# to that level are automatically included in the table of contents, even if
# they do not have an id attribute.
# Note: This feature currently applies only to Markdown headings.
# Minimum value: 0, maximum value: 99, default value: 0.
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.

Nabil Chouika's avatar
Nabil Chouika committed
313
TOC_INCLUDE_HEADINGS   = 0
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
314
315
316
317
318
319
320

# When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can
# be prevented in individual cases by putting a % sign in front of the word or
# globally by setting AUTOLINK_SUPPORT to NO.
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
321
AUTOLINK_SUPPORT       = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
322
323
324
325
326
327
328
329
330

# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should set this
# tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string);
# versus func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
331
BUILTIN_STL_SUPPORT    = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
332
333
334
335
336

# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
337
CPP_CLI_SUPPORT        = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
338
339
340
341
342
343
344

# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
# will parse them like normal C++ but will assume all classes use public instead
# of private inheritance when no explicit protection keyword is present.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
345
SIP_SUPPORT            = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
346
347
348
349
350
351
352
353
354

# For Microsoft's IDL there are propget and propput attributes to indicate
# getter and setter methods for a property. Setting this option to YES will make
# doxygen to replace the get and set methods by a property in the documentation.
# This will only work if the methods are indeed getting or setting a simple
# type. If this is not the case, or you want to show the methods anyway, you
# should set this option to NO.
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
355
IDL_PROPERTY_SUPPORT   = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
356
357
358
359
360
361
362

# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
363
DISTRIBUTE_GROUP_DOC   = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378

# If one adds a struct or class to a group and this option is enabled, then also
# any nested class or struct is added to the same group. By default this option
# is disabled and one has to add nested compounds explicitly via \ingroup.
# The default value is: NO.

GROUP_NESTED_COMPOUNDS = NO

# Set the SUBGROUPING tag to YES to allow class member groups of the same type
# (for instance a group of public functions) to be put as a subgroup of that
# type (e.g. under the Public Functions section). Set it to NO to prevent
# subgrouping. Alternatively, this can be done per class using the
# \nosubgrouping command.
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
379
SUBGROUPING            = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399

# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
# are shown inside the group in which they are included (e.g. using \ingroup)
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
# and RTF).
#
# Note that this feature does not work in combination with
# SEPARATE_MEMBER_PAGES.
# The default value is: NO.

INLINE_GROUPED_CLASSES = NO

# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
# with only public data fields or simple typedef fields will be shown inline in
# the documentation of the scope in which they are defined (i.e. file,
# namespace, or group documentation), provided this scope is documented. If set
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
# Man pages) or section (for LaTeX and RTF).
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
400
INLINE_SIMPLE_STRUCTS  = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
401
402
403
404
405
406
407
408
409
410

# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
# enum is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
# namespace, or class. And the struct will be named TypeS. This can typically be
# useful for C code in case the coding convention dictates that all compound
# types are typedef'ed and only the typedef is referenced, never the tag name.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
411
TYPEDEF_HIDES_STRUCT   = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
412
413
414
415
416
417
418
419
420
421
422
423

# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
# cache is used to resolve symbols given their name and scope. Since this can be
# an expensive process and often the same symbol appears multiple times in the
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
# doxygen will become slower. If the cache is too large, memory is wasted. The
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
# symbols. At the end of a run doxygen will report the cache usage and suggest
# the optimal cache size from a speed point of view.
# Minimum value: 0, maximum value: 9, default value: 0.

Nabil Chouika's avatar
Nabil Chouika committed
424
LOOKUP_CACHE_SIZE      = 0
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
425
426
427
428
429
430
431
432
433
434
435
436
437

#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------

# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
# documentation are documented, even if no documentation was available. Private
# class members and static file members will be hidden unless the
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
# Note: This will also disable the warnings about undocumented members that are
# normally produced when WARNINGS is set to YES.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
438
EXTRACT_ALL            = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
439
440
441
442
443

# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
# be included in the documentation.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
444
EXTRACT_PRIVATE        = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
445
446
447
448
449

# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
450
EXTRACT_PACKAGE        = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
451
452
453
454
455

# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
# included in the documentation.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
456
EXTRACT_STATIC         = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
457
458
459
460
461
462
463

# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
# only classes defined in header files are included. Does not have any effect
# for Java sources.
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
464
EXTRACT_LOCAL_CLASSES  = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
465
466
467
468
469
470
471

# This flag is only useful for Objective-C code. If set to YES, local methods,
# which are defined in the implementation section but not in the interface are
# included in the documentation. If set to NO, only methods in the interface are
# included.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
472
EXTRACT_LOCAL_METHODS  = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
473
474
475
476
477
478
479
480

# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base name of
# the file that contains the anonymous namespace. By default anonymous namespace
# are hidden.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
481
EXTRACT_ANON_NSPACES   = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
482
483
484
485
486
487
488

# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
# undocumented members inside documented classes or files. If set to NO these
# members will be included in the various overviews, but no documentation
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
489
HIDE_UNDOC_MEMBERS     = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
490
491
492
493
494
495
496

# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy. If set
# to NO, these classes will be included in the various overviews. This option
# has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
497
HIDE_UNDOC_CLASSES     = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
498
499
500
501
502
503

# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
# (class|struct|union) declarations. If set to NO, these declarations will be
# included in the documentation.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
504
HIDE_FRIEND_COMPOUNDS  = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
505
506
507
508
509
510

# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
# documentation blocks found inside the body of a function. If set to NO, these
# blocks will be appended to the function's detailed documentation block.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
511
HIDE_IN_BODY_DOCS      = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
512
513
514
515
516
517

# The INTERNAL_DOCS tag determines if documentation that is typed after a
# \internal command is included. If the tag is set to NO then the documentation
# will be excluded. Set it to YES to include the internal documentation.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
518
INTERNAL_DOCS          = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
519
520
521
522
523
524
525
526

# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
# names in lower-case letters. If set to YES, upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
# and Mac users are advised to set this option to NO.
# The default value is: system dependent.

Nabil Chouika's avatar
Nabil Chouika committed
527
CASE_SENSE_NAMES       = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
528
529
530
531
532
533

# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
# their full class and namespace scopes in the documentation. If set to YES, the
# scope will be hidden.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
534
HIDE_SCOPE_NAMES       = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
535
536
537
538
539
540

# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
# append additional text to a page's title, such as Class Reference. If set to
# YES the compound reference will be hidden.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
541
HIDE_COMPOUND_REFERENCE= NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
542
543
544
545
546

# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
# the files that are included by a file in the documentation of that file.
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
547
SHOW_INCLUDE_FILES     = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
548
549
550
551
552
553

# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
# grouped member an include statement to the documentation, telling the reader
# which file to include in order to use the member.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
554
SHOW_GROUPED_MEMB_INC  = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
555
556
557
558
559

# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
# files with double quotes in the documentation rather than with sharp brackets.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
560
FORCE_LOCAL_INCLUDES   = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
561
562
563
564
565

# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
# documentation for inline members.
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
566
INLINE_INFO            = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
567
568
569
570
571
572

# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
# (detailed) documentation of file and class members alphabetically by member
# name. If set to NO, the members will appear in declaration order.
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
573
SORT_MEMBER_DOCS       = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
574
575
576
577
578
579
580

# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
# descriptions of file, namespace and class members alphabetically by member
# name. If set to NO, the members will appear in declaration order. Note that
# this will also influence the order of the classes in the class list.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
581
SORT_BRIEF_DOCS        = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599

# 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 constructors will appear in the
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
# member documentation.
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
# detailed member documentation.
# The default value is: NO.

SORT_MEMBERS_CTORS_1ST = NO

# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
# of group names into alphabetical order. If set to NO the group names will
# appear in their defined order.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
600
SORT_GROUP_NAMES       = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
601
602
603
604
605
606
607
608
609

# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
# fully-qualified names, including namespaces. If set to NO, the class list will
# be sorted only by class name, not including the namespace part.
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
# Note: This option applies only to the class list, not to the alphabetical
# list.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
610
SORT_BY_SCOPE_NAME     = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
611
612
613
614
615
616
617
618
619

# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
# type resolution of all parameters of a function it will reject a match between
# the prototype and the implementation of a member function even if there is
# only one candidate or it is obvious which candidate to choose by doing a
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
# accept a match between prototype and implementation in such cases.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
620
STRICT_PROTO_MATCHING  = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
621
622
623
624
625

# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
# list. This list is created by putting \todo commands in the documentation.
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
626
GENERATE_TODOLIST      = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
627
628
629
630
631

# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
# list. This list is created by putting \test commands in the documentation.
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
632
GENERATE_TESTLIST      = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
633
634
635
636
637

# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
# list. This list is created by putting \bug commands in the documentation.
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
638
GENERATE_BUGLIST       = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
639
640
641
642
643
644

# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
# the deprecated list. This list is created by putting \deprecated commands in
# the documentation.
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
645
GENERATE_DEPRECATEDLIST= YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
646
647
648
649
650

# The ENABLED_SECTIONS tag can be used to enable conditional documentation
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
# ... \endcond blocks.

Nabil Chouika's avatar
Nabil Chouika committed
651
ENABLED_SECTIONS       =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
652
653
654
655
656
657
658
659
660
661

# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
# initial value of a variable or macro / define can have for it to appear in the
# documentation. If the initializer consists of more lines than specified here
# it will be hidden. Use a value of 0 to hide initializers completely. The
# appearance of the value of individual variables and macros / defines can be
# controlled using \showinitializer or \hideinitializer command in the
# documentation regardless of this setting.
# Minimum value: 0, maximum value: 10000, default value: 30.

Nabil Chouika's avatar
Nabil Chouika committed
662
MAX_INITIALIZER_LINES  = 30
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
663
664
665
666
667
668

# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
# the bottom of the documentation of classes and structs. If set to YES, the
# list will mention the files that were used to generate the documentation.
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
669
SHOW_USED_FILES        = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
670
671
672
673
674
675

# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
# will remove the Files entry from the Quick Index and from the Folder Tree View
# (if specified).
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
676
SHOW_FILES             = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
677
678
679
680
681
682

# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
# page. This will remove the Namespaces entry from the Quick Index and from the
# Folder Tree View (if specified).
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
683
SHOW_NAMESPACES        = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
684
685
686
687
688
689
690
691
692

# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via
# popen()) the command command input-file, where command is the value of the
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
# by doxygen. Whatever the program writes to standard output is used as the file
# version. For an example see the documentation.

Nabil Chouika's avatar
Nabil Chouika committed
693
FILE_VERSION_FILTER    =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
694
695
696
697
698
699
700
701
702
703
704
705

# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
# by doxygen. The layout file controls the global structure of the generated
# output files in an output format independent way. To create the layout file
# that represents doxygen's defaults, run doxygen with the -l option. You can
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
# will be used as the name of the layout file.
#
# Note that if you run doxygen from a directory containing a file called
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.

Nabil Chouika's avatar
Nabil Chouika committed
706
LAYOUT_FILE            =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
707
708
709
710
711
712
713
714
715

# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
# extension is automatically appended if omitted. This requires the bibtex tool
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
# For LaTeX the style of the bibliography can be controlled using
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
# search path. See also \cite for info how to create references.

Nabil Chouika's avatar
Nabil Chouika committed
716
CITE_BIB_FILES         =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
717
718
719
720
721
722
723
724
725
726

#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
#---------------------------------------------------------------------------

# The QUIET tag can be used to turn on/off the messages that are generated to
# standard output by doxygen. If QUIET is set to YES this implies that the
# messages are off.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
727
QUIET                  = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
728
729
730
731
732
733
734
735

# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
# this implies that the warnings are on.
#
# Tip: Turn warnings on while writing the documentation.
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
736
WARNINGS               = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
737
738
739
740
741
742

# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
# will automatically be disabled.
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
743
WARN_IF_UNDOCUMENTED   = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
744
745
746
747
748
749
750

# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some parameters
# in a documented function, or documenting parameters that don't exist or using
# markup commands wrongly.
# The default value is: YES.

Nabil Chouika's avatar
Nabil Chouika committed
751
WARN_IF_DOC_ERROR      = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
752
753
754
755
756
757
758

# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
# are documented, but have no documentation for their parameters or return
# value. If set to NO, doxygen will only warn about wrong or incomplete
# parameter documentation, but not about the absence of documentation.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
759
WARN_NO_PARAMDOC       = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
760
761
762
763
764

# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
# a warning is encountered.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
765
WARN_AS_ERROR          = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
766
767
768
769
770
771
772
773
774

# The WARN_FORMAT tag determines the format of the warning messages that doxygen
# can produce. The string should contain the $file, $line, and $text tags, which
# will be replaced by the file and line number from which the warning originated
# and the warning text. Optionally the format may contain $version, which will
# be replaced by the version of the file (if it could be obtained via
# FILE_VERSION_FILTER)
# The default value is: $file:$line: $text.

Nabil Chouika's avatar
Nabil Chouika committed
775
WARN_FORMAT            = "$file:$line: $text"
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
776
777
778
779
780

# The WARN_LOGFILE tag can be used to specify a file to which warning and error
# messages should be written. If left blank the output is written to standard
# error (stderr).

Nabil Chouika's avatar
Nabil Chouika committed
781
WARN_LOGFILE           =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
782
783
784
785
786
787
788
789
790
791
792

#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------

# The INPUT tag is used to specify the files and/or directories that contain
# documented source files. You may enter file names like myfile.cpp or
# directories like /usr/src/myproject. Separate the files or directories with
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

Nabil Chouika's avatar
Nabil Chouika committed
793
794
INPUT                  = src \
                         include
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
795
796
797
798
799
800
801
802

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
# documentation (see: http://www.gnu.org/software/libiconv) for the list of
# possible encodings.
# The default value is: UTF-8.

Nabil Chouika's avatar
Nabil Chouika committed
803
INPUT_ENCODING         = UTF-8
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818

# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
# *.h) to filter out the source-files in the directories.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# read by doxygen.
#
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.

Nabil Chouika's avatar
Nabil Chouika committed
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
FILE_PATTERNS          = *.c \
                         *.cc \
                         *.cxx \
                         *.cpp \
                         *.c++ \
                         *.java \
                         *.ii \
                         *.ixx \
                         *.ipp \
                         *.i++ \
                         *.inl \
                         *.idl \
                         *.ddl \
                         *.odl \
                         *.h \
                         *.hh \
                         *.hxx \
                         *.hpp \
                         *.h++ \
                         *.cs \
                         *.d \
                         *.php \
                         *.php4 \
                         *.php5 \
                         *.phtml \
                         *.inc \
                         *.m \
                         *.markdown \
                         *.md \
                         *.mm \
                         *.dox \
                         *.py \
                         *.pyw \
                         *.f90 \
                         *.f95 \
                         *.f03 \
                         *.f08 \
                         *.f \
                         *.for \
                         *.tcl \
                         *.vhd \
                         *.vhdl \
                         *.ucf \
                         *.qsf
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
863
864
865
866
867

# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
868
RECURSIVE              = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
869
870
871
872
873
874
875
876

# The EXCLUDE tag can be used to specify files and/or directories that should be
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
#
# Note that relative paths are relative to the directory from which doxygen is
# run.

Nabil Chouika's avatar
Nabil Chouika committed
877
EXCLUDE                =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
878
879
880
881
882
883

# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
# from the input.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
884
EXCLUDE_SYMLINKS       = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
885
886
887
888
889
890
891
892

# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories.
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/*

Nabil Chouika's avatar
Nabil Chouika committed
893
EXCLUDE_PATTERNS       =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
894
895
896
897
898
899
900
901
902
903

# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories use the pattern */test/*

Nabil Chouika's avatar
Nabil Chouika committed
904
EXCLUDE_SYMBOLS        =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
905
906
907
908
909

# The EXAMPLE_PATH tag can be used to specify one or more files or directories
# that contain example code fragments that are included (see the \include
# command).

Nabil Chouika's avatar
Nabil Chouika committed
910
EXAMPLE_PATH           =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
911
912
913
914
915
916

# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
# *.h) to filter out the source-files in the directories. If left blank all
# files are included.

Nabil Chouika's avatar
Nabil Chouika committed
917
EXAMPLE_PATTERNS       = *
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
918
919
920
921
922
923

# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude commands
# irrespective of the value of the RECURSIVE tag.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
924
EXAMPLE_RECURSIVE      = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
925
926
927
928
929

# The IMAGE_PATH tag can be used to specify one or more files or directories
# that contain images that are to be included in the documentation (see the
# \image command).

Nabil Chouika's avatar
Nabil Chouika committed
930
IMAGE_PATH             =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950

# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command:
#
# <filter> <input-file>
#
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
# name of an input file. Doxygen will then use the output that the filter
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
# will be ignored.
#
# Note that the filter must not add or remove lines; it is applied before the
# code is scanned, but not when the output code is generated. If lines are added
# or removed, the anchors will not be placed correctly.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.

Nabil Chouika's avatar
Nabil Chouika committed
951
INPUT_FILTER           =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
952
953
954
955
956
957
958
959
960
961
962
963

# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis. Doxygen will compare the file name with each pattern and apply the
# filter if there is a match. The filters are a list of the form: pattern=filter
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
# patterns match the file name, INPUT_FILTER is applied.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.

Nabil Chouika's avatar
Nabil Chouika committed
964
FILTER_PATTERNS        =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
965
966
967
968
969
970

# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will also be used to filter the input files that are used for
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
971
FILTER_SOURCE_FILES    = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
972
973
974
975
976
977
978

# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
# it is also possible to disable source filtering for a specific pattern using
# *.ext= (so without naming a filter).
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.

Nabil Chouika's avatar
Nabil Chouika committed
979
FILTER_SOURCE_PATTERNS =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
980
981
982
983
984
985

# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
# is part of the input, its contents will be placed on the main page
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.

Nabil Chouika's avatar
Nabil Chouika committed
986
USE_MDFILE_AS_MAINPAGE =
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
987
988
989
990
991
992
993
994
995
996
997
998

#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------

# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
# generated. Documented entities will be cross-referenced with these sources.
#
# Note: To get rid of all source code in the generated output, make sure that
# also VERBATIM_HEADERS is set to NO.
# The default value is: NO.

Nabil Chouika's avatar
Nabil Chouika committed
999
SOURCE_BROWSER         = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1000