Repository Access Links:

This URL has Read-Only access.
Statistics
| Branch: | Revision:

dolibarr-module-template / build / doxygen / mymodule.doxyfile @ ef37f43f

History | View | Annotate | Download (103.4 kB)

1
# Doxyfile 1.8.12
2

    
3
# This file describes the settings to be used by the documentation system
4
# doxygen (www.doxygen.org) for a project.
5
#
6
# All text after a 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 (\" \").
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 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 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           = mymodule
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         = development
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          = My module brief.
48

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

    
54
PROJECT_LOGO           = ../../img/mymodule.png
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       = ../../doc/code/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         = YES
72

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

    
79
ALLOW_UNICODE_NAMES    = YES
80

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

    
94
OUTPUT_LANGUAGE        = English
95

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

    
101
BRIEF_MEMBER_DESC      = YES
102

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

    
110
REPEAT_BRIEF           = NO
111

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

    
121
ABBREVIATE_BRIEF       =
122

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

    
128
ALWAYS_DETAILED_SEC    = NO
129

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

    
136
INLINE_INHERITED_MEMB  = NO
137

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

    
143
FULL_PATH_NAMES        = YES
144

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

    
155
STRIP_FROM_PATH        = "../.."
156

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

    
164
STRIP_FROM_INC_PATH    =
165

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

    
171
SHORT_NAMES            = NO
172

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

    
180
JAVADOC_AUTOBRIEF      = YES
181

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

    
188
QT_AUTOBRIEF           = NO
189

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

    
200
MULTILINE_CPP_IS_BRIEF = NO
201

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

    
206
INHERIT_DOCS           = YES
207

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

    
213
SEPARATE_MEMBER_PAGES  = NO
214

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

    
219
TAB_SIZE               = 4
220

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

    
231
ALIASES                =
232

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

    
237
TCL_SUBST              =
238

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

    
245
OPTIMIZE_OUTPUT_FOR_C  = NO
246

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

    
253
OPTIMIZE_OUTPUT_JAVA   = NO
254

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

    
259
OPTIMIZE_FOR_FORTRAN   = NO
260

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

    
265
OPTIMIZE_OUTPUT_VHDL   = NO
266

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

    
284
EXTENSION_MAPPING      =
285

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

    
294
MARKDOWN_SUPPORT       = YES
295

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

    
303
TOC_INCLUDE_HEADINGS   = 0
304

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

    
311
AUTOLINK_SUPPORT       = YES
312

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

    
321
BUILTIN_STL_SUPPORT    = NO
322

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

    
327
CPP_CLI_SUPPORT        = NO
328

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

    
335
SIP_SUPPORT            = NO
336

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

    
345
IDL_PROPERTY_SUPPORT   = YES
346

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

    
353
DISTRIBUTE_GROUP_DOC   = NO
354

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

    
360
GROUP_NESTED_COMPOUNDS = NO
361

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

    
369
SUBGROUPING            = YES
370

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

    
380
INLINE_GROUPED_CLASSES = NO
381

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

    
390
INLINE_SIMPLE_STRUCTS  = NO
391

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

    
401
TYPEDEF_HIDES_STRUCT   = NO
402

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

    
414
LOOKUP_CACHE_SIZE      = 0
415

    
416
#---------------------------------------------------------------------------
417
# Build related configuration options
418
#---------------------------------------------------------------------------
419

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

    
428
EXTRACT_ALL            = NO
429

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

    
434
EXTRACT_PRIVATE        = YES
435

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

    
440
EXTRACT_PACKAGE        = NO
441

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

    
446
EXTRACT_STATIC         = YES
447

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

    
454
EXTRACT_LOCAL_CLASSES  = YES
455

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

    
462
EXTRACT_LOCAL_METHODS  = NO
463

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

    
471
EXTRACT_ANON_NSPACES   = YES
472

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

    
479
HIDE_UNDOC_MEMBERS     = YES
480

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

    
487
HIDE_UNDOC_CLASSES     = NO
488

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

    
494
HIDE_FRIEND_COMPOUNDS  = NO
495

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

    
501
HIDE_IN_BODY_DOCS      = NO
502

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

    
508
INTERNAL_DOCS          = NO
509

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

    
517
CASE_SENSE_NAMES       = NO
518

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

    
524
HIDE_SCOPE_NAMES       = NO
525

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

    
531
HIDE_COMPOUND_REFERENCE= NO
532

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

    
537
SHOW_INCLUDE_FILES     = YES
538

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

    
544
SHOW_GROUPED_MEMB_INC  = NO
545

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

    
550
FORCE_LOCAL_INCLUDES   = NO
551

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

    
556
INLINE_INFO            = YES
557

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

    
563
SORT_MEMBER_DOCS       = YES
564

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

    
571
SORT_BRIEF_DOCS        = NO
572

    
573
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
574
# (brief and detailed) documentation of class members so that constructors and
575
# destructors are listed first. If set to NO the constructors will appear in the
576
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
577
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
578
# member documentation.
579
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
580
# detailed member documentation.
581
# The default value is: NO.
582

    
583
SORT_MEMBERS_CTORS_1ST = NO
584

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

    
590
SORT_GROUP_NAMES       = NO
591

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

    
600
SORT_BY_SCOPE_NAME     = NO
601

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

    
610
STRICT_PROTO_MATCHING  = NO
611

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

    
616
GENERATE_TODOLIST      = YES
617

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

    
622
GENERATE_TESTLIST      = YES
623

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

    
628
GENERATE_BUGLIST       = YES
629

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

    
635
GENERATE_DEPRECATEDLIST= YES
636

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

    
641
ENABLED_SECTIONS       =
642

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

    
652
MAX_INITIALIZER_LINES  = 30
653

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

    
659
SHOW_USED_FILES        = YES
660

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

    
666
SHOW_FILES             = YES
667

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

    
673
SHOW_NAMESPACES        = NO
674

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

    
683
FILE_VERSION_FILTER    =
684

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

    
696
LAYOUT_FILE            =
697

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

    
706
CITE_BIB_FILES         =
707

    
708
#---------------------------------------------------------------------------
709
# Configuration options related to warning and progress messages
710
#---------------------------------------------------------------------------
711

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

    
717
QUIET                  = NO
718

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

    
726
WARNINGS               = YES
727

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

    
733
WARN_IF_UNDOCUMENTED   = YES
734

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

    
741
WARN_IF_DOC_ERROR      = YES
742

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

    
749
WARN_NO_PARAMDOC       = YES
750

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

    
755
WARN_AS_ERROR          = NO
756

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

    
765
WARN_FORMAT            = "$file:$line: $text"
766

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

    
771
WARN_LOGFILE           = doxygen_warnings.log
772

    
773
#---------------------------------------------------------------------------
774
# Configuration options related to the input files
775
#---------------------------------------------------------------------------
776

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

    
783
INPUT                  = ../..
784

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

    
792
INPUT_ENCODING         = UTF-8
793

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

    
808
FILE_PATTERNS          = *.php \
809
                         *.pl
810

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

    
815
RECURSIVE              = YES
816

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

    
824
EXCLUDE                = ../../build \
825
                         ../../dev \
826
                         ../../doc \
827
                         ../../vendor
828

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

    
834
EXCLUDE_SYMLINKS       = YES
835

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

    
843
EXCLUDE_PATTERNS       =
844

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

    
854
EXCLUDE_SYMBOLS        =
855

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

    
860
EXAMPLE_PATH           =
861

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

    
867
EXAMPLE_PATTERNS       = *.php
868

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

    
874
EXAMPLE_RECURSIVE      = NO
875

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

    
880
IMAGE_PATH             = ../../doc/images
881

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

    
901
INPUT_FILTER           =
902

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

    
914
FILTER_PATTERNS        =
915

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

    
921
FILTER_SOURCE_FILES    = NO
922

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

    
929
FILTER_SOURCE_PATTERNS =
930

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

    
936
USE_MDFILE_AS_MAINPAGE =
937

    
938
#---------------------------------------------------------------------------
939
# Configuration options related to source browsing
940
#---------------------------------------------------------------------------
941

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

    
949
SOURCE_BROWSER         = YES
950

    
951
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
952
# classes and enums directly into the documentation.
953
# The default value is: NO.
954

    
955
INLINE_SOURCES         = NO
956

    
957
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
958
# special comment blocks from generated source code fragments. Normal C, C++ and
959
# Fortran comments will always remain visible.
960
# The default value is: YES.
961

    
962
STRIP_CODE_COMMENTS    = YES
963

    
964
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
965
# function all documented functions referencing it will be listed.
966
# The default value is: NO.
967

    
968
REFERENCED_BY_RELATION = YES
969

    
970
# If the REFERENCES_RELATION tag is set to YES then for each documented function
971
# all documented entities called/used by that function will be listed.
972
# The default value is: NO.
973

    
974
REFERENCES_RELATION    = YES
975

    
976
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
977
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
978
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
979
# link to the documentation.
980
# The default value is: YES.
981

    
982
REFERENCES_LINK_SOURCE = YES
983

    
984
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
985
# source code will show a tooltip with additional information such as prototype,
986
# brief description and links to the definition and documentation. Since this
987
# will make the HTML file larger and loading of large files a bit slower, you
988
# can opt to disable this feature.
989
# The default value is: YES.
990
# This tag requires that the tag SOURCE_BROWSER is set to YES.
991

    
992
SOURCE_TOOLTIPS        = YES
993

    
994
# If the USE_HTAGS tag is set to YES then the references to source code will
995
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
996
# source browser. The htags tool is part of GNU's global source tagging system
997
# (see http://www.gnu.org/software/global/global.html). You will need version
998
# 4.8.6 or higher.
999
#
1000
# To use it do the following:
1001
# - Install the latest version of global
1002
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1003
# - Make sure the INPUT points to the root of the source tree
1004
# - Run doxygen as normal
1005
#
1006
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1007
# tools must be available from the command line (i.e. in the search path).
1008
#
1009
# The result: instead of the source browser generated by doxygen, the links to
1010
# source code will now point to the output of htags.
1011
# The default value is: NO.
1012
# This tag requires that the tag SOURCE_BROWSER is set to YES.
1013

    
1014
USE_HTAGS              = NO
1015

    
1016
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1017
# verbatim copy of the header file for each class for which an include is
1018
# specified. Set to NO to disable this.
1019
# See also: Section \class.
1020
# The default value is: YES.
1021

    
1022
VERBATIM_HEADERS       = YES
1023

    
1024
#---------------------------------------------------------------------------
1025
# Configuration options related to the alphabetical class index
1026
#---------------------------------------------------------------------------
1027

    
1028
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1029
# compounds will be generated. Enable this if the project contains a lot of
1030
# classes, structs, unions or interfaces.
1031
# The default value is: YES.
1032

    
1033
ALPHABETICAL_INDEX     = YES
1034

    
1035
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1036
# which the alphabetical index list will be split.
1037
# Minimum value: 1, maximum value: 20, default value: 5.
1038
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1039

    
1040
COLS_IN_ALPHA_INDEX    = 5
1041

    
1042
# In case all classes in a project start with a common prefix, all classes will
1043
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1044
# can be used to specify a prefix (or a list of prefixes) that should be ignored
1045
# while generating the index headers.
1046
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1047

    
1048
IGNORE_PREFIX          =
1049

    
1050
#---------------------------------------------------------------------------
1051
# Configuration options related to the HTML output
1052
#---------------------------------------------------------------------------
1053

    
1054
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1055
# The default value is: YES.
1056

    
1057
GENERATE_HTML          = YES
1058

    
1059
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1060
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1061
# it.
1062
# The default directory is: html.
1063
# This tag requires that the tag GENERATE_HTML is set to YES.
1064

    
1065
HTML_OUTPUT            = ./
1066

    
1067
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1068
# generated HTML page (for example: .htm, .php, .asp).
1069
# The default value is: .html.
1070
# This tag requires that the tag GENERATE_HTML is set to YES.
1071

    
1072
HTML_FILE_EXTENSION    = .html
1073

    
1074
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1075
# each generated HTML page. If the tag is left blank doxygen will generate a
1076
# standard header.
1077
#
1078
# To get valid HTML the header file that includes any scripts and style sheets
1079
# that doxygen needs, which is dependent on the configuration options used (e.g.
1080
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1081
# default header using
1082
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1083
# YourConfigFile
1084
# and then modify the file new_header.html. See also section "Doxygen usage"
1085
# for information on how to generate the default header that doxygen normally
1086
# uses.
1087
# Note: The header is subject to change so you typically have to regenerate the
1088
# default header when upgrading to a newer version of doxygen. For a description
1089
# of the possible markers and block names see the documentation.
1090
# This tag requires that the tag GENERATE_HTML is set to YES.
1091

    
1092
HTML_HEADER            =
1093

    
1094
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1095
# generated HTML page. If the tag is left blank doxygen will generate a standard
1096
# footer. See HTML_HEADER for more information on how to generate a default
1097
# footer and what special commands can be used inside the footer. See also
1098
# section "Doxygen usage" for information on how to generate the default footer
1099
# that doxygen normally uses.
1100
# This tag requires that the tag GENERATE_HTML is set to YES.
1101

    
1102
HTML_FOOTER            =
1103

    
1104
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1105
# sheet that is used by each HTML page. It can be used to fine-tune the look of
1106
# the HTML output. If left blank doxygen will generate a default style sheet.
1107
# See also section "Doxygen usage" for information on how to generate the style
1108
# sheet that doxygen normally uses.
1109
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1110
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1111
# obsolete.
1112
# This tag requires that the tag GENERATE_HTML is set to YES.
1113

    
1114
HTML_STYLESHEET        =
1115

    
1116
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1117
# cascading style sheets that are included after the standard style sheets
1118
# created by doxygen. Using this option one can overrule certain style aspects.
1119
# This is preferred over using HTML_STYLESHEET since it does not replace the
1120
# standard style sheet and is therefore more robust against future updates.
1121
# Doxygen will copy the style sheet files to the output directory.
1122
# Note: The order of the extra style sheet files is of importance (e.g. the last
1123
# style sheet in the list overrules the setting of the previous ones in the
1124
# list). For an example see the documentation.
1125
# This tag requires that the tag GENERATE_HTML is set to YES.
1126

    
1127
HTML_EXTRA_STYLESHEET  =
1128

    
1129
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1130
# other source files which should be copied to the HTML output directory. Note
1131
# that these files will be copied to the base HTML output directory. Use the
1132
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1133
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1134
# files will be copied as-is; there are no commands or markers available.
1135
# This tag requires that the tag GENERATE_HTML is set to YES.
1136

    
1137
HTML_EXTRA_FILES       =
1138

    
1139
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1140
# will adjust the colors in the style sheet and background images according to
1141
# this color. Hue is specified as an angle on a colorwheel, see
1142
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1143
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1144
# purple, and 360 is red again.
1145
# Minimum value: 0, maximum value: 359, default value: 220.
1146
# This tag requires that the tag GENERATE_HTML is set to YES.
1147

    
1148
HTML_COLORSTYLE_HUE    = 220
1149

    
1150
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1151
# in the HTML output. For a value of 0 the output will use grayscales only. A
1152
# value of 255 will produce the most vivid colors.
1153
# Minimum value: 0, maximum value: 255, default value: 100.
1154
# This tag requires that the tag GENERATE_HTML is set to YES.
1155

    
1156
HTML_COLORSTYLE_SAT    = 100
1157

    
1158
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1159
# luminance component of the colors in the HTML output. Values below 100
1160
# gradually make the output lighter, whereas values above 100 make the output
1161
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1162
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1163
# change the gamma.
1164
# Minimum value: 40, maximum value: 240, default value: 80.
1165
# This tag requires that the tag GENERATE_HTML is set to YES.
1166

    
1167
HTML_COLORSTYLE_GAMMA  = 80
1168

    
1169
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1170
# page will contain the date and time when the page was generated. Setting this
1171
# to YES can help to show when doxygen was last run and thus if the
1172
# documentation is up to date.
1173
# The default value is: NO.
1174
# This tag requires that the tag GENERATE_HTML is set to YES.
1175

    
1176
HTML_TIMESTAMP         = YES
1177

    
1178
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1179
# documentation will contain sections that can be hidden and shown after the
1180
# page has loaded.
1181
# The default value is: NO.
1182
# This tag requires that the tag GENERATE_HTML is set to YES.
1183

    
1184
HTML_DYNAMIC_SECTIONS  = YES
1185

    
1186
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1187
# shown in the various tree structured indices initially; the user can expand
1188
# and collapse entries dynamically later on. Doxygen will expand the tree to
1189
# such a level that at most the specified number of entries are visible (unless
1190
# a fully collapsed tree already exceeds this amount). So setting the number of
1191
# entries 1 will produce a full collapsed tree by default. 0 is a special value
1192
# representing an infinite number of entries and will result in a full expanded
1193
# tree by default.
1194
# Minimum value: 0, maximum value: 9999, default value: 100.
1195
# This tag requires that the tag GENERATE_HTML is set to YES.
1196

    
1197
HTML_INDEX_NUM_ENTRIES = 100
1198

    
1199
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1200
# generated that can be used as input for Apple's Xcode 3 integrated development
1201
# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1202
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1203
# Makefile in the HTML output directory. Running make will produce the docset in
1204
# that directory and running make install will install the docset in
1205
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1206
# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1207
# for more information.
1208
# The default value is: NO.
1209
# This tag requires that the tag GENERATE_HTML is set to YES.
1210

    
1211
GENERATE_DOCSET        = NO
1212

    
1213
# This tag determines the name of the docset feed. A documentation feed provides
1214
# an umbrella under which multiple documentation sets from a single provider
1215
# (such as a company or product suite) can be grouped.
1216
# The default value is: Doxygen generated docs.
1217
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1218

    
1219
DOCSET_FEEDNAME        = "Doxygen generated docs"
1220

    
1221
# This tag specifies a string that should uniquely identify the documentation
1222
# set bundle. This should be a reverse domain-name style string, e.g.
1223
# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1224
# The default value is: org.doxygen.Project.
1225
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1226

    
1227
DOCSET_BUNDLE_ID       = org.doxygen.Project
1228

    
1229
# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1230
# the documentation publisher. This should be a reverse domain-name style
1231
# string, e.g. com.mycompany.MyDocSet.documentation.
1232
# The default value is: org.doxygen.Publisher.
1233
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1234

    
1235
DOCSET_PUBLISHER_ID    = org.dolibarr.doc
1236

    
1237
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1238
# The default value is: Publisher.
1239
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1240

    
1241
DOCSET_PUBLISHER_NAME  = Dolibarrteam
1242

    
1243
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1244
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1245
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1246
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1247
# Windows.
1248
#
1249
# The HTML Help Workshop contains a compiler that can convert all HTML output
1250
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1251
# files are now used as the Windows 98 help format, and will replace the old
1252
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1253
# HTML files also contain an index, a table of contents, and you can search for
1254
# words in the documentation. The HTML workshop also contains a viewer for
1255
# compressed HTML files.
1256
# The default value is: NO.
1257
# This tag requires that the tag GENERATE_HTML is set to YES.
1258

    
1259
GENERATE_HTMLHELP      = NO
1260

    
1261
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1262
# file. You can add a path in front of the file if the result should not be
1263
# written to the html output directory.
1264
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1265

    
1266
CHM_FILE               =
1267

    
1268
# The HHC_LOCATION tag can be used to specify the location (absolute path
1269
# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1270
# doxygen will try to run the HTML help compiler on the generated index.hhp.
1271
# The file has to be specified with full path.
1272
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1273

    
1274
HHC_LOCATION           =
1275

    
1276
# The GENERATE_CHI flag controls if a separate .chi index file is generated
1277
# (YES) or that it should be included in the master .chm file (NO).
1278
# The default value is: NO.
1279
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1280

    
1281
GENERATE_CHI           = NO
1282

    
1283
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1284
# and project file content.
1285
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1286

    
1287
CHM_INDEX_ENCODING     =
1288

    
1289
# The BINARY_TOC flag controls whether a binary table of contents is generated
1290
# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1291
# enables the Previous and Next buttons.
1292
# The default value is: NO.
1293
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1294

    
1295
BINARY_TOC             = NO
1296

    
1297
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1298
# the table of contents of the HTML help documentation and to the tree view.
1299
# The default value is: NO.
1300
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1301

    
1302
TOC_EXPAND             = NO
1303

    
1304
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1305
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1306
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1307
# (.qch) of the generated HTML documentation.
1308
# The default value is: NO.
1309
# This tag requires that the tag GENERATE_HTML is set to YES.
1310

    
1311
GENERATE_QHP           = NO
1312

    
1313
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1314
# the file name of the resulting .qch file. The path specified is relative to
1315
# the HTML output folder.
1316
# This tag requires that the tag GENERATE_QHP is set to YES.
1317

    
1318
QCH_FILE               =
1319

    
1320
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1321
# Project output. For more information please see Qt Help Project / Namespace
1322
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1323
# The default value is: org.doxygen.Project.
1324
# This tag requires that the tag GENERATE_QHP is set to YES.
1325

    
1326
QHP_NAMESPACE          = org.doxygen.Project
1327

    
1328
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1329
# Help Project output. For more information please see Qt Help Project / Virtual
1330
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1331
# folders).
1332
# The default value is: doc.
1333
# This tag requires that the tag GENERATE_QHP is set to YES.
1334

    
1335
QHP_VIRTUAL_FOLDER     = doc
1336

    
1337
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1338
# filter to add. For more information please see Qt Help Project / Custom
1339
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1340
# filters).
1341
# This tag requires that the tag GENERATE_QHP is set to YES.
1342

    
1343
QHP_CUST_FILTER_NAME   =
1344

    
1345
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1346
# custom filter to add. For more information please see Qt Help Project / Custom
1347
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1348
# filters).
1349
# This tag requires that the tag GENERATE_QHP is set to YES.
1350

    
1351
QHP_CUST_FILTER_ATTRS  =
1352

    
1353
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1354
# project's filter section matches. Qt Help Project / Filter Attributes (see:
1355
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1356
# This tag requires that the tag GENERATE_QHP is set to YES.
1357

    
1358
QHP_SECT_FILTER_ATTRS  =
1359

    
1360
# The QHG_LOCATION tag can be used to specify the location of Qt's
1361
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1362
# generated .qhp file.
1363
# This tag requires that the tag GENERATE_QHP is set to YES.
1364

    
1365
QHG_LOCATION           =
1366

    
1367
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1368
# generated, together with the HTML files, they form an Eclipse help plugin. To
1369
# install this plugin and make it available under the help contents menu in
1370
# Eclipse, the contents of the directory containing the HTML and XML files needs
1371
# to be copied into the plugins directory of eclipse. The name of the directory
1372
# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1373
# After copying Eclipse needs to be restarted before the help appears.
1374
# The default value is: NO.
1375
# This tag requires that the tag GENERATE_HTML is set to YES.
1376

    
1377
GENERATE_ECLIPSEHELP   = YES
1378

    
1379
# A unique identifier for the Eclipse help plugin. When installing the plugin
1380
# the directory name containing the HTML and XML files should also have this
1381
# name. Each documentation set should have its own identifier.
1382
# The default value is: org.doxygen.Project.
1383
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1384

    
1385
ECLIPSE_DOC_ID         = org.doxygen.Project
1386

    
1387
# If you want full control over the layout of the generated HTML pages it might
1388
# be necessary to disable the index and replace it with your own. The
1389
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1390
# of each HTML page. A value of NO enables the index and the value YES disables
1391
# it. Since the tabs in the index contain the same information as the navigation
1392
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1393
# The default value is: NO.
1394
# This tag requires that the tag GENERATE_HTML is set to YES.
1395

    
1396
DISABLE_INDEX          = NO
1397

    
1398
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1399
# structure should be generated to display hierarchical information. If the tag
1400
# value is set to YES, a side panel will be generated containing a tree-like
1401
# index structure (just like the one that is generated for HTML Help). For this
1402
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1403
# (i.e. any modern browser). Windows users are probably better off using the
1404
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1405
# further fine-tune the look of the index. As an example, the default style
1406
# sheet generated by doxygen has an example that shows how to put an image at
1407
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1408
# the same information as the tab index, you could consider setting
1409
# DISABLE_INDEX to YES when enabling this option.
1410
# The default value is: NO.
1411
# This tag requires that the tag GENERATE_HTML is set to YES.
1412

    
1413
GENERATE_TREEVIEW      = NO
1414

    
1415
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1416
# doxygen will group on one line in the generated HTML documentation.
1417
#
1418
# Note that a value of 0 will completely suppress the enum values from appearing
1419
# in the overview section.
1420
# Minimum value: 0, maximum value: 20, default value: 4.
1421
# This tag requires that the tag GENERATE_HTML is set to YES.
1422

    
1423
ENUM_VALUES_PER_LINE   = 4
1424

    
1425
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1426
# to set the initial width (in pixels) of the frame in which the tree is shown.
1427
# Minimum value: 0, maximum value: 1500, default value: 250.
1428
# This tag requires that the tag GENERATE_HTML is set to YES.
1429

    
1430
TREEVIEW_WIDTH         = 250
1431

    
1432
# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1433
# external symbols imported via tag files in a separate window.
1434
# The default value is: NO.
1435
# This tag requires that the tag GENERATE_HTML is set to YES.
1436

    
1437
EXT_LINKS_IN_WINDOW    = NO
1438

    
1439
# Use this tag to change the font size of LaTeX formulas included as images in
1440
# the HTML documentation. When you change the font size after a successful
1441
# doxygen run you need to manually remove any form_*.png images from the HTML
1442
# output directory to force them to be regenerated.
1443
# Minimum value: 8, maximum value: 50, default value: 10.
1444
# This tag requires that the tag GENERATE_HTML is set to YES.
1445

    
1446
FORMULA_FONTSIZE       = 10
1447

    
1448
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1449
# generated for formulas are transparent PNGs. Transparent PNGs are not
1450
# supported properly for IE 6.0, but are supported on all modern browsers.
1451
#
1452
# Note that when changing this option you need to delete any form_*.png files in
1453
# the HTML output directory before the changes have effect.
1454
# The default value is: YES.
1455
# This tag requires that the tag GENERATE_HTML is set to YES.
1456

    
1457
FORMULA_TRANSPARENT    = YES
1458

    
1459
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1460
# http://www.mathjax.org) which uses client side Javascript for the rendering
1461
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1462
# installed or if you want to formulas look prettier in the HTML output. When
1463
# enabled you may also need to install MathJax separately and configure the path
1464
# to it using the MATHJAX_RELPATH option.
1465
# The default value is: NO.
1466
# This tag requires that the tag GENERATE_HTML is set to YES.
1467

    
1468
USE_MATHJAX            = NO
1469

    
1470
# When MathJax is enabled you can set the default output format to be used for
1471
# the MathJax output. See the MathJax site (see:
1472
# http://docs.mathjax.org/en/latest/output.html) for more details.
1473
# Possible values are: HTML-CSS (which is slower, but has the best
1474
# compatibility), NativeMML (i.e. MathML) and SVG.
1475
# The default value is: HTML-CSS.
1476
# This tag requires that the tag USE_MATHJAX is set to YES.
1477

    
1478
MATHJAX_FORMAT         = HTML-CSS
1479

    
1480
# When MathJax is enabled you need to specify the location relative to the HTML
1481
# output directory using the MATHJAX_RELPATH option. The destination directory
1482
# should contain the MathJax.js script. For instance, if the mathjax directory
1483
# is located at the same level as the HTML output directory, then
1484
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1485
# Content Delivery Network so you can quickly see the result without installing
1486
# MathJax. However, it is strongly recommended to install a local copy of
1487
# MathJax from http://www.mathjax.org before deployment.
1488
# The default value is: http://cdn.mathjax.org/mathjax/latest.
1489
# This tag requires that the tag USE_MATHJAX is set to YES.
1490

    
1491
MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
1492

    
1493
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1494
# extension names that should be enabled during MathJax rendering. For example
1495
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1496
# This tag requires that the tag USE_MATHJAX is set to YES.
1497

    
1498
MATHJAX_EXTENSIONS     =
1499

    
1500
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1501
# of code that will be used on startup of the MathJax code. See the MathJax site
1502
# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1503
# example see the documentation.
1504
# This tag requires that the tag USE_MATHJAX is set to YES.
1505

    
1506
MATHJAX_CODEFILE       =
1507

    
1508
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1509
# the HTML output. The underlying search engine uses javascript and DHTML and
1510
# should work on any modern browser. Note that when using HTML help
1511
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1512
# there is already a search function so this one should typically be disabled.
1513
# For large projects the javascript based search engine can be slow, then
1514
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1515
# search using the keyboard; to jump to the search box use <access key> + S
1516
# (what the <access key> is depends on the OS and browser, but it is typically
1517
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1518
# key> to jump into the search results window, the results can be navigated
1519
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1520
# the search. The filter options can be selected when the cursor is inside the
1521
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1522
# to select a filter and <Enter> or <escape> to activate or cancel the filter
1523
# option.
1524
# The default value is: YES.
1525
# This tag requires that the tag GENERATE_HTML is set to YES.
1526

    
1527
SEARCHENGINE           = NO
1528

    
1529
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1530
# implemented using a web server instead of a web client using Javascript. There
1531
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1532
# setting. When disabled, doxygen will generate a PHP script for searching and
1533
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1534
# and searching needs to be provided by external tools. See the section
1535
# "External Indexing and Searching" for details.
1536
# The default value is: NO.
1537
# This tag requires that the tag SEARCHENGINE is set to YES.
1538

    
1539
SERVER_BASED_SEARCH    = NO
1540

    
1541
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1542
# script for searching. Instead the search results are written to an XML file
1543
# which needs to be processed by an external indexer. Doxygen will invoke an
1544
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1545
# search results.
1546
#
1547
# Doxygen ships with an example indexer (doxyindexer) and search engine
1548
# (doxysearch.cgi) which are based on the open source search engine library
1549
# Xapian (see: http://xapian.org/).
1550
#
1551
# See the section "External Indexing and Searching" for details.
1552
# The default value is: NO.
1553
# This tag requires that the tag SEARCHENGINE is set to YES.
1554

    
1555
EXTERNAL_SEARCH        = NO
1556

    
1557
# The SEARCHENGINE_URL should point to a search engine hostedc by a web server
1558
# which will return the search results when EXTERNAL_SEARCH is enabled.
1559
#
1560
# Doxygen ships with an example indexer (doxyindexer) and search engine
1561
# (doxysearch.cgi) which are based on the open source search engine library
1562
# Xapian (see: http://xapian.org/). See the section "External Indexing and
1563
# Searching" for details.
1564
# This tag requires that the tag SEARCHENGINE is set to YES.
1565

    
1566
SEARCHENGINE_URL       =
1567

    
1568
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1569
# search data is written to a file for indexing by an external tool. With the
1570
# SEARCHDATA_FILE tag the name of this file can be specified.
1571
# The default file is: searchdata.xml.
1572
# This tag requires that the tag SEARCHENGINE is set to YES.
1573

    
1574
SEARCHDATA_FILE        = searchdata.xml
1575

    
1576
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1577
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1578
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1579
# projects and redirect the results back to the right project.
1580
# This tag requires that the tag SEARCHENGINE is set to YES.
1581

    
1582
EXTERNAL_SEARCH_ID     =
1583

    
1584
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1585
# projects other than the one defined by this configuration file, but that are
1586
# all added to the same external search index. Each project needs to have a
1587
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1588
# to a relative location where the documentation can be found. The format is:
1589
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1590
# This tag requires that the tag SEARCHENGINE is set to YES.
1591

    
1592
EXTRA_SEARCH_MAPPINGS  =
1593

    
1594
#---------------------------------------------------------------------------
1595
# Configuration options related to the LaTeX output
1596
#---------------------------------------------------------------------------
1597

    
1598
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1599
# The default value is: YES.
1600

    
1601
GENERATE_LATEX         = NO
1602

    
1603
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1604
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1605
# it.
1606
# The default directory is: latex.
1607
# This tag requires that the tag GENERATE_LATEX is set to YES.
1608

    
1609
LATEX_OUTPUT           = latex
1610

    
1611
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1612
# invoked.
1613
#
1614
# Note that when enabling USE_PDFLATEX this option is only used for generating
1615
# bitmaps for formulas in the HTML output, but not in the Makefile that is
1616
# written to the output directory.
1617
# The default file is: latex.
1618
# This tag requires that the tag GENERATE_LATEX is set to YES.
1619

    
1620
LATEX_CMD_NAME         = latex
1621

    
1622
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1623
# index for LaTeX.
1624
# The default file is: makeindex.
1625
# This tag requires that the tag GENERATE_LATEX is set to YES.
1626

    
1627
MAKEINDEX_CMD_NAME     = makeindex
1628

    
1629
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1630
# documents. This may be useful for small projects and may help to save some
1631
# trees in general.
1632
# The default value is: NO.
1633
# This tag requires that the tag GENERATE_LATEX is set to YES.
1634

    
1635
COMPACT_LATEX          = NO
1636

    
1637
# The PAPER_TYPE tag can be used to set the paper type that is used by the
1638
# printer.
1639
# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1640
# 14 inches) and executive (7.25 x 10.5 inches).
1641
# The default value is: a4.
1642
# This tag requires that the tag GENERATE_LATEX is set to YES.
1643

    
1644
PAPER_TYPE             = a4
1645

    
1646
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1647
# that should be included in the LaTeX output. The package can be specified just
1648
# by its name or with the correct syntax as to be used with the LaTeX
1649
# \usepackage command. To get the times font for instance you can specify :
1650
# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1651
# To use the option intlimits with the amsmath package you can specify:
1652
# EXTRA_PACKAGES=[intlimits]{amsmath}
1653
# If left blank no extra packages will be included.
1654
# This tag requires that the tag GENERATE_LATEX is set to YES.
1655

    
1656
EXTRA_PACKAGES         =
1657

    
1658
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1659
# generated LaTeX document. The header should contain everything until the first
1660
# chapter. If it is left blank doxygen will generate a standard header. See
1661
# section "Doxygen usage" for information on how to let doxygen write the
1662
# default header to a separate file.
1663
#
1664
# Note: Only use a user-defined header if you know what you are doing! The
1665
# following commands have a special meaning inside the header: $title,
1666
# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1667
# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1668
# string, for the replacement values of the other commands the user is referred
1669
# to HTML_HEADER.
1670
# This tag requires that the tag GENERATE_LATEX is set to YES.
1671

    
1672
LATEX_HEADER           =
1673

    
1674
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1675
# generated LaTeX document. The footer should contain everything after the last
1676
# chapter. If it is left blank doxygen will generate a standard footer. See
1677
# LATEX_HEADER for more information on how to generate a default footer and what
1678
# special commands can be used inside the footer.
1679
#
1680
# Note: Only use a user-defined footer if you know what you are doing!
1681
# This tag requires that the tag GENERATE_LATEX is set to YES.
1682

    
1683
LATEX_FOOTER           =
1684

    
1685
# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1686
# LaTeX style sheets that are included after the standard style sheets created
1687
# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1688
# will copy the style sheet files to the output directory.
1689
# Note: The order of the extra style sheet files is of importance (e.g. the last
1690
# style sheet in the list overrules the setting of the previous ones in the
1691
# list).
1692
# This tag requires that the tag GENERATE_LATEX is set to YES.
1693

    
1694
LATEX_EXTRA_STYLESHEET =
1695

    
1696
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1697
# other source files which should be copied to the LATEX_OUTPUT output
1698
# directory. Note that the files will be copied as-is; there are no commands or
1699
# markers available.
1700
# This tag requires that the tag GENERATE_LATEX is set to YES.
1701

    
1702
LATEX_EXTRA_FILES      =
1703

    
1704
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1705
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1706
# contain links (just like the HTML output) instead of page references. This
1707
# makes the output suitable for online browsing using a PDF viewer.
1708
# The default value is: YES.
1709
# This tag requires that the tag GENERATE_LATEX is set to YES.
1710

    
1711
PDF_HYPERLINKS         = YES
1712

    
1713
# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1714
# the PDF file directly from the LaTeX files. Set this option to YES, to get a
1715
# higher quality PDF documentation.
1716
# The default value is: YES.
1717
# This tag requires that the tag GENERATE_LATEX is set to YES.
1718

    
1719
USE_PDFLATEX           = YES
1720

    
1721
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1722
# command to the generated LaTeX files. This will instruct LaTeX to keep running
1723
# if errors occur, instead of asking the user for help. This option is also used
1724
# when generating formulas in HTML.
1725
# The default value is: NO.
1726
# This tag requires that the tag GENERATE_LATEX is set to YES.
1727

    
1728
LATEX_BATCHMODE        = NO
1729

    
1730
# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1731
# index chapters (such as File Index, Compound Index, etc.) in the output.
1732
# The default value is: NO.
1733
# This tag requires that the tag GENERATE_LATEX is set to YES.
1734

    
1735
LATEX_HIDE_INDICES     = NO
1736

    
1737
# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1738
# code with syntax highlighting in the LaTeX output.
1739
#
1740
# Note that which sources are shown also depends on other settings such as
1741
# SOURCE_BROWSER.
1742
# The default value is: NO.
1743
# This tag requires that the tag GENERATE_LATEX is set to YES.
1744

    
1745
LATEX_SOURCE_CODE      = NO
1746

    
1747
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1748
# bibliography, e.g. plainnat, or ieeetr. See
1749
# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1750
# The default value is: plain.
1751
# This tag requires that the tag GENERATE_LATEX is set to YES.
1752

    
1753
LATEX_BIB_STYLE        = plain
1754

    
1755
# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1756
# page will contain the date and time when the page was generated. Setting this
1757
# to NO can help when comparing the output of multiple runs.
1758
# The default value is: NO.
1759
# This tag requires that the tag GENERATE_LATEX is set to YES.
1760

    
1761
LATEX_TIMESTAMP        = NO
1762

    
1763
#---------------------------------------------------------------------------
1764
# Configuration options related to the RTF output
1765
#---------------------------------------------------------------------------
1766

    
1767
# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1768
# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1769
# readers/editors.
1770
# The default value is: NO.
1771

    
1772
GENERATE_RTF           = NO
1773

    
1774
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1775
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1776
# it.
1777
# The default directory is: rtf.
1778
# This tag requires that the tag GENERATE_RTF is set to YES.
1779

    
1780
RTF_OUTPUT             = rtf
1781

    
1782
# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1783
# documents. This may be useful for small projects and may help to save some
1784
# trees in general.
1785
# The default value is: NO.
1786
# This tag requires that the tag GENERATE_RTF is set to YES.
1787

    
1788
COMPACT_RTF            = NO
1789

    
1790
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1791
# contain hyperlink fields. The RTF file will contain links (just like the HTML
1792
# output) instead of page references. This makes the output suitable for online
1793
# browsing using Word or some other Word compatible readers that support those
1794
# fields.
1795
#
1796
# Note: WordPad (write) and others do not support links.
1797
# The default value is: NO.
1798
# This tag requires that the tag GENERATE_RTF is set to YES.
1799

    
1800
RTF_HYPERLINKS         = NO
1801

    
1802
# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1803
# file, i.e. a series of assignments. You only have to provide replacements,
1804
# missing definitions are set to their default value.
1805
#
1806
# See also section "Doxygen usage" for information on how to generate the
1807
# default style sheet that doxygen normally uses.
1808
# This tag requires that the tag GENERATE_RTF is set to YES.
1809

    
1810
RTF_STYLESHEET_FILE    =
1811

    
1812
# Set optional variables used in the generation of an RTF document. Syntax is
1813
# similar to doxygen's config file. A template extensions file can be generated
1814
# using doxygen -e rtf extensionFile.
1815
# This tag requires that the tag GENERATE_RTF is set to YES.
1816

    
1817
RTF_EXTENSIONS_FILE    =
1818

    
1819
# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1820
# with syntax highlighting in the RTF output.
1821
#
1822
# Note that which sources are shown also depends on other settings such as
1823
# SOURCE_BROWSER.
1824
# The default value is: NO.
1825
# This tag requires that the tag GENERATE_RTF is set to YES.
1826

    
1827
RTF_SOURCE_CODE        = NO
1828

    
1829
#---------------------------------------------------------------------------
1830
# Configuration options related to the man page output
1831
#---------------------------------------------------------------------------
1832

    
1833
# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1834
# classes and files.
1835
# The default value is: NO.
1836

    
1837
GENERATE_MAN           = NO
1838

    
1839
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1840
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1841
# it. A directory man3 will be created inside the directory specified by
1842
# MAN_OUTPUT.
1843
# The default directory is: man.
1844
# This tag requires that the tag GENERATE_MAN is set to YES.
1845

    
1846
MAN_OUTPUT             = man
1847

    
1848
# The MAN_EXTENSION tag determines the extension that is added to the generated
1849
# man pages. In case the manual section does not start with a number, the number
1850
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1851
# optional.
1852
# The default value is: .3.
1853
# This tag requires that the tag GENERATE_MAN is set to YES.
1854

    
1855
MAN_EXTENSION          = .3
1856

    
1857
# The MAN_SUBDIR tag determines the name of the directory created within
1858
# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1859
# MAN_EXTENSION with the initial . removed.
1860
# This tag requires that the tag GENERATE_MAN is set to YES.
1861

    
1862
MAN_SUBDIR             =
1863

    
1864
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1865
# will generate one additional man file for each entity documented in the real
1866
# man page(s). These additional files only source the real man page, but without
1867
# them the man command would be unable to find the correct page.
1868
# The default value is: NO.
1869
# This tag requires that the tag GENERATE_MAN is set to YES.
1870

    
1871
MAN_LINKS              = NO
1872

    
1873
#---------------------------------------------------------------------------
1874
# Configuration options related to the XML output
1875
#---------------------------------------------------------------------------
1876

    
1877
# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1878
# captures the structure of the code including all documentation.
1879
# The default value is: NO.
1880

    
1881
GENERATE_XML           = NO
1882

    
1883
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1884
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1885
# it.
1886
# The default directory is: xml.
1887
# This tag requires that the tag GENERATE_XML is set to YES.
1888

    
1889
XML_OUTPUT             = xml
1890

    
1891
# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1892
# listings (including syntax highlighting and cross-referencing information) to
1893
# the XML output. Note that enabling this will significantly increase the size
1894
# of the XML output.
1895
# The default value is: YES.
1896
# This tag requires that the tag GENERATE_XML is set to YES.
1897

    
1898
XML_PROGRAMLISTING     = YES
1899

    
1900
#---------------------------------------------------------------------------
1901
# Configuration options related to the DOCBOOK output
1902
#---------------------------------------------------------------------------
1903

    
1904
# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1905
# that can be used to generate PDF.
1906
# The default value is: NO.
1907

    
1908
GENERATE_DOCBOOK       = NO
1909

    
1910
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1911
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1912
# front of it.
1913
# The default directory is: docbook.
1914
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1915

    
1916
DOCBOOK_OUTPUT         = docbook
1917

    
1918
# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1919
# program listings (including syntax highlighting and cross-referencing
1920
# information) to the DOCBOOK output. Note that enabling this will significantly
1921
# increase the size of the DOCBOOK output.
1922
# The default value is: NO.
1923
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1924

    
1925
DOCBOOK_PROGRAMLISTING = NO
1926

    
1927
#---------------------------------------------------------------------------
1928
# Configuration options for the AutoGen Definitions output
1929
#---------------------------------------------------------------------------
1930

    
1931
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1932
# AutoGen Definitions (see http://autogen.sf.net) file that captures the
1933
# structure of the code including all documentation. Note that this feature is
1934
# still experimental and incomplete at the moment.
1935
# The default value is: NO.
1936

    
1937
GENERATE_AUTOGEN_DEF   = NO
1938

    
1939
#---------------------------------------------------------------------------
1940
# Configuration options related to the Perl module output
1941
#---------------------------------------------------------------------------
1942

    
1943
# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1944
# file that captures the structure of the code including all documentation.
1945
#
1946
# Note that this feature is still experimental and incomplete at the moment.
1947
# The default value is: NO.
1948

    
1949
GENERATE_PERLMOD       = NO
1950

    
1951
# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1952
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1953
# output from the Perl module output.
1954
# The default value is: NO.
1955
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1956

    
1957
PERLMOD_LATEX          = NO
1958

    
1959
# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1960
# formatted so it can be parsed by a human reader. This is useful if you want to
1961
# understand what is going on. On the other hand, if this tag is set to NO, the
1962
# size of the Perl module output will be much smaller and Perl will parse it
1963
# just the same.
1964
# The default value is: YES.
1965
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1966

    
1967
PERLMOD_PRETTY         = YES
1968

    
1969
# The names of the make variables in the generated doxyrules.make file are
1970
# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1971
# so different doxyrules.make files included by the same Makefile don't
1972
# overwrite each other's variables.
1973
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1974

    
1975
PERLMOD_MAKEVAR_PREFIX =
1976

    
1977
#---------------------------------------------------------------------------
1978
# Configuration options related to the preprocessor
1979
#---------------------------------------------------------------------------
1980

    
1981
# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
1982
# C-preprocessor directives found in the sources and include files.
1983
# The default value is: YES.
1984

    
1985
ENABLE_PREPROCESSING   = NO
1986

    
1987
# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
1988
# in the source code. If set to NO, only conditional compilation will be
1989
# performed. Macro expansion can be done in a controlled way by setting
1990
# EXPAND_ONLY_PREDEF to YES.
1991
# The default value is: NO.
1992
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1993

    
1994
MACRO_EXPANSION        = NO
1995

    
1996
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1997
# the macro expansion is limited to the macros specified with the PREDEFINED and
1998
# EXPAND_AS_DEFINED tags.
1999
# The default value is: NO.
2000
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2001

    
2002
EXPAND_ONLY_PREDEF     = YES
2003

    
2004
# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2005
# INCLUDE_PATH will be searched if a #include is found.
2006
# The default value is: YES.
2007
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2008

    
2009
SEARCH_INCLUDES        = YES
2010

    
2011
# The INCLUDE_PATH tag can be used to specify one or more directories that
2012
# contain include files that are not input files but should be processed by the
2013
# preprocessor.
2014
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2015

    
2016
INCLUDE_PATH           =
2017

    
2018
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2019
# patterns (like *.h and *.hpp) to filter out the header-files in the
2020
# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2021
# used.
2022
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2023

    
2024
INCLUDE_FILE_PATTERNS  =
2025

    
2026
# The PREDEFINED tag can be used to specify one or more macro names that are
2027
# defined before the preprocessor is started (similar to the -D option of e.g.
2028
# gcc). The argument of the tag is a list of macros of the form: name or
2029
# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2030
# is assumed. To prevent a macro definition from being undefined via #undef or
2031
# recursively expanded use the := operator instead of the = operator.
2032
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2033

    
2034
PREDEFINED             =
2035

    
2036
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2037
# tag can be used to specify a list of macro names that should be expanded. The
2038
# macro definition that is found in the sources will be used. Use the PREDEFINED
2039
# tag if you want to use a different macro definition that overrules the
2040
# definition found in the source code.
2041
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2042

    
2043
EXPAND_AS_DEFINED      =
2044

    
2045
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2046
# remove all references to function-like macros that are alone on a line, have
2047
# an all uppercase name, and do not end with a semicolon. Such function macros
2048
# are typically used for boiler-plate code, and will confuse the parser if not
2049
# removed.
2050
# The default value is: YES.
2051
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2052

    
2053
SKIP_FUNCTION_MACROS   = YES
2054

    
2055
#---------------------------------------------------------------------------
2056
# Configuration options related to external references
2057
#---------------------------------------------------------------------------
2058

    
2059
# The TAGFILES tag can be used to specify one or more tag files. For each tag
2060
# file the location of the external documentation should be added. The format of
2061
# a tag file without this location is as follows:
2062
# TAGFILES = file1 file2 ...
2063
# Adding location for the tag files is done as follows:
2064
# TAGFILES = file1=loc1 "file2 = loc2" ...
2065
# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2066
# section "Linking to external documentation" for more information about the use
2067
# of tag files.
2068
# Note: Each tag file must have a unique name (where the name does NOT include
2069
# the path). If a tag file is not located in the directory in which doxygen is
2070
# run, you must also specify the path to the tagfile here.
2071

    
2072
TAGFILES               =
2073

    
2074
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2075
# tag file that is based on the input files it reads. See section "Linking to
2076
# external documentation" for more information about the usage of tag files.
2077

    
2078
GENERATE_TAGFILE       =
2079

    
2080
# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2081
# the class index. If set to NO, only the inherited external classes will be
2082
# listed.
2083
# The default value is: NO.
2084

    
2085
ALLEXTERNALS           = NO
2086

    
2087
# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2088
# in the modules index. If set to NO, only the current project's groups will be
2089
# listed.
2090
# The default value is: YES.
2091

    
2092
EXTERNAL_GROUPS        = YES
2093

    
2094
# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2095
# the related pages index. If set to NO, only the current project's pages will
2096
# be listed.
2097
# The default value is: YES.
2098

    
2099
EXTERNAL_PAGES         = YES
2100

    
2101
# The PERL_PATH should be the absolute path and name of the perl script
2102
# interpreter (i.e. the result of 'which perl').
2103
# The default file (with absolute path) is: /usr/bin/perl.
2104

    
2105
PERL_PATH              = /usr/bin/perl
2106

    
2107
#---------------------------------------------------------------------------
2108
# Configuration options related to the dot tool
2109
#---------------------------------------------------------------------------
2110

    
2111
# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2112
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2113
# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2114
# disabled, but it is recommended to install and use dot, since it yields more
2115
# powerful graphs.
2116
# The default value is: YES.
2117

    
2118
CLASS_DIAGRAMS         = NO
2119

    
2120
# You can define message sequence charts within doxygen comments using the \msc
2121
# command. Doxygen will then run the mscgen tool (see:
2122
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2123
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2124
# the mscgen tool resides. If left empty the tool is assumed to be found in the
2125
# default search path.
2126

    
2127
MSCGEN_PATH            =
2128

    
2129
# You can include diagrams made with dia in doxygen documentation. Doxygen will
2130
# then run dia to produce the diagram and insert it in the documentation. The
2131
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2132
# If left empty dia is assumed to be found in the default search path.
2133

    
2134
DIA_PATH               =
2135

    
2136
# If set to YES the inheritance and collaboration graphs will hide inheritance
2137
# and usage relations if the target is undocumented or is not a class.
2138
# The default value is: YES.
2139

    
2140
HIDE_UNDOC_RELATIONS   = NO
2141

    
2142
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2143
# available from the path. This tool is part of Graphviz (see:
2144
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2145
# Bell Labs. The other options in this section have no effect if this option is
2146
# set to NO
2147
# The default value is: NO.
2148

    
2149
HAVE_DOT               = YES
2150

    
2151
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2152
# to run in parallel. When set to 0 doxygen will base this on the number of
2153
# processors available in the system. You can set it explicitly to a value
2154
# larger than 0 to get control over the balance between CPU load and processing
2155
# speed.
2156
# Minimum value: 0, maximum value: 32, default value: 0.
2157
# This tag requires that the tag HAVE_DOT is set to YES.
2158

    
2159
DOT_NUM_THREADS        = 0
2160

    
2161
# When you want a differently looking font in the dot files that doxygen
2162
# generates you can specify the font name using DOT_FONTNAME. You need to make
2163
# sure dot is able to find the font, which can be done by putting it in a
2164
# standard location or by setting the DOTFONTPATH environment variable or by
2165
# setting DOT_FONTPATH to the directory containing the font.
2166
# The default value is: Helvetica.
2167
# This tag requires that the tag HAVE_DOT is set to YES.
2168

    
2169
DOT_FONTNAME           = FreeSans.ttf
2170

    
2171
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2172
# dot graphs.
2173
# Minimum value: 4, maximum value: 24, default value: 10.
2174
# This tag requires that the tag HAVE_DOT is set to YES.
2175

    
2176
DOT_FONTSIZE           = 10
2177

    
2178
# By default doxygen will tell dot to use the default font as specified with
2179
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2180
# the path where dot can find it using this tag.
2181
# This tag requires that the tag HAVE_DOT is set to YES.
2182

    
2183
DOT_FONTPATH           =
2184

    
2185
# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2186
# each documented class showing the direct and indirect inheritance relations.
2187
# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2188
# The default value is: YES.
2189
# This tag requires that the tag HAVE_DOT is set to YES.
2190

    
2191
CLASS_GRAPH            = YES
2192

    
2193
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2194
# graph for each documented class showing the direct and indirect implementation
2195
# dependencies (inheritance, containment, and class references variables) of the
2196
# class with other documented classes.
2197
# The default value is: YES.
2198
# This tag requires that the tag HAVE_DOT is set to YES.
2199

    
2200
COLLABORATION_GRAPH    = YES
2201

    
2202
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2203
# groups, showing the direct groups dependencies.
2204
# The default value is: YES.
2205
# This tag requires that the tag HAVE_DOT is set to YES.
2206

    
2207
GROUP_GRAPHS           = NO
2208

    
2209
# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2210
# collaboration diagrams in a style similar to the OMG's Unified Modeling
2211
# Language.
2212
# The default value is: NO.
2213
# This tag requires that the tag HAVE_DOT is set to YES.
2214

    
2215
UML_LOOK               = NO
2216

    
2217
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2218
# class node. If there are many fields or methods and many nodes the graph may
2219
# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2220
# number of items for each type to make the size more manageable. Set this to 0
2221
# for no limit. Note that the threshold may be exceeded by 50% before the limit
2222
# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2223
# but if the number exceeds 15, the total amount of fields shown is limited to
2224
# 10.
2225
# Minimum value: 0, maximum value: 100, default value: 10.
2226
# This tag requires that the tag HAVE_DOT is set to YES.
2227

    
2228
UML_LIMIT_NUM_FIELDS   = 10
2229

    
2230
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2231
# collaboration graphs will show the relations between templates and their
2232
# instances.
2233
# The default value is: NO.
2234
# This tag requires that the tag HAVE_DOT is set to YES.
2235

    
2236
TEMPLATE_RELATIONS     = NO
2237

    
2238
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2239
# YES then doxygen will generate a graph for each documented file showing the
2240
# direct and indirect include dependencies of the file with other documented
2241
# files.
2242
# The default value is: YES.
2243
# This tag requires that the tag HAVE_DOT is set to YES.
2244

    
2245
INCLUDE_GRAPH          = YES
2246

    
2247
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2248
# set to YES then doxygen will generate a graph for each documented file showing
2249
# the direct and indirect include dependencies of the file with other documented
2250
# files.
2251
# The default value is: YES.
2252
# This tag requires that the tag HAVE_DOT is set to YES.
2253

    
2254
INCLUDED_BY_GRAPH      = YES
2255

    
2256
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2257
# dependency graph for every global function or class method.
2258
#
2259
# Note that enabling this option will significantly increase the time of a run.
2260
# So in most cases it will be better to enable call graphs for selected
2261
# functions only using the \callgraph command. Disabling a call graph can be
2262
# accomplished by means of the command \hidecallgraph.
2263
# The default value is: NO.
2264
# This tag requires that the tag HAVE_DOT is set to YES.
2265

    
2266
CALL_GRAPH             = NO
2267

    
2268
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2269
# dependency graph for every global function or class method.
2270
#
2271
# Note that enabling this option will significantly increase the time of a run.
2272
# So in most cases it will be better to enable caller graphs for selected
2273
# functions only using the \callergraph command. Disabling a caller graph can be
2274
# accomplished by means of the command \hidecallergraph.
2275
# The default value is: NO.
2276
# This tag requires that the tag HAVE_DOT is set to YES.
2277

    
2278
CALLER_GRAPH           = NO
2279

    
2280
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2281
# hierarchy of all classes instead of a textual one.
2282
# The default value is: YES.
2283
# This tag requires that the tag HAVE_DOT is set to YES.
2284

    
2285
GRAPHICAL_HIERARCHY    = YES
2286

    
2287
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2288
# dependencies a directory has on other directories in a graphical way. The
2289
# dependency relations are determined by the #include relations between the
2290
# files in the directories.
2291
# The default value is: YES.
2292
# This tag requires that the tag HAVE_DOT is set to YES.
2293

    
2294
DIRECTORY_GRAPH        = YES
2295

    
2296
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2297
# generated by dot. For an explanation of the image formats see the section
2298
# output formats in the documentation of the dot tool (Graphviz (see:
2299
# http://www.graphviz.org/)).
2300
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2301
# to make the SVG files visible in IE 9+ (other browsers do not have this
2302
# requirement).
2303
# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2304
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2305
# png:gdiplus:gdiplus.
2306
# The default value is: png.
2307
# This tag requires that the tag HAVE_DOT is set to YES.
2308

    
2309
DOT_IMAGE_FORMAT       = svg
2310

    
2311
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2312
# enable generation of interactive SVG images that allow zooming and panning.
2313
#
2314
# Note that this requires a modern browser other than Internet Explorer. Tested
2315
# and working are Firefox, Chrome, Safari, and Opera.
2316
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2317
# the SVG files visible. Older versions of IE do not have SVG support.
2318
# The default value is: NO.
2319
# This tag requires that the tag HAVE_DOT is set to YES.
2320

    
2321
INTERACTIVE_SVG        = YES
2322

    
2323
# The DOT_PATH tag can be used to specify the path where the dot tool can be
2324
# found. If left blank, it is assumed the dot tool can be found in the path.
2325
# This tag requires that the tag HAVE_DOT is set to YES.
2326

    
2327
DOT_PATH               =
2328

    
2329
# The DOTFILE_DIRS tag can be used to specify one or more directories that
2330
# contain dot files that are included in the documentation (see the \dotfile
2331
# command).
2332
# This tag requires that the tag HAVE_DOT is set to YES.
2333

    
2334
DOTFILE_DIRS           =
2335

    
2336
# The MSCFILE_DIRS tag can be used to specify one or more directories that
2337
# contain msc files that are included in the documentation (see the \mscfile
2338
# command).
2339

    
2340
MSCFILE_DIRS           =
2341

    
2342
# The DIAFILE_DIRS tag can be used to specify one or more directories that
2343
# contain dia files that are included in the documentation (see the \diafile
2344
# command).
2345

    
2346
DIAFILE_DIRS           =
2347

    
2348
# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2349
# path where java can find the plantuml.jar file. If left blank, it is assumed
2350
# PlantUML is not used or called during a preprocessing step. Doxygen will
2351
# generate a warning when it encounters a \startuml command in this case and
2352
# will not generate output for the diagram.
2353

    
2354
PLANTUML_JAR_PATH      =
2355

    
2356
# When using plantuml, the specified paths are searched for files specified by
2357
# the !include statement in a plantuml block.
2358

    
2359
PLANTUML_INCLUDE_PATH  =
2360

    
2361
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2362
# that will be shown in the graph. If the number of nodes in a graph becomes
2363
# larger than this value, doxygen will truncate the graph, which is visualized
2364
# by representing a node as a red box. Note that doxygen if the number of direct
2365
# children of the root node in a graph is already larger than
2366
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2367
# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2368
# Minimum value: 0, maximum value: 10000, default value: 50.
2369
# This tag requires that the tag HAVE_DOT is set to YES.
2370

    
2371
DOT_GRAPH_MAX_NODES    = 1024
2372

    
2373
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2374
# generated by dot. A depth value of 3 means that only nodes reachable from the
2375
# root by following a path via at most 3 edges will be shown. Nodes that lay
2376
# further from the root node will be omitted. Note that setting this option to 1
2377
# or 2 may greatly reduce the computation time needed for large code bases. Also
2378
# note that the size of a graph can be further restricted by
2379
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2380
# Minimum value: 0, maximum value: 1000, default value: 0.
2381
# This tag requires that the tag HAVE_DOT is set to YES.
2382

    
2383
MAX_DOT_GRAPH_DEPTH    = 0
2384

    
2385
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2386
# background. This is disabled by default, because dot on Windows does not seem
2387
# to support this out of the box.
2388
#
2389
# Warning: Depending on the platform used, enabling this option may lead to
2390
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2391
# read).
2392
# The default value is: NO.
2393
# This tag requires that the tag HAVE_DOT is set to YES.
2394

    
2395
DOT_TRANSPARENT        = YES
2396

    
2397
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2398
# files in one run (i.e. multiple -o and -T options on the command line). This
2399
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2400
# this, this feature is disabled by default.
2401
# The default value is: NO.
2402
# This tag requires that the tag HAVE_DOT is set to YES.
2403

    
2404
DOT_MULTI_TARGETS      = NO
2405

    
2406
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2407
# explaining the meaning of the various boxes and arrows in the dot generated
2408
# graphs.
2409
# The default value is: YES.
2410
# This tag requires that the tag HAVE_DOT is set to YES.
2411

    
2412
GENERATE_LEGEND        = YES
2413

    
2414
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2415
# files that are used to generate the various graphs.
2416
# The default value is: YES.
2417
# This tag requires that the tag HAVE_DOT is set to YES.
2418

    
2419
DOT_CLEANUP            = YES