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           = CanFestival

    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         = 3.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

    41

OUTPUT_DIRECTORY       = ./

    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       = "The $name class" \

    90

                         "The $name widget" \

    91

                         "The $name file" \

    92

                         is \

    93

                         provides \

    94

                         specifies \

    95

                         contains \

    96

                         represents \

    97

                         a \

    98

                         an \

    99

                         the

   100

   101

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

   102

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

   103

# description.

   104

   105

ALWAYS_DETAILED_SEC    = NO

   106

   107

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

   108

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

   109

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

   110

# operators of the base classes will not be shown.

   111

   112

INLINE_INHERITED_MEMB  = NO

   113

   114

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

   115

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

   116

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

   117

   118

FULL_PATH_NAMES        = YES

   119

   120

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

   121

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

   122

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

   123

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

   124

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

   125

# path to strip.

   126

   127

STRIP_FROM_PATH        = ../../

   128

   129

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

   130

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

   131

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

   132

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

   133

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

   134

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

   135

   136

STRIP_FROM_INC_PATH    = 

   137

   138

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

   139

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

   140

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

   141

   142

SHORT_NAMES            = NO

   143

   144

# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 

   145

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

   146

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

   147

# comments will behave just like regular Qt-style comments 

   148

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

   149

   150

JAVADOC_AUTOBRIEF      = NO

   151

   152

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

   153

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

   154

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

   155

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

   156

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

   157

   158

QT_AUTOBRIEF           = NO

   159

   160

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

   161

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

   162

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

   163

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

   164

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

   165

   166

MULTILINE_CPP_IS_BRIEF = NO

   167

   168

# If the DETAILS_AT_TOP tag is set to YES then Doxygen 

   169

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

   170

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

   171

# documentation.

   172

   173

DETAILS_AT_TOP         = NO

   174

   175

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

   176

# member inherits the documentation from any documented member that it 

   177

# re-implements.

   178

   179

INHERIT_DOCS           = YES

   180

   181

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

   182

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

   183

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

   184

   185

SEPARATE_MEMBER_PAGES  = NO

   186

   187

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

   188

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

   189

   190

TAB_SIZE               = 8

   191

   192

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

   193

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

   194

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

   195

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

   196

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

   197

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

   198

   199

ALIASES                = 

   200

   201

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

   202

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

   203

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

   204

# of all members will be omitted, etc.

   205

   206

OPTIMIZE_OUTPUT_FOR_C  = YES

   207

   208

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

   209

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

   210

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

   211

# scopes will look different, etc.

   212

   213

OPTIMIZE_OUTPUT_JAVA   = NO

   214

   215

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

   216

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

   217

# Fortran.

   218

   219

OPTIMIZE_FOR_FORTRAN   = NO

   220

   221

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

   222

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

   223

# VHDL.

   224

   225

OPTIMIZE_OUTPUT_VHDL   = NO

   226

   227

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

   228

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

   229

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

   230

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

   231

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

   232

# diagrams that involve STL classes more complete and accurate.

   233

   234

BUILTIN_STL_SUPPORT    = NO

   235

   236

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

   237

# enable parsing support.

   238

   239

CPP_CLI_SUPPORT        = NO

   240

   241

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

   242

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

   243

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

   244

   245

SIP_SUPPORT            = NO

   246

   247

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

   248

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

   249

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

   250

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

   251

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

   252

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

   253

   254

IDL_PROPERTY_SUPPORT   = YES

   255

   256

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

   257

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

   258

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

   259

# all members of a group must be documented explicitly.

   260

   261

DISTRIBUTE_GROUP_DOC   = NO

   262

   263

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

   264

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

   265

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

   266

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

   267

# the \nosubgrouping command.

   268

   269

SUBGROUPING            = YES

   270

   271

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

   272

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

   273

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

   274

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

   275

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

   276

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

   277

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

   278

   279

TYPEDEF_HIDES_STRUCT   = NO

   280

   281

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

   282

# Build related configuration options

   283

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

   284

   285

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

   286

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

   287

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

   288

# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

   289

   290

EXTRACT_ALL            = NO

   291

   292

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

   293

# will be included in the documentation.

   294

   295

EXTRACT_PRIVATE        = NO

   296

   297

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

   298

# will be included in the documentation.

   299

   300

EXTRACT_STATIC         = NO

   301

   302

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

   303

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

   304

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

   305

   306

EXTRACT_LOCAL_CLASSES  = NO

   307

   308

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

   309

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

   310

# the interface are included in the documentation. 

   311

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

   312

   313

EXTRACT_LOCAL_METHODS  = NO

   314

   315

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

   316

# extracted and appear in the documentation as a namespace called 

   317

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

   318

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

   319

# anonymous namespace are hidden.

   320

   321

EXTRACT_ANON_NSPACES   = NO

   322

   323

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

   324

# undocumented members of documented classes, files or namespaces. 

   325

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

   326

# various overviews, but no documentation section is generated. 

   327

# This option has no effect if EXTRACT_ALL is enabled.

   328

   329

HIDE_UNDOC_MEMBERS     = YES

   330

   331

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

   332

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

   333

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

   334

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

   335

   336

HIDE_UNDOC_CLASSES     = YES

   337

   338

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

   339

# friend (class|struct|union) declarations. 

   340

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

   341

# documentation.

   342

   343

HIDE_FRIEND_COMPOUNDS  = YES

   344

   345

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

   346

# documentation blocks found inside the body of a function. 

   347

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

   348

# function's detailed documentation block.

   349

   350

HIDE_IN_BODY_DOCS      = NO

   351

   352

# The INTERNAL_DOCS tag determines if documentation 

   353

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

   354

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

   355

# Set it to YES to include the internal documentation.

   356

   357

INTERNAL_DOCS          = YES

   358

   359

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

   360

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

   361

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

   362

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

   363

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

   364

   365

CASE_SENSE_NAMES       = YES

   366

   367

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

   368

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

   369

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

   370

   371

HIDE_SCOPE_NAMES       = NO

   372

   373

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

   374

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

   375

# of that file.

   376

   377

SHOW_INCLUDE_FILES     = YES

   378

   379

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

   380

# is inserted in the documentation for inline members.

   381

   382

INLINE_INFO            = YES

   383

   384

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

   385

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

   386

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

   387

# declaration order.

   388

   389

SORT_MEMBER_DOCS       = YES

   390

   391

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

   392

# brief documentation of file, namespace and class members alphabetically 

   393

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

   394

# declaration order.

   395

   396

SORT_BRIEF_DOCS        = NO

   397

   398

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

   399

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

   400

# the group names will appear in their defined order.

   401

   402

SORT_GROUP_NAMES       = NO

   403

   404

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

   405

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

   406

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

   407

# not including the namespace part. 

   408

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

   409

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

   410

# alphabetical list.

   411

   412

SORT_BY_SCOPE_NAME     = NO

   413

   414

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

   415

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

   416

# commands in the documentation.

   417

   418

GENERATE_TODOLIST      = YES

   419

   420

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

   421

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

   422

# commands in the documentation.

   423

   424

GENERATE_TESTLIST      = YES

   425

   426

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

   427

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

   428

# commands in the documentation.

   429

   430

GENERATE_BUGLIST       = YES

   431

   432

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

   433

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

   434

# \deprecated commands in the documentation.

   435

   436

GENERATE_DEPRECATEDLIST= YES

   437

   438

# The ENABLED_SECTIONS tag can be used to enable conditional 

   439

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

   440

   441

ENABLED_SECTIONS       = 

   442

   443

# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 

   444

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

   445

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

   446

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

   447

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

   448

# documentation can be controlled using \showinitializer or \hideinitializer 

   449

# command in the documentation regardless of this setting.

   450

   451

MAX_INITIALIZER_LINES  = 30

   452

   453

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

   454

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

   455

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

   456

   457

SHOW_USED_FILES        = NO

   458

   459

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

   460

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

   461

# in the documentation. The default is NO.

   462

   463

SHOW_DIRECTORIES       = NO

   464

   465

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

   466

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

   467

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

   468

   469

SHOW_FILES             = YES

   470

   471

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

   472

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

   473

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

   474

   475

SHOW_NAMESPACES        = YES

   476

   477

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

   478

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

   479

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

   480

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

   481

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

   482

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

   483

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

   484

   485

FILE_VERSION_FILTER    = 

   486

   487

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

   488

# configuration options related to warning and progress messages

   489

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

   490

   491

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

   492

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

   493

   494

QUIET                  = NO

   495

   496