doc/doxygen/Doxyfile
author Christian Taedcke <hacking@taedcke.com>
Wed, 09 Nov 2011 15:02:47 +0000
changeset 689 d6fcd388f2db
parent 561 f9be4262c68d
child 753 072787c24bec
permissions -rwxr-xr-x
Win32 IXXAT driver:
CHANGED: - Removed deprecated call to VCI_GetBrdTypeByName().
- The board type given to VCI2_PrepareBoard() is now always 0, because this parameter is not used.
- Removed the board_name parameter from IXXAT::open(). The board that should be opened is identified by the parameter board_number.
The correct parameter board_number can be determined using XAT_EnumHwEntry() and XAT_GetConfig().
- Changed the constructor IXXAT::IXXAT(). board->busname now only contains the board_number, see XAT_EnumHwEntry() and XAT_GetConfig().
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
     1
# Doxyfile 1.5.6
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
     2
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
     3
# This file describes the settings to be used by the documentation system
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
     4
# doxygen (www.doxygen.org) for a project
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
     5
#
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
     6
# All text after a hash (#) is considered a comment and will be ignored
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
     7
# The format is:
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
     8
#       TAG = value [value, ...]
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
     9
# For lists items can also be appended using:
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    10
#       TAG += value [value, ...]
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    11
# Values that contain spaces should be placed between quotes (" ")
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    12
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    13
#---------------------------------------------------------------------------
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    14
# Project related configuration options
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    15
#---------------------------------------------------------------------------
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    16
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    17
# This tag specifies the encoding used for all characters in the config file 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    18
# that follow. The default is UTF-8 which is also the encoding used for all 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    19
# text before the first occurrence of this tag. Doxygen uses libiconv (or the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    20
# iconv built into libc) for the transcoding. See 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    21
# http://www.gnu.org/software/libiconv for the list of possible encodings.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    22
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    23
DOXYFILE_ENCODING      = UTF-8
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    24
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    26
# by quotes) that should identify the project.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    27
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    28
PROJECT_NAME           = CanFestival
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    29
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    30
# The PROJECT_NUMBER tag can be used to enter a project or revision number. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    31
# This could be handy for archiving the generated documentation or 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    32
# if some version control system is used.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    33
529
c171e11707c5 Second time, Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 528
diff changeset
    34
PROJECT_NUMBER         = 3.0
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    35
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    36
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    37
# base path where the generated documentation will be put. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    38
# If a relative path is entered, it will be relative to the location 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    39
# where doxygen was started. If left blank the current directory will be used.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    40
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    41
OUTPUT_DIRECTORY       = ./
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    42
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    43
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    44
# 4096 sub-directories (in 2 levels) under the output directory of each output 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    45
# format and will distribute the generated files over these directories. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    46
# Enabling this option can be useful when feeding doxygen a huge amount of 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    47
# source files, where putting all generated files in the same directory would 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    48
# otherwise cause performance problems for the file system.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    49
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    50
CREATE_SUBDIRS         = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    51
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    52
# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    53
# documentation generated by doxygen is written. Doxygen will use this 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    54
# information to generate all constant output in the proper language. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    55
# The default language is English, other supported languages are: 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    56
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    57
# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    58
# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    59
# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    60
# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    61
# and Ukrainian.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    62
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    63
OUTPUT_LANGUAGE        = English
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    64
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    65
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    66
# include brief member descriptions after the members that are listed in 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    67
# the file and class documentation (similar to JavaDoc). 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    68
# Set to NO to disable this.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    69
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    70
BRIEF_MEMBER_DESC      = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    71
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    72
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    73
# the brief description of a member or function before the detailed description. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    74
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    75
# brief descriptions will be completely suppressed.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    76
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    77
REPEAT_BRIEF           = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    78
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    79
# This tag implements a quasi-intelligent brief description abbreviator 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    80
# that is used to form the text in various listings. Each string 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    81
# in this list, if found as the leading text of the brief description, will be 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    82
# stripped from the text and the result after processing the whole list, is 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    83
# used as the annotated text. Otherwise, the brief description is used as-is. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    84
# If left blank, the following values are used ("$name" is automatically 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    85
# replaced with the name of the entity): "The $name class" "The $name widget" 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    86
# "The $name file" "is" "provides" "specifies" "contains" 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    87
# "represents" "a" "an" "the"
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    88
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    89
ABBREVIATE_BRIEF       = "The $name class" \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    90
                         "The $name widget" \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    91
                         "The $name file" \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    92
                         is \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    93
                         provides \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    94
                         specifies \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    95
                         contains \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    96
                         represents \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    97
                         a \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    98
                         an \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
    99
                         the
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   100
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   101
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   102
# Doxygen will generate a detailed section even if there is only a brief 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   103
# description.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   104
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   105
ALWAYS_DETAILED_SEC    = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   106
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   107
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   108
# inherited members of a class in the documentation of that class as if those 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   109
# members were ordinary class members. Constructors, destructors and assignment 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   110
# operators of the base classes will not be shown.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   111
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   112
INLINE_INHERITED_MEMB  = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   113
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   114
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   115
# path before files name in the file list and in the header files. If set 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   116
# to NO the shortest path that makes the file name unique will be used.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   117
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   118
FULL_PATH_NAMES        = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   119
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   120
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   121
# can be used to strip a user-defined part of the path. Stripping is 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   122
# only done if one of the specified strings matches the left-hand part of 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   123
# the path. The tag can be used to show relative paths in the file list. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   124
# If left blank the directory from which doxygen is run is used as the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   125
# path to strip.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   126
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   127
STRIP_FROM_PATH        = ../../
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   128
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   129
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   130
# the path mentioned in the documentation of a class, which tells 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   131
# the reader which header file to include in order to use a class. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   132
# If left blank only the name of the header file containing the class 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   133
# definition is used. Otherwise one should specify the include paths that 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   134
# are normally passed to the compiler using the -I flag.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   135
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   136
STRIP_FROM_INC_PATH    = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   137
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   138
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   139
# (but less readable) file names. This can be useful is your file systems 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   140
# doesn't support long names like on DOS, Mac, or CD-ROM.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   141
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   142
SHORT_NAMES            = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   143
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   144
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   145
# will interpret the first line (until the first dot) of a JavaDoc-style 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   146
# comment as the brief description. If set to NO, the JavaDoc 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   147
# comments will behave just like regular Qt-style comments 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   148
# (thus requiring an explicit @brief command for a brief description.)
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   149
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   150
JAVADOC_AUTOBRIEF      = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   151
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   152
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   153
# interpret the first line (until the first dot) of a Qt-style 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   154
# comment as the brief description. If set to NO, the comments 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   155
# will behave just like regular Qt-style comments (thus requiring 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   156
# an explicit \brief command for a brief description.)
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   157
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   158
QT_AUTOBRIEF           = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   159
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   160
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   161
# treat a multi-line C++ special comment block (i.e. a block of //! or /// 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   162
# comments) as a brief description. This used to be the default behaviour. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   163
# The new default is to treat a multi-line C++ comment block as a detailed 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   164
# description. Set this tag to YES if you prefer the old behaviour instead.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   165
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   166
MULTILINE_CPP_IS_BRIEF = NO
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   167
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   168
# If the DETAILS_AT_TOP tag is set to YES then Doxygen 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   169
# will output the detailed description near the top, like JavaDoc.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   170
# If set to NO, the detailed description appears after the member 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   171
# documentation.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   172
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   173
DETAILS_AT_TOP         = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   174
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   175
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   176
# member inherits the documentation from any documented member that it 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   177
# re-implements.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   178
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   179
INHERIT_DOCS           = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   180
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   181
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   182
# a new page for each member. If set to NO, the documentation of a member will 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   183
# be part of the file/class/namespace that contains it.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   184
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   185
SEPARATE_MEMBER_PAGES  = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   186
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   187
# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   188
# Doxygen uses this value to replace tabs by spaces in code fragments.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   189
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   190
TAB_SIZE               = 8
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   191
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   192
# This tag can be used to specify a number of aliases that acts 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   193
# as commands in the documentation. An alias has the form "name=value". 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   194
# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   195
# put the command \sideeffect (or @sideeffect) in the documentation, which 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   196
# will result in a user-defined paragraph with heading "Side Effects:". 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   197
# You can put \n's in the value part of an alias to insert newlines.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   198
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   199
ALIASES                = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   200
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   201
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   202
# sources only. Doxygen will then generate output that is more tailored for C. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   203
# For instance, some of the names that are used will be different. The list 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   204
# of all members will be omitted, etc.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   205
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   206
OPTIMIZE_OUTPUT_FOR_C  = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   207
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   208
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   209
# sources only. Doxygen will then generate output that is more tailored for 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   210
# Java. For instance, namespaces will be presented as packages, qualified 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   211
# scopes will look different, etc.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   212
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   213
OPTIMIZE_OUTPUT_JAVA   = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   214
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   215
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   216
# sources only. Doxygen will then generate output that is more tailored for 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   217
# Fortran.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   218
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   219
OPTIMIZE_FOR_FORTRAN   = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   220
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   221
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   222
# sources. Doxygen will then generate output that is tailored for 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   223
# VHDL.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   224
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   225
OPTIMIZE_OUTPUT_VHDL   = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   226
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   227
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   228
# to include (a tag file for) the STL sources as input, then you should 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   229
# set this tag to YES in order to let doxygen match functions declarations and 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   230
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   231
# func(std::string) {}). This also make the inheritance and collaboration 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   232
# diagrams that involve STL classes more complete and accurate.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   233
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   234
BUILTIN_STL_SUPPORT    = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   235
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   236
# If you use Microsoft's C++/CLI language, you should set this option to YES to
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   237
# enable parsing support.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   238
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   239
CPP_CLI_SUPPORT        = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   240
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   241
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   242
# Doxygen will parse them like normal C++ but will assume all classes use public 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   243
# instead of private inheritance when no explicit protection keyword is present.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   244
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   245
SIP_SUPPORT            = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   246
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   247
# For Microsoft's IDL there are propget and propput attributes to indicate getter 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   248
# and setter methods for a property. Setting this option to YES (the default) 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   249
# will make doxygen to replace the get and set methods by a property in the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   250
# documentation. This will only work if the methods are indeed getting or 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   251
# setting a simple type. If this is not the case, or you want to show the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   252
# methods anyway, you should set this option to NO.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   253
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   254
IDL_PROPERTY_SUPPORT   = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   255
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   256
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   257
# tag is set to YES, then doxygen will reuse the documentation of the first 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   258
# member in the group (if any) for the other members of the group. By default 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   259
# all members of a group must be documented explicitly.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   260
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   261
DISTRIBUTE_GROUP_DOC   = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   262
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   263
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   264
# the same type (for instance a group of public functions) to be put as a 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   265
# subgroup of that type (e.g. under the Public Functions section). Set it to 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   266
# NO to prevent subgrouping. Alternatively, this can be done per class using 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   267
# the \nosubgrouping command.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   268
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   269
SUBGROUPING            = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   270
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   271
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   272
# is documented as struct, union, or enum with the name of the typedef. So 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   273
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   274
# with name TypeT. When disabled the typedef will appear as a member of a file, 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   275
# namespace, or class. And the struct will be named TypeS. This can typically 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   276
# be useful for C code in case the coding convention dictates that all compound 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   277
# types are typedef'ed and only the typedef is referenced, never the tag name.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   278
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   279
TYPEDEF_HIDES_STRUCT   = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   280
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   281
#---------------------------------------------------------------------------
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   282
# Build related configuration options
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   283
#---------------------------------------------------------------------------
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   284
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   285
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   286
# documentation are documented, even if no documentation was available. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   287
# Private class members and static file members will be hidden unless 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   288
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   289
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   290
EXTRACT_ALL            = NO
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   291
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   292
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   293
# will be included in the documentation.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   294
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   295
EXTRACT_PRIVATE        = NO
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   296
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   297
# If the EXTRACT_STATIC tag is set to YES all static members of a file 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   298
# will be included in the documentation.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   299
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   300
EXTRACT_STATIC         = NO
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   301
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   302
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   303
# defined locally in source files will be included in the documentation. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   304
# If set to NO only classes defined in header files are included.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   305
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   306
EXTRACT_LOCAL_CLASSES  = NO
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   307
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   308
# This flag is only useful for Objective-C code. When set to YES local 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   309
# methods, which are defined in the implementation section but not in 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   310
# the interface are included in the documentation. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   311
# If set to NO (the default) only methods in the interface are included.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   312
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   313
EXTRACT_LOCAL_METHODS  = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   314
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   315
# If this flag is set to YES, the members of anonymous namespaces will be 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   316
# extracted and appear in the documentation as a namespace called 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   317
# 'anonymous_namespace{file}', where file will be replaced with the base 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   318
# name of the file that contains the anonymous namespace. By default 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   319
# anonymous namespace are hidden.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   320
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   321
EXTRACT_ANON_NSPACES   = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   322
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   323
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   324
# undocumented members of documented classes, files or namespaces. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   325
# If set to NO (the default) these members will be included in the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   326
# various overviews, but no documentation section is generated. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   327
# This option has no effect if EXTRACT_ALL is enabled.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   328
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   329
HIDE_UNDOC_MEMBERS     = YES
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   330
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   331
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   332
# undocumented classes that are normally visible in the class hierarchy. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   333
# If set to NO (the default) these classes will be included in the various 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   334
# overviews. This option has no effect if EXTRACT_ALL is enabled.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   335
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   336
HIDE_UNDOC_CLASSES     = YES
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   337
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   338
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   339
# friend (class|struct|union) declarations. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   340
# If set to NO (the default) these declarations will be included in the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   341
# documentation.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   342
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   343
HIDE_FRIEND_COMPOUNDS  = YES
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   344
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   345
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   346
# documentation blocks found inside the body of a function. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   347
# If set to NO (the default) these blocks will be appended to the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   348
# function's detailed documentation block.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   349
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   350
HIDE_IN_BODY_DOCS      = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   351
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   352
# The INTERNAL_DOCS tag determines if documentation 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   353
# that is typed after a \internal command is included. If the tag is set 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   354
# to NO (the default) then the documentation will be excluded. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   355
# Set it to YES to include the internal documentation.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   356
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   357
INTERNAL_DOCS          = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   358
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   359
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   360
# file names in lower-case letters. If set to YES upper-case letters are also 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   361
# allowed. This is useful if you have classes or files whose names only differ 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   362
# in case and if your file system supports case sensitive file names. Windows 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   363
# and Mac users are advised to set this option to NO.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   364
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   365
CASE_SENSE_NAMES       = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   366
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   367
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   368
# will show members with their full class and namespace scopes in the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   369
# documentation. If set to YES the scope will be hidden.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   370
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   371
HIDE_SCOPE_NAMES       = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   372
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   373
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   374
# will put a list of the files that are included by a file in the documentation 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   375
# of that file.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   376
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   377
SHOW_INCLUDE_FILES     = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   378
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   379
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   380
# is inserted in the documentation for inline members.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   381
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   382
INLINE_INFO            = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   383
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   384
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   385
# will sort the (detailed) documentation of file and class members 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   386
# alphabetically by member name. If set to NO the members will appear in 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   387
# declaration order.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   388
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   389
SORT_MEMBER_DOCS       = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   390
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   391
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   392
# brief documentation of file, namespace and class members alphabetically 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   393
# by member name. If set to NO (the default) the members will appear in 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   394
# declaration order.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   395
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   396
SORT_BRIEF_DOCS        = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   397
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   398
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   399
# hierarchy of group names into alphabetical order. If set to NO (the default) 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   400
# the group names will appear in their defined order.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   401
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   402
SORT_GROUP_NAMES       = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   403
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   404
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   405
# sorted by fully-qualified names, including namespaces. If set to 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   406
# NO (the default), the class list will be sorted only by class name, 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   407
# not including the namespace part. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   408
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   409
# Note: This option applies only to the class list, not to the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   410
# alphabetical list.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   411
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   412
SORT_BY_SCOPE_NAME     = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   413
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   414
# The GENERATE_TODOLIST tag can be used to enable (YES) or 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   415
# disable (NO) the todo list. This list is created by putting \todo 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   416
# commands in the documentation.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   417
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   418
GENERATE_TODOLIST      = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   419
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   420
# The GENERATE_TESTLIST tag can be used to enable (YES) or 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   421
# disable (NO) the test list. This list is created by putting \test 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   422
# commands in the documentation.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   423
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   424
GENERATE_TESTLIST      = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   425
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   426
# The GENERATE_BUGLIST tag can be used to enable (YES) or 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   427
# disable (NO) the bug list. This list is created by putting \bug 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   428
# commands in the documentation.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   429
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   430
GENERATE_BUGLIST       = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   431
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   432
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   433
# disable (NO) the deprecated list. This list is created by putting 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   434
# \deprecated commands in the documentation.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   435
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   436
GENERATE_DEPRECATEDLIST= YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   437
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   438
# The ENABLED_SECTIONS tag can be used to enable conditional 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   439
# documentation sections, marked by \if sectionname ... \endif.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   440
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   441
ENABLED_SECTIONS       = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   442
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   443
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   444
# the initial value of a variable or define consists of for it to appear in 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   445
# the documentation. If the initializer consists of more lines than specified 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   446
# here it will be hidden. Use a value of 0 to hide initializers completely. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   447
# The appearance of the initializer of individual variables and defines in the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   448
# documentation can be controlled using \showinitializer or \hideinitializer 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   449
# command in the documentation regardless of this setting.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   450
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   451
MAX_INITIALIZER_LINES  = 30
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   452
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   453
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   454
# at the bottom of the documentation of classes and structs. If set to YES the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   455
# list will mention the files that were used to generate the documentation.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   456
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   457
SHOW_USED_FILES        = NO
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   458
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   459
# If the sources in your project are distributed over multiple directories 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   460
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   461
# in the documentation. The default is NO.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   462
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   463
SHOW_DIRECTORIES       = NO
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   464
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   465
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   466
# This will remove the Files entry from the Quick Index and from the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   467
# Folder Tree View (if specified). The default is YES.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   468
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   469
SHOW_FILES             = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   470
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   471
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   472
# Namespaces page.  This will remove the Namespaces entry from the Quick Index
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   473
# and from the Folder Tree View (if specified). The default is YES.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   474
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   475
SHOW_NAMESPACES        = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   476
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   477
# The FILE_VERSION_FILTER tag can be used to specify a program or script that 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   478
# doxygen should invoke to get the current version for each file (typically from 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   479
# the version control system). Doxygen will invoke the program by executing (via 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   480
# popen()) the command <command> <input-file>, where <command> is the value of 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   481
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   482
# provided by doxygen. Whatever the program writes to standard output 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   483
# is used as the file version. See the manual for examples.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   484
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   485
FILE_VERSION_FILTER    = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   486
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   487
#---------------------------------------------------------------------------
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   488
# configuration options related to warning and progress messages
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   489
#---------------------------------------------------------------------------
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   490
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   491
# The QUIET tag can be used to turn on/off the messages that are generated 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   492
# by doxygen. Possible values are YES and NO. If left blank NO is used.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   493
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   494
QUIET                  = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   495
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   496
# The WARNINGS tag can be used to turn on/off the warning messages that are 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   497
# generated by doxygen. Possible values are YES and NO. If left blank 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   498
# NO is used.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   499
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   500
WARNINGS               = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   501
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   502
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   503
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   504
# automatically be disabled.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   505
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   506
WARN_IF_UNDOCUMENTED   = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   507
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   508
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   509
# potential errors in the documentation, such as not documenting some 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   510
# parameters in a documented function, or documenting parameters that 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   511
# don't exist or using markup commands wrongly.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   512
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   513
WARN_IF_DOC_ERROR      = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   514
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   515
# This WARN_NO_PARAMDOC option can be abled to get warnings for 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   516
# functions that are documented, but have no documentation for their parameters 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   517
# or return value. If set to NO (the default) doxygen will only warn about 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   518
# wrong or incomplete parameter documentation, but not about the absence of 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   519
# documentation.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   520
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   521
WARN_NO_PARAMDOC       = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   522
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   523
# The WARN_FORMAT tag determines the format of the warning messages that 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   524
# doxygen can produce. The string should contain the $file, $line, and $text 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   525
# tags, which will be replaced by the file and line number from which the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   526
# warning originated and the warning text. Optionally the format may contain 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   527
# $version, which will be replaced by the version of the file (if it could 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   528
# be obtained via FILE_VERSION_FILTER)
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   529
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   530
WARN_FORMAT            = "$file:$line: $text"
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   531
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   532
# The WARN_LOGFILE tag can be used to specify a file to which warning 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   533
# and error messages should be written. If left blank the output is written 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   534
# to stderr.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   535
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   536
WARN_LOGFILE           = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   537
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   538
#---------------------------------------------------------------------------
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   539
# configuration options related to the input files
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   540
#---------------------------------------------------------------------------
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   541
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   542
# The INPUT tag can be used to specify the files and/or directories that contain 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   543
# documented source files. You may enter file names like "myfile.cpp" or 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   544
# directories like "/usr/src/myproject". Separate the files or directories 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   545
# with spaces.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   546
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   547
INPUT                  = \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   548
../../include/unix/canfestival.h \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   549
../../include/can.h \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   550
../../include/can_driver.h \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   551
../../include/data.h \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   552
../../include/emcy.h \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   553
../../include/nmtMaster.h \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   554
../../include/nmtSlave.h \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   555
../../include/pdo.h \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   556
../../include/sdo.h \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   557
../../include/timers_driver.h \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   558
../../include/timer.h \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   559
../../include/states.h \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   560
../../include/objacces.h \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   561
../../src/nmtMaster.c \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   562
../../drivers/unix/unix.c \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   563
../../drivers/win32/win32.cpp \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   564
../../src/timer.c \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   565
../../src/objacces.c \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   566
../../src/states.c \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   567
../../drivers/timers_unix/timers_unix.c \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   568
../../src/sdo.c \
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   569
../../src/pdo.c
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   570
f9be4262c68d Add doxygen comments in headers file
greg
parents: 529
diff changeset
   571
#../../drivers/timers_win32/timers_win32.cpp \
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   572
# This tag can be used to specify the character encoding of the source files 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   573
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   574
# also the default input encoding. Doxygen uses libiconv (or the iconv built 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   575
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   576
# the list of possible encodings.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   577
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   578
INPUT_ENCODING         = UTF-8
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   579
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   580
# If the value of the INPUT tag contains directories, you can use the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   581
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   582
# and *.h) to filter out the source-files in the directories. If left 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   583
# blank the following patterns are tested: 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   584
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   585
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   586
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   587
FILE_PATTERNS          = *.c \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   588
                         *.cc \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   589
                         *.cxx \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   590
                         *.cpp \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   591
                         *.c++ \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   592
                         *.d \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   593
                         *.java \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   594
                         *.ii \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   595
                         *.ixx \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   596
                         *.ipp \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   597
                         *.i++ \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   598
                         *.inl \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   599
                         *.h \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   600
                         *.hh \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   601
                         *.hxx \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   602
                         *.hpp \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   603
                         *.h++ \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   604
                         *.idl \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   605
                         *.odl \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   606
                         *.cs \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   607
                         *.php \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   608
                         *.php3 \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   609
                         *.inc \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   610
                         *.m \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   611
                         *.mm \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   612
                         *.dox \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   613
                         *.py \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   614
                         *.C \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   615
                         *.CC \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   616
                         *.C++ \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   617
                         *.II \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   618
                         *.I++ \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   619
                         *.H \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   620
                         *.HH \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   621
                         *.H++ \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   622
                         *.CS \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   623
                         *.PHP \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   624
                         *.PHP3 \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   625
                         *.M \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   626
                         *.MM \
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   627
                         *.PY
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   628
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   629
# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   630
# should be searched for input files as well. Possible values are YES and NO. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   631
# If left blank NO is used.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   632
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   633
RECURSIVE              = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   634
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   635
# The EXCLUDE tag can be used to specify files and/or directories that should 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   636
# excluded from the INPUT source files. This way you can easily exclude a 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   637
# subdirectory from a directory tree whose root is specified with the INPUT tag.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   638
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   639
EXCLUDE                = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   640
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   641
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   642
# directories that are symbolic links (a Unix filesystem feature) are excluded 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   643
# from the input.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   644
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   645
EXCLUDE_SYMLINKS       = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   646
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   647
# If the value of the INPUT tag contains directories, you can use the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   648
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   649
# certain files from those directories. Note that the wildcards are matched 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   650
# against the file with absolute path, so to exclude all test directories 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   651
# for example use the pattern */test/*
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   652
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   653
EXCLUDE_PATTERNS       = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   654
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   655
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   656
# (namespaces, classes, functions, etc.) that should be excluded from the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   657
# output. The symbol name can be a fully qualified name, a word, or if the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   658
# wildcard * is used, a substring. Examples: ANamespace, AClass, 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   659
# AClass::ANamespace, ANamespace::*Test
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   660
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   661
EXCLUDE_SYMBOLS        = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   662
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   663
# The EXAMPLE_PATH tag can be used to specify one or more files or 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   664
# directories that contain example code fragments that are included (see 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   665
# the \include command).
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   666
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   667
EXAMPLE_PATH           =
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   668
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   669
# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   670
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   671
# and *.h) to filter out the source-files in the directories. If left 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   672
# blank all files are included.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   673
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   674
EXAMPLE_PATTERNS       = *
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   675
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   676
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   677
# searched for input files to be used with the \include or \dontinclude 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   678
# commands irrespective of the value of the RECURSIVE tag. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   679
# Possible values are YES and NO. If left blank NO is used.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   680
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   681
EXAMPLE_RECURSIVE      = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   682
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   683
# The IMAGE_PATH tag can be used to specify one or more files or 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   684
# directories that contain image that are included in the documentation (see 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   685
# the \image command).
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   686
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   687
IMAGE_PATH             = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   688
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   689
# The INPUT_FILTER tag can be used to specify a program that doxygen should 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   690
# invoke to filter for each input file. Doxygen will invoke the filter program 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   691
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   692
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   693
# input file. Doxygen will then use the output that the filter program writes 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   694
# to standard output.  If FILTER_PATTERNS is specified, this tag will be 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   695
# ignored.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   696
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   697
INPUT_FILTER           = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   698
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   699
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   700
# basis.  Doxygen will compare the file name with each pattern and apply the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   701
# filter if there is a match.  The filters are a list of the form: 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   702
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   703
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   704
# is applied to all files.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   705
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   706
FILTER_PATTERNS        = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   707
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   708
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   709
# INPUT_FILTER) will be used to filter the input files when producing source 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   710
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   711
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   712
FILTER_SOURCE_FILES    = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   713
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   714
#---------------------------------------------------------------------------
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   715
# configuration options related to source browsing
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   716
#---------------------------------------------------------------------------
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   717
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   718
# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   719
# be generated. Documented entities will be cross-referenced with these sources. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   720
# Note: To get rid of all source code in the generated output, make sure also 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   721
# VERBATIM_HEADERS is set to NO.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   722
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   723
SOURCE_BROWSER         = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   724
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   725
# Setting the INLINE_SOURCES tag to YES will include the body 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   726
# of functions and classes directly in the documentation.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   727
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   728
INLINE_SOURCES         = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   729
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   730
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   731
# doxygen to hide any special comment blocks from generated source code 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   732
# fragments. Normal C and C++ comments will always remain visible.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   733
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   734
STRIP_CODE_COMMENTS    = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   735
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   736
# If the REFERENCED_BY_RELATION tag is set to YES 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   737
# then for each documented function all documented 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   738
# functions referencing it will be listed.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   739
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents: 207
diff changeset
   740
REFERENCED_BY_RELATION = YES
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   741
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   742
# If the REFERENCES_RELATION tag is set to YES 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   743
# then for each documented function all documented entities 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   744
# called/used by that function will be listed.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   745
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   746
REFERENCES_RELATION    = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   747
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   748
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   749
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   750
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   751
# link to the source code.  Otherwise they will link to the documentstion.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   752
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   753
REFERENCES_LINK_SOURCE = YES
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   754
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   755
# If the USE_HTAGS tag is set to YES then the references to source code 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   756
# will point to the HTML generated by the htags(1) tool instead of doxygen 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   757
# built-in source browser. The htags tool is part of GNU's global source 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   758
# tagging system (see http://www.gnu.org/software/global/global.html). You 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   759
# will need version 4.8.6 or higher.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   760
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   761
USE_HTAGS              = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   762
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   763
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   764
# will generate a verbatim copy of the header file for each class for 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   765
# which an include is specified. Set to NO to disable this.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   766
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   767
VERBATIM_HEADERS       = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   768
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   769
#---------------------------------------------------------------------------
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   770
# configuration options related to the alphabetical class index
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   771
#---------------------------------------------------------------------------
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   772
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   773
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   774
# of all compounds will be generated. Enable this if the project 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   775
# contains a lot of classes, structs, unions or interfaces.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   776
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   777
ALPHABETICAL_INDEX     = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   778
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   779
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   780
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   781
# in which this list will be split (can be a number in the range [1..20])
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   782
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   783
COLS_IN_ALPHA_INDEX    = 5
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   784
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   785
# In case all classes in a project start with a common prefix, all 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   786
# classes will be put under the same header in the alphabetical index. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   787
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   788
# should be ignored while generating the index headers.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   789
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   790
IGNORE_PREFIX          = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   791
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   792
#---------------------------------------------------------------------------
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   793
# configuration options related to the HTML output
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   794
#---------------------------------------------------------------------------
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   795
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   796
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   797
# generate HTML output.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   798
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   799
GENERATE_HTML          = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   800
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   801
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   802
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   803
# put in front of it. If left blank `html' will be used as the default path.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   804
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   805
HTML_OUTPUT            = html
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   806
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   807
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   808
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   809
# doxygen will generate files with .html extension.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   810
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   811
HTML_FILE_EXTENSION    = .html
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   812
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   813
# The HTML_HEADER tag can be used to specify a personal HTML header for 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   814
# each generated HTML page. If it is left blank doxygen will generate a 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   815
# standard header.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   816
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   817
HTML_HEADER            = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   818
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   819
# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   820
# each generated HTML page. If it is left blank doxygen will generate a 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   821
# standard footer.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   822
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   823
HTML_FOOTER            = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   824
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   825
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   826
# style sheet that is used by each HTML page. It can be used to 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   827
# fine-tune the look of the HTML output. If the tag is left blank doxygen 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   828
# will generate a default style sheet. Note that doxygen will try to copy 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   829
# the style sheet file to the HTML output directory, so don't put your own 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   830
# stylesheet in the HTML output directory as well, or it will be erased!
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   831
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   832
HTML_STYLESHEET        = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   833
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   834
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   835
# files or namespaces will be aligned in HTML using tables. If set to 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   836
# NO a bullet list will be used.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   837
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   838
HTML_ALIGN_MEMBERS     = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   839
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   840
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   841
# will be generated that can be used as input for tools like the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   842
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   843
# of the generated HTML documentation.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   844
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   845
GENERATE_HTMLHELP      = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   846
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   847
# If the GENERATE_DOCSET tag is set to YES, additional index files 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   848
# will be generated that can be used as input for Apple's Xcode 3 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   849
# integrated development environment, introduced with OSX 10.5 (Leopard). 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   850
# To create a documentation set, doxygen will generate a Makefile in the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   851
# HTML output directory. Running make will produce the docset in that 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   852
# directory and running "make install" will install the docset in 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   853
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   854
# it at startup.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   855
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   856
GENERATE_DOCSET        = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   857
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   858
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   859
# feed. A documentation feed provides an umbrella under which multiple 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   860
# documentation sets from a single provider (such as a company or product suite) 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   861
# can be grouped.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   862
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   863
DOCSET_FEEDNAME        = "Doxygen generated docs"
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   864
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   865
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   866
# should uniquely identify the documentation set bundle. This should be a 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   867
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   868
# will append .docset to the name.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   869
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   870
DOCSET_BUNDLE_ID       = org.doxygen.Project
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   871
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   872
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   873
# documentation will contain sections that can be hidden and shown after the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   874
# page has loaded. For this to work a browser that supports 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   875
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   876
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   877
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   878
HTML_DYNAMIC_SECTIONS  = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   879
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   880
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   881
# be used to specify the file name of the resulting .chm file. You 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   882
# can add a path in front of the file if the result should not be 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   883
# written to the html output directory.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   884
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   885
CHM_FILE               = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   886
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   887
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   888
# be used to specify the location (absolute path including file name) of 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   889
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   890
# the HTML help compiler on the generated index.hhp.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   891
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   892
HHC_LOCATION           = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   893
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   894
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   895
# controls if a separate .chi index file is generated (YES) or that 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   896
# it should be included in the master .chm file (NO).
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   897
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   898
GENERATE_CHI           = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   899
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   900
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   901
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   902
# content.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   903
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   904
CHM_INDEX_ENCODING     = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   905
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   906
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   907
# controls whether a binary table of contents is generated (YES) or a 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   908
# normal table of contents (NO) in the .chm file.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   909
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   910
BINARY_TOC             = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   911
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   912
# The TOC_EXPAND flag can be set to YES to add extra items for group members 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   913
# to the contents of the HTML help documentation and to the tree view.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   914
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   915
TOC_EXPAND             = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   916
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   917
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   918
# top of each HTML page. The value NO (the default) enables the index and 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   919
# the value YES disables it.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   920
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   921
DISABLE_INDEX          = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   922
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   923
# This tag can be used to set the number of enum values (range [1..20]) 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   924
# that doxygen will group on one line in the generated HTML documentation.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   925
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   926
ENUM_VALUES_PER_LINE   = 4
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   927
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   928
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   929
# structure should be generated to display hierarchical information.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   930
# If the tag value is set to FRAME, a side panel will be generated
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   931
# containing a tree-like index structure (just like the one that 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   932
# is generated for HTML Help). For this to work a browser that supports 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   933
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   934
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   935
# probably better off using the HTML help feature. Other possible values 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   936
# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   937
# and Class Hiererachy pages using a tree view instead of an ordered list;
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   938
# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   939
# disables this behavior completely. For backwards compatibility with previous
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   940
# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   941
# respectively.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   942
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   943
GENERATE_TREEVIEW      = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   944
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   945
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   946
# used to set the initial width (in pixels) of the frame in which the tree 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   947
# is shown.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   948
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   949
TREEVIEW_WIDTH         = 250
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   950
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   951
# Use this tag to change the font size of Latex formulas included 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   952
# as images in the HTML documentation. The default is 10. Note that 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   953
# when you change the font size after a successful doxygen run you need 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   954
# to manually remove any form_*.png images from the HTML output directory 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   955
# to force them to be regenerated.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   956
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   957
FORMULA_FONTSIZE       = 10
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   958
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   959
#---------------------------------------------------------------------------
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   960
# configuration options related to the LaTeX output
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   961
#---------------------------------------------------------------------------
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   962
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   963
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   964
# generate Latex output.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   965
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   966
GENERATE_LATEX         = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   967
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   968
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   969
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   970
# put in front of it. If left blank `latex' will be used as the default path.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   971
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   972
LATEX_OUTPUT           = latex
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   973
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   974
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   975
# invoked. If left blank `latex' will be used as the default command name.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   976
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   977
LATEX_CMD_NAME         = latex
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   978
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   979
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   980
# generate index for LaTeX. If left blank `makeindex' will be used as the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   981
# default command name.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   982
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   983
MAKEINDEX_CMD_NAME     = makeindex
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   984
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   985
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   986
# LaTeX documents. This may be useful for small projects and may help to 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   987
# save some trees in general.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   988
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   989
COMPACT_LATEX          = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   990
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   991
# The PAPER_TYPE tag can be used to set the paper type that is used 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   992
# by the printer. Possible values are: a4, a4wide, letter, legal and 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   993
# executive. If left blank a4wide will be used.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   994
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   995
PAPER_TYPE             = a4wide
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   996
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   997
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   998
# packages that should be included in the LaTeX output.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
   999
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1000
EXTRA_PACKAGES         = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1001
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1002
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1003
# the generated latex document. The header should contain everything until 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1004
# the first chapter. If it is left blank doxygen will generate a 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1005
# standard header. Notice: only use this tag if you know what you are doing!
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1006
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1007
LATEX_HEADER           = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1008
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1009
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1010
# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1011
# contain links (just like the HTML output) instead of page references 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1012
# This makes the output suitable for online browsing using a pdf viewer.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1013
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1014
PDF_HYPERLINKS         = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1015
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1016
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1017
# plain latex in the generated Makefile. Set this option to YES to get a 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1018
# higher quality PDF documentation.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1019
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1020
USE_PDFLATEX           = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1021
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1022
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1023
# command to the generated LaTeX files. This will instruct LaTeX to keep 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1024
# running if errors occur, instead of asking the user for help. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1025
# This option is also used when generating formulas in HTML.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1026
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1027
LATEX_BATCHMODE        = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1028
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1029
# If LATEX_HIDE_INDICES is set to YES then doxygen will not 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1030
# include the index chapters (such as File Index, Compound Index, etc.) 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1031
# in the output.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1032
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1033
LATEX_HIDE_INDICES     = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1034
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1035
#---------------------------------------------------------------------------
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1036
# configuration options related to the RTF output
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1037
#---------------------------------------------------------------------------
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1038
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1039
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1040
# The RTF output is optimized for Word 97 and may not look very pretty with 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1041
# other RTF readers or editors.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1042
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1043
GENERATE_RTF           = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1044
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1045
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1046
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1047
# put in front of it. If left blank `rtf' will be used as the default path.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1048
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1049
RTF_OUTPUT             = rtf
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1050
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1051
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1052
# RTF documents. This may be useful for small projects and may help to 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1053
# save some trees in general.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1054
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1055
COMPACT_RTF            = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1056
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1057
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1058
# will contain hyperlink fields. The RTF file will 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1059
# contain links (just like the HTML output) instead of page references. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1060
# This makes the output suitable for online browsing using WORD or other 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1061
# programs which support those fields. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1062
# Note: wordpad (write) and others do not support links.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1063
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1064
RTF_HYPERLINKS         = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1065
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1066
# Load stylesheet definitions from file. Syntax is similar to doxygen's 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1067
# config file, i.e. a series of assignments. You only have to provide 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1068
# replacements, missing definitions are set to their default value.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1069
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1070
RTF_STYLESHEET_FILE    = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1071
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1072
# Set optional variables used in the generation of an rtf document. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1073
# Syntax is similar to doxygen's config file.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1074
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1075
RTF_EXTENSIONS_FILE    = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1076
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1077
#---------------------------------------------------------------------------
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1078
# configuration options related to the man page output
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1079
#---------------------------------------------------------------------------
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1080
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1081
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1082
# generate man pages
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1083
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1084
GENERATE_MAN           = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1085
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1086
# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1087
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1088
# put in front of it. If left blank `man' will be used as the default path.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1089
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1090
MAN_OUTPUT             = man
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1091
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1092
# The MAN_EXTENSION tag determines the extension that is added to 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1093
# the generated man pages (default is the subroutine's section .3)
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1094
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1095
MAN_EXTENSION          = .3
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1096
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1097
# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1098
# then it will generate one additional man file for each entity 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1099
# documented in the real man page(s). These additional files 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1100
# only source the real man page, but without them the man command 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1101
# would be unable to find the correct page. The default is NO.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1102
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1103
MAN_LINKS              = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1104
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1105
#---------------------------------------------------------------------------
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1106
# configuration options related to the XML output
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1107
#---------------------------------------------------------------------------
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1108
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1109
# If the GENERATE_XML tag is set to YES Doxygen will 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1110
# generate an XML file that captures the structure of 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1111
# the code including all documentation.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1112
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1113
GENERATE_XML           = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1114
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1115
# The XML_OUTPUT tag is used to specify where the XML pages will be put. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1116
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1117
# put in front of it. If left blank `xml' will be used as the default path.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1118
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1119
XML_OUTPUT             = xml
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1120
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1121
# The XML_SCHEMA tag can be used to specify an XML schema, 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1122
# which can be used by a validating XML parser to check the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1123
# syntax of the XML files.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1124
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1125
XML_SCHEMA             = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1126
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1127
# The XML_DTD tag can be used to specify an XML DTD, 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1128
# which can be used by a validating XML parser to check the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1129
# syntax of the XML files.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1130
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1131
XML_DTD                = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1132
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1133
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1134
# dump the program listings (including syntax highlighting 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1135
# and cross-referencing information) to the XML output. Note that 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1136
# enabling this will significantly increase the size of the XML output.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1137
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1138
XML_PROGRAMLISTING     = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1139
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1140
#---------------------------------------------------------------------------
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1141
# configuration options for the AutoGen Definitions output
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1142
#---------------------------------------------------------------------------
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1143
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1144
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1145
# generate an AutoGen Definitions (see autogen.sf.net) file 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1146
# that captures the structure of the code including all 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1147
# documentation. Note that this feature is still experimental 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1148
# and incomplete at the moment.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1149
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1150
GENERATE_AUTOGEN_DEF   = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1151
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1152
#---------------------------------------------------------------------------
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1153
# configuration options related to the Perl module output
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1154
#---------------------------------------------------------------------------
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1155
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1156
# If the GENERATE_PERLMOD tag is set to YES Doxygen will 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1157
# generate a Perl module file that captures the structure of 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1158
# the code including all documentation. Note that this 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1159
# feature is still experimental and incomplete at the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1160
# moment.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1161
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1162
GENERATE_PERLMOD       = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1163
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1164
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1165
# the necessary Makefile rules, Perl scripts and LaTeX code to be able 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1166
# to generate PDF and DVI output from the Perl module output.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1167
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1168
PERLMOD_LATEX          = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1169
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1170
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1171
# nicely formatted so it can be parsed by a human reader.  This is useful 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1172
# if you want to understand what is going on.  On the other hand, if this 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1173
# tag is set to NO the size of the Perl module output will be much smaller 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1174
# and Perl will parse it just the same.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1175
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1176
PERLMOD_PRETTY         = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1177
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1178
# The names of the make variables in the generated doxyrules.make file 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1179
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1180
# This is useful so different doxyrules.make files included by the same 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1181
# Makefile don't overwrite each other's variables.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1182
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1183
PERLMOD_MAKEVAR_PREFIX = 
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1184
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1185
#---------------------------------------------------------------------------
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1186
# Configuration options related to the preprocessor   
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1187
#---------------------------------------------------------------------------
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1188
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1189
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1190
# evaluate all C-preprocessor directives found in the sources and include 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1191
# files.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1192
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1193
ENABLE_PREPROCESSING   = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1194
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1195
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1196
# names in the source code. If set to NO (the default) only conditional 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1197
# compilation will be performed. Macro expansion can be done in a controlled 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1198
# way by setting EXPAND_ONLY_PREDEF to YES.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1199
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1200
MACRO_EXPANSION        = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1201
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1202
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1203
# then the macro expansion is limited to the macros specified with the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1204
# PREDEFINED and EXPAND_AS_DEFINED tags.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1205
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1206
EXPAND_ONLY_PREDEF     = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1207
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1208
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1209
# in the INCLUDE_PATH (see below) will be search if a #include is found.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1210
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1211
SEARCH_INCLUDES        = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1212
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1213
# The INCLUDE_PATH tag can be used to specify one or more directories that 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1214
# contain include files that are not input files but should be processed by 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1215
# the preprocessor.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1216
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1217
INCLUDE_PATH           = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1218
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1219
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1220
# patterns (like *.h and *.hpp) to filter out the header-files in the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1221
# directories. If left blank, the patterns specified with FILE_PATTERNS will 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1222
# be used.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1223
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1224
INCLUDE_FILE_PATTERNS  = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1225
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1226
# The PREDEFINED tag can be used to specify one or more macro names that 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1227
# are defined before the preprocessor is started (similar to the -D option of 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1228
# gcc). The argument of the tag is a list of macros of the form: name 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1229
# or name=definition (no spaces). If the definition and the = are 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1230
# omitted =1 is assumed. To prevent a macro definition from being 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1231
# undefined via #undef or recursively expanded use the := operator 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1232
# instead of the = operator.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1233
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1234
PREDEFINED             = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1235
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1236
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1237
# this tag can be used to specify a list of macro names that should be expanded. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1238
# The macro definition that is found in the sources will be used. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1239
# Use the PREDEFINED tag if you want to use a different macro definition.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1240
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1241
EXPAND_AS_DEFINED      = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1242
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1243
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1244
# doxygen's preprocessor will remove all function-like macros that are alone 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1245
# on a line, have an all uppercase name, and do not end with a semicolon. Such 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1246
# function macros are typically used for boiler-plate code, and will confuse 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1247
# the parser if not removed.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1248
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1249
SKIP_FUNCTION_MACROS   = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1250
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1251
#---------------------------------------------------------------------------
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1252
# Configuration::additions related to external references   
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1253
#---------------------------------------------------------------------------
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1254
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1255
# The TAGFILES option can be used to specify one or more tagfiles. 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1256
# Optionally an initial location of the external documentation 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1257
# can be added for each tagfile. The format of a tag file without 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1258
# this location is as follows: 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1259
#   TAGFILES = file1 file2 ... 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1260
# Adding location for the tag files is done as follows: 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1261
#   TAGFILES = file1=loc1 "file2 = loc2" ... 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1262
# where "loc1" and "loc2" can be relative or absolute paths or 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1263
# URLs. If a location is present for each tag, the installdox tool 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1264
# does not have to be run to correct the links.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1265
# Note that each tag file must have a unique name
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1266
# (where the name does NOT include the path)
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1267
# If a tag file is not located in the directory in which doxygen 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1268
# is run, you must also specify the path to the tagfile here.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1269
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1270
TAGFILES               = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1271
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1272
# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1273
# a tag file that is based on the input files it reads.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1274
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1275
GENERATE_TAGFILE       = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1276
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1277
# If the ALLEXTERNALS tag is set to YES all external classes will be listed 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1278
# in the class index. If set to NO only the inherited external classes 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1279
# will be listed.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1280
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1281
ALLEXTERNALS           = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1282
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1283
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1284
# in the modules index. If set to NO, only the current project's groups will 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1285
# be listed.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1286
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1287
EXTERNAL_GROUPS        = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1288
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1289
# The PERL_PATH should be the absolute path and name of the perl script 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1290
# interpreter (i.e. the result of `which perl').
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1291
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1292
PERL_PATH              = /usr/bin/perl
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1293
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1294
#---------------------------------------------------------------------------
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1295
# Configuration options related to the dot tool   
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1296
#---------------------------------------------------------------------------
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1297
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1298
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1299
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1300
# or super classes. Setting the tag to NO turns the diagrams off. Note that 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1301
# this option is superseded by the HAVE_DOT option below. This is only a 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1302
# fallback. It is recommended to install and use dot, since it yields more 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1303
# powerful graphs.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1304
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1305
CLASS_DIAGRAMS         = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1306
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1307
# You can define message sequence charts within doxygen comments using the \msc 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1308
# command. Doxygen will then run the mscgen tool (see 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1309
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1310
# documentation. The MSCGEN_PATH tag allows you to specify the directory where 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1311
# the mscgen tool resides. If left empty the tool is assumed to be found in the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1312
# default search path.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1313
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1314
MSCGEN_PATH            = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1315
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1316
# If set to YES, the inheritance and collaboration graphs will hide 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1317
# inheritance and usage relations if the target is undocumented 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1318
# or is not a class.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1319
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1320
HIDE_UNDOC_RELATIONS   = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1321
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1322
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1323
# available from the path. This tool is part of Graphviz, a graph visualization 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1324
# toolkit from AT&T and Lucent Bell Labs. The other options in this section 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1325
# have no effect if this option is set to NO (the default)
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1326
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1327
HAVE_DOT               = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1328
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1329
# By default doxygen will write a font called FreeSans.ttf to the output 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1330
# directory and reference it in all dot files that doxygen generates. This 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1331
# font does not include all possible unicode characters however, so when you need 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1332
# these (or just want a differently looking font) you can specify the font name 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1333
# using DOT_FONTNAME. You need need to make sure dot is able to find the font, 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1334
# which can be done by putting it in a standard location or by setting the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1335
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1336
# containing the font.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1337
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1338
DOT_FONTNAME           = FreeSans
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1339
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1340
# By default doxygen will tell dot to use the output directory to look for the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1341
# FreeSans.ttf font (which doxygen will put there itself). If you specify a 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1342
# different font using DOT_FONTNAME you can set the path where dot 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1343
# can find it using this tag.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1344
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1345
DOT_FONTPATH           = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1346
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1347
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1348
# will generate a graph for each documented class showing the direct and 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1349
# indirect inheritance relations. Setting this tag to YES will force the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1350
# the CLASS_DIAGRAMS tag to NO.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1351
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1352
CLASS_GRAPH            = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1353
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1354
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1355
# will generate a graph for each documented class showing the direct and 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1356
# indirect implementation dependencies (inheritance, containment, and 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1357
# class references variables) of the class with other documented classes.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1358
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1359
COLLABORATION_GRAPH    = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1360
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1361
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1362
# will generate a graph for groups, showing the direct groups dependencies
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1363
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1364
GROUP_GRAPHS           = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1365
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1366
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1367
# collaboration diagrams in a style similar to the OMG's Unified Modeling 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1368
# Language.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1369
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1370
UML_LOOK               = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1371
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1372
# If set to YES, the inheritance and collaboration graphs will show the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1373
# relations between templates and their instances.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1374
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1375
TEMPLATE_RELATIONS     = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1376
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1377
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1378
# tags are set to YES then doxygen will generate a graph for each documented 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1379
# file showing the direct and indirect include dependencies of the file with 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1380
# other documented files.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1381
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1382
INCLUDE_GRAPH          = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1383
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1384
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1385
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1386
# documented header file showing the documented files that directly or 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1387
# indirectly include this file.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1388
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1389
INCLUDED_BY_GRAPH      = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1390
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1391
# If the CALL_GRAPH and HAVE_DOT options are set to YES then 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1392
# doxygen will generate a call dependency graph for every global function 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1393
# or class method. Note that enabling this option will significantly increase 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1394
# the time of a run. So in most cases it will be better to enable call graphs 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1395
# for selected functions only using the \callgraph command.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1396
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1397
CALL_GRAPH             = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1398
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1399
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1400
# doxygen will generate a caller dependency graph for every global function 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1401
# or class method. Note that enabling this option will significantly increase 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1402
# the time of a run. So in most cases it will be better to enable caller 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1403
# graphs for selected functions only using the \callergraph command.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1404
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1405
CALLER_GRAPH           = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1406
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1407
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1408
# will graphical hierarchy of all classes instead of a textual one.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1409
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1410
GRAPHICAL_HIERARCHY    = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1411
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1412
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1413
# then doxygen will show the dependencies a directory has on other directories 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1414
# in a graphical way. The dependency relations are determined by the #include
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1415
# relations between the files in the directories.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1416
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1417
DIRECTORY_GRAPH        = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1418
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1419
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1420
# generated by dot. Possible values are png, jpg, or gif
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1421
# If left blank png will be used.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1422
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1423
DOT_IMAGE_FORMAT       = png
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1424
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1425
# The tag DOT_PATH can be used to specify the path where the dot tool can be 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1426
# found. If left blank, it is assumed the dot tool can be found in the path.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1427
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1428
DOT_PATH               = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1429
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1430
# The DOTFILE_DIRS tag can be used to specify one or more directories that 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1431
# contain dot files that are included in the documentation (see the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1432
# \dotfile command).
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1433
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1434
DOTFILE_DIRS           = 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1435
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1436
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1437
# nodes that will be shown in the graph. If the number of nodes in a graph 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1438
# becomes larger than this value, doxygen will truncate the graph, which is 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1439
# visualized by representing a node as a red box. Note that doxygen if the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1440
# number of direct children of the root node in a graph is already larger than 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1441
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1442
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1443
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1444
DOT_GRAPH_MAX_NODES    = 50
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1445
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1446
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1447
# graphs generated by dot. A depth value of 3 means that only nodes reachable 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1448
# from the root by following a path via at most 3 edges will be shown. Nodes 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1449
# that lay further from the root node will be omitted. Note that setting this 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1450
# option to 1 or 2 may greatly reduce the computation time needed for large 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1451
# code bases. Also note that the size of a graph can be further restricted by 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1452
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1453
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1454
MAX_DOT_GRAPH_DEPTH    = 1000
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1455
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1456
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1457
# background. This is enabled by default, which results in a transparent 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1458
# background. Warning: Depending on the platform used, enabling this option 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1459
# may lead to badly anti-aliased labels on the edges of a graph (i.e. they 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1460
# become hard to read).
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1461
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1462
DOT_TRANSPARENT        = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1463
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1464
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1465
# files in one run (i.e. multiple -o and -T options on the command line). This 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1466
# makes dot run faster, but since only newer versions of dot (>1.8.10) 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1467
# support this, this feature is disabled by default.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1468
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1469
DOT_MULTI_TARGETS      = NO
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1470
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1471
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1472
# generate a legend page explaining the meaning of the various boxes and 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1473
# arrows in the dot generated graphs.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1474
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1475
GENERATE_LEGEND        = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1476
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1477
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1478
# remove the intermediate dot files that are used to generate 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1479
# the various graphs.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1480
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1481
DOT_CLEANUP            = YES
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1482
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1483
#---------------------------------------------------------------------------
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1484
# Configuration::additions related to the search engine   
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
  1485
#---------------------------------------------------------------------------
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1486
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1487
# The SEARCHENGINE tag specifies whether or not a search engine should be 
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1488
# used. If set to NO the values of all tags below this one will be ignored.
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1489
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 464
diff changeset
  1490
SEARCHENGINE           = NO