Doxyfile.in 102 KB
Newer Older
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1
# Doxyfile 1.8.9.1
2 3

# This file describes the settings to be used by the documentation system
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
4
# doxygen (www.doxygen.org) for a project.
5
#
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
6 7 8 9
# All text after a double hash (##) is considered a comment and is placed in
# front of the TAG it is preceding.
#
# All text after a single hash (#) is considered a comment and will be ignored.
10
# The format is:
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
11 12 13 14
# TAG = value [value, ...]
# For lists, items can also be appended using:
# TAG += value [value, ...]
# 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
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
21 22 23 24 25
# that follow. The default is UTF-8 which is also the encoding used for all text
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
# for the list of possible encodings.
# The default value is: UTF-8.
Rémi Duraffort's avatar
Rémi Duraffort committed
26 27 28

DOXYFILE_ENCODING      = UTF-8

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
29 30 31 32 33
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
# double-quotes, unless you are using Doxywizard) that should identify the
# project for which the documentation is generated. This name is used in the
# title of most generated pages and in a few other places.
# The default value is: My Project.
34

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
35
PROJECT_NAME           = VLC
36

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
37 38 39
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
# control system is used.
40

41
PROJECT_NUMBER         = @VERSION@
42

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.

PROJECT_BRIEF          =

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

PROJECT_LOGO           =

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

61
OUTPUT_DIRECTORY       = doxygen
62

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
63 64 65 66 67 68 69
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
# will distribute the generated files over these directories. Enabling this
# option can be useful when feeding doxygen a huge amount of source files, where
# putting all generated files in the same directory would otherwise causes
# performance problems for the file system.
# The default value is: NO.
70 71 72

CREATE_SUBDIRS         = NO

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

ALLOW_UNICODE_NAMES    = NO

81 82 83
# 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.
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
84 85 86 87 88 89 90 91 92
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
# Ukrainian and Vietnamese.
# The default value is: English.
93 94 95

OUTPUT_LANGUAGE        = English

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
96 97 98 99
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
# descriptions after the members that are listed in the file and class
# documentation (similar to Javadoc). Set to NO to disable this.
# The default value is: YES.
100 101 102

BRIEF_MEMBER_DESC      = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
103 104 105 106
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
# description of a member or function before the detailed description
#
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
107
# brief descriptions will be completely suppressed.
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
108
# The default value is: YES.
109 110 111

REPEAT_BRIEF           = YES

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

121
ABBREVIATE_BRIEF       =
122

123
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
124
# doxygen will generate a detailed section even if there is only a brief
125
# description.
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
126
# The default value is: NO.
127 128 129

ALWAYS_DETAILED_SEC    = NO

130 131 132
# 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
133
# operators of the base classes will not be shown.
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
134
# The default value is: NO.
135 136 137

INLINE_INHERITED_MEMB  = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
138 139 140 141
# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
# before files name in the file list and in the header files. If set to NO the
# shortest path that makes the file name unique will be used
# The default value is: YES.
142 143 144

FULL_PATH_NAMES        = YES

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

STRIP_FROM_PATH        = ..

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

164
STRIP_FROM_INC_PATH    =
165

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

SHORT_NAMES            = NO

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

JAVADOC_AUTOBRIEF      = YES

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

QT_AUTOBRIEF           = NO

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

MULTILINE_CPP_IS_BRIEF = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
202 203 204
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
# documentation from any documented member that it re-implements.
# The default value is: YES.
205 206 207

INHERIT_DOCS           = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
208 209 210 211
# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
# page for each member. If set to NO, the documentation of a member will be part
# of the file/class/namespace that contains it.
# The default value is: NO.
212 213 214

SEPARATE_MEMBER_PAGES  = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
215 216 217
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
# uses this value to replace tabs by spaces in code fragments.
# Minimum value: 1, maximum value: 16, default value: 4.
218

Antoine Cellerier's avatar
Antoine Cellerier committed
219
TAB_SIZE               = 4
220

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

ALIASES                = "libvlc_return_bool=\if LIBVLC_RETURN_BOOL\n\par LIBVLC_RETURN_BOOL\n\endif"
232

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

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
237 238 239 240 241 242 243
TCL_SUBST              =

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

OPTIMIZE_OUTPUT_FOR_C  = YES

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

OPTIMIZE_OUTPUT_JAVA   = NO

255
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
256 257
# sources. Doxygen will then generate output that is tailored for Fortran.
# The default value is: NO.
Rémi Duraffort's avatar
Rémi Duraffort committed
258 259 260

OPTIMIZE_FOR_FORTRAN   = NO

261
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
262 263
# sources. Doxygen will then generate output that is tailored for VHDL.
# The default value is: NO.
Rémi Duraffort's avatar
Rémi Duraffort committed
264 265 266

OPTIMIZE_OUTPUT_VHDL   = NO

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

EXTENSION_MAPPING      =

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
# documentation. See http://daringfireball.net/projects/markdown/ for details.
# The output of markdown processing is further processed by doxygen, so you can
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
# case of backward compatibilities issues.
# The default value is: YES.

MARKDOWN_SUPPORT       = YES

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

AUTOLINK_SUPPORT       = YES

304
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
305 306 307 308
# to include (a tag file for) the STL sources as input, then you should set this
# tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string);
# versus func(std::string) {}). This also make the inheritance and collaboration
Rémi Duraffort's avatar
Rémi Duraffort committed
309
# diagrams that involve STL classes more complete and accurate.
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
310
# The default value is: NO.
Rémi Duraffort's avatar
Rémi Duraffort committed
311 312 313 314 315

BUILTIN_STL_SUPPORT    = NO

# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
316
# The default value is: NO.
Rémi Duraffort's avatar
Rémi Duraffort committed
317 318 319

CPP_CLI_SUPPORT        = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
320 321 322 323 324
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
# will parse them like normal C++ but will assume all classes use public instead
# of private inheritance when no explicit protection keyword is present.
# The default value is: NO.
Rémi Duraffort's avatar
Rémi Duraffort committed
325 326 327

SIP_SUPPORT            = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
328 329 330 331 332 333 334
# For Microsoft's IDL there are propget and propput attributes to indicate
# getter and setter methods for a property. Setting this option to YES will make
# doxygen to replace the get and set methods by a property in the documentation.
# This will only work if the methods are indeed getting or setting a simple
# type. If this is not the case, or you want to show the methods anyway, you
# should set this option to NO.
# The default value is: YES.
Rémi Duraffort's avatar
Rémi Duraffort committed
335 336 337

IDL_PROPERTY_SUPPORT   = YES

338
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
339
# tag is set to YES then doxygen will reuse the documentation of the first
340
# member in the group (if any) for the other members of the group. By default
Rémi Duraffort's avatar
Rémi Duraffort committed
341
# all members of a group must be documented explicitly.
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
342
# The default value is: NO.
Rémi Duraffort's avatar
Rémi Duraffort committed
343 344 345

DISTRIBUTE_GROUP_DOC   = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
346 347 348 349 350 351
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
# (for instance a group of public functions) to be put as a subgroup of that
# type (e.g. under the Public Functions section). Set it to NO to prevent
# subgrouping. Alternatively, this can be done per class using the
# \nosubgrouping command.
# The default value is: YES.
352 353 354

SUBGROUPING            = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
# are shown inside the group in which they are included (e.g. using \ingroup)
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
# and RTF).
#
# Note that this feature does not work in combination with
# SEPARATE_MEMBER_PAGES.
# The default value is: NO.

INLINE_GROUPED_CLASSES = NO

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

INLINE_SIMPLE_STRUCTS  = NO

# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
# enum is documented as struct, union, or enum with the name of the typedef. So
378 379
# 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,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
380 381
# 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
Rémi Duraffort's avatar
Rémi Duraffort committed
382
# types are typedef'ed and only the typedef is referenced, never the tag name.
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
383
# The default value is: NO.
Rémi Duraffort's avatar
Rémi Duraffort committed
384 385 386

TYPEDEF_HIDES_STRUCT   = NO

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

LOOKUP_CACHE_SIZE      = 0
399

400 401 402 403
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
404 405 406 407 408 409 410
# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
# documentation are documented, even if no documentation was available. Private
# class members and static file members will be hidden unless the
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
# Note: This will also disable the warnings about undocumented members that are
# normally produced when WARNINGS is set to YES.
# The default value is: NO.
411 412 413

EXTRACT_ALL            = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
414 415 416
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
# be included in the documentation.
# The default value is: NO.
417 418 419

EXTRACT_PRIVATE        = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
420 421 422 423 424 425 426 427 428
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
# The default value is: NO.

EXTRACT_PACKAGE        = NO

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

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
430
EXTRACT_STATIC         = YES
431

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
432 433 434 435 436
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
# only classes defined in header files are included. Does not have any effect
# for Java sources.
# The default value is: YES.
437 438 439

EXTRACT_LOCAL_CLASSES  = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
440 441 442 443 444
# This flag is only useful for Objective-C code. If set to YES, local methods,
# which are defined in the implementation section but not in the interface are
# included in the documentation. If set to NO, only methods in the interface are
# included.
# The default value is: NO.
445 446 447

EXTRACT_LOCAL_METHODS  = NO

448 449
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
450 451 452 453
# 'anonymous_namespace{file}', where file will be replaced with the base name of
# the file that contains the anonymous namespace. By default anonymous namespace
# are hidden.
# The default value is: NO.
Rémi Duraffort's avatar
Rémi Duraffort committed
454 455 456

EXTRACT_ANON_NSPACES   = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
457 458 459 460 461
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
# undocumented members inside documented classes or files. If set to NO these
# members will be included in the various overviews, but no documentation
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
462 463 464

HIDE_UNDOC_MEMBERS     = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
465 466 467 468 469
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy. If set
# to NO, these classes will be included in the various overviews. This option
# has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
470 471 472

HIDE_UNDOC_CLASSES     = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
473 474 475 476
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
# (class|struct|union) declarations. If set to NO, these declarations will be
# included in the documentation.
# The default value is: NO.
477

478
HIDE_FRIEND_COMPOUNDS  = NO
479

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
480 481 482 483
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
# documentation blocks found inside the body of a function. If set to NO, these
# blocks will be appended to the function's detailed documentation block.
# The default value is: NO.
484

485
HIDE_IN_BODY_DOCS      = NO
486

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
487 488 489 490
# The INTERNAL_DOCS tag determines if documentation that is typed after a
# \internal command is included. If the tag is set to NO then the documentation
# will be excluded. Set it to YES to include the internal documentation.
# The default value is: NO.
491 492 493

INTERNAL_DOCS          = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
494 495
# 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
496 497
# 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
498
# and Mac users are advised to set this option to NO.
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
499
# The default value is: system dependent.
500 501 502

CASE_SENSE_NAMES       = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
503 504 505 506
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
# their full class and namespace scopes in the documentation. If set to YES, the
# scope will be hidden.
# The default value is: NO.
507 508 509

HIDE_SCOPE_NAMES       = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
510 511 512 513 514 515 516 517 518 519
# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
# append additional text to a page's title, such as Class Reference. If set to
# YES the compound reference will be hidden.
# The default value is: NO.

HIDE_COMPOUND_REFERENCE= NO

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

521
SHOW_INCLUDE_FILES     = NO
522

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
523 524 525 526 527 528 529 530 531 532
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
# grouped member an include statement to the documentation, telling the reader
# which file to include in order to use the member.
# The default value is: NO.

SHOW_GROUPED_MEMB_INC  = NO

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

FORCE_LOCAL_INCLUDES   = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
536 537 538
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
# documentation for inline members.
# The default value is: YES.
539 540 541

INLINE_INFO            = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
542 543 544 545
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
# (detailed) documentation of file and class members alphabetically by member
# name. If set to NO, the members will appear in declaration order.
# The default value is: YES.
546 547 548

SORT_MEMBER_DOCS       = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
549 550 551 552 553
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
# descriptions of file, namespace and class members alphabetically by member
# name. If set to NO, the members will appear in declaration order. Note that
# this will also influence the order of the classes in the class list.
# The default value is: NO.
554

555
SORT_BRIEF_DOCS        = NO
556

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
557 558 559 560 561 562 563 564 565
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
# (brief and detailed) documentation of class members so that constructors and
# destructors are listed first. If set to NO the constructors will appear in the
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
# member documentation.
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
# detailed member documentation.
# The default value is: NO.
566 567 568

SORT_MEMBERS_CTORS_1ST = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
569 570 571 572
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
# of group names into alphabetical order. If set to NO the group names will
# appear in their defined order.
# The default value is: NO.
Rémi Duraffort's avatar
Rémi Duraffort committed
573 574 575

SORT_GROUP_NAMES       = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
576 577 578
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
# fully-qualified names, including namespaces. If set to NO, the class list will
# be sorted only by class name, not including the namespace part.
579
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
580 581 582
# Note: This option applies only to the class list, not to the alphabetical
# list.
# The default value is: NO.
583

584
SORT_BY_SCOPE_NAME     = NO
585

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
586 587 588 589 590 591 592 593 594 595 596 597 598
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
# type resolution of all parameters of a function it will reject a match between
# the prototype and the implementation of a member function even if there is
# only one candidate or it is obvious which candidate to choose by doing a
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
# accept a match between prototype and implementation in such cases.
# The default value is: NO.

STRICT_PROTO_MATCHING  = NO

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

GENERATE_TODOLIST      = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
602 603 604
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
# list. This list is created by putting \test commands in the documentation.
# The default value is: YES.
605 606 607

GENERATE_TESTLIST      = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
608 609 610
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
# list. This list is created by putting \bug commands in the documentation.
# The default value is: YES.
611 612 613

GENERATE_BUGLIST       = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
614 615 616 617
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
# the deprecated list. This list is created by putting \deprecated commands in
# the documentation.
# The default value is: YES.
618

619
GENERATE_DEPRECATEDLIST= YES
620

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
621 622 623
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
# ... \endcond blocks.
624

625
ENABLED_SECTIONS       =
626

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
627 628 629 630 631 632 633 634
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
# initial value of a variable or macro / define can have for it to appear in the
# documentation. If the initializer consists of more lines than specified here
# it will be hidden. Use a value of 0 to hide initializers completely. The
# appearance of the value of individual variables and macros / defines can be
# controlled using \showinitializer or \hideinitializer command in the
# documentation regardless of this setting.
# Minimum value: 0, maximum value: 10000, default value: 30.
635 636 637

MAX_INITIALIZER_LINES  = 30

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
638 639
# 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
640
# list will mention the files that were used to generate the documentation.
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
641
# The default value is: YES.
642 643 644

SHOW_USED_FILES        = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
645 646 647 648
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
# will remove the Files entry from the Quick Index and from the Folder Tree View
# (if specified).
# The default value is: YES.
Rémi Duraffort's avatar
Rémi Duraffort committed
649 650 651

SHOW_FILES             = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
652 653 654 655
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
# page. This will remove the Namespaces entry from the Quick Index and from the
# Folder Tree View (if specified).
# The default value is: YES.
Rémi Duraffort's avatar
Rémi Duraffort committed
656 657 658

SHOW_NAMESPACES        = YES

659 660 661
# 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
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
662 663 664 665
# popen()) the command command input-file, where command is the value of the
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
# by doxygen. Whatever the program writes to standard output is used as the file
# version. For an example see the documentation.
666

667 668
FILE_VERSION_FILTER    =

669 670
# 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
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
671 672 673 674 675 676 677 678
# output files in an output format independent way. To create the layout file
# that represents doxygen's defaults, run doxygen with the -l option. You can
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
# will be used as the name of the layout file.
#
# Note that if you run doxygen from a directory containing a file called
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.
679 680

LAYOUT_FILE            =
681

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
682 683 684 685 686 687 688 689 690 691
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
# extension is automatically appended if omitted. This requires the bibtex tool
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
# For LaTeX the style of the bibliography can be controlled using
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
# search path. See also \cite for info how to create references.

CITE_BIB_FILES         =

692
#---------------------------------------------------------------------------
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
693
# Configuration options related to warning and progress messages
694 695
#---------------------------------------------------------------------------

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
696 697 698 699
# The QUIET tag can be used to turn on/off the messages that are generated to
# standard output by doxygen. If QUIET is set to YES this implies that the
# messages are off.
# The default value is: NO.
700 701 702

QUIET                  = NO

703
# The WARNINGS tag can be used to turn on/off the warning messages that are
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
704 705 706 707 708
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
# this implies that the warnings are on.
#
# Tip: Turn warnings on while writing the documentation.
# The default value is: YES.
709 710 711

WARNINGS               = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
712 713 714 715
# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
# will automatically be disabled.
# The default value is: YES.
716 717 718

WARN_IF_UNDOCUMENTED   = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
719 720 721 722 723
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some parameters
# in a documented function, or documenting parameters that don't exist or using
# markup commands wrongly.
# The default value is: YES.
724 725 726

WARN_IF_DOC_ERROR      = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
727 728 729 730 731
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
# are documented, but have no documentation for their parameters or return
# value. If set to NO, doxygen will only warn about wrong or incomplete
# parameter documentation, but not about the absence of documentation.
# The default value is: NO.
732 733 734

WARN_NO_PARAMDOC       = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
735 736 737 738 739 740 741
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
# can produce. The string should contain the $file, $line, and $text tags, which
# will be replaced by the file and line number from which the warning originated
# and the warning text. Optionally the format may contain $version, which will
# be replaced by the version of the file (if it could be obtained via
# FILE_VERSION_FILTER)
# The default value is: $file:$line: $text.
742 743 744

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

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
745 746 747
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
# messages should be written. If left blank the output is written to standard
# error (stderr).
748

749
WARN_LOGFILE           =
750 751

#---------------------------------------------------------------------------
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
752
# Configuration options related to the input files
753 754
#---------------------------------------------------------------------------

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
755 756 757 758 759
# The INPUT tag is used to specify the files and/or directories that contain
# documented source files. You may enter file names like myfile.cpp or
# directories like /usr/src/myproject. Separate the files or directories with
# spaces.
# Note: If this tag is empty the current directory is searched.
760

761
INPUT                  = @top_srcdir@/src \
762
                         @top_srcdir@/include \
763
                         @top_srcdir@/doc/standalone \
764
                         @top_srcdir@/modules/access/http
765

766
# This tag can be used to specify the character encoding of the source files
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
767 768 769 770 771
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
# documentation (see: http://www.gnu.org/software/libiconv) for the list of
# possible encodings.
# The default value is: UTF-8.
Rémi Duraffort's avatar
Rémi Duraffort committed
772 773 774

INPUT_ENCODING         = UTF-8

775
# If the value of the INPUT tag contains directories, you can use the
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
776 777 778 779 780 781 782
# FILE_PATTERNS tag to specify one or more wildcard patterns (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++, *.java, *.ii,
# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
# *.qsf, *.as and *.js.
783

784
FILE_PATTERNS          =
785

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
786 787 788
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# The default value is: NO.
789 790 791

RECURSIVE              = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
792
# The EXCLUDE tag can be used to specify files and/or directories that should be
793
# excluded from the INPUT source files. This way you can easily exclude a
794
# subdirectory from a directory tree whose root is specified with the INPUT tag.
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
795 796 797
#
# Note that relative paths are relative to the directory from which doxygen is
# run.
798

799
EXCLUDE                = @top_srcdir@/src/extras
800

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
801 802
# 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
803
# from the input.
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
804
# The default value is: NO.
805 806 807

EXCLUDE_SYMLINKS       = NO

808 809
# 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
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
810 811 812 813
# certain files from those directories.
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/*
814

815
EXCLUDE_PATTERNS       = */test/* *_test.c
816

817 818 819 820
# 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,
Rémi Duraffort's avatar
Rémi Duraffort committed
821
# AClass::ANamespace, ANamespace::*Test
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
822 823 824
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories use the pattern */test/*
Rémi Duraffort's avatar
Rémi Duraffort committed
825

826
EXCLUDE_SYMBOLS        =
Rémi Duraffort's avatar
Rémi Duraffort committed
827

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
828 829 830
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
# that contain example code fragments that are included (see the \include
# command).
831

832
EXAMPLE_PATH           =
833

834
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
835 836 837
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
# *.h) to filter out the source-files in the directories. If left blank all
# files are included.
838

839
EXAMPLE_PATTERNS       =
840

841
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
842 843 844
# searched for input files to be used with the \include or \dontinclude commands
# irrespective of the value of the RECURSIVE tag.
# The default value is: NO.
845 846 847

EXAMPLE_RECURSIVE      = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
848 849 850
# The IMAGE_PATH tag can be used to specify one or more files or directories
# that contain images that are to be included in the documentation (see the
# \image command).
851

852
IMAGE_PATH             =
853

854 855
# 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
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
856 857 858 859 860 861 862 863 864 865 866 867
# by executing (via popen()) the command:
#
# <filter> <input-file>
#
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
# name of an input file. Doxygen will then use the output that the filter
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
# will be ignored.
#
# Note that the filter must not add or remove lines; it is applied before the
# code is scanned, but not when the output code is generated. If lines are added
# or removed, the anchors will not be placed correctly.
868

869
INPUT_FILTER           = "@top_srcdir@/doc/doc_helper.sh"
870

871
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
872 873 874 875 876
# basis. Doxygen will compare the file name with each pattern and apply the
# filter if there is a match. The filters are a list of the form: pattern=filter
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
# patterns match the file name, INPUT_FILTER is applied.
877

878
FILTER_PATTERNS        =
879

880
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
881 882 883
# INPUT_FILTER) will also be used to filter the input files that are used for
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
# The default value is: NO.
884 885 886

FILTER_SOURCE_FILES    = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
# it is also possible to disable source filtering for a specific pattern using
# *.ext= (so without naming a filter).
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.

FILTER_SOURCE_PATTERNS =

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

USE_MDFILE_AS_MAINPAGE =

902
#---------------------------------------------------------------------------
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
903
# Configuration options related to source browsing
904 905
#---------------------------------------------------------------------------

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
906 907 908 909 910 911
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
# generated. Documented entities will be cross-referenced with these sources.
#
# Note: To get rid of all source code in the generated output, make sure that
# also VERBATIM_HEADERS is set to NO.
# The default value is: NO.
912 913 914

SOURCE_BROWSER         = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
915 916 917
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
# classes and enums directly into the documentation.
# The default value is: NO.
918 919 920

INLINE_SOURCES         = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
921 922 923 924
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
# special comment blocks from generated source code fragments. Normal C, C++ and
# Fortran comments will always remain visible.
# The default value is: YES.
925 926 927

STRIP_CODE_COMMENTS    = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
928 929 930
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
# function all documented functions referencing it will be listed.
# The default value is: NO.
931 932 933

REFERENCED_BY_RELATION = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
934 935 936
# If the REFERENCES_RELATION tag is set to YES then for each documented function
# all documented entities called/used by that function will be listed.
# The default value is: NO.
937 938 939

REFERENCES_RELATION    = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
940 941 942 943 944
# If the REFERENCES_LINK_SOURCE tag is set to YES 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.
# The default value is: YES.
Rémi Duraffort's avatar
Rémi Duraffort committed
945 946 947

REFERENCES_LINK_SOURCE = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
# source code will show a tooltip with additional information such as prototype,
# brief description and links to the definition and documentation. Since this
# will make the HTML file larger and loading of large files a bit slower, you
# can opt to disable this feature.
# The default value is: YES.
# This tag requires that the tag SOURCE_BROWSER is set to YES.

SOURCE_TOOLTIPS        = YES

# 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 will need version
# 4.8.6 or higher.
#
# To use it do the following:
# - Install the latest version of global
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
# - Make sure the INPUT points to the root of the source tree
# - Run doxygen as normal
#
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
# tools must be available from the command line (i.e. in the search path).
#
# The result: instead of the source browser generated by doxygen, the links to
# source code will now point to the output of htags.
# The default value is: NO.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
Rémi Duraffort's avatar
Rémi Duraffort committed
977 978 979

USE_HTAGS              = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
980 981 982 983 984
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
# verbatim copy of the header file for each class for which an include is
# specified. Set to NO to disable this.
# See also: Section \class.
# The default value is: YES.
985 986 987

VERBATIM_HEADERS       = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
# cost of reduced performance. This can be particularly helpful with template
# rich C++ code for which doxygen's built-in parser lacks the necessary type
# information.
# Note: The availability of this option depends on whether or not doxygen was
# compiled with the --with-libclang option.
# The default value is: NO.

CLANG_ASSISTED_PARSING = NO

# If clang assisted parsing is enabled you can provide the compiler with command
# line options that you would normally use when invoking the compiler. Note that
# the include paths will already be set by doxygen for the files and directories
# specified with INPUT and INCLUDE_PATH.
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.

CLANG_OPTIONS          =

1007
#---------------------------------------------------------------------------
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1008
# Configuration options related to the alphabetical class index
1009 1010
#---------------------------------------------------------------------------

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1011 1012 1013 1014
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
# compounds will be generated. Enable this if the project contains a lot of
# classes, structs, unions or interfaces.
# The default value is: YES.
1015 1016 1017

ALPHABETICAL_INDEX     = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1018 1019 1020 1021
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
# which the alphabetical index list will be split.
# Minimum value: 1, maximum value: 20, default value: 5.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1022 1023 1024

COLS_IN_ALPHA_INDEX    = 5

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1025 1026 1027 1028 1029
# 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 a prefix (or a list of prefixes) that should be ignored
# while generating the index headers.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1030

1031
IGNORE_PREFIX          =
1032 1033

#---------------------------------------------------------------------------
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1034
# Configuration options related to the HTML output
1035 1036
#---------------------------------------------------------------------------

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1037 1038
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
# The default value is: YES.
1039 1040 1041

GENERATE_HTML          = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1042 1043 1044 1045 1046
# 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 put in front of
# it.
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
1047 1048 1049

HTML_OUTPUT            = html

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1050 1051 1052 1053
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).
# The default value is: .html.
# This tag requires that the tag GENERATE_HTML is set to YES.
1054 1055 1056

HTML_FILE_EXTENSION    = .html

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1057 1058
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
# each generated HTML page. If the tag is left blank doxygen will generate a
1059
# standard header.
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
#
# To get valid HTML the header file that includes any scripts and style sheets
# that doxygen needs, which is dependent on the configuration options used (e.g.
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
# default header using
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
# YourConfigFile
# and then modify the file new_header.html. See also section "Doxygen usage"
# for information on how to generate the default header that doxygen normally
# uses.
# Note: The header is subject to change so you typically have to regenerate the
# default header when upgrading to a newer version of doxygen. For a description
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
1074

1075
HTML_HEADER            =
1076

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1077 1078 1079 1080 1081 1082 1083
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
# footer. See HTML_HEADER for more information on how to generate a default
# footer and what special commands can be used inside the footer. See also
# section "Doxygen usage" for information on how to generate the default footer
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
1084

1085
HTML_FOOTER            =
1086

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1087 1088 1089 1090 1091 1092 1093 1094 1095
# 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 left blank doxygen will generate a default style sheet.
# See also section "Doxygen usage" for information on how to generate the style
# sheet that doxygen normally uses.
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
1096

1097 1098
HTML_STYLESHEET        =

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# cascading style sheets that are included after the standard style sheets
# created by doxygen. Using this option one can overrule certain style aspects.
# This is preferred over using HTML_STYLESHEET since it does not replace the
# standard style sheet and is therefore more robust against future updates.
# Doxygen will copy the style sheet files to the output directory.
# Note: The order of the extra style sheet files is of importance (e.g. the last
# style sheet in the list overrules the setting of the previous ones in the
# list). For an example see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_STYLESHEET  =

# 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 the
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_FILES       =

# 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.
# Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES.
1130 1131 1132

HTML_COLORSTYLE_HUE    = 220

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1133 1134 1135 1136 1137
# 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 grayscales only. A
# value of 255 will produce the most vivid colors.
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
1138 1139 1140

HTML_COLORSTYLE_SAT    = 100

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1141 1142 1143 1144 1145 1146 1147 1148
# 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, and 100 does not
# change the gamma.
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.
1149 1150 1151

HTML_COLORSTYLE_GAMMA  = 80

1152
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1153 1154 1155 1156 1157
# page will contain the date and time when the page was generated. Setting this
# to YES can help to show when doxygen was last run and thus if the
# documentation is up to date.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
1158 1159

HTML_TIMESTAMP         = NO
1160

1161 1162
# 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
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1163 1164 1165
# page has loaded.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
1166

1167
HTML_DYNAMIC_SECTIONS  = NO
1168

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
# shown in the various tree structured indices initially; the user can expand
# and collapse entries dynamically later on. Doxygen will expand the tree to
# such a level that at most the specified number of entries are visible (unless
# a fully collapsed tree already exceeds this amount). So setting the number of
# entries 1 will produce a full collapsed tree by default. 0 is a special value
# representing an infinite number of entries and will result in a full expanded
# tree by default.
# Minimum value: 0, maximum value: 9999, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_INDEX_NUM_ENTRIES = 100

# 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 (see: http://developer.apple.com/tools/xcode/), 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
1190
# for more information.
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1191 1192
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
Rémi Duraffort's avatar
Rémi Duraffort committed
1193 1194 1195

GENERATE_DOCSET        = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1196 1197 1198 1199 1200
# This tag determines the name of the docset feed. A documentation feed provides
# an umbrella under which multiple documentation sets from a single provider
# (such as a company or product suite) can be grouped.
# The default value is: Doxygen generated docs.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
Rémi Duraffort's avatar
Rémi Duraffort committed
1201

1202
DOCSET_FEEDNAME        = "VideoLAN developer docs"
Rémi Duraffort's avatar
Rémi Duraffort committed
1203

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1204 1205 1206 1207 1208
# 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 will append .docset to the name.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
Rémi Duraffort's avatar
Rémi Duraffort committed
1209 1210 1211

DOCSET_BUNDLE_ID       = org.videolan.vlc

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1212
# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1213 1214
# the documentation publisher. This should be a reverse domain-name style
# string, e.g. com.mycompany.MyDocSet.documentation.
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1215 1216
# The default value is: org.doxygen.Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1217 1218 1219

DOCSET_PUBLISHER_ID    = org.videolan

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1220 1221 1222
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
# The default value is: Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1223 1224 1225

DOCSET_PUBLISHER_NAME  = VideoLAN

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
# Windows.
#
# The HTML Help Workshop contains a compiler that can convert all HTML output
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
# files are now used as the Windows 98 help format, and will replace the old
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
# HTML files also contain an index, a table of contents, and you can search for
# words in the documentation. The HTML workshop also contains a viewer for
# compressed HTML files.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
Rémi Duraffort's avatar
Rémi Duraffort committed
1241

1242
GENERATE_HTMLHELP      = NO
Rémi Duraffort's avatar
Rémi Duraffort committed
1243

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1244 1245
# 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
1246
# written to the html output directory.
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1247
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1248

1249
CHM_FILE               =
1250

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1251 1252 1253 1254 1255
# 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 the HTML help compiler on the generated index.hhp.
# The file has to be specified with full path.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1256

1257
HHC_LOCATION           =
1258

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1259 1260 1261 1262
# The GENERATE_CHI flag controls if a separate .chi index file is generated
# (YES) or that it should be included in the master .chm file (NO).
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1263 1264 1265

GENERATE_CHI           = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1266 1267 1268
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
# and project file content.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
Rémi Duraffort's avatar
Rémi Duraffort committed
1269

1270
CHM_INDEX_ENCODING     =
Rémi Duraffort's avatar
Rémi Duraffort committed
1271

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1272 1273 1274 1275 1276
# The BINARY_TOC flag controls whether a binary table of contents is generated
# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
# enables the Previous and Next buttons.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1277 1278 1279

BINARY_TOC             = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1280 1281 1282 1283
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
# the table of contents of the HTML help documentation and to the tree view.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1284 1285 1286

TOC_EXPAND             = NO

1287
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1288 1289 1290 1291 1292
# 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 Qt Compressed Help
# (.qch) of the generated HTML documentation.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
1293 1294 1295

GENERATE_QHP           = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1296 1297 1298 1299
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
# the file name of the resulting .qch file. The path specified is relative to
# the HTML output folder.
# This tag requires that the tag GENERATE_QHP is set to YES.
1300 1301 1302

QCH_FILE               =

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1303 1304 1305 1306 1307
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
# Project output. For more information please see Qt Help Project / Namespace
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_QHP is set to YES.
1308 1309 1310

QHP_NAMESPACE          = org.doxygen.Project

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1311 1312 1313 1314 1315 1316
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
# Help Project output. For more information please see Qt Help Project / Virtual
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
# folders).
# The default value is: doc.
# This tag requires that the tag GENERATE_QHP is set to YES.
1317 1318 1319

QHP_VIRTUAL_FOLDER     = doc

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1320 1321 1322 1323 1324
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
# filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
1325 1326 1327

QHP_CUST_FILTER_NAME   =

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1328 1329 1330 1331 1332
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
# custom filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
1333 1334 1335

QHP_CUST_FILTER_ATTRS  =

1336
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1337 1338 1339
# project's filter section matches. Qt Help Project / Filter Attributes (see:
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
# This tag requires that the tag GENERATE_QHP is set to YES.
1340 1341 1342

QHP_SECT_FILTER_ATTRS  =

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1343 1344 1345 1346
# 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 .qhp file.
# This tag requires that the tag GENERATE_QHP is set to YES.
1347 1348 1349

QHG_LOCATION           =

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1350 1351 1352 1353 1354 1355 1356 1357 1358
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
# generated, together with the HTML files, they 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 the help appears.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
1359 1360 1361

GENERATE_ECLIPSEHELP   = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1362 1363 1364 1365 1366
# A unique identifier for the Eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have this
# name. Each documentation set should have its own identifier.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1367 1368 1369

ECLIPSE_DOC_ID         = org.doxygen.Project

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1370 1371 1372 1373 1374 1375 1376 1377
# If you want full control over the layout of the generated HTML pages it might
# be necessary to disable the index and replace it with your own. The
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
# of each HTML page. A value of NO enables the index and the value YES disables
# it. Since the tabs in the index contain the same information as the navigation
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
1378 1379 1380

DISABLE_INDEX          = NO

Rémi Duraffort's avatar
Rémi Duraffort committed
1381
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
# 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. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
# further fine-tune the look of the index. As an example, the default style
# sheet generated by doxygen has an example that shows how to put an image at
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
# the same information as the tab index, you could consider setting
# DISABLE_INDEX to YES when enabling this option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
1395 1396 1397

GENERATE_TREEVIEW      = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1398 1399 1400 1401 1402 1403 1404
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
# doxygen will group on one line in the generated HTML documentation.
#
# Note that a value of 0 will completely suppress the enum values from appearing
# in the overview section.
# Minimum value: 0, maximum value: 20, default value: 4.
# This tag requires that the tag GENERATE_HTML is set to YES.
1405

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1406
ENUM_VALUES_PER_LINE   = 4
1407

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1408 1409 1410 1411
# 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 is shown.
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.
1412 1413 1414

TREEVIEW_WIDTH         = 250

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1415 1416 1417 1418
# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
# external symbols imported via tag files in a separate window.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
1419 1420 1421

EXT_LINKS_IN_WINDOW    = NO

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1422 1423 1424 1425 1426 1427
# Use this tag to change the font size of LaTeX formulas included as images in
# the HTML documentation. 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 to force them to be regenerated.
# Minimum value: 8, maximum value: 50, default value: 10.
# This tag requires that the tag GENERATE_HTML is set to YES.
Rémi Duraffort's avatar
Rémi Duraffort committed
1428 1429 1430

FORMULA_FONTSIZE       = 10

1431
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1432 1433 1434 1435 1436 1437 1438
# 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 in
# the HTML output directory before the changes have effect.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
1439 1440 1441

FORMULA_TRANSPARENT    = YES

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
# http://www.mathjax.org) which uses client side Javascript for the rendering</