1

#---------------------------------------------------------------------------

     2

#

     4

#

     6

#

     8

#

     9

#---------------------------------------------------------------------------

    10

    11

# This file describes the settings to be used by the documentation system

    12

# doxygen (www.doxygen.org) for a project

    13

#

    14

# All text after a hash (#) is considered a comment and will be ignored

    15

# The format is:

    16

#       TAG = value [value, ...]

    17

# For lists items can also be appended using:

    18

#       TAG += value [value, ...]

    19

# Values that contain spaces should be placed between quotes (" ")

    20

    21

#---------------------------------------------------------------------------

    22

# Project related configuration options

    23

#---------------------------------------------------------------------------

    24

    25

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

    26

# by quotes) that should identify the project.

    27

    29

    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

    32

# if some version control system is used.

    33

    34

PROJECT_NUMBER         = 1.0

    35

    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

    39

# where doxygen was started. If left blank the current directory will be used.

    40

    42

    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

    48

# otherwise cause performance problems for the file system.

    49

    50

CREATE_SUBDIRS         = NO

    51

    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

# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,

    57

# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,

    58

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

    59

# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,

    60

# Swedish, and Ukrainian.

    61

    63

    64

# This tag can be used to specify the encoding used in the generated output.

    65

# The encoding is not always determined by the language that is chosen,

    66

# but also whether or not the output is meant for Windows or non-Windows users.

    67

# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES

    68

# forces the Windows encoding (this is the default for the Windows binary),

    69

# whereas setting the tag to NO uses a Unix-style encoding (the default for

    70

# all platforms other than Windows).

    71

    72

USE_WINDOWS_ENCODING   = NO

    73

    74

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

    75

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

    76

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

    77

# Set to NO to disable this.

    78

    79

BRIEF_MEMBER_DESC      = YES

    80

    81

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

    82

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

    83

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

    84

# brief descriptions will be completely suppressed.

    85

    86

REPEAT_BRIEF           = YES

    87

    88

# This tag implements a quasi-intelligent brief description abbreviator

    89

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

    90

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

    91

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

    92

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

    93

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

    94

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

    95

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

    96

# "represents" "a" "an" "the"

    97

    98

ABBREVIATE_BRIEF       =

    99

   100

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

   101

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

   102

# description.

   103

   104

ALWAYS_DETAILED_SEC    = NO

   105

   106

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

   107

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

   108

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

   109

# operators of the base classes will not be shown.

   110

   111

INLINE_INHERITED_MEMB  = NO

   112

   113

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

   114

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

   115

# to NO the shortest path that makes the file name unique will be used.

   116

   117

FULL_PATH_NAMES        = NO

   118

   119

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

   120

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

   121

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

   122

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

   123

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

   124

# path to strip.

   125

   126

STRIP_FROM_PATH        =

   127

   128

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

   129

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

   130

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

   131

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

   132

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

   133

# are normally passed to the compiler using the -I flag.

   134

   135

STRIP_FROM_INC_PATH    =

   136

   137

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

   138

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

   139

# doesn't support long names like on DOS, Mac, or CD-ROM.

   140

   141

SHORT_NAMES            = NO

   142

   143

# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen

   144

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

   145

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

   146

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

   147

# explicit @brief command for a brief description.

   148

   149

JAVADOC_AUTOBRIEF      = YES

   150

   151

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

   152

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

   153

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

   154

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

   155

# description. Set this tag to YES if you prefer the old behaviour instead.

   156

   157

MULTILINE_CPP_IS_BRIEF = YES

   158

   159

# If the DETAILS_AT_TOP tag is set to YES then Doxygen

   160

# will output the detailed description near the top, like JavaDoc.

   161

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

   162

# documentation.

   163

   164

DETAILS_AT_TOP         = YES

   165

   166

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

   167

# member inherits the documentation from any documented member that it

   168

# re-implements.

   169

   170

INHERIT_DOCS           = YES

   171

   172

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

   173

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

   174

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

   175

# all members of a group must be documented explicitly.

   176

   177

DISTRIBUTE_GROUP_DOC   = NO

   178

   179

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

   180

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

   181

# be part of the file/class/namespace that contains it.

   182

   183

SEPARATE_MEMBER_PAGES  = NO

   184

   185

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

   186

# Doxygen uses this value to replace tabs by spaces in code fragments.

   187

   189

   190

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

   191

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

   192

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

   193

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

   194

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

   195

# You can put \n's in the value part of an alias to insert newlines.

   196

   197

ALIASES                =

   198

   199

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

   200

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

   201

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

   202

# of all members will be omitted, etc.

   203

   204

OPTIMIZE_OUTPUT_FOR_C  = YES

   205

   206

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

   207

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

   208

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

   209

# will look different, etc.

   210

   211

OPTIMIZE_OUTPUT_JAVA   = NO

   212

   213

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

   214

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

   215

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

   216

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

   217

# the \nosubgrouping command.

   218

   219

SUBGROUPING            = YES

   220

   221

#---------------------------------------------------------------------------

   222

# Build related configuration options

   223

#---------------------------------------------------------------------------

   224

   225

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

   226

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

   227

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

   228

# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

   229

   231

   232

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

   233

# will be included in the documentation.

   234

   235

EXTRACT_PRIVATE        = YES

   236

   237

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

   238

# will be included in the documentation.

   239

   240

EXTRACT_STATIC         = YES

   241

   242

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

   243

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

   244

# If set to NO only classes defined in header files are included.

   245

   246

EXTRACT_LOCAL_CLASSES  = YES

   247

   248

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

   249

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

   250

# the interface are included in the documentation.

   251

# If set to NO (the default) only methods in the interface are included.

   252

   253

EXTRACT_LOCAL_METHODS  = YES

   254

   255

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

   256

# undocumented members of documented classes, files or namespaces.

   257

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

   258

# various overviews, but no documentation section is generated.

   259

# This option has no effect if EXTRACT_ALL is enabled.

   260

   262

   263

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

   264

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

   265

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

   266

# overviews. This option has no effect if EXTRACT_ALL is enabled.

   267

   269

   270

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

   271

# friend (class|struct|union) declarations.

   272

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

   273

# documentation.

   274

   275

HIDE_FRIEND_COMPOUNDS  = NO

   276

   277

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

   278

# documentation blocks found inside the body of a function.

   279

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

   280

# function's detailed documentation block.

   281

   282

HIDE_IN_BODY_DOCS      = NO

   283

   284

# The INTERNAL_DOCS tag determines if documentation

   285

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

   286

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

   287

# Set it to YES to include the internal documentation.

   288

   289

INTERNAL_DOCS          = NO

   290

   291

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

   292

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

   293

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

   294

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

   295

# and Mac users are advised to set this option to NO.

   296

   297

CASE_SENSE_NAMES       = YES

   298

   299

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

   300

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

   301

# documentation. If set to YES the scope will be hidden.

   302

   303

HIDE_SCOPE_NAMES       = NO

   304

   305

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

   306

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

   307

# of that file.

   308

   309

SHOW_INCLUDE_FILES     = NO

   310

   311

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

   312

# is inserted in the documentation for inline members.

   313

   314

INLINE_INFO            = YES

   315

   316

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

   317

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

   318

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

   319

# declaration order.

   320

   321

SORT_MEMBER_DOCS       = NO

   322

   323

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

   324

# brief documentation of file, namespace and class members alphabetically

   325

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

   326

# declaration order.

   327

   328

SORT_BRIEF_DOCS        = NO

   329

   330

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

   331

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

   332

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

   333

# not including the namespace part.

   334

# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.

   335

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

   336

# alphabetical list.

   337

   338

SORT_BY_SCOPE_NAME     = NO

   339

   340

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

   341

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

   342

# commands in the documentation.

   343

   344

GENERATE_TODOLIST      = YES

   345

   346

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

   347

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

   348

# commands in the documentation.

   349

   350

GENERATE_TESTLIST      = NO

   351

   352

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

   353

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

   354

# commands in the documentation.

   355

   356

GENERATE_BUGLIST       = NO

   357

   358

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

   359

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

   360

# \deprecated commands in the documentation.

   361

   362

GENERATE_DEPRECATEDLIST= NO

   363

   364

# The ENABLED_SECTIONS tag can be used to enable conditional

   365

# documentation sections, marked by \if sectionname ... \endif.

   366

   367

ENABLED_SECTIONS       =

   368

   369

# The MAX_INITIALIZER_LINES tag determines the maximum number of lines

   370

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

   371

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

   372

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

   373

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

   374

# documentation can be controlled using \showinitializer or \hideinitializer

   375

# command in the documentation regardless of this setting.

   376

   377

MAX_INITIALIZER_LINES  = 30

   378

   379

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

   380

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

   381

# list will mention the files that were used to generate the documentation.

   382

   383

SHOW_USED_FILES        = NO

   384

   385

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

   386

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

   387

# in the documentation. The default is YES.

   388

   389

SHOW_DIRECTORIES       = YES

   390

   391

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

   392

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

   393

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

   394

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

   395

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

   396

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

   397

# is used as the file version. See the manual for examples.

   398

   399

FILE_VERSION_FILTER    =

   400

   401

#---------------------------------------------------------------------------

   402

# configuration options related to warning and progress messages

   403

#---------------------------------------------------------------------------

   404

   405

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

   406

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

   407

   408

QUIET                  = YES

   409

   410

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

   411

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

   412

# NO is used.

   413

   414

WARNINGS               = YES

   415

   416

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

   417

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

   418

# automatically be disabled.

   419

   420

WARN_IF_UNDOCUMENTED   = YES

   421

   422

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

   423

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

   424

# parameters in a documented function, or documenting parameters that

   425

# don't exist or using markup commands wrongly.

   426

   427

WARN_IF_DOC_ERROR      = YES

   428

   429

# This WARN_NO_PARAMDOC option can be abled to get warnings for

   430

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

   431

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

   432

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

   433

# documentation.

   434

   436

   437

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

   438

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

   439

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

   440

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

   441

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

   442

# be obtained via FILE_VERSION_FILTER)

   443

   444

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

   445

   446

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

   447

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

   448

# to stderr.

   449

   450

WARN_LOGFILE           =

   451

   452

#---------------------------------------------------------------------------

   453

# configuration options related to the input files

   454

#---------------------------------------------------------------------------

   455

   456

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

   457

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

   458

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

   459

# with spaces.

   460

   461

INPUT                  = master include

   462

   463

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

   464

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

   465

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

   466

# blank the following patterns are tested:

   467

# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx

   468

# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm

   469

   470

FILE_PATTERNS          =

   471

   472

# The RECURSIVE tag can be used to turn specify whether or not subdirectories

   473

# should be searched for input files as well. Possible values are YES and NO.

   474

# If left blank NO is used.

   475

   476

RECURSIVE              = NO

   477

   478

# The EXCLUDE tag can be used to specify files and/or directories that should

   479

# excluded from the INPUT source files. This way you can easily exclude a

   480

# subdirectory from a directory tree whose root is specified with the INPUT tag.

   481

   482

EXCLUDE                =

   483

   484

# The EXCLUDE_SYMLINKS tag can be used select whether or not files or

   485

# directories that are symbolic links (a Unix filesystem feature) are excluded

   486

# from the input.

   487

   488

EXCLUDE_SYMLINKS       = NO

   489

   490

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

   491

# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude

   492

# certain files from those directories. Note that the wildcards are matched

   493

# against the file with absolute path, so to exclude all test directories

   494

# for example use the pattern */test/*