1

# Doxyfile 1.5.6

     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

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

    18

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

    19

# text before the first occurrence of this tag. Doxygen uses libiconv (or the 

    20

# iconv built into libc) for the transcoding. See 

    21

# http://www.gnu.org/software/libiconv for the list of possible encodings.

    22

    23

DOXYFILE_ENCODING      = UTF-8

    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

    28

PROJECT_NAME           = "@PROJECT_LONG_NAME@"

    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         = @PROJECT_VERSION@

    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

    41

OUTPUT_DIRECTORY       = @DOXYGEN_OUTPUT_DIR@

    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

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

    57

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

    58

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

    59

# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, 

    60

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

    61

# and Ukrainian.

    62

    63

OUTPUT_LANGUAGE        = English

    64

    65

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

    66

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

    67

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

    68

# Set to NO to disable this.

    69

    70

BRIEF_MEMBER_DESC      = YES

    71

    72

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

    73

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

    74

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

    75

# brief descriptions will be completely suppressed.

    76

    77

REPEAT_BRIEF           = YES

    78

    79

# This tag implements a quasi-intelligent brief description abbreviator 

    80

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

    81

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

    82

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

    83

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

    84

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

    85

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

    86

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

    87

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

    88

    89

ABBREVIATE_BRIEF       = 

    90

    91

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

    92

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

    93

# description.

    94

    95

ALWAYS_DETAILED_SEC    = NO

    96

    97

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

    98

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

    99

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

   100

# operators of the base classes will not be shown.

   101

   102

INLINE_INHERITED_MEMB  = NO

   103

   104

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

   105

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

   106

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

   107

   108

FULL_PATH_NAMES        = YES

   109

   110

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

   111

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

   112

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

   113

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

   114

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

   115

# path to strip.

   116

   117

STRIP_FROM_PATH        = 

   118

   119

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

   120

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

   121

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

   122

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

   123

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

   124

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

   125

   126

STRIP_FROM_INC_PATH    = 

   127

   128

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

   129

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

   130

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

   131

   132

SHORT_NAMES            = NO

   133

   134

# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 

   135

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

   136

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

   137

# comments will behave just like regular Qt-style comments 

   138

# (thus requiring an explicit @brief command for a brief description.)

   139

   140

JAVADOC_AUTOBRIEF      = YES

   141

   142

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

   143

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

   144

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

   145

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

   146

# an explicit \brief command for a brief description.)

   147

   148

QT_AUTOBRIEF           = NO

   149

   150

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

   151

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

   152

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

   153

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

   154

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

   155

   156

MULTILINE_CPP_IS_BRIEF = NO

   157

   158

# If the DETAILS_AT_TOP tag is set to YES then Doxygen 

   159

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

   160

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

   161

# documentation.

   162

   163

DETAILS_AT_TOP         = NO

   164

   165

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

   166

# member inherits the documentation from any documented member that it 

   167

# re-implements.

   168

   169

INHERIT_DOCS           = YES

   170

   171

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

   172

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

   173

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

   174

   175

SEPARATE_MEMBER_PAGES  = NO

   176

   177

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

   178

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

   179

   180

TAB_SIZE               = 4

   181

   182

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

   183

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

   184

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

   185

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

   186

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

   187

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

   188

   189

ALIASES                = 

   190

   191

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

   192

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

   193

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

   194

# of all members will be omitted, etc.

   195

   196

OPTIMIZE_OUTPUT_FOR_C  = YES

   197

   198

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

   199

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

   200

# Java. For instance, namespaces will be presented as packages, qualified 

   201

# scopes will look different, etc.

   202

   203

OPTIMIZE_OUTPUT_JAVA   = NO

   204

   205

# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 

   206

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

   207

# Fortran.

   208

   209

OPTIMIZE_FOR_FORTRAN   = NO

   210

   211

# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 

   212

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

   213

# VHDL.

   214

   215

OPTIMIZE_OUTPUT_VHDL   = NO

   216

   217

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

   218

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

   219

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

   220

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

   221

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

   222

# diagrams that involve STL classes more complete and accurate.

   223

   224

BUILTIN_STL_SUPPORT    = NO

   225

   226

# If you use Microsoft's C++/CLI language, you should set this option to YES to

   227

# enable parsing support.

   228

   229

CPP_CLI_SUPPORT        = NO

   230

   231

# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 

   232

# Doxygen will parse them like normal C++ but will assume all classes use public 

   233

# instead of private inheritance when no explicit protection keyword is present.

   234

   235

SIP_SUPPORT            = NO

   236

   237

# For Microsoft's IDL there are propget and propput attributes to indicate getter 

   238

# and setter methods for a property. Setting this option to YES (the default) 

   239

# will make doxygen to replace the get and set methods by a property in the 

   240

# documentation. This will only work if the methods are indeed getting or 

   241

# setting a simple type. If this is not the case, or you want to show the 

   242

# methods anyway, you should set this option to NO.

   243

   244

IDL_PROPERTY_SUPPORT   = YES

   245

   246

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

   247

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

   248

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

   249

# all members of a group must be documented explicitly.

   250

   251

DISTRIBUTE_GROUP_DOC   = NO

   252

   253

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

   254

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

   255

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

   256

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

   257

# the \nosubgrouping command.

   258

   259

SUBGROUPING            = YES

   260

   261

# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 

   262

# is documented as struct, union, or enum with the name of the typedef. So 

   263

# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 

   264

# with name TypeT. When disabled the typedef will appear as a member of a file, 

   265

# namespace, or class. And the struct will be named TypeS. This can typically 

   266

# be useful for C code in case the coding convention dictates that all compound 

   267

# types are typedef'ed and only the typedef is referenced, never the tag name.

   268

   269

TYPEDEF_HIDES_STRUCT   = NO

   270

   271

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

   272

# Build related configuration options

   273

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

   274

   275

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

   276

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

   277

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

   278

# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

   279

   280

EXTRACT_ALL            = NO

   281

   282

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

   283

# will be included in the documentation.

   284

   285

EXTRACT_PRIVATE        = NO

   286

   287

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

   288

# will be included in the documentation.

   289

   290

EXTRACT_STATIC         = NO

   291

   292

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

   293

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

   294

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

   295

   296

EXTRACT_LOCAL_CLASSES  = YES

   297

   298

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

   299

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

   300

# the interface are included in the documentation. 

   301

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

   302

   303

EXTRACT_LOCAL_METHODS  = NO

   304

   305

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

   306

# extracted and appear in the documentation as a namespace called 

   307

# 'anonymous_namespace{file}', where file will be replaced with the base 

   308

# name of the file that contains the anonymous namespace. By default 

   309

# anonymous namespace are hidden.

   310

   311

EXTRACT_ANON_NSPACES   = NO

   312

   313

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

   314

# undocumented members of documented classes, files or namespaces. 

   315

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

   316

# various overviews, but no documentation section is generated. 

   317

# This option has no effect if EXTRACT_ALL is enabled.

   318

   319

HIDE_UNDOC_MEMBERS     = NO

   320

   321

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

   322

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

   323

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

   324

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

   325

   326

HIDE_UNDOC_CLASSES     = NO

   327

   328

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

   329

# friend (class|struct|union) declarations. 

   330

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

   331

# documentation.

   332

   333

HIDE_FRIEND_COMPOUNDS  = NO

   334

   335

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

   336

# documentation blocks found inside the body of a function. 

   337

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

   338

# function's detailed documentation block.

   339

   340

HIDE_IN_BODY_DOCS      = NO

   341

   342

# The INTERNAL_DOCS tag determines if documentation 

   343

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

   344

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

   345

# Set it to YES to include the internal documentation.

   346

   347

INTERNAL_DOCS          = NO

   348

   349

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

   350

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

   351

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

   352

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

   353

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

   354

   355

CASE_SENSE_NAMES       = YES

   356

   357

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

   358

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

   359

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

   360

   361

HIDE_SCOPE_NAMES       = NO

   362

   363

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

   364

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

   365

# of that file.

   366

   367

SHOW_INCLUDE_FILES     = YES

   368

   369

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

   370

# is inserted in the documentation for inline members.

   371

   372

INLINE_INFO            = YES

   373

   374

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

   375

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

   376

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

   377

# declaration order.

   378

   379

SORT_MEMBER_DOCS       = YES

   380

   381

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

   382

# brief documentation of file, namespace and class members alphabetically 

   383

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

   384

# declaration order.

   385

   386

SORT_BRIEF_DOCS        = NO

   387

   388

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

   389

# hierarchy of group names into alphabetical order. If set to NO (the default) 

   390

# the group names will appear in their defined order.

   391

   392

SORT_GROUP_NAMES       = NO

   393

   394

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

   395

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

   396

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

   397

# not including the namespace part. 

   398

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

   399

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

   400

# alphabetical list.

   401

   402

SORT_BY_SCOPE_NAME     = NO

   403

   404

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

   405

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

   406

# commands in the documentation.

   407

   408

GENERATE_TODOLIST      = YES

   409

   410

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

   411

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

   412

# commands in the documentation.

   413

   414

GENERATE_TESTLIST      = YES

   415

   416

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

   417

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

   418

# commands in the documentation.

   419

   420

GENERATE_BUGLIST       = YES

   421

   422

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

   423

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

   424

# \deprecated commands in the documentation.

   425

   426

GENERATE_DEPRECATEDLIST= YES

   427

   428

# The ENABLED_SECTIONS tag can be used to enable conditional 

   429

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

   430

   431

ENABLED_SECTIONS       = 

   432

   433

# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 

   434

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

   435

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

   436

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

   437

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

   438

# documentation can be controlled using \showinitializer or \hideinitializer 

   439

# command in the documentation regardless of this setting.

   440

   441

MAX_INITIALIZER_LINES  = 30

   442

   443

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

   444

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

   445

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

   446

   447

SHOW_USED_FILES        = YES

   448

   449

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

   450

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

   451

# in the documentation. The default is NO.

   452

   453

SHOW_DIRECTORIES       = NO

   454

   455

# Set the SHOW_FILES tag to NO to disable the generation of the Files page.

   456

# This will remove the Files entry from the Quick Index and from the 

   457

# Folder Tree View (if specified). The default is YES.

   458

   459

SHOW_FILES             = YES

   460

   461

# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 

   462

# Namespaces page.  This will remove the Namespaces entry from the Quick Index

   463

# and from the Folder Tree View (if specified). The default is YES.

   464

   465

SHOW_NAMESPACES        = YES

   466

   467

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

   468

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

   469

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

   470

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

   471

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

   472

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

   473

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

   474

   475

FILE_VERSION_FILTER    = 

   476

   477

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

   478

# configuration options related to warning and progress messages

   479

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

   480

   481

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

   482

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

   483

   484

QUIET                  = YES

   485

   486

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

   487

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

   488

# NO is used.

   489

   490

WARNINGS               = YES

   491

   492

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

   493

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

   494

# automatically be disabled.

   495

   496

WARN_IF_UNDOCUMENTED   = YES

   497

   498

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

   499

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

   500

# parameters in a documented function, or documenting parameters that 

   501

# don't exist or using markup commands wrongly.

   502

   503

WARN_IF_DOC_ERROR      = YES

   504

   505

# This WARN_NO_PARAMDOC option can be abled to get warnings for 

   506

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

   507

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

   508

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

   509

# documentation.

   510

   511

WARN_NO_PARAMDOC       = NO

   512

   513

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

   514

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

   515

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

   516

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

   517

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

   518

# be obtained via FILE_VERSION_FILTER)

   519

   520

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

   521

   522

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

   523

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

   524

# to stderr.

   525

   526

WARN_LOGFILE           = 

   527

   528

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

   529

# configuration options related to the input files