Doxyfile.in 76.3 KB
Newer Older
1
# Doxyfile 1.7.6.1
2 3

# This file describes the settings to be used by the documentation system
4
# doxygen (www.doxygen.org) for a project
5
#
6
# All text after a hash (#) is considered a comment and will be ignored
7 8 9 10
# The format is:
#       TAG = value [value, ...]
# For lists items can also be appended using:
#       TAG += value [value, ...]
11
# Values that contain spaces should be placed between quotes (" ")
12 13 14 15 16

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

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

DOXYFILE_ENCODING      = UTF-8

25 26
# The PROJECT_NAME tag is a single word (or sequence of words) that should 
# identify the project. Note that if you do not use Doxywizard you need 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
27
# to put quotes around the project name if it contains spaces.
28

29
PROJECT_NAME           = ScalFmm
30

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

35
PROJECT_NUMBER         = @SCALFMM_MAJOR_VERSION@.@SCALFMM_MINOR_VERSION@
36

37 38
# Using the PROJECT_BRIEF tag one can provide an optional one line description 
# for a project that appears at the top of each page and should give viewer 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
39 40
# a quick idea about the purpose of the project. Keep the description short.

41
PROJECT_BRIEF          = 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
42

43 44 45
# With the PROJECT_LOGO tag one can specify an logo or icon that is 
# included in the documentation. The maximum height of the logo should not 
# exceed 55 pixels and the maximum width should not exceed 200 pixels. 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
46 47
# Doxygen will copy the logo to the output directory.

48
PROJECT_LOGO           = @CMAKE_CURRENT_SOURCE_DIR@/scalfmm.png
BRAMAS Berenger's avatar
BRAMAS Berenger committed
49

50 51 52
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
# base path where the generated documentation will be put. 
# If a relative path is entered, it will be relative to the location 
53 54 55 56
# where doxygen was started. If left blank the current directory will be used.

OUTPUT_DIRECTORY       = ../Doc

57 58 59 60 61
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
# 4096 sub-directories (in 2 levels) under the output directory of each output 
# format and will distribute the generated files over these directories. 
# Enabling this option can be useful when feeding doxygen a huge amount of 
# source files, where putting all generated files in the same directory would 
62 63 64 65
# otherwise cause performance problems for the file system.

CREATE_SUBDIRS         = NO

66 67 68 69 70 71 72 73 74 75
# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
# documentation generated by doxygen is written. Doxygen will use this 
# information to generate all constant output in the proper language. 
# The default language is English, other supported languages are: 
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, 
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
76

BRAMAS Berenger's avatar
BRAMAS Berenger committed
77
OUTPUT_LANGUAGE        = English
78

79 80 81
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
# include brief member descriptions after the members that are listed in 
# the file and class documentation (similar to JavaDoc). 
82 83 84 85
# Set to NO to disable this.

BRIEF_MEMBER_DESC      = YES

86 87 88
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
# the brief description of a member or function before the detailed description. 
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
89 90 91 92
# brief descriptions will be completely suppressed.

REPEAT_BRIEF           = YES

93 94 95 96 97 98 99 100
# This tag implements a quasi-intelligent brief description abbreviator 
# that is used to form the text in various listings. Each string 
# in this list, if found as the leading text of the brief description, will be 
# stripped from the text and the result after processing the whole list, is 
# used as the annotated text. Otherwise, the brief description is used as-is. 
# If left blank, the following values are used ("$name" is automatically 
# replaced with the name of the entity): "The $name class" "The $name widget" 
# "The $name file" "is" "provides" "specifies" "contains" 
101 102 103 104 105 106 107 108 109 110 111 112 113 114
# "represents" "a" "an" "the"

ABBREVIATE_BRIEF       = "The $name class" \
                         "The $name widget" \
                         "The $name file" \
                         is \
                         provides \
                         specifies \
                         contains \
                         represents \
                         a \
                         an \
                         the

115 116
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
# Doxygen will generate a detailed section even if there is only a brief 
117 118 119 120
# description.

ALWAYS_DETAILED_SEC    = YES

121 122 123
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
# inherited members of a class in the documentation of that class as if those 
# members were ordinary class members. Constructors, destructors and assignment 
124 125 126 127
# operators of the base classes will not be shown.

INLINE_INHERITED_MEMB  = YES

128 129
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
# path before files name in the file list and in the header files. If set 
130 131
# to NO the shortest path that makes the file name unique will be used.

132
FULL_PATH_NAMES        = NO
133

134 135 136 137 138 139 140 141 142 143 144 145 146 147
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
# can be used to strip a user-defined part of the path. Stripping is 
# only done if one of the specified strings matches the left-hand part of 
# the path. The tag can be used to show relative paths in the file list. 
# If left blank the directory from which doxygen is run is used as the 
# path to strip.

STRIP_FROM_PATH        = 

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

150
STRIP_FROM_INC_PATH    = 
151

152 153
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
# (but less readable) file names. This can be useful if your file system 
154 155 156 157
# doesn't support long names like on DOS, Mac, or CD-ROM.

SHORT_NAMES            = NO

158 159 160 161
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
# will interpret the first line (until the first dot) of a JavaDoc-style 
# comment as the brief description. If set to NO, the JavaDoc 
# comments will behave just like regular Qt-style comments 
162 163 164 165
# (thus requiring an explicit @brief command for a brief description.)

JAVADOC_AUTOBRIEF      = NO

166 167 168 169
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
# interpret the first line (until the first dot) of a Qt-style 
# comment as the brief description. If set to NO, the comments 
# will behave just like regular Qt-style comments (thus requiring 
170 171 172 173
# an explicit \brief command for a brief description.)

QT_AUTOBRIEF           = NO

174 175 176 177
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
# treat a multi-line C++ special comment block (i.e. a block of //! or /// 
# comments) as a brief description. This used to be the default behaviour. 
# The new default is to treat a multi-line C++ comment block as a detailed 
178 179 180 181
# description. Set this tag to YES if you prefer the old behaviour instead.

MULTILINE_CPP_IS_BRIEF = NO

182 183
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
# member inherits the documentation from any documented member that it 
184 185 186 187
# re-implements.

INHERIT_DOCS           = YES

188 189
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
# a new page for each member. If set to NO, the documentation of a member will 
190 191 192 193
# be part of the file/class/namespace that contains it.

SEPARATE_MEMBER_PAGES  = NO

194
# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
195 196 197 198
# Doxygen uses this value to replace tabs by spaces in code fragments.

TAB_SIZE               = 8

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

206
ALIASES                = 
207

208 209 210
# This tag can be used to specify a number of word-keyword mappings (TCL only). 
# A mapping has the form "name=value". For example adding 
# "class=itcl::class" will allow you to use the command class in the 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
211 212
# itcl::class meaning.

213
TCL_SUBST              = 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
214

215 216 217
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
# sources only. Doxygen will then generate output that is more tailored for C. 
# For instance, some of the names that are used will be different. The list 
218 219 220 221
# of all members will be omitted, etc.

OPTIMIZE_OUTPUT_FOR_C  = NO

222 223 224
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
# sources only. Doxygen will then generate output that is more tailored for 
# Java. For instance, namespaces will be presented as packages, qualified 
225 226 227 228
# scopes will look different, etc.

OPTIMIZE_OUTPUT_JAVA   = NO

229 230
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 
# sources only. Doxygen will then generate output that is more tailored for 
231 232 233 234
# Fortran.

OPTIMIZE_FOR_FORTRAN   = NO

235 236
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 
# sources. Doxygen will then generate output that is tailored for 
237 238 239 240
# VHDL.

OPTIMIZE_OUTPUT_VHDL   = NO

241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
# Doxygen selects the parser to use depending on the extension of the files it 
# parses. With this tag you can assign which parser to use for a given extension. 
# Doxygen has a built-in mapping, but you can override or extend it using this 
# tag. The format is ext=language, where ext is a file extension, and language 
# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, 
# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make 
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions 
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.

EXTENSION_MAPPING      = 

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

BUILTIN_STL_SUPPORT    = NO

262
# If you use Microsoft's C++/CLI language, you should set this option to YES to 
263 264 265 266
# enable parsing support.

CPP_CLI_SUPPORT        = NO

267 268
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 
# Doxygen will parse them like normal C++ but will assume all classes use public 
269 270 271 272
# instead of private inheritance when no explicit protection keyword is present.

SIP_SUPPORT            = NO

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

IDL_PROPERTY_SUPPORT   = YES

282 283 284
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
# tag is set to YES, then doxygen will reuse the documentation of the first 
# member in the group (if any) for the other members of the group. By default 
285 286 287 288
# all members of a group must be documented explicitly.

DISTRIBUTE_GROUP_DOC   = NO

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

SUBGROUPING            = YES

297 298 299
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 
# unions are shown inside the group in which they are included (e.g. using 
# @ingroup) instead of on a separate page (for HTML and Man pages) or 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
300 301 302 303
# section (for LaTeX and RTF).

INLINE_GROUPED_CLASSES = NO

304 305 306 307 308 309
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 
# unions with only public data fields will be shown inline in the documentation 
# of the scope in which they are defined (i.e. file, namespace, or group 
# documentation), provided this scope is documented. If set to NO (the default), 
# structs, classes, and unions are shown on a separate page (for HTML and Man 
# pages) or section (for LaTeX and RTF).
BRAMAS Berenger's avatar
BRAMAS Berenger committed
310 311 312

INLINE_SIMPLE_STRUCTS  = NO

313 314 315 316 317 318
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 
# is documented as struct, union, or enum with the name of the typedef. So 
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 
# with name TypeT. When disabled the typedef will appear as a member of a file, 
# namespace, or class. And the struct will be named TypeS. This can typically 
# be useful for C code in case the coding convention dictates that all compound 
319 320 321 322
# types are typedef'ed and only the typedef is referenced, never the tag name.

TYPEDEF_HIDES_STRUCT   = NO

323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 
# determine which symbols to keep in memory and which to flush to disk. 
# When the cache is full, less often used symbols will be written to disk. 
# For small to medium size projects (<1000 input files) the default value is 
# probably good enough. For larger projects a too small cache size can cause 
# doxygen to be busy swapping symbols to and from disk most of the time 
# causing a significant performance penalty. 
# If the system has enough physical memory increasing the cache will improve the 
# performance by keeping more symbols in memory. Note that the value works on 
# a logarithmic scale so increasing the size by one will roughly double the 
# memory usage. The cache size is given by this formula: 
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 
# corresponding to a cache size of 2^16 = 65536 symbols.

SYMBOL_CACHE_SIZE      = 0

# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be 
# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given 
# their name and scope. Since this can be an expensive process and often the 
# same symbol appear multiple times in the code, doxygen keeps a cache of 
# pre-resolved symbols. If the cache is too small doxygen will become slower. 
# If the cache is too large, memory is wasted. The cache size is given by this 
# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, 
# corresponding to a cache size of 2^16 = 65536 symbols.
BRAMAS Berenger's avatar
BRAMAS Berenger committed
347 348 349

LOOKUP_CACHE_SIZE      = 0

350 351 352 353
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------

354 355 356 357
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
# documentation are documented, even if no documentation was available. 
# Private class members and static file members will be hidden unless 
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
358 359 360

EXTRACT_ALL            = YES

361
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
362 363
# will be included in the documentation.

364
EXTRACT_PRIVATE        = YES
365

366
# If the EXTRACT_STATIC tag is set to YES all static members of a file 
367 368
# will be included in the documentation.

369
EXTRACT_STATIC         = YES
370

371 372
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
# defined locally in source files will be included in the documentation. 
373 374 375 376
# If set to NO only classes defined in header files are included.

EXTRACT_LOCAL_CLASSES  = YES

377 378 379
# This flag is only useful for Objective-C code. When set to YES local 
# methods, which are defined in the implementation section but not in 
# the interface are included in the documentation. 
380 381 382 383
# If set to NO (the default) only methods in the interface are included.

EXTRACT_LOCAL_METHODS  = NO

384 385 386 387
# If this flag is set to YES, the members of anonymous namespaces will be 
# extracted and appear in the documentation as a namespace called 
# 'anonymous_namespace{file}', where file will be replaced with the base 
# name of the file that contains the anonymous namespace. By default 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
388
# anonymous namespaces are hidden.
389 390 391

EXTRACT_ANON_NSPACES   = NO

392 393 394 395
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
# undocumented members of documented classes, files or namespaces. 
# If set to NO (the default) these members will be included in the 
# various overviews, but no documentation section is generated. 
396 397 398 399
# This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_MEMBERS     = NO

400 401 402
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
# undocumented classes that are normally visible in the class hierarchy. 
# If set to NO (the default) these classes will be included in the various 
403 404 405 406
# overviews. This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_CLASSES     = NO

407 408 409
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
# friend (class|struct|union) declarations. 
# If set to NO (the default) these declarations will be included in the 
410 411 412 413
# documentation.

HIDE_FRIEND_COMPOUNDS  = NO

414 415 416
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
# documentation blocks found inside the body of a function. 
# If set to NO (the default) these blocks will be appended to the 
417 418 419 420
# function's detailed documentation block.

HIDE_IN_BODY_DOCS      = NO

421 422 423
# The INTERNAL_DOCS tag determines if documentation 
# that is typed after a \internal command is included. If the tag is set 
# to NO (the default) then the documentation will be excluded. 
424 425
# Set it to YES to include the internal documentation.

426
INTERNAL_DOCS          = YES
427

428 429 430 431
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
# file names in lower-case letters. If set to YES upper-case letters are also 
# allowed. This is useful if you have classes or files whose names only differ 
# in case and if your file system supports case sensitive file names. Windows 
432 433 434 435
# and Mac users are advised to set this option to NO.

CASE_SENSE_NAMES       = NO

436 437
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
# will show members with their full class and namespace scopes in the 
438 439 440 441
# documentation. If set to YES the scope will be hidden.

HIDE_SCOPE_NAMES       = NO

442 443
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
# will put a list of the files that are included by a file in the documentation 
444 445 446 447
# of that file.

SHOW_INCLUDE_FILES     = YES

448 449
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 
# will list include files with double quotes in the documentation 
450 451 452 453
# rather than with sharp brackets.

FORCE_LOCAL_INCLUDES   = NO

454
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
455 456 457 458
# is inserted in the documentation for inline members.

INLINE_INFO            = YES

459 460 461
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
# will sort the (detailed) documentation of file and class members 
# alphabetically by member name. If set to NO the members will appear in 
462 463 464 465
# declaration order.

SORT_MEMBER_DOCS       = YES

466 467 468
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
# brief documentation of file, namespace and class members alphabetically 
# by member name. If set to NO (the default) the members will appear in 
469 470
# declaration order.

Quentin Khan's avatar
Quentin Khan committed
471
SORT_BRIEF_DOCS        = YES
472

473 474 475 476 477 478
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 
# will sort the (brief and detailed) documentation of class members so that 
# constructors and destructors are listed first. If set to NO (the default) 
# the constructors will appear in the respective orders defined by 
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 
479 480 481 482
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.

SORT_MEMBERS_CTORS_1ST = NO

483 484
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 
# hierarchy of group names into alphabetical order. If set to NO (the default) 
485 486 487 488
# the group names will appear in their defined order.

SORT_GROUP_NAMES       = NO

489 490 491 492 493 494
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
# sorted by fully-qualified names, including namespaces. If set to 
# NO (the default), the class list will be sorted only by class name, 
# not including the namespace part. 
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 
# Note: This option applies only to the class list, not to the 
495 496 497 498
# alphabetical list.

SORT_BY_SCOPE_NAME     = NO

499 500 501 502 503
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 
# do proper type resolution of all parameters of a function it will reject a 
# match between the prototype and the implementation of a member function even 
# if there is only one candidate or it is obvious which candidate to choose 
# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
504 505 506 507
# will still accept a match between prototype and implementation in such cases.

STRICT_PROTO_MATCHING  = NO

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

BRAMAS Berenger's avatar
BRAMAS Berenger committed
512
GENERATE_TODOLIST      = NO
513

514 515
# The GENERATE_TESTLIST tag can be used to enable (YES) or 
# disable (NO) the test list. This list is created by putting \test 
516 517 518 519
# commands in the documentation.

GENERATE_TESTLIST      = YES

520 521
# The GENERATE_BUGLIST tag can be used to enable (YES) or 
# disable (NO) the bug list. This list is created by putting \bug 
522 523 524 525
# commands in the documentation.

GENERATE_BUGLIST       = YES

526 527
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
# disable (NO) the deprecated list. This list is created by putting 
528 529 530 531
# \deprecated commands in the documentation.

GENERATE_DEPRECATEDLIST= YES

532 533
# The ENABLED_SECTIONS tag can be used to enable conditional 
# documentation sections, marked by \if sectionname ... \endif.
534

535
ENABLED_SECTIONS       = 
536

537 538 539 540 541 542
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
# the initial value of a variable or macro consists of for it to appear in 
# the documentation. If the initializer consists of more lines than specified 
# here it will be hidden. Use a value of 0 to hide initializers completely. 
# The appearance of the initializer of individual variables and macros in the 
# documentation can be controlled using \showinitializer or \hideinitializer 
543 544 545 546
# command in the documentation regardless of this setting.

MAX_INITIALIZER_LINES  = 30

547 548
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
# at the bottom of the documentation of classes and structs. If set to YES the 
549 550 551 552
# list will mention the files that were used to generate the documentation.

SHOW_USED_FILES        = YES

553 554 555 556
# If the sources in your project are distributed over multiple directories 
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
# in the documentation. The default is NO.

557
SHOW_DIRECTORIES       = YES
558 559 560

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

SHOW_FILES             = YES

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

SHOW_NAMESPACES        = YES

571 572 573 574 575 576
# The FILE_VERSION_FILTER tag can be used to specify a program or script that 
# doxygen should invoke to get the current version for each file (typically from 
# the version control system). Doxygen will invoke the program by executing (via 
# popen()) the command <command> <input-file>, where <command> is the value of 
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
# provided by doxygen. Whatever the program writes to standard output 
577 578
# is used as the file version. See the manual for examples.

579
FILE_VERSION_FILTER    = 
580

581 582 583 584 585
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 
# by doxygen. The layout file controls the global structure of the generated 
# output files in an output format independent way. The create the layout file 
# that represents doxygen's defaults, run doxygen with the -l option. 
# You can optionally specify a file name after the option, if omitted 
586 587
# DoxygenLayout.xml will be used as the name of the layout file.

588
LAYOUT_FILE            = 
589

590 591 592 593 594 595 596
# The CITE_BIB_FILES tag can be used to specify one or more bib files 
# containing the references data. This must be a list of .bib files. The 
# .bib extension is automatically appended if omitted. Using this command 
# requires the bibtex tool to be installed. See also 
# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 
# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 
# feature you need bibtex and perl available in the search path.
BRAMAS Berenger's avatar
BRAMAS Berenger committed
597

598
CITE_BIB_FILES         = 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
599

600 601 602 603
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------

604
# The QUIET tag can be used to turn on/off the messages that are generated 
605 606 607 608
# by doxygen. Possible values are YES and NO. If left blank NO is used.

QUIET                  = NO

609 610
# The WARNINGS tag can be used to turn on/off the warning messages that are 
# generated by doxygen. Possible values are YES and NO. If left blank 
611 612 613 614
# NO is used.

WARNINGS               = YES

615 616
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
617 618 619 620
# automatically be disabled.

WARN_IF_UNDOCUMENTED   = YES

621 622 623
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
# potential errors in the documentation, such as not documenting some 
# parameters in a documented function, or documenting parameters that 
624 625 626 627
# don't exist or using markup commands wrongly.

WARN_IF_DOC_ERROR      = YES

628 629 630 631
# The WARN_NO_PARAMDOC option can be enabled to get warnings for 
# functions that are documented, but have no documentation for their parameters 
# or return value. If set to NO (the default) doxygen will only warn about 
# wrong or incomplete parameter documentation, but not about the absence of 
632 633 634 635
# documentation.

WARN_NO_PARAMDOC       = NO

636 637 638 639 640
# The WARN_FORMAT tag determines the format of the warning messages that 
# doxygen can produce. The string should contain the $file, $line, and $text 
# tags, which will be replaced by the file and line number from which the 
# warning originated and the warning text. Optionally the format may contain 
# $version, which will be replaced by the version of the file (if it could 
641 642 643 644
# be obtained via FILE_VERSION_FILTER)

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

645 646
# The WARN_LOGFILE tag can be used to specify a file to which warning 
# and error messages should be written. If left blank the output is written 
647 648
# to stderr.

649
WARN_LOGFILE           = 
650 651 652 653 654

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

655 656 657
# The INPUT tag can be used to specify the files and/or directories that contain 
# documented source files. You may enter file names like "myfile.cpp" or 
# directories like "/usr/src/myproject". Separate the files or directories 
658 659
# with spaces.

PIACIBELLO Cyrille's avatar
oubli  
PIACIBELLO Cyrille committed
660
INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/../Doc/Site_dox \
661
                         @CMAKE_CURRENT_SOURCE_DIR@/../Src/ \
BRAMAS Berenger's avatar
BRAMAS Berenger committed
662 663
                         @CMAKE_CURRENT_SOURCE_DIR@/../Examples/ \
                         @CMAKE_CURRENT_SOURCE_DIR@/../Tests/
664

665 666 667 668
# This tag can be used to specify the character encoding of the source files 
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
# also the default input encoding. Doxygen uses libiconv (or the iconv built 
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
669 670 671 672
# the list of possible encodings.

INPUT_ENCODING         = UTF-8

673 674 675 676 677 678
# If the value of the INPUT tag contains directories, you can use the 
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
# and *.h) to filter out the source-files in the directories. If left 
# blank the following patterns are tested: 
# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
679
# *.f90 *.f *.for *.vhd *.vhdl
680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712

FILE_PATTERNS          = *.c \
                         *.cc \
                         *.cxx \
                         *.cpp \
                         *.c++ \
                         *.d \
                         *.java \
                         *.ii \
                         *.ixx \
                         *.ipp \
                         *.i++ \
                         *.inl \
                         *.h \
                         *.hh \
                         *.hxx \
                         *.hpp \
                         *.h++ \
                         *.idl \
                         *.odl \
                         *.cs \
                         *.php \
                         *.php3 \
                         *.inc \
                         *.m \
                         *.mm \
                         *.dox \
                         *.py \
                         *.f90 \
                         *.f \
                         *.vhd \
                         *.vhdl

713 714
# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
# should be searched for input files as well. Possible values are YES and NO. 
715 716 717 718
# If left blank NO is used.

RECURSIVE              = YES

719 720 721 722
# The EXCLUDE tag can be used to specify files and/or directories that should be 
# excluded from the INPUT source files. This way you can easily exclude a 
# subdirectory from a directory tree whose root is specified with the INPUT tag. 
# Note that relative paths are relative to the directory from which doxygen is 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
723
# run.
724

725
EXCLUDE                = 
726

727 728
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 
# directories that are symbolic links (a Unix file system feature) are excluded 
729 730 731 732
# from the input.

EXCLUDE_SYMLINKS       = YES

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

739
EXCLUDE_PATTERNS       = 
740

741 742 743 744
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
# (namespaces, classes, functions, etc.) that should be excluded from the 
# output. The symbol name can be a fully qualified name, a word, or if the 
# wildcard * is used, a substring. Examples: ANamespace, AClass, 
745 746
# AClass::ANamespace, ANamespace::*Test

747
EXCLUDE_SYMBOLS        = 
748

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

BRAMAS Berenger's avatar
BRAMAS Berenger committed
753 754
EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/../UTests \
                         @CMAKE_CURRENT_SOURCE_DIR@/../Tests
755

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

EXAMPLE_PATTERNS       = *

763 764 765
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
# searched for input files to be used with the \include or \dontinclude 
# commands irrespective of the value of the RECURSIVE tag. 
766 767
# Possible values are YES and NO. If left blank NO is used.

BRAMAS Berenger's avatar
BRAMAS Berenger committed
768
EXAMPLE_RECURSIVE      = YES
769

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

PIACIBELLO Cyrille's avatar
oubli  
PIACIBELLO Cyrille committed
774 775
IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/../Doc/Image_dox/.

776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
# The INPUT_FILTER tag can be used to specify a program that doxygen should 
# invoke to filter for each input file. Doxygen will invoke the filter program 
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
# input file. Doxygen will then use the output that the filter program writes 
# to standard output.  If FILTER_PATTERNS is specified, this tag will be 
# ignored.

INPUT_FILTER           = 

# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
# basis.  Doxygen will compare the file name with each pattern and apply the 
# filter if there is a match.  The filters are a list of the form: 
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
# info on how filters are used. If FILTER_PATTERNS is empty or if 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
791
# non of the patterns match the file name, INPUT_FILTER is applied.
792

793
FILTER_PATTERNS        = 
794

795 796
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
# INPUT_FILTER) will be used to filter the input files when producing source 
797 798 799 800
# files to browse (i.e. when SOURCE_BROWSER is set to YES).

FILTER_SOURCE_FILES    = NO

801 802 803 804
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) 
# and it is also possible to disable source filtering for a specific pattern 
# using *.ext= (so without naming a filter). This option only has effect when 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
805 806
# FILTER_SOURCE_FILES is enabled.

807
FILTER_SOURCE_PATTERNS = 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
808

809 810 811 812
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------

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

818
SOURCE_BROWSER         = YES
819

820
# Setting the INLINE_SOURCES tag to YES will include the body 
821 822 823 824
# of functions and classes directly in the documentation.

INLINE_SOURCES         = NO

825 826 827
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
# doxygen to hide any special comment blocks from generated source code 
# fragments. Normal C and C++ comments will always remain visible.
828 829 830

STRIP_CODE_COMMENTS    = NO

831 832
# If the REFERENCED_BY_RELATION tag is set to YES 
# then for each documented function all documented 
833 834 835 836
# functions referencing it will be listed.

REFERENCED_BY_RELATION = NO

837 838
# If the REFERENCES_RELATION tag is set to YES 
# then for each documented function all documented entities 
839 840 841 842
# called/used by that function will be listed.

REFERENCES_RELATION    = NO

843 844 845 846
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 
# link to the source code.  Otherwise they will link to the documentation.
847 848 849

REFERENCES_LINK_SOURCE = NO

850 851 852 853
# If the USE_HTAGS tag is set to YES then the references to source code 
# will point to the HTML generated by the htags(1) tool instead of doxygen 
# built-in source browser. The htags tool is part of GNU's global source 
# tagging system (see http://www.gnu.org/software/global/global.html). You 
854 855 856 857
# will need version 4.8.6 or higher.

USE_HTAGS              = NO

858 859
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
# will generate a verbatim copy of the header file for each class for 
860 861
# which an include is specified. Set to NO to disable this.

862
VERBATIM_HEADERS       = YES
863 864 865 866 867

#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------

868 869
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
# of all compounds will be generated. Enable this if the project 
870 871 872 873
# contains a lot of classes, structs, unions or interfaces.

ALPHABETICAL_INDEX     = YES

874 875
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
876 877 878 879
# in which this list will be split (can be a number in the range [1..20])

COLS_IN_ALPHA_INDEX    = 5

880 881 882
# In case all classes in a project start with a common prefix, all 
# classes will be put under the same header in the alphabetical index. 
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
883 884
# should be ignored while generating the index headers.

885
IGNORE_PREFIX          = 
886 887 888 889 890

#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------

891
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
892 893 894 895
# generate HTML output.

GENERATE_HTML          = YES

896 897
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
898 899 900 901
# put in front of it. If left blank `html' will be used as the default path.

HTML_OUTPUT            = html

902 903
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
904 905 906 907
# doxygen will generate files with .html extension.

HTML_FILE_EXTENSION    = .html

908 909 910 911 912 913 914 915 916
# The HTML_HEADER tag can be used to specify a personal HTML header for 
# each generated HTML page. If it is left blank doxygen will generate a 
# standard header. Note that when using a custom header you are responsible  
# for the proper inclusion of any scripts and style sheets that doxygen 
# needs, which is dependent on the configuration options used. 
# It is advised to generate a default header using "doxygen -w html 
# header.html footer.html stylesheet.css YourConfigFile" and then modify 
# that header. Note that the header is subject to change so you typically 
# have to redo this when upgrading to a newer version of doxygen or when 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
917
# changing the value of configuration settings such as GENERATE_TREEVIEW!
918

919
HTML_HEADER            = 
920

921 922
# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
# each generated HTML page. If it is left blank doxygen will generate a 
923 924
# standard footer.

925
HTML_FOOTER            = 
926

927 928 929 930 931 932
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
# style sheet that is used by each HTML page. It can be used to 
# fine-tune the look of the HTML output. If the tag is left blank doxygen 
# will generate a default style sheet. Note that doxygen will try to copy 
# the style sheet file to the HTML output directory, so don't put your own 
# style sheet in the HTML output directory as well, or it will be erased!
933

934
HTML_STYLESHEET        = 
PIACIBELLO Cyrille's avatar
oubli  
PIACIBELLO Cyrille committed
935

936 937 938 939 940
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 
# other source files which should be copied to the HTML output directory. Note 
# that these files will be copied to the base HTML output directory. Use the 
# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 
# files. In the HTML_STYLESHEET file, use the file name only. Also note that 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
941 942
# the files will be copied as-is; there are no commands or markers available.

943
HTML_EXTRA_FILES       = 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
944

945 946 947 948 949 950
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 
# Doxygen will adjust the colors in the style sheet and background images 
# according to this color. Hue is specified as an angle on a colorwheel, 
# see http://en.wikipedia.org/wiki/Hue for more information. 
# For instance the value 0 represents red, 60 is yellow, 120 is green, 
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 
951 952 953 954
# The allowed range is 0 to 359.

HTML_COLORSTYLE_HUE    = 220

955 956
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 
# the colors in the HTML output. For a value of 0 the output will use 
957 958 959 960
# grayscales only. A value of 255 will produce the most vivid colors.

HTML_COLORSTYLE_SAT    = 100

961 962 963 964 965
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 
# the luminance component of the colors in the HTML output. Values below 
# 100 gradually make the output lighter, whereas values above 100 make 
# the output darker. The value divided by 100 is the actual gamma applied, 
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 
966 967 968 969
# and 100 does not change the gamma.

HTML_COLORSTYLE_GAMMA  = 80

970 971
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 
# page will contain the date and time when the page was generated. Setting 
972 973 974 975
# this to NO can help when comparing the output of multiple runs.

HTML_TIMESTAMP         = YES

976 977 978 979 980 981 982 983 984 985 986
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
# files or namespaces will be aligned in HTML using tables. If set to 
# NO a bullet list will be used.

HTML_ALIGN_MEMBERS     = YES

# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
# documentation will contain sections that can be hidden and shown after the 
# page has loaded. For this to work a browser that supports 
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
987

Quentin Khan's avatar
Quentin Khan committed
988
HTML_DYNAMIC_SECTIONS  = YES
989

990 991 992 993 994 995 996 997 998
# If the GENERATE_DOCSET tag is set to YES, additional index files 
# will be generated that can be used as input for Apple's Xcode 3 
# integrated development environment, introduced with OSX 10.5 (Leopard). 
# To create a documentation set, doxygen will generate a Makefile in the 
# HTML output directory. Running make will produce the docset in that 
# directory and running "make install" will install the docset in 
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
# it at startup. 
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 
999 1000 1001 1002
# for more information.

GENERATE_DOCSET        = NO

1003 1004 1005
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
# feed. A documentation feed provides an umbrella under which multiple 
# documentation sets from a single provider (such as a company or product suite) 
1006 1007 1008 1009
# can be grouped.

DOCSET_FEEDNAME        = "Doxygen generated docs"

1010 1011 1012
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
# should uniquely identify the documentation set bundle. This should be a 
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
1013 1014 1015 1016
# will append .docset to the name.

DOCSET_BUNDLE_ID       = org.doxygen.Project

1017 1018 1019
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 
# the documentation publisher. This should be a reverse domain-name style 
# string, e.g. com.mycompany.MyDocSet.documentation.
1020 1021 1022 1023 1024 1025 1026

DOCSET_PUBLISHER_ID    = org.doxygen.Publisher

# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.

DOCSET_PUBLISHER_NAME  = Publisher

1027 1028 1029
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
# will be generated that can be used as input for tools like the 
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
1030 1031 1032 1033
# of the generated HTML documentation.

GENERATE_HTMLHELP      = NO

1034 1035 1036
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
# be used to specify the file name of the resulting .chm file. You 
# can add a path in front of the file if the result should not be 
1037 1038
# written to the html output directory.

1039
CHM_FILE               = 
1040

1041 1042 1043
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
# be used to specify the location (absolute path including file name) of 
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
1044 1045
# the HTML help compiler on the generated index.hhp.

1046
HHC_LOCATION           = 
1047

1048 1049
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
# controls if a separate .chi index file is generated (YES) or that 
1050 1051 1052 1053
# it should be included in the master .chm file (NO).

GENERATE_CHI           = NO

1054 1055
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 
# is used to encode HtmlHelp index (hhk), content (hhc) and project file 
1056 1057
# content.

1058
CHM_INDEX_ENCODING     = 
1059

1060 1061
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
# controls whether a binary table of contents is generated (YES) or a 
1062 1063 1064 1065
# normal table of contents (NO) in the .chm file.

BINARY_TOC             = NO

1066
# The TOC_EXPAND flag can be set to YES to add extra items for group members 
1067 1068 1069 1070
# to the contents of the HTML help documentation and to the tree view.

TOC_EXPAND             = NO

1071 1072 1073
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 
# that can be used as input for Qt's qhelpgenerator to generate a 
1074 1075 1076 1077
# Qt Compressed Help (.qch) of the generated HTML documentation.

GENERATE_QHP           = NO

1078 1079
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 
# be used to specify the file name of the resulting .qch file. 
1080 1081
# The path specified is relative to the HTML output folder.

1082
QCH_FILE               = 
1083

1084 1085
# The QHP_NAMESPACE tag specifies the namespace to use when generating 
# Qt Help Project output. For more information please see 
1086 1087 1088 1089
# http://doc.trolltech.com/qthelpproject.html#namespace

QHP_NAMESPACE          = org.doxygen.Project

1090 1091
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 
# Qt Help Project output. For more information please see 
1092 1093 1094 1095
# http://doc.trolltech.com/qthelpproject.html#virtual-folders

QHP_VIRTUAL_FOLDER     = doc

1096 1097
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 
# add. For more information please see 
1098 1099
# http://doc.trolltech.com/qthelpproject.html#custom-filters

1100
QHP_CUST_FILTER_NAME   = 
1101

1102 1103 1104
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 
# custom filter to add. For more information please see 
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 
1105 1106
# Qt Help Project / Custom Filters</a>.

1107
QHP_CUST_FILTER_ATTRS  = 
1108

1109 1110 1111 1112
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 
# project's 
# filter section matches. 
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 
1113 1114
# Qt Help Project / Filter Attributes</a>.

1115
QHP_SECT_FILTER_ATTRS  = 
1116

1117 1118 1119
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 
# be used to specify the location of Qt's qhelpgenerator. 
# If non-empty doxygen will try to run qhelpgenerator on the generated 
1120 1121
# .qhp file.

1122
QHG_LOCATION           = 
1123

1124 1125 1126 1127 1128 1129 1130
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files  
# will be generated, which together with the HTML files, form an Eclipse help 
# plugin. To install this plugin and make it available under the help contents 
# menu in Eclipse, the contents of the directory containing the HTML and XML 
# files needs to be copied into the plugins directory of eclipse. The name of 
# the directory within the plugins directory should be the same as 
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 
1131 1132 1133 1134
# the help appears.

GENERATE_ECLIPSEHELP   = NO

1135 1136
# A unique identifier for the eclipse help plugin. When installing the plugin 
# the directory name containing the HTML and XML files should also have 
1137 1138 1139 1140
# this name.

ECLIPSE_DOC_ID         = org.doxygen.Project

1141 1142 1143 1144
# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 
# at top of each HTML page. The value NO (the default) enables the index and 
# the value YES disables it. Since the tabs have the same information as the 
# navigation tree you can set this option to NO if you already set 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
1145
# GENERATE_TREEVIEW to YES.
1146 1147 1148

DISABLE_INDEX          = NO

1149 1150 1151 1152 1153 1154 1155 1156
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 
# structure should be generated to display hierarchical information. 
# If the tag value is set to YES, a side panel will be generated 
# containing a tree-like index structure (just like the one that 
# is generated for HTML Help). For this to work a browser that supports 
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 
# Windows users are probably better off using the HTML help feature. 
# Since the tree basically has the same information as the tab index you 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
1157
# could consider to set DISABLE_INDEX to NO when enabling this option.
1158 1159 1160

GENERATE_TREEVIEW      = YES

1161 1162 1163
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 
# (range [0,1..20]) that doxygen will group on one line in the generated HTML 
# documentation. Note that a value of 0 will completely suppress the enum 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
1164 1165 1166 1167
# values from appearing in the overview section.

ENUM_VALUES_PER_LINE   = 4

1168 1169 1170 1171 1172 1173 1174
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, 
# and Class Hierarchy pages using a tree view instead of an ordered list.

USE_INLINE_TREES       = NO

# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
# used to set the initial width (in pixels) of the frame in which the tree 
1175 1176 1177 1178
# is shown.

TREEVIEW_WIDTH         = 250

1179
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 
1180 1181 1182 1183
# links to external symbols imported via tag files in a separate window.

EXT_LINKS_IN_WINDOW    = NO

1184 1185 1186 1187
# Use this tag to change the font size of Latex formulas included 
# as images in the HTML documentation. The default is 10. Note that 
# when you change the font size after a successful doxygen run you need 
# to manually remove any form_*.png images from the HTML output directory 
1188 1189 1190 1191
# to force them to be regenerated.

FORMULA_FONTSIZE       = 10

1192 1193 1194 1195
# Use the FORMULA_TRANPARENT tag to determine whether or not the images 
# generated for formulas are transparent PNGs. Transparent PNGs are 
# not supported properly for IE 6.0, but are supported on all modern browsers. 
# Note that when changing this option you need to delete any form_*.png files 
1196 1197 1198 1199
# in the HTML output before the changes have effect.

FORMULA_TRANSPARENT    = YES

1200 1201 1202 1203 1204
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 
# (see http://www.mathjax.org) which uses client side Javascript for the 
# rendering instead of using prerendered bitmaps. Use this if you do not 
# have LaTeX installed or if you want to formulas look prettier in the HTML 
# output. When enabled you also need to install MathJax separately and 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
1205 1206 1207 1208
# configure the path to it using the MATHJAX_RELPATH option.

USE_MATHJAX            = NO

1209 1210 1211 1212 1213 1214 1215 1216
# When MathJax is enabled you need to specify the location relative to the 
# HTML output directory using the MATHJAX_RELPATH option. The destination 
# directory should contain the MathJax.js script. For instance, if the mathjax 
# directory is located at the same level as the HTML output directory, then 
# MATHJAX_RELPATH should be ../mathjax. The default value points to the 
# mathjax.org site, so you can quickly see the result without installing 
# MathJax, but it is strongly recommended to install a local copy of MathJax 
# before deployment.
BRAMAS Berenger's avatar
BRAMAS Berenger committed
1217 1218 1219

MATHJAX_RELPATH        = http://www.mathjax.org/mathjax

1220
# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
1221 1222
# names that should be enabled during MathJax rendering.

1223
MATHJAX_EXTENSIONS     = 
PIACIBELLO Cyrille's avatar
oubli  
PIACIBELLO Cyrille committed
1224

1225 1226 1227 1228 1229 1230
# When the SEARCHENGINE tag is enabled doxygen will generate a search box 
# for the HTML output. The underlying search engine uses javascript 
# and DHTML and should work on any modern browser. Note that when using 
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 
# (GENERATE_DOCSET) there is already a search function so this one should 
# typically be disabled. For large projects the javascript based search engine 
1231 1232 1233 1234
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.

SEARCHENGINE           = NO

1235 1236 1237 1238 1239 1240 1241
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 
# implemented using a PHP enabled web server instead of at the web client 
# using Javascript. Doxygen will generate the search PHP script and index 
# file to put on the web server. The advantage of the server 
# based approach is that it scales better to large projects and allows 
# full text search. The disadvantages are that it is more difficult to setup 
# and does not have live searching capabilities.
1242 1243 1244 1245 1246 1247 1248

SERVER_BASED_SEARCH    = NO

#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------

1249
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
1250 1251 1252 1253
# generate Latex output.

GENERATE_LATEX         = NO

1254 1255
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1256 1257 1258 1259
# put in front of it. If left blank `latex' will be used as the default path.

LATEX_OUTPUT           = latex

1260 1261 1262 1263
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
# invoked. If left blank `latex' will be used as the default command name. 
# Note that when enabling USE_PDFLATEX this option is only used for 
# generating bitmaps for formulas in the HTML output, but not in the 
1264 1265 1266 1267
# Makefile that is written to the output directory.

LATEX_CMD_NAME         = latex

1268 1269
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
# generate index for LaTeX. If left blank `makeindex' will be used as the 
1270 1271 1272 1273
# default command name.

MAKEINDEX_CMD_NAME     = makeindex

1274 1275
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
# LaTeX documents. This may be useful for small projects and may help to 
1276 1277 1278 1279
# save some trees in general.

COMPACT_LATEX          = NO

1280 1281 1282
# The PAPER_TYPE tag can be used to set the paper type that is used 
# by the printer. Possible values are: a4, letter, legal and 
# executive. If left blank a4wide will be used.
1283 1284 1285

PAPER_TYPE             = a4wide

1286
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
1287 1288
# packages that should be included in the LaTeX output.

1289
EXTRA_PACKAGES         = 
1290

1291 1292 1293
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
# the generated latex document. The header should contain everything until 
# the first chapter. If it is left blank doxygen will generate a 
1294 1295
# standard header. Notice: only use this tag if you know what you are doing!

1296
LATEX_HEADER           = 
1297

1298 1299 1300
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 
# the generated latex document. The footer should contain everything after 
# the last chapter. If it is left blank doxygen will generate a 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
1301 1302
# standard footer. Notice: only use this tag if you know what you are doing!

1303
LATEX_FOOTER           = 
PIACIBELLO Cyrille's avatar
oubli  
PIACIBELLO Cyrille committed
1304

1305 1306 1307
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
# contain links (just like the HTML output) instead of page references 
1308 1309 1310 1311
# This makes the output suitable for online browsing using a pdf viewer.

PDF_HYPERLINKS         = YES

1312 1313
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
# plain latex in the generated Makefile. Set this option to YES to get a 
1314 1315 1316 1317
# higher quality PDF documentation.

USE_PDFLATEX           = YES

1318 1319 1320
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
# command to the generated LaTeX files. This will instruct LaTeX to keep 
# running if errors occur, instead of asking the user for help. 
1321 1322 1323 1324
# This option is also used when generating formulas in HTML.

LATEX_BATCHMODE        = NO

1325 1326
# If LATEX_HIDE_INDICES is set to YES then doxygen will not 
# include the index chapters (such as File Index, Compound Index, etc.) 
1327 1328 1329 1330
# in the output.

LATEX_HIDE_INDICES     = NO

1331 1332 1333
# If LATEX_SOURCE_CODE is set to YES then doxygen will include 
# source code with syntax highlighting in the LaTeX output. 
# Note that which sources are shown also depends on other settings 
1334 1335 1336 1337
# such as SOURCE_BROWSER.

LATEX_SOURCE_CODE      = NO

1338 1339
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 
# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 
BRAMAS Berenger's avatar
BRAMAS Berenger committed
1340 1341 1342 1343
# http://en.wikipedia.org/wiki/BibTeX for more info.

LATEX_BIB_STYLE        = plain

1344 1345 1346 1347
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------

1348 1349
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
# The RTF output is optimized for Word 97 and may not look very pretty with 
1350 1351 1352 1353
# other RTF readers or editors.

GENERATE_RTF           = NO

1354 1355
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1356 1357 1358 1359
# put in front of it. If left blank `rtf' will be used as the default path.

RTF_OUTPUT             = rtf

1360 1361
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
# RTF documents. This may be useful for small projects and may help to 
1362 1363 1364 1365
# save some trees in general.

COMPACT_RTF            = NO

1366 1367 1368 1369 1370
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
# will contain hyperlink fields. The RTF file will 
# contain links (just like the HTML output) instead of page references. 
# This makes the output suitable for online browsing using WORD or other 
# programs which support those fields. 
1371 1372 1373 1374
# Note: wordpad (write) and others do not support links.

RTF_HYPERLINKS         = NO

1375 1376
# Load style sheet definitions from file. Syntax is similar to doxygen's 
# config file, i.e. a series of assignments. You only have to provide 
1377 1378
# replacements, missing definitions are set to their default value.

1379
RTF_STYLESHEET_FILE    = 
1380

1381
# Set optional variables used in the generation of an rtf document. 
1382 1383
# Syntax is similar to doxygen's config file.

1384
RTF_EXTENSIONS_FILE    = 
1385 1386