17

# This tag specifies the encoding used for all characters in the config file that

    18

# follow. The default is UTF-8 which is also the encoding used for all text before

    19

# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into

    20

# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of

    25

# The PROJECT_NAME tag is a single word (or a sequence of words surrounded

    30

# The PROJECT_NUMBER tag can be used to enter a project or revision number.

    31

# This could be handy for archiving the generated documentation or

    36

# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)

    37

# base path where the generated documentation will be put.

    38

# If a relative path is entered, it will be relative to the location

    43

# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create

    44

# 4096 sub-directories (in 2 levels) under the output directory of each output

    45

# format and will distribute the generated files over these directories.

    46

# Enabling this option can be useful when feeding doxygen a huge amount of

    47

# source files, where putting all generated files in the same directory would

    52

# The OUTPUT_LANGUAGE tag is used to specify the language in which all

    53

# documentation generated by doxygen is written. Doxygen will use this

    54

# information to generate all constant output in the proper language.

    55

# The default language is English, other supported languages are:

    56

# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,

    57

# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,

    58

# Italian, Japanese, Japanese-en (Japanese with English messages), Korean,

    59

# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,

    64

# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will

    65

# include brief member descriptions after the members that are listed in

    66

# the file and class documentation (similar to JavaDoc).

    71

# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend

    72

# the brief description of a member or function before the detailed description.

    73

# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the

    78

# This tag implements a quasi-intelligent brief description abbreviator

    79

# that is used to form the text in various listings. Each string

    80

# in this list, if found as the leading text of the brief description, will be

    81

# stripped from the text and the result after processing the whole list, is

    82

# used as the annotated text. Otherwise, the brief description is used as-is.

    83

# If left blank, the following values are used ("$name" is automatically

    84

# replaced with the name of the entity): "The $name class" "The $name widget"

    85

# "The $name file" "is" "provides" "specifies" "contains"

    88

ABBREVIATE_BRIEF       =

    89

    90

# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then

    91

# Doxygen will generate a detailed section even if there is only a brief

    96

# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all

    97

# inherited members of a class in the documentation of that class as if those

    98

# members were ordinary class members. Constructors, destructors and assignment

   103

# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full

   104

# path before files name in the file list and in the header files. If set

   109

# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag

   110

# can be used to strip a user-defined part of the path. Stripping is

   111

# only done if one of the specified strings matches the left-hand part of

   112

# the path. The tag can be used to show relative paths in the file list.

   113

# If left blank the directory from which doxygen is run is used as the

   116

STRIP_FROM_PATH        =

   117

   118

# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of

   119

# the path mentioned in the documentation of a class, which tells

   120

# the reader which header file to include in order to use a class.

   121

# If left blank only the name of the header file containing the class

   122

# definition is used. Otherwise one should specify the include paths that

   125

STRIP_FROM_INC_PATH    =

   126

   127

# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter

   128

# (but less readable) file names. This can be useful is your file systems

   133

# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen

   134

# will interpret the first line (until the first dot) of a JavaDoc-style

   135

# comment as the brief description. If set to NO, the JavaDoc

   136

# comments will behave just like regular Qt-style comments

   141

# If the QT_AUTOBRIEF tag is set to YES then Doxygen will

   142

# interpret the first line (until the first dot) of a Qt-style

   143

# comment as the brief description. If set to NO, the comments

   144

# will behave just like regular Qt-style comments (thus requiring

   149

# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen

   150

# treat a multi-line C++ special comment block (i.e. a block of //! or ///

   151

# comments) as a brief description. This used to be the default behaviour.

   152

# The new default is to treat a multi-line C++ comment block as a detailed

   157

# If the DETAILS_AT_TOP tag is set to YES then Doxygen

   159

# If set to NO, the detailed description appears after the member

   164

# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented

   165

# member inherits the documentation from any documented member that it

   170

# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce

   171

# a new page for each member. If set to NO, the documentation of a member will

   176

# The TAB_SIZE tag can be used to set the number of spaces in a tab.

   181

# This tag can be used to specify a number of aliases that acts

   182

# as commands in the documentation. An alias has the form "name=value".

   183

# For example adding "sideeffect=\par Side Effects:\n" will allow you to

   184

# put the command \sideeffect (or @sideeffect) in the documentation, which

   185

# will result in a user-defined paragraph with heading "Side Effects:".

   188

ALIASES                =

   189

   190

# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C

   191

# sources only. Doxygen will then generate output that is more tailored for C.

   192

# For instance, some of the names that are used will be different. The list

   197

# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java

   198

# sources only. Doxygen will then generate output that is more tailored for Java.

   199

# For instance, namespaces will be presented as packages, qualified scopes

   204

# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to

   205

# include (a tag file for) the STL sources as input, then you should

   206

# set this tag to YES in order to let doxygen match functions declarations and

   207

# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.

   208

# func(std::string) {}). This also make the inheritance and collaboration

   218

# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC

   219

# tag is set to YES, then doxygen will reuse the documentation of the first

   220

# member in the group (if any) for the other members of the group. By default

   225

# Set the SUBGROUPING tag to YES (the default) to allow class member groups of

   226

# the same type (for instance a group of public functions) to be put as a

   227

# subgroup of that type (e.g. under the Public Functions section). Set it to

   228

# NO to prevent subgrouping. Alternatively, this can be done per class using

   237

# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in

   238

# documentation are documented, even if no documentation was available.

   239

# Private class members and static file members will be hidden unless

   244

# If the EXTRACT_PRIVATE tag is set to YES all private members of a class

   249

# If the EXTRACT_STATIC tag is set to YES all static members of a file

   254

# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)

   255

# defined locally in source files will be included in the documentation.

   260

# This flag is only useful for Objective-C code. When set to YES local

   261

# methods, which are defined in the implementation section but not in

   262

# the interface are included in the documentation.

   267

# If this flag is set to YES, the members of anonymous namespaces will be extracted

   268

# and appear in the documentation as a namespace called 'anonymous_namespace{file}',

   269

# where file will be replaced with the base name of the file that contains the anonymous

   274

# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all

   275

# undocumented members of documented classes, files or namespaces.

   276

# If set to NO (the default) these members will be included in the

   277

# various overviews, but no documentation section is generated.

   282

# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all

   283

# undocumented classes that are normally visible in the class hierarchy.

   284

# If set to NO (the default) these classes will be included in the various

   289

# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all

   290

# friend (class|struct|union) declarations.

   291

# If set to NO (the default) these declarations will be included in the

   296

# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any

   297

# documentation blocks found inside the body of a function.

   298

# If set to NO (the default) these blocks will be appended to the

   303

# The INTERNAL_DOCS tag determines if documentation

   304

# that is typed after a \internal command is included. If the tag is set

   305

# to NO (the default) then the documentation will be excluded.

   310

# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate

   311

# file names in lower-case letters. If set to YES upper-case letters are also

   312

# allowed. This is useful if you have classes or files whose names only differ

   313

# in case and if your file system supports case sensitive file names. Windows

   318

# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen

   319

# will show members with their full class and namespace scopes in the

   324

# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen

   325

# will put a list of the files that are included by a file in the documentation

   330

# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]

   335

# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen

   336

# will sort the (detailed) documentation of file and class members

   337

# alphabetically by member name. If set to NO the members will appear in

   342

# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the

   343

# brief documentation of file, namespace and class members alphabetically

   344

# by member name. If set to NO (the default) the members will appear in

   349

# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be

   350

# sorted by fully-qualified names, including namespaces. If set to

   351

# NO (the default), the class list will be sorted only by class name,

   352

# not including the namespace part.

   354

# Note: This option applies only to the class list, not to the

   359

# The GENERATE_TODOLIST tag can be used to enable (YES) or

   360

# disable (NO) the todo list. This list is created by putting \todo

   365

# The GENERATE_TESTLIST tag can be used to enable (YES) or

   366

# disable (NO) the test list. This list is created by putting \test

   371

# The GENERATE_BUGLIST tag can be used to enable (YES) or

   372

# disable (NO) the bug list. This list is created by putting \bug

   377

# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or

   378

# disable (NO) the deprecated list. This list is created by putting

   383

# The ENABLED_SECTIONS tag can be used to enable conditional

   386

ENABLED_SECTIONS       =

   387

   388

# The MAX_INITIALIZER_LINES tag determines the maximum number of lines

   389

# the initial value of a variable or define consists of for it to appear in

   390

# the documentation. If the initializer consists of more lines than specified

   391

# here it will be hidden. Use a value of 0 to hide initializers completely.

   392

# The appearance of the initializer of individual variables and defines in the

   393

# documentation can be controlled using \showinitializer or \hideinitializer

   398

# Set the SHOW_USED_FILES tag to NO to disable the list of files generated

   399

# at the bottom of the documentation of classes and structs. If set to YES the

   404

# If the sources in your project are distributed over multiple directories

   405

# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy

   410

# The FILE_VERSION_FILTER tag can be used to specify a program or script that

   411

# doxygen should invoke to get the current version for each file (typically from the

   412

# version control system). Doxygen will invoke the program by executing (via

   413

# popen()) the command <command> <input-file>, where <command> is the value of

   414

# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file

   415

# provided by doxygen. Whatever the program writes to standard output

   418

FILE_VERSION_FILTER    =

   424

# The QUIET tag can be used to turn on/off the messages that are generated

   429

# The WARNINGS tag can be used to turn on/off the warning messages that are

   430

# generated by doxygen. Possible values are YES and NO. If left blank

   435

# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings

   436

# for undocumented members. If EXTRACT_ALL is set to YES then this flag will

   441

# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for

   442

# potential errors in the documentation, such as not documenting some

   443

# parameters in a documented function, or documenting parameters that

   448

# This WARN_NO_PARAMDOC option can be abled to get warnings for

   449

# functions that are documented, but have no documentation for their parameters

   450

# or return value. If set to NO (the default) doxygen will only warn about

   451

# wrong or incomplete parameter documentation, but not about the absence of

   456

# The WARN_FORMAT tag determines the format of the warning messages that

   457

# doxygen can produce. The string should contain the $file, $line, and $text

   458

# tags, which will be replaced by the file and line number from which the

   459

# warning originated and the warning text. Optionally the format may contain

   460

# $version, which will be replaced by the version of the file (if it could

   465

# The WARN_LOGFILE tag can be used to specify a file to which warning

   466

# and error messages should be written. If left blank the output is written

   469

WARN_LOGFILE           =

   475

# The INPUT tag can be used to specify the files and/or directories that contain

   476

# documented source files. You may enter file names like "myfile.cpp" or

   477

# directories like "/usr/src/myproject". Separate the files or directories

   484

# This tag can be used to specify the character encoding of the source files that

   485

# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default

   486

# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.

   491

# If the value of the INPUT tag contains directories, you can use the

   492

# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp

   493

# and *.h) to filter out the source-files in the directories. If left