1

# Doxyfile 1.5.1

     2

     3

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

     4

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

     5

#

     6

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

     7

# The format is:

     8

#       TAG = value [value, ...]

     9

# For lists items can also be appended using:

    10

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

    11

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

    12

    13

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

    14

# Project related configuration options

    15

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

    16

    17

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

    18

# by quotes) that should identify the project.

    19

    20

PROJECT_NAME           = "@PROJECT_LONG_NAME@"

    21

    22

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

    23

# This could be handy for archiving the generated documentation or 

    24

# if some version control system is used.

    25

    26

PROJECT_NUMBER         = @PROJECT_VERSION@

    27

    28

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

    29

# base path where the generated documentation will be put. 

    30

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

    31

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

    32

    33

OUTPUT_DIRECTORY       = @PROJECT_DOXYGEN_DIR@

    34

    35

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

    36

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

    37

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

    38

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

    39

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

    40

# otherwise cause performance problems for the file system.

    41

    42

CREATE_SUBDIRS         = NO

    43

    44

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

    45

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

    46

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

    47

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

    48

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

    49

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

    50

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

    51

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

    52

# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.

    53

    54

OUTPUT_LANGUAGE        = English

    55

    56

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

    57

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

    58

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

    59

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

    60

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

    61

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

    62

# all platforms other than Windows).

    63

    64

USE_WINDOWS_ENCODING   = NO

    65

    66

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

    67

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

    68

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

    69

# Set to NO to disable this.

    70

    71

BRIEF_MEMBER_DESC      = YES

    72

    73

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

    74

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

    75

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

    76

# brief descriptions will be completely suppressed.

    77

    78

REPEAT_BRIEF           = YES

    79

    80

# This tag implements a quasi-intelligent brief description abbreviator 

    81

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

    82

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

    83

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

    84

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

    85

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

    86

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

    87

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

    88

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

    89

    90

ABBREVIATE_BRIEF       = 

    91

    92

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

    93

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

    94

# description.

    95

    96

ALWAYS_DETAILED_SEC    = NO

    97

    98

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

    99

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

   100

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

   101

# operators of the base classes will not be shown.

   102

   103

INLINE_INHERITED_MEMB  = NO

   104

   105

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

   106

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

   107

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

   108

   109

FULL_PATH_NAMES        = YES

   110

   111

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

   112

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

   113

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

   114

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

   115

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

   116

# path to strip.

   117

   118

STRIP_FROM_PATH        = 

   119

   120

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

   121

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

   122

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

   123

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

   124

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

   125

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

   126

   127

STRIP_FROM_INC_PATH    = 

   128

   129

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

   130

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

   131

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

   132

   133

SHORT_NAMES            = NO

   134

   135

# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 

   136

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

   137

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

   138

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

   139

# explicit @brief command for a brief description.

   140

   141

JAVADOC_AUTOBRIEF      = YES

   142

   143

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

   144

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

   145

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

   146

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

   147

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

   148

   149

MULTILINE_CPP_IS_BRIEF = NO

   150

   151

# If the DETAILS_AT_TOP tag is set to YES then Doxygen 

   152

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

   153

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

   154

# documentation.

   155

   156

DETAILS_AT_TOP         = NO

   157

   158

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

   159

# member inherits the documentation from any documented member that it 

   160

# re-implements.

   161

   162

INHERIT_DOCS           = YES

   163

   164

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

   165

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

   166

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

   167

   168

SEPARATE_MEMBER_PAGES  = NO

   169

   170

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

   171

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

   172

   173

TAB_SIZE               = 8

   174

   175

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

   176

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

   177

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

   178

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

   179

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

   180

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

   181

   182

ALIASES                = 

   183

   184

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

   185

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

   186

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

   187

# of all members will be omitted, etc.

   188

   189

OPTIMIZE_OUTPUT_FOR_C  = NO

   190

   191

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

   192

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

   193

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

   194

# will look different, etc.

   195

   196

OPTIMIZE_OUTPUT_JAVA   = NO

   197

   198

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

   199

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

   200

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

   201

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

   202

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

   203

# diagrams that involve STL classes more complete and accurate.

   204

   205

BUILTIN_STL_SUPPORT    = NO

   206

   207

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

   208

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

   209

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

   210

# all members of a group must be documented explicitly.

   211

   212

DISTRIBUTE_GROUP_DOC   = NO

   213

   214

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

   215

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

   216

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

   217

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

   218

# the \nosubgrouping command.

   219

   220

SUBGROUPING            = YES

   221

   222

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

   223

# Build related configuration options

   224

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

   225

   226

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

   227

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

   228

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

   229

# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

   230

   231

EXTRACT_ALL            = NO

   232

   233

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

   234

# will be included in the documentation.

   235

   236

EXTRACT_PRIVATE        = NO

   237

   238

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

   239

# will be included in the documentation.

   240

   241

EXTRACT_STATIC         = NO

   242

   243

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

   244

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

   245

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

   246

   247

EXTRACT_LOCAL_CLASSES  = YES

   248

   249

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

   250

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

   251

# the interface are included in the documentation. 

   252

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

   253

   254

EXTRACT_LOCAL_METHODS  = NO

   255

   256

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

   257

# undocumented members of documented classes, files or namespaces. 

   258

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

   259

# various overviews, but no documentation section is generated. 

   260

# This option has no effect if EXTRACT_ALL is enabled.

   261

   262

HIDE_UNDOC_MEMBERS     = NO

   263

   264

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

   265

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

   266

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

   267

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

   268

   269

HIDE_UNDOC_CLASSES     = NO

   270

   271

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

   272

# friend (class|struct|union) declarations. 

   273

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

   274

# documentation.

   275

   276

HIDE_FRIEND_COMPOUNDS  = NO

   277

   278

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

   279

# documentation blocks found inside the body of a function. 

   280

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

   281

# function's detailed documentation block.

   282

   283

HIDE_IN_BODY_DOCS      = NO

   284

   285

# The INTERNAL_DOCS tag determines if documentation 

   286

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

   287

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

   288

# Set it to YES to include the internal documentation.

   289

   290

INTERNAL_DOCS          = NO

   291

   292

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

   293

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

   294

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

   295

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

   296

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

   297

   298

CASE_SENSE_NAMES       = YES

   299

   300

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

   301

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

   302

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

   303

   304

HIDE_SCOPE_NAMES       = NO

   305

   306

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

   307

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

   308

# of that file.

   309

   310

SHOW_INCLUDE_FILES     = YES

   311

   312

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

   313

# is inserted in the documentation for inline members.

   314

   315

INLINE_INFO            = YES

   316

   317

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

   318

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

   319

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

   320

# declaration order.

   321

   322

SORT_MEMBER_DOCS       = YES

   323

   324

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

   325

# brief documentation of file, namespace and class members alphabetically 

   326

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

   327

# declaration order.

   328

   329

SORT_BRIEF_DOCS        = NO

   330

   331

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

   332

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

   333

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

   334

# not including the namespace part. 

   335

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

   336

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

   337

# alphabetical list.

   338

   339

SORT_BY_SCOPE_NAME     = NO

   340

   341

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

   342

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

   343

# commands in the documentation.

   344

   345

GENERATE_TODOLIST      = YES

   346

   347

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

   348

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

   349

# commands in the documentation.

   350

   351

GENERATE_TESTLIST      = YES

   352

   353

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

   354

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

   355

# commands in the documentation.

   356

   357

GENERATE_BUGLIST       = YES

   358

   359

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

   360

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

   361

# \deprecated commands in the documentation.

   362

   363

GENERATE_DEPRECATEDLIST= YES

   364

   365

# The ENABLED_SECTIONS tag can be used to enable conditional 

   366

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

   367

   368

ENABLED_SECTIONS       = 

   369

   370

# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 

   371

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

   372

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

   373

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

   374

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

   375

# documentation can be controlled using \showinitializer or \hideinitializer 

   376

# command in the documentation regardless of this setting.

   377

   378

MAX_INITIALIZER_LINES  = 30

   379

   380

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

   381

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

   382

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

   383

   384

SHOW_USED_FILES        = YES

   385

   386

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

   387

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

   388

# in the documentation. The default is NO.

   389

   390

SHOW_DIRECTORIES       = NO

   391

   392

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

   393

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

   394

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

   395

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

   396

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

   397

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

   398

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

   399

   400

FILE_VERSION_FILTER    = 

   401

   402

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

   403

# configuration options related to warning and progress messages

   404

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

   405

   406

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

   407

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

   408

   409

QUIET                  = YES

   410

   411

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

   412

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

   413

# NO is used.

   414

   415

WARNINGS               = YES

   416

   417

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

   418

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

   419

# automatically be disabled.

   420

   421

WARN_IF_UNDOCUMENTED   = YES

   422

   423

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

   424

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

   425

# parameters in a documented function, or documenting parameters that 

   426

# don't exist or using markup commands wrongly.

   427

   428

WARN_IF_DOC_ERROR      = YES

   429

   430

# This WARN_NO_PARAMDOC option can be abled to get warnings for 

   431

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

   432

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

   433

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

   434

# documentation.

   435

   436

WARN_NO_PARAMDOC       = NO

   437

   438

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

   439

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

   440

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

   441

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

   442

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

   443

# be obtained via FILE_VERSION_FILTER)

   444

   445

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

   446

   447

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

   448

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

   449

# to stderr.

   450

   451

WARN_LOGFILE           = 

   452

   453

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

   454

# configuration options related to the input files

   455

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

   456

   457

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

   458

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

   459

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

   460

# with spaces.

   461

   462

INPUT                  = @PROJECT_DOX_FILE@ @PROJECT_SOURCECODE_DIR@

   463

   464

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

   465

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

   466

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

   467

# blank the following patterns are tested: 

   468

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

   469

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

   470

   471

FILE_PATTERNS          = *.hh *.cc

   472

   473

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

   474

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

   475

# If left blank NO is used.

   476

   477

RECURSIVE              = YES

   478

   479

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

   480

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

   481

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

   482

   483

EXCLUDE                = 

   484

   485

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

   486

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

   487

# from the input.

   488

   489

EXCLUDE_SYMLINKS       = NO

   490

   491

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

   492

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

   493

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

   494

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

   495

# for example use the pattern */test/*

   496

   497

EXCLUDE_PATTERNS       = */.svn/*

   498

   499

# The EXAMPLE_PATH tag can be used to specify one or more files or 

   500

# directories that contain example code fragments that are included (see 

   501

# the \include command).

   502

   503

EXAMPLE_PATH           = 

   504

   505

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

   506

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

   507

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

   508

# blank all files are included.

   509

   510

EXAMPLE_PATTERNS       = 

   511

   512

# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 

   513

# searched for input files to be used with the \include or \dontinclude 

   514

# commands irrespective of the value of the RECURSIVE tag. 

   515

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

   516

   517

EXAMPLE_RECURSIVE      = NO

   518

   519

# The IMAGE_PATH tag can be used to specify one or more files or 

   520

# directories that contain image that are included in the documentation (see 

   521

# the \image command).

   522

   523

IMAGE_PATH             = 

   524

   525

# The INPUT_FILTER tag can be used to specify a program that doxygen should 

   526

# invoke to filter for each input file. Doxygen will invoke the filter program 

   527

# by executing (via popen()) the command <filter> <input-file>, where <filter> 

   528

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

   529

# input file. Doxygen will then use the output that the filter program writes