project_files/frontlib/hw_doc.doxygen
author Wuzzy <Wuzzy2@mail.ru>
Thu, 08 Oct 2020 12:33:14 +0200
changeset 15742 0b5aea8e5eab
parent 8262 f01702bfb764
permissions -rw-r--r--
Fix hammer not digging when hitting hog with 0 health
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
8262
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
     1
# Doxyfile 1.8.2
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
     2
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
     3
# This file describes the settings to be used by the documentation system
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
     4
# doxygen (www.doxygen.org) for a project
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
     5
#
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
     6
# All text after a hash (#) is considered a comment and will be ignored
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
     7
# The format is:
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
     8
#       TAG = value [value, ...]
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
     9
# For lists items can also be appended using:
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    10
#       TAG += value [value, ...]
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    11
# Values that contain spaces should be placed between quotes (" ")
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    12
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    13
#---------------------------------------------------------------------------
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    14
# Project related configuration options
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    15
#---------------------------------------------------------------------------
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    16
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    17
# This tag specifies the encoding used for all characters in the config file 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    18
# that follow. The default is UTF-8 which is also the encoding used for all 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    19
# text before the first occurrence of this tag. Doxygen uses libiconv (or the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    20
# iconv built into libc) for the transcoding. See 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    21
# http://www.gnu.org/software/libiconv for the list of possible encodings.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    22
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    23
DOXYFILE_ENCODING      = UTF-8
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    24
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    25
# The PROJECT_NAME tag is a single word (or sequence of words) that should 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    26
# identify the project. Note that if you do not use Doxywizard you need 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    27
# to put quotes around the project name if it contains spaces.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    28
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    29
PROJECT_NAME           = "HW Frontlib"
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    30
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    31
# The PROJECT_NUMBER tag can be used to enter a project or revision number. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    32
# This could be handy for archiving the generated documentation or 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    33
# if some version control system is used.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    34
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    35
PROJECT_NUMBER         = ""
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    36
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    37
# Using the PROJECT_BRIEF tag one can provide an optional one line description 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    38
# for a project that appears at the top of each page and should give viewer 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    39
# a quick idea about the purpose of the project. Keep the description short.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    40
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    41
PROJECT_BRIEF          = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    42
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    43
# With the PROJECT_LOGO tag one can specify an logo or icon that is 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    44
# included in the documentation. The maximum height of the logo should not 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    45
# exceed 55 pixels and the maximum width should not exceed 200 pixels. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    46
# Doxygen will copy the logo to the output directory.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    47
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    48
PROJECT_LOGO           = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    49
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    50
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    51
# base path where the generated documentation will be put. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    52
# If a relative path is entered, it will be relative to the location 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    53
# where doxygen was started. If left blank the current directory will be used.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    54
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    55
OUTPUT_DIRECTORY       = "doc"
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    56
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    57
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    58
# 4096 sub-directories (in 2 levels) under the output directory of each output 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    59
# format and will distribute the generated files over these directories. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    60
# Enabling this option can be useful when feeding doxygen a huge amount of 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    61
# source files, where putting all generated files in the same directory would 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    62
# otherwise cause performance problems for the file system.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    63
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    64
CREATE_SUBDIRS         = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    65
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    66
# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    67
# documentation generated by doxygen is written. Doxygen will use this 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    68
# information to generate all constant output in the proper language. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    69
# The default language is English, other supported languages are: 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    70
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    71
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    72
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    73
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    74
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    75
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    76
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    77
OUTPUT_LANGUAGE        = English
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    78
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    79
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    80
# include brief member descriptions after the members that are listed in 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    81
# the file and class documentation (similar to JavaDoc). 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    82
# Set to NO to disable this.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    83
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    84
BRIEF_MEMBER_DESC      = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    85
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    86
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    87
# the brief description of a member or function before the detailed description. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    88
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    89
# brief descriptions will be completely suppressed.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    90
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    91
REPEAT_BRIEF           = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    92
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    93
# This tag implements a quasi-intelligent brief description abbreviator 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    94
# that is used to form the text in various listings. Each string 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    95
# in this list, if found as the leading text of the brief description, will be 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    96
# stripped from the text and the result after processing the whole list, is 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    97
# used as the annotated text. Otherwise, the brief description is used as-is. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    98
# If left blank, the following values are used ("$name" is automatically 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
    99
# replaced with the name of the entity): "The $name class" "The $name widget" 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   100
# "The $name file" "is" "provides" "specifies" "contains" 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   101
# "represents" "a" "an" "the"
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   102
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   103
ABBREVIATE_BRIEF       = "The $name class" \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   104
                         "The $name widget" \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   105
                         "The $name file" \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   106
                         is \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   107
                         provides \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   108
                         specifies \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   109
                         contains \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   110
                         represents \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   111
                         a \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   112
                         an \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   113
                         the
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   114
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   115
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   116
# Doxygen will generate a detailed section even if there is only a brief 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   117
# description.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   118
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   119
ALWAYS_DETAILED_SEC    = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   120
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   121
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   122
# inherited members of a class in the documentation of that class as if those 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   123
# members were ordinary class members. Constructors, destructors and assignment 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   124
# operators of the base classes will not be shown.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   125
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   126
INLINE_INHERITED_MEMB  = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   127
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   128
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   129
# path before files name in the file list and in the header files. If set 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   130
# to NO the shortest path that makes the file name unique will be used.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   131
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   132
FULL_PATH_NAMES        = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   133
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   134
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   135
# can be used to strip a user-defined part of the path. Stripping is 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   136
# only done if one of the specified strings matches the left-hand part of 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   137
# the path. The tag can be used to show relative paths in the file list. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   138
# If left blank the directory from which doxygen is run is used as the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   139
# path to strip. Note that you specify absolute paths here, but also 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   140
# relative paths, which will be relative from the directory where doxygen is 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   141
# started.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   142
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   143
STRIP_FROM_PATH        = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   144
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   145
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   146
# the path mentioned in the documentation of a class, which tells 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   147
# the reader which header file to include in order to use a class. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   148
# If left blank only the name of the header file containing the class 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   149
# definition is used. Otherwise one should specify the include paths that 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   150
# are normally passed to the compiler using the -I flag.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   151
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   152
STRIP_FROM_INC_PATH    = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   153
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   154
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   155
# (but less readable) file names. This can be useful if your file system 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   156
# doesn't support long names like on DOS, Mac, or CD-ROM.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   157
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   158
SHORT_NAMES            = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   159
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   160
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   161
# will interpret the first line (until the first dot) of a JavaDoc-style 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   162
# comment as the brief description. If set to NO, the JavaDoc 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   163
# comments will behave just like regular Qt-style comments 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   164
# (thus requiring an explicit @brief command for a brief description.)
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   165
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   166
JAVADOC_AUTOBRIEF      = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   167
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   168
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   169
# interpret the first line (until the first dot) of a Qt-style 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   170
# comment as the brief description. If set to NO, the comments 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   171
# will behave just like regular Qt-style comments (thus requiring 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   172
# an explicit \brief command for a brief description.)
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   173
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   174
QT_AUTOBRIEF           = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   175
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   176
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   177
# treat a multi-line C++ special comment block (i.e. a block of //! or /// 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   178
# comments) as a brief description. This used to be the default behaviour. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   179
# The new default is to treat a multi-line C++ comment block as a detailed 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   180
# description. Set this tag to YES if you prefer the old behaviour instead.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   181
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   182
MULTILINE_CPP_IS_BRIEF = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   183
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   184
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   185
# member inherits the documentation from any documented member that it 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   186
# re-implements.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   187
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   188
INHERIT_DOCS           = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   189
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   190
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   191
# a new page for each member. If set to NO, the documentation of a member will 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   192
# be part of the file/class/namespace that contains it.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   193
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   194
SEPARATE_MEMBER_PAGES  = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   195
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   196
# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   197
# Doxygen uses this value to replace tabs by spaces in code fragments.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   198
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   199
TAB_SIZE               = 4
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   200
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   201
# This tag can be used to specify a number of aliases that acts 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   202
# as commands in the documentation. An alias has the form "name=value". 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   203
# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   204
# put the command \sideeffect (or @sideeffect) in the documentation, which 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   205
# will result in a user-defined paragraph with heading "Side Effects:". 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   206
# You can put \n's in the value part of an alias to insert newlines.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   207
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   208
ALIASES                = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   209
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   210
# This tag can be used to specify a number of word-keyword mappings (TCL only). 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   211
# A mapping has the form "name=value". For example adding 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   212
# "class=itcl::class" will allow you to use the command class in the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   213
# itcl::class meaning.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   214
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   215
TCL_SUBST              = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   216
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   217
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   218
# sources only. Doxygen will then generate output that is more tailored for C. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   219
# For instance, some of the names that are used will be different. The list 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   220
# of all members will be omitted, etc.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   221
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   222
OPTIMIZE_OUTPUT_FOR_C  = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   223
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   224
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   225
# sources only. Doxygen will then generate output that is more tailored for 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   226
# Java. For instance, namespaces will be presented as packages, qualified 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   227
# scopes will look different, etc.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   228
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   229
OPTIMIZE_OUTPUT_JAVA   = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   230
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   231
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   232
# sources only. Doxygen will then generate output that is more tailored for 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   233
# Fortran.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   234
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   235
OPTIMIZE_FOR_FORTRAN   = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   236
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   237
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   238
# sources. Doxygen will then generate output that is tailored for 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   239
# VHDL.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   240
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   241
OPTIMIZE_OUTPUT_VHDL   = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   242
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   243
# Doxygen selects the parser to use depending on the extension of the files it 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   244
# parses. With this tag you can assign which parser to use for a given 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   245
# extension. Doxygen has a built-in mapping, but you can override or extend it 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   246
# using this tag. The format is ext=language, where ext is a file extension, 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   247
# and language is one of the parsers supported by doxygen: IDL, Java, 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   248
# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   249
# C++. For instance to make doxygen treat .inc files as Fortran files (default 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   250
# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   251
# that for custom extensions you also need to set FILE_PATTERNS otherwise the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   252
# files are not read by doxygen.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   253
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   254
EXTENSION_MAPPING      = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   255
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   256
# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   257
# comments according to the Markdown format, which allows for more readable 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   258
# documentation. See http://daringfireball.net/projects/markdown/ for details. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   259
# The output of markdown processing is further processed by doxygen, so you 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   260
# can mix doxygen, HTML, and XML commands with Markdown formatting. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   261
# Disable only in case of backward compatibilities issues.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   262
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   263
MARKDOWN_SUPPORT       = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   264
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   265
# When enabled doxygen tries to link words that correspond to documented classes, 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   266
# or namespaces to their corresponding documentation. Such a link can be 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   267
# prevented in individual cases by by putting a % sign in front of the word or 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   268
# globally by setting AUTOLINK_SUPPORT to NO.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   269
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   270
AUTOLINK_SUPPORT       = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   271
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   272
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   273
# to include (a tag file for) the STL sources as input, then you should 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   274
# set this tag to YES in order to let doxygen match functions declarations and 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   275
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   276
# func(std::string) {}). This also makes the inheritance and collaboration 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   277
# diagrams that involve STL classes more complete and accurate.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   278
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   279
BUILTIN_STL_SUPPORT    = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   280
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   281
# If you use Microsoft's C++/CLI language, you should set this option to YES to 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   282
# enable parsing support.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   283
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   284
CPP_CLI_SUPPORT        = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   285
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   286
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   287
# Doxygen will parse them like normal C++ but will assume all classes use public 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   288
# instead of private inheritance when no explicit protection keyword is present.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   289
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   290
SIP_SUPPORT            = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   291
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   292
# For Microsoft's IDL there are propget and propput attributes to indicate
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   293
# getter and setter methods for a property. Setting this option to YES (the
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   294
# default) will make doxygen replace the get and set methods by a property in
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   295
# the documentation. This will only work if the methods are indeed getting or
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   296
# setting a simple type. If this is not the case, or you want to show the
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   297
# methods anyway, you should set this option to NO.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   298
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   299
IDL_PROPERTY_SUPPORT   = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   300
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   301
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   302
# tag is set to YES, then doxygen will reuse the documentation of the first 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   303
# member in the group (if any) for the other members of the group. By default 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   304
# all members of a group must be documented explicitly.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   305
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   306
DISTRIBUTE_GROUP_DOC   = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   307
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   308
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   309
# the same type (for instance a group of public functions) to be put as a 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   310
# subgroup of that type (e.g. under the Public Functions section). Set it to 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   311
# NO to prevent subgrouping. Alternatively, this can be done per class using 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   312
# the \nosubgrouping command.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   313
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   314
SUBGROUPING            = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   315
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   316
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   317
# unions are shown inside the group in which they are included (e.g. using 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   318
# @ingroup) instead of on a separate page (for HTML and Man pages) or 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   319
# section (for LaTeX and RTF).
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   320
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   321
INLINE_GROUPED_CLASSES = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   322
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   323
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   324
# unions with only public data fields will be shown inline in the documentation 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   325
# of the scope in which they are defined (i.e. file, namespace, or group 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   326
# documentation), provided this scope is documented. If set to NO (the default), 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   327
# structs, classes, and unions are shown on a separate page (for HTML and Man 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   328
# pages) or section (for LaTeX and RTF).
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   329
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   330
INLINE_SIMPLE_STRUCTS  = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   331
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   332
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   333
# is documented as struct, union, or enum with the name of the typedef. So 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   334
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   335
# with name TypeT. When disabled the typedef will appear as a member of a file, 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   336
# namespace, or class. And the struct will be named TypeS. This can typically 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   337
# be useful for C code in case the coding convention dictates that all compound 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   338
# types are typedef'ed and only the typedef is referenced, never the tag name.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   339
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   340
TYPEDEF_HIDES_STRUCT   = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   341
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   342
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   343
# determine which symbols to keep in memory and which to flush to disk. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   344
# When the cache is full, less often used symbols will be written to disk. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   345
# For small to medium size projects (<1000 input files) the default value is 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   346
# probably good enough. For larger projects a too small cache size can cause 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   347
# doxygen to be busy swapping symbols to and from disk most of the time 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   348
# causing a significant performance penalty. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   349
# If the system has enough physical memory increasing the cache will improve the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   350
# performance by keeping more symbols in memory. Note that the value works on 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   351
# a logarithmic scale so increasing the size by one will roughly double the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   352
# memory usage. The cache size is given by this formula: 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   353
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   354
# corresponding to a cache size of 2^16 = 65536 symbols.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   355
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   356
SYMBOL_CACHE_SIZE      = 0
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   357
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   358
# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   359
# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   360
# their name and scope. Since this can be an expensive process and often the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   361
# same symbol appear multiple times in the code, doxygen keeps a cache of 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   362
# pre-resolved symbols. If the cache is too small doxygen will become slower. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   363
# If the cache is too large, memory is wasted. The cache size is given by this 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   364
# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   365
# corresponding to a cache size of 2^16 = 65536 symbols.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   366
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   367
LOOKUP_CACHE_SIZE      = 0
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   368
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   369
#---------------------------------------------------------------------------
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   370
# Build related configuration options
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   371
#---------------------------------------------------------------------------
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   372
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   373
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   374
# documentation are documented, even if no documentation was available. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   375
# Private class members and static file members will be hidden unless 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   376
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   377
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   378
EXTRACT_ALL            = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   379
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   380
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   381
# will be included in the documentation.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   382
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   383
EXTRACT_PRIVATE        = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   384
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   385
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   386
# scope will be included in the documentation.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   387
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   388
EXTRACT_PACKAGE        = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   389
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   390
# If the EXTRACT_STATIC tag is set to YES all static members of a file 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   391
# will be included in the documentation.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   392
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   393
EXTRACT_STATIC         = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   394
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   395
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   396
# defined locally in source files will be included in the documentation. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   397
# If set to NO only classes defined in header files are included.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   398
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   399
EXTRACT_LOCAL_CLASSES  = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   400
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   401
# This flag is only useful for Objective-C code. When set to YES local 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   402
# methods, which are defined in the implementation section but not in 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   403
# the interface are included in the documentation. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   404
# If set to NO (the default) only methods in the interface are included.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   405
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   406
EXTRACT_LOCAL_METHODS  = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   407
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   408
# If this flag is set to YES, the members of anonymous namespaces will be 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   409
# extracted and appear in the documentation as a namespace called 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   410
# 'anonymous_namespace{file}', where file will be replaced with the base 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   411
# name of the file that contains the anonymous namespace. By default 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   412
# anonymous namespaces are hidden.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   413
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   414
EXTRACT_ANON_NSPACES   = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   415
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   416
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   417
# undocumented members of documented classes, files or namespaces. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   418
# If set to NO (the default) these members will be included in the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   419
# various overviews, but no documentation section is generated. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   420
# This option has no effect if EXTRACT_ALL is enabled.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   421
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   422
HIDE_UNDOC_MEMBERS     = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   423
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   424
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   425
# undocumented classes that are normally visible in the class hierarchy. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   426
# If set to NO (the default) these classes will be included in the various 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   427
# overviews. This option has no effect if EXTRACT_ALL is enabled.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   428
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   429
HIDE_UNDOC_CLASSES     = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   430
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   431
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   432
# friend (class|struct|union) declarations. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   433
# If set to NO (the default) these declarations will be included in the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   434
# documentation.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   435
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   436
HIDE_FRIEND_COMPOUNDS  = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   437
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   438
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   439
# documentation blocks found inside the body of a function. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   440
# If set to NO (the default) these blocks will be appended to the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   441
# function's detailed documentation block.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   442
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   443
HIDE_IN_BODY_DOCS      = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   444
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   445
# The INTERNAL_DOCS tag determines if documentation 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   446
# that is typed after a \internal command is included. If the tag is set 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   447
# to NO (the default) then the documentation will be excluded. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   448
# Set it to YES to include the internal documentation.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   449
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   450
INTERNAL_DOCS          = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   451
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   452
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   453
# file names in lower-case letters. If set to YES upper-case letters are also 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   454
# allowed. This is useful if you have classes or files whose names only differ 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   455
# in case and if your file system supports case sensitive file names. Windows 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   456
# and Mac users are advised to set this option to NO.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   457
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   458
CASE_SENSE_NAMES       = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   459
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   460
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   461
# will show members with their full class and namespace scopes in the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   462
# documentation. If set to YES the scope will be hidden.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   463
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   464
HIDE_SCOPE_NAMES       = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   465
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   466
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   467
# will put a list of the files that are included by a file in the documentation 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   468
# of that file.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   469
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   470
SHOW_INCLUDE_FILES     = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   471
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   472
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   473
# will list include files with double quotes in the documentation 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   474
# rather than with sharp brackets.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   475
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   476
FORCE_LOCAL_INCLUDES   = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   477
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   478
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   479
# is inserted in the documentation for inline members.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   480
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   481
INLINE_INFO            = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   482
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   483
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   484
# will sort the (detailed) documentation of file and class members 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   485
# alphabetically by member name. If set to NO the members will appear in 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   486
# declaration order.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   487
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   488
SORT_MEMBER_DOCS       = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   489
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   490
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   491
# brief documentation of file, namespace and class members alphabetically 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   492
# by member name. If set to NO (the default) the members will appear in 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   493
# declaration order.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   494
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   495
SORT_BRIEF_DOCS        = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   496
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   497
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   498
# will sort the (brief and detailed) documentation of class members so that 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   499
# constructors and destructors are listed first. If set to NO (the default) 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   500
# the constructors will appear in the respective orders defined by 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   501
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   502
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   503
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   504
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   505
SORT_MEMBERS_CTORS_1ST = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   506
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   507
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   508
# hierarchy of group names into alphabetical order. If set to NO (the default) 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   509
# the group names will appear in their defined order.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   510
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   511
SORT_GROUP_NAMES       = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   512
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   513
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   514
# sorted by fully-qualified names, including namespaces. If set to 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   515
# NO (the default), the class list will be sorted only by class name, 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   516
# not including the namespace part. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   517
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   518
# Note: This option applies only to the class list, not to the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   519
# alphabetical list.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   520
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   521
SORT_BY_SCOPE_NAME     = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   522
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   523
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   524
# do proper type resolution of all parameters of a function it will reject a 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   525
# match between the prototype and the implementation of a member function even 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   526
# if there is only one candidate or it is obvious which candidate to choose 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   527
# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   528
# will still accept a match between prototype and implementation in such cases.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   529
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   530
STRICT_PROTO_MATCHING  = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   531
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   532
# The GENERATE_TODOLIST tag can be used to enable (YES) or 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   533
# disable (NO) the todo list. This list is created by putting \todo 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   534
# commands in the documentation.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   535
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   536
GENERATE_TODOLIST      = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   537
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   538
# The GENERATE_TESTLIST tag can be used to enable (YES) or 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   539
# disable (NO) the test list. This list is created by putting \test 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   540
# commands in the documentation.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   541
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   542
GENERATE_TESTLIST      = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   543
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   544
# The GENERATE_BUGLIST tag can be used to enable (YES) or 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   545
# disable (NO) the bug list. This list is created by putting \bug 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   546
# commands in the documentation.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   547
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   548
GENERATE_BUGLIST       = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   549
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   550
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   551
# disable (NO) the deprecated list. This list is created by putting 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   552
# \deprecated commands in the documentation.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   553
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   554
GENERATE_DEPRECATEDLIST= YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   555
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   556
# The ENABLED_SECTIONS tag can be used to enable conditional 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   557
# documentation sections, marked by \if sectionname ... \endif.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   558
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   559
ENABLED_SECTIONS       = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   560
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   561
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   562
# the initial value of a variable or macro consists of for it to appear in 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   563
# the documentation. If the initializer consists of more lines than specified 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   564
# here it will be hidden. Use a value of 0 to hide initializers completely. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   565
# The appearance of the initializer of individual variables and macros in the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   566
# documentation can be controlled using \showinitializer or \hideinitializer 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   567
# command in the documentation regardless of this setting.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   568
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   569
MAX_INITIALIZER_LINES  = 30
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   570
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   571
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   572
# at the bottom of the documentation of classes and structs. If set to YES the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   573
# list will mention the files that were used to generate the documentation.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   574
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   575
SHOW_USED_FILES        = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   576
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   577
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   578
# This will remove the Files entry from the Quick Index and from the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   579
# Folder Tree View (if specified). The default is YES.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   580
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   581
SHOW_FILES             = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   582
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   583
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   584
# Namespaces page.  This will remove the Namespaces entry from the Quick Index 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   585
# and from the Folder Tree View (if specified). The default is YES.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   586
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   587
SHOW_NAMESPACES        = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   588
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   589
# The FILE_VERSION_FILTER tag can be used to specify a program or script that 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   590
# doxygen should invoke to get the current version for each file (typically from 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   591
# the version control system). Doxygen will invoke the program by executing (via 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   592
# popen()) the command <command> <input-file>, where <command> is the value of 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   593
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   594
# provided by doxygen. Whatever the program writes to standard output 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   595
# is used as the file version. See the manual for examples.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   596
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   597
FILE_VERSION_FILTER    = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   598
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   599
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   600
# by doxygen. The layout file controls the global structure of the generated 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   601
# output files in an output format independent way. To create the layout file 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   602
# that represents doxygen's defaults, run doxygen with the -l option. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   603
# You can optionally specify a file name after the option, if omitted 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   604
# DoxygenLayout.xml will be used as the name of the layout file.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   605
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   606
LAYOUT_FILE            = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   607
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   608
# The CITE_BIB_FILES tag can be used to specify one or more bib files 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   609
# containing the references data. This must be a list of .bib files. The 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   610
# .bib extension is automatically appended if omitted. Using this command 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   611
# requires the bibtex tool to be installed. See also 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   612
# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   613
# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   614
# feature you need bibtex and perl available in the search path.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   615
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   616
CITE_BIB_FILES         = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   617
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   618
#---------------------------------------------------------------------------
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   619
# configuration options related to warning and progress messages
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   620
#---------------------------------------------------------------------------
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   621
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   622
# The QUIET tag can be used to turn on/off the messages that are generated 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   623
# by doxygen. Possible values are YES and NO. If left blank NO is used.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   624
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   625
QUIET                  = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   626
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   627
# The WARNINGS tag can be used to turn on/off the warning messages that are 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   628
# generated by doxygen. Possible values are YES and NO. If left blank 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   629
# NO is used.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   630
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   631
WARNINGS               = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   632
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   633
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   634
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   635
# automatically be disabled.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   636
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   637
WARN_IF_UNDOCUMENTED   = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   638
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   639
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   640
# potential errors in the documentation, such as not documenting some 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   641
# parameters in a documented function, or documenting parameters that 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   642
# don't exist or using markup commands wrongly.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   643
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   644
WARN_IF_DOC_ERROR      = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   645
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   646
# The WARN_NO_PARAMDOC option can be enabled to get warnings for 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   647
# functions that are documented, but have no documentation for their parameters 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   648
# or return value. If set to NO (the default) doxygen will only warn about 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   649
# wrong or incomplete parameter documentation, but not about the absence of 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   650
# documentation.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   651
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   652
WARN_NO_PARAMDOC       = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   653
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   654
# The WARN_FORMAT tag determines the format of the warning messages that 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   655
# doxygen can produce. The string should contain the $file, $line, and $text 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   656
# tags, which will be replaced by the file and line number from which the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   657
# warning originated and the warning text. Optionally the format may contain 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   658
# $version, which will be replaced by the version of the file (if it could 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   659
# be obtained via FILE_VERSION_FILTER)
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   660
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   661
WARN_FORMAT            = "$file:$line: $text"
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   662
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   663
# The WARN_LOGFILE tag can be used to specify a file to which warning 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   664
# and error messages should be written. If left blank the output is written 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   665
# to stderr.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   666
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   667
WARN_LOGFILE           = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   668
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   669
#---------------------------------------------------------------------------
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   670
# configuration options related to the input files
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   671
#---------------------------------------------------------------------------
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   672
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   673
# The INPUT tag can be used to specify the files and/or directories that contain 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   674
# documented source files. You may enter file names like "myfile.cpp" or 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   675
# directories like "/usr/src/myproject". Separate the files or directories 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   676
# with spaces.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   677
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   678
INPUT                  = .
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   679
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   680
# This tag can be used to specify the character encoding of the source files 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   681
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   682
# also the default input encoding. Doxygen uses libiconv (or the iconv built 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   683
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   684
# the list of possible encodings.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   685
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   686
INPUT_ENCODING         = UTF-8
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   687
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   688
# If the value of the INPUT tag contains directories, you can use the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   689
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   690
# and *.h) to filter out the source-files in the directories. If left 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   691
# blank the following patterns are tested: 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   692
# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   693
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   694
# *.f90 *.f *.for *.vhd *.vhdl
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   695
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   696
FILE_PATTERNS          = *.c \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   697
                         *.cc \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   698
                         *.cxx \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   699
                         *.cpp \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   700
                         *.c++ \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   701
                         *.d \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   702
                         *.java \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   703
                         *.ii \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   704
                         *.ixx \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   705
                         *.ipp \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   706
                         *.i++ \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   707
                         *.inl \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   708
                         *.h \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   709
                         *.hh \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   710
                         *.hxx \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   711
                         *.hpp \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   712
                         *.h++ \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   713
                         *.idl \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   714
                         *.odl \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   715
                         *.cs \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   716
                         *.php \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   717
                         *.php3 \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   718
                         *.inc \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   719
                         *.m \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   720
                         *.markdown \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   721
                         *.md \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   722
                         *.mm \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   723
                         *.dox \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   724
                         *.py \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   725
                         *.f90 \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   726
                         *.f \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   727
                         *.for \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   728
                         *.vhd \
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   729
                         *.vhdl
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   730
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   731
# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   732
# should be searched for input files as well. Possible values are YES and NO. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   733
# If left blank NO is used.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   734
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   735
RECURSIVE              = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   736
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   737
# The EXCLUDE tag can be used to specify files and/or directories that should be 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   738
# excluded from the INPUT source files. This way you can easily exclude a 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   739
# subdirectory from a directory tree whose root is specified with the INPUT tag. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   740
# Note that relative paths are relative to the directory from which doxygen is 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   741
# run.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   742
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   743
EXCLUDE                = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   744
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   745
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   746
# directories that are symbolic links (a Unix file system feature) are excluded 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   747
# from the input.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   748
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   749
EXCLUDE_SYMLINKS       = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   750
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   751
# If the value of the INPUT tag contains directories, you can use the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   752
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   753
# certain files from those directories. Note that the wildcards are matched 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   754
# against the file with absolute path, so to exclude all test directories 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   755
# for example use the pattern */test/*
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   756
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   757
EXCLUDE_PATTERNS       = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   758
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   759
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   760
# (namespaces, classes, functions, etc.) that should be excluded from the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   761
# output. The symbol name can be a fully qualified name, a word, or if the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   762
# wildcard * is used, a substring. Examples: ANamespace, AClass, 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   763
# AClass::ANamespace, ANamespace::*Test
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   764
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   765
EXCLUDE_SYMBOLS        = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   766
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   767
# The EXAMPLE_PATH tag can be used to specify one or more files or 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   768
# directories that contain example code fragments that are included (see 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   769
# the \include command).
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   770
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   771
EXAMPLE_PATH           = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   772
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   773
# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   774
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   775
# and *.h) to filter out the source-files in the directories. If left 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   776
# blank all files are included.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   777
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   778
EXAMPLE_PATTERNS       = *
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   779
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   780
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   781
# searched for input files to be used with the \include or \dontinclude 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   782
# commands irrespective of the value of the RECURSIVE tag. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   783
# Possible values are YES and NO. If left blank NO is used.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   784
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   785
EXAMPLE_RECURSIVE      = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   786
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   787
# The IMAGE_PATH tag can be used to specify one or more files or 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   788
# directories that contain image that are included in the documentation (see 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   789
# the \image command).
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   790
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   791
IMAGE_PATH             = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   792
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   793
# The INPUT_FILTER tag can be used to specify a program that doxygen should 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   794
# invoke to filter for each input file. Doxygen will invoke the filter program 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   795
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   796
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   797
# input file. Doxygen will then use the output that the filter program writes 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   798
# to standard output.  If FILTER_PATTERNS is specified, this tag will be 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   799
# ignored.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   800
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   801
INPUT_FILTER           = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   802
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   803
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   804
# basis.  Doxygen will compare the file name with each pattern and apply the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   805
# filter if there is a match.  The filters are a list of the form: 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   806
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   807
# info on how filters are used. If FILTER_PATTERNS is empty or if 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   808
# non of the patterns match the file name, INPUT_FILTER is applied.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   809
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   810
FILTER_PATTERNS        = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   811
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   812
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   813
# INPUT_FILTER) will be used to filter the input files when producing source 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   814
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   815
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   816
FILTER_SOURCE_FILES    = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   817
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   818
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   819
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   820
# and it is also possible to disable source filtering for a specific pattern 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   821
# using *.ext= (so without naming a filter). This option only has effect when 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   822
# FILTER_SOURCE_FILES is enabled.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   823
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   824
FILTER_SOURCE_PATTERNS = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   825
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   826
#---------------------------------------------------------------------------
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   827
# configuration options related to source browsing
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   828
#---------------------------------------------------------------------------
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   829
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   830
# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   831
# be generated. Documented entities will be cross-referenced with these sources. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   832
# Note: To get rid of all source code in the generated output, make sure also 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   833
# VERBATIM_HEADERS is set to NO.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   834
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   835
SOURCE_BROWSER         = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   836
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   837
# Setting the INLINE_SOURCES tag to YES will include the body 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   838
# of functions and classes directly in the documentation.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   839
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   840
INLINE_SOURCES         = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   841
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   842
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   843
# doxygen to hide any special comment blocks from generated source code 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   844
# fragments. Normal C, C++ and Fortran comments will always remain visible.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   845
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   846
STRIP_CODE_COMMENTS    = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   847
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   848
# If the REFERENCED_BY_RELATION tag is set to YES 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   849
# then for each documented function all documented 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   850
# functions referencing it will be listed.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   851
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   852
REFERENCED_BY_RELATION = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   853
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   854
# If the REFERENCES_RELATION tag is set to YES 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   855
# then for each documented function all documented entities 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   856
# called/used by that function will be listed.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   857
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   858
REFERENCES_RELATION    = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   859
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   860
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   861
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   862
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   863
# link to the source code.  Otherwise they will link to the documentation.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   864
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   865
REFERENCES_LINK_SOURCE = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   866
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   867
# If the USE_HTAGS tag is set to YES then the references to source code 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   868
# will point to the HTML generated by the htags(1) tool instead of doxygen 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   869
# built-in source browser. The htags tool is part of GNU's global source 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   870
# tagging system (see http://www.gnu.org/software/global/global.html). You 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   871
# will need version 4.8.6 or higher.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   872
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   873
USE_HTAGS              = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   874
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   875
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   876
# will generate a verbatim copy of the header file for each class for 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   877
# which an include is specified. Set to NO to disable this.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   878
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   879
VERBATIM_HEADERS       = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   880
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   881
#---------------------------------------------------------------------------
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   882
# configuration options related to the alphabetical class index
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   883
#---------------------------------------------------------------------------
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   884
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   885
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   886
# of all compounds will be generated. Enable this if the project 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   887
# contains a lot of classes, structs, unions or interfaces.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   888
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   889
ALPHABETICAL_INDEX     = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   890
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   891
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   892
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   893
# in which this list will be split (can be a number in the range [1..20])
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   894
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   895
COLS_IN_ALPHA_INDEX    = 5
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   896
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   897
# In case all classes in a project start with a common prefix, all 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   898
# classes will be put under the same header in the alphabetical index. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   899
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   900
# should be ignored while generating the index headers.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   901
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   902
IGNORE_PREFIX          = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   903
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   904
#---------------------------------------------------------------------------
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   905
# configuration options related to the HTML output
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   906
#---------------------------------------------------------------------------
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   907
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   908
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   909
# generate HTML output.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   910
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   911
GENERATE_HTML          = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   912
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   913
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   914
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   915
# put in front of it. If left blank `html' will be used as the default path.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   916
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   917
HTML_OUTPUT            = html
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   918
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   919
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   920
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   921
# doxygen will generate files with .html extension.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   922
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   923
HTML_FILE_EXTENSION    = .html
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   924
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   925
# The HTML_HEADER tag can be used to specify a personal HTML header for 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   926
# each generated HTML page. If it is left blank doxygen will generate a 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   927
# standard header. Note that when using a custom header you are responsible  
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   928
# for the proper inclusion of any scripts and style sheets that doxygen 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   929
# needs, which is dependent on the configuration options used. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   930
# It is advised to generate a default header using "doxygen -w html 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   931
# header.html footer.html stylesheet.css YourConfigFile" and then modify 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   932
# that header. Note that the header is subject to change so you typically 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   933
# have to redo this when upgrading to a newer version of doxygen or when 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   934
# changing the value of configuration settings such as GENERATE_TREEVIEW!
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   935
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   936
HTML_HEADER            = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   937
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   938
# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   939
# each generated HTML page. If it is left blank doxygen will generate a 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   940
# standard footer.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   941
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   942
HTML_FOOTER            = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   943
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   944
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   945
# style sheet that is used by each HTML page. It can be used to 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   946
# fine-tune the look of the HTML output. If left blank doxygen will 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   947
# generate a default style sheet. Note that it is recommended to use 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   948
# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   949
# tag will in the future become obsolete.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   950
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   951
HTML_STYLESHEET        = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   952
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   953
# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   954
# user-defined cascading style sheet that is included after the standard 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   955
# style sheets created by doxygen. Using this option one can overrule 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   956
# certain style aspects. This is preferred over using HTML_STYLESHEET 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   957
# since it does not replace the standard style sheet and is therefor more 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   958
# robust against future updates. Doxygen will copy the style sheet file to 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   959
# the output directory.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   960
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   961
HTML_EXTRA_STYLESHEET  = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   962
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   963
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   964
# other source files which should be copied to the HTML output directory. Note 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   965
# that these files will be copied to the base HTML output directory. Use the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   966
# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   967
# files. In the HTML_STYLESHEET file, use the file name only. Also note that 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   968
# the files will be copied as-is; there are no commands or markers available.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   969
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   970
HTML_EXTRA_FILES       = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   971
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   972
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   973
# Doxygen will adjust the colors in the style sheet and background images 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   974
# according to this color. Hue is specified as an angle on a colorwheel, 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   975
# see http://en.wikipedia.org/wiki/Hue for more information. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   976
# For instance the value 0 represents red, 60 is yellow, 120 is green, 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   977
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   978
# The allowed range is 0 to 359.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   979
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   980
HTML_COLORSTYLE_HUE    = 220
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   981
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   982
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   983
# the colors in the HTML output. For a value of 0 the output will use 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   984
# grayscales only. A value of 255 will produce the most vivid colors.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   985
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   986
HTML_COLORSTYLE_SAT    = 100
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   987
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   988
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   989
# the luminance component of the colors in the HTML output. Values below 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   990
# 100 gradually make the output lighter, whereas values above 100 make 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   991
# the output darker. The value divided by 100 is the actual gamma applied, 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   992
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   993
# and 100 does not change the gamma.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   994
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   995
HTML_COLORSTYLE_GAMMA  = 80
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   996
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   997
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   998
# page will contain the date and time when the page was generated. Setting 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
   999
# this to NO can help when comparing the output of multiple runs.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1000
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1001
HTML_TIMESTAMP         = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1002
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1003
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1004
# documentation will contain sections that can be hidden and shown after the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1005
# page has loaded.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1006
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1007
HTML_DYNAMIC_SECTIONS  = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1008
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1009
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1010
# entries shown in the various tree structured indices initially; the user 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1011
# can expand and collapse entries dynamically later on. Doxygen will expand 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1012
# the tree to such a level that at most the specified number of entries are 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1013
# visible (unless a fully collapsed tree already exceeds this amount). 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1014
# So setting the number of entries 1 will produce a full collapsed tree by 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1015
# default. 0 is a special value representing an infinite number of entries 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1016
# and will result in a full expanded tree by default.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1017
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1018
HTML_INDEX_NUM_ENTRIES = 100
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1019
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1020
# If the GENERATE_DOCSET tag is set to YES, additional index files 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1021
# will be generated that can be used as input for Apple's Xcode 3 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1022
# integrated development environment, introduced with OSX 10.5 (Leopard). 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1023
# To create a documentation set, doxygen will generate a Makefile in the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1024
# HTML output directory. Running make will produce the docset in that 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1025
# directory and running "make install" will install the docset in 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1026
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1027
# it at startup. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1028
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1029
# for more information.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1030
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1031
GENERATE_DOCSET        = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1032
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1033
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1034
# feed. A documentation feed provides an umbrella under which multiple 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1035
# documentation sets from a single provider (such as a company or product suite) 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1036
# can be grouped.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1037
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1038
DOCSET_FEEDNAME        = "Doxygen generated docs"
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1039
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1040
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1041
# should uniquely identify the documentation set bundle. This should be a 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1042
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1043
# will append .docset to the name.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1044
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1045
DOCSET_BUNDLE_ID       = org.doxygen.Project
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1046
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1047
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1048
# identify the documentation publisher. This should be a reverse domain-name 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1049
# style string, e.g. com.mycompany.MyDocSet.documentation.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1050
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1051
DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1052
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1053
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1054
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1055
DOCSET_PUBLISHER_NAME  = Publisher
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1056
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1057
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1058
# will be generated that can be used as input for tools like the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1059
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1060
# of the generated HTML documentation.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1061
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1062
GENERATE_HTMLHELP      = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1063
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1064
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1065
# be used to specify the file name of the resulting .chm file. You 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1066
# can add a path in front of the file if the result should not be 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1067
# written to the html output directory.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1068
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1069
CHM_FILE               = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1070
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1071
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1072
# be used to specify the location (absolute path including file name) of 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1073
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1074
# the HTML help compiler on the generated index.hhp.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1075
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1076
HHC_LOCATION           = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1077
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1078
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1079
# controls if a separate .chi index file is generated (YES) or that 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1080
# it should be included in the master .chm file (NO).
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1081
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1082
GENERATE_CHI           = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1083
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1084
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1085
# is used to encode HtmlHelp index (hhk), content (hhc) and project file 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1086
# content.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1087
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1088
CHM_INDEX_ENCODING     = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1089
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1090
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1091
# controls whether a binary table of contents is generated (YES) or a 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1092
# normal table of contents (NO) in the .chm file.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1093
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1094
BINARY_TOC             = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1095
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1096
# The TOC_EXPAND flag can be set to YES to add extra items for group members 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1097
# to the contents of the HTML help documentation and to the tree view.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1098
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1099
TOC_EXPAND             = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1100
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1101
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1102
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1103
# that can be used as input for Qt's qhelpgenerator to generate a 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1104
# Qt Compressed Help (.qch) of the generated HTML documentation.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1105
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1106
GENERATE_QHP           = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1107
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1108
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1109
# be used to specify the file name of the resulting .qch file. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1110
# The path specified is relative to the HTML output folder.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1111
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1112
QCH_FILE               = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1113
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1114
# The QHP_NAMESPACE tag specifies the namespace to use when generating 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1115
# Qt Help Project output. For more information please see 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1116
# http://doc.trolltech.com/qthelpproject.html#namespace
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1117
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1118
QHP_NAMESPACE          = org.doxygen.Project
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1119
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1120
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1121
# Qt Help Project output. For more information please see 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1122
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1123
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1124
QHP_VIRTUAL_FOLDER     = doc
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1125
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1126
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1127
# add. For more information please see 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1128
# http://doc.trolltech.com/qthelpproject.html#custom-filters
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1129
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1130
QHP_CUST_FILTER_NAME   = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1131
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1132
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1133
# custom filter to add. For more information please see 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1134
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1135
# Qt Help Project / Custom Filters</a>.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1136
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1137
QHP_CUST_FILTER_ATTRS  = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1138
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1139
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1140
# project's 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1141
# filter section matches. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1142
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1143
# Qt Help Project / Filter Attributes</a>.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1144
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1145
QHP_SECT_FILTER_ATTRS  = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1146
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1147
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1148
# be used to specify the location of Qt's qhelpgenerator. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1149
# If non-empty doxygen will try to run qhelpgenerator on the generated 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1150
# .qhp file.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1151
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1152
QHG_LOCATION           = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1153
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1154
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files  
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1155
# will be generated, which together with the HTML files, form an Eclipse help 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1156
# plugin. To install this plugin and make it available under the help contents 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1157
# menu in Eclipse, the contents of the directory containing the HTML and XML 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1158
# files needs to be copied into the plugins directory of eclipse. The name of 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1159
# the directory within the plugins directory should be the same as 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1160
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1161
# the help appears.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1162
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1163
GENERATE_ECLIPSEHELP   = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1164
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1165
# A unique identifier for the eclipse help plugin. When installing the plugin 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1166
# the directory name containing the HTML and XML files should also have 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1167
# this name.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1168
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1169
ECLIPSE_DOC_ID         = org.doxygen.Project
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1170
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1171
# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1172
# at top of each HTML page. The value NO (the default) enables the index and 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1173
# the value YES disables it. Since the tabs have the same information as the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1174
# navigation tree you can set this option to NO if you already set 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1175
# GENERATE_TREEVIEW to YES.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1176
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1177
DISABLE_INDEX          = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1178
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1179
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1180
# structure should be generated to display hierarchical information. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1181
# If the tag value is set to YES, a side panel will be generated 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1182
# containing a tree-like index structure (just like the one that 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1183
# is generated for HTML Help). For this to work a browser that supports 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1184
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1185
# Windows users are probably better off using the HTML help feature. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1186
# Since the tree basically has the same information as the tab index you 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1187
# could consider to set DISABLE_INDEX to NO when enabling this option.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1188
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1189
GENERATE_TREEVIEW      = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1190
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1191
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1192
# (range [0,1..20]) that doxygen will group on one line in the generated HTML 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1193
# documentation. Note that a value of 0 will completely suppress the enum 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1194
# values from appearing in the overview section.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1195
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1196
ENUM_VALUES_PER_LINE   = 4
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1197
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1198
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1199
# used to set the initial width (in pixels) of the frame in which the tree 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1200
# is shown.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1201
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1202
TREEVIEW_WIDTH         = 250
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1203
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1204
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1205
# links to external symbols imported via tag files in a separate window.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1206
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1207
EXT_LINKS_IN_WINDOW    = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1208
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1209
# Use this tag to change the font size of Latex formulas included 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1210
# as images in the HTML documentation. The default is 10. Note that 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1211
# when you change the font size after a successful doxygen run you need 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1212
# to manually remove any form_*.png images from the HTML output directory 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1213
# to force them to be regenerated.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1214
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1215
FORMULA_FONTSIZE       = 10
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1216
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1217
# Use the FORMULA_TRANPARENT tag to determine whether or not the images 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1218
# generated for formulas are transparent PNGs. Transparent PNGs are 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1219
# not supported properly for IE 6.0, but are supported on all modern browsers. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1220
# Note that when changing this option you need to delete any form_*.png files 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1221
# in the HTML output before the changes have effect.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1222
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1223
FORMULA_TRANSPARENT    = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1224
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1225
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1226
# (see http://www.mathjax.org) which uses client side Javascript for the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1227
# rendering instead of using prerendered bitmaps. Use this if you do not 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1228
# have LaTeX installed or if you want to formulas look prettier in the HTML 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1229
# output. When enabled you may also need to install MathJax separately and 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1230
# configure the path to it using the MATHJAX_RELPATH option.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1231
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1232
USE_MATHJAX            = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1233
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1234
# When MathJax is enabled you need to specify the location relative to the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1235
# HTML output directory using the MATHJAX_RELPATH option. The destination 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1236
# directory should contain the MathJax.js script. For instance, if the mathjax 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1237
# directory is located at the same level as the HTML output directory, then 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1238
# MATHJAX_RELPATH should be ../mathjax. The default value points to 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1239
# the MathJax Content Delivery Network so you can quickly see the result without 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1240
# installing MathJax.  However, it is strongly recommended to install a local 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1241
# copy of MathJax from http://www.mathjax.org before deployment.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1242
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1243
MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1244
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1245
# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1246
# names that should be enabled during MathJax rendering.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1247
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1248
MATHJAX_EXTENSIONS     = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1249
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1250
# When the SEARCHENGINE tag is enabled doxygen will generate a search box 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1251
# for the HTML output. The underlying search engine uses javascript 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1252
# and DHTML and should work on any modern browser. Note that when using 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1253
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1254
# (GENERATE_DOCSET) there is already a search function so this one should 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1255
# typically be disabled. For large projects the javascript based search engine 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1256
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1257
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1258
SEARCHENGINE           = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1259
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1260
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1261
# implemented using a PHP enabled web server instead of at the web client 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1262
# using Javascript. Doxygen will generate the search PHP script and index 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1263
# file to put on the web server. The advantage of the server 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1264
# based approach is that it scales better to large projects and allows 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1265
# full text search. The disadvantages are that it is more difficult to setup 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1266
# and does not have live searching capabilities.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1267
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1268
SERVER_BASED_SEARCH    = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1269
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1270
#---------------------------------------------------------------------------
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1271
# configuration options related to the LaTeX output
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1272
#---------------------------------------------------------------------------
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1273
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1274
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1275
# generate Latex output.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1276
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1277
GENERATE_LATEX         = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1278
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1279
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1280
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1281
# put in front of it. If left blank `latex' will be used as the default path.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1282
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1283
LATEX_OUTPUT           = latex
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1284
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1285
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1286
# invoked. If left blank `latex' will be used as the default command name. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1287
# Note that when enabling USE_PDFLATEX this option is only used for 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1288
# generating bitmaps for formulas in the HTML output, but not in the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1289
# Makefile that is written to the output directory.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1290
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1291
LATEX_CMD_NAME         = latex
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1292
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1293
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1294
# generate index for LaTeX. If left blank `makeindex' will be used as the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1295
# default command name.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1296
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1297
MAKEINDEX_CMD_NAME     = makeindex
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1298
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1299
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1300
# LaTeX documents. This may be useful for small projects and may help to 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1301
# save some trees in general.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1302
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1303
COMPACT_LATEX          = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1304
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1305
# The PAPER_TYPE tag can be used to set the paper type that is used 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1306
# by the printer. Possible values are: a4, letter, legal and 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1307
# executive. If left blank a4wide will be used.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1308
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1309
PAPER_TYPE             = a4
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1310
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1311
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1312
# packages that should be included in the LaTeX output.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1313
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1314
EXTRA_PACKAGES         = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1315
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1316
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1317
# the generated latex document. The header should contain everything until 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1318
# the first chapter. If it is left blank doxygen will generate a 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1319
# standard header. Notice: only use this tag if you know what you are doing!
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1320
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1321
LATEX_HEADER           = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1322
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1323
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1324
# the generated latex document. The footer should contain everything after 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1325
# the last chapter. If it is left blank doxygen will generate a 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1326
# standard footer. Notice: only use this tag if you know what you are doing!
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1327
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1328
LATEX_FOOTER           = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1329
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1330
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1331
# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1332
# contain links (just like the HTML output) instead of page references 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1333
# This makes the output suitable for online browsing using a pdf viewer.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1334
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1335
PDF_HYPERLINKS         = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1336
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1337
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1338
# plain latex in the generated Makefile. Set this option to YES to get a 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1339
# higher quality PDF documentation.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1340
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1341
USE_PDFLATEX           = YES
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1342
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1343
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1344
# command to the generated LaTeX files. This will instruct LaTeX to keep 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1345
# running if errors occur, instead of asking the user for help. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1346
# This option is also used when generating formulas in HTML.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1347
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1348
LATEX_BATCHMODE        = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1349
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1350
# If LATEX_HIDE_INDICES is set to YES then doxygen will not 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1351
# include the index chapters (such as File Index, Compound Index, etc.) 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1352
# in the output.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1353
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1354
LATEX_HIDE_INDICES     = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1355
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1356
# If LATEX_SOURCE_CODE is set to YES then doxygen will include 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1357
# source code with syntax highlighting in the LaTeX output. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1358
# Note that which sources are shown also depends on other settings 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1359
# such as SOURCE_BROWSER.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1360
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1361
LATEX_SOURCE_CODE      = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1362
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1363
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1364
# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1365
# http://en.wikipedia.org/wiki/BibTeX for more info.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1366
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1367
LATEX_BIB_STYLE        = plain
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1368
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1369
#---------------------------------------------------------------------------
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1370
# configuration options related to the RTF output
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1371
#---------------------------------------------------------------------------
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1372
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1373
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1374
# The RTF output is optimized for Word 97 and may not look very pretty with 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1375
# other RTF readers or editors.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1376
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1377
GENERATE_RTF           = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1378
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1379
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1380
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1381
# put in front of it. If left blank `rtf' will be used as the default path.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1382
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1383
RTF_OUTPUT             = rtf
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1384
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1385
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1386
# RTF documents. This may be useful for small projects and may help to 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1387
# save some trees in general.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1388
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1389
COMPACT_RTF            = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1390
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1391
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1392
# will contain hyperlink fields. The RTF file will 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1393
# contain links (just like the HTML output) instead of page references. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1394
# This makes the output suitable for online browsing using WORD or other 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1395
# programs which support those fields. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1396
# Note: wordpad (write) and others do not support links.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1397
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1398
RTF_HYPERLINKS         = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1399
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1400
# Load style sheet definitions from file. Syntax is similar to doxygen's 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1401
# config file, i.e. a series of assignments. You only have to provide 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1402
# replacements, missing definitions are set to their default value.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1403
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1404
RTF_STYLESHEET_FILE    = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1405
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1406
# Set optional variables used in the generation of an rtf document. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1407
# Syntax is similar to doxygen's config file.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1408
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1409
RTF_EXTENSIONS_FILE    = 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1410
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1411
#---------------------------------------------------------------------------
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1412
# configuration options related to the man page output
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1413
#---------------------------------------------------------------------------
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1414
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1415
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1416
# generate man pages
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1417
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1418
GENERATE_MAN           = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1419
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1420
# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1421
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1422
# put in front of it. If left blank `man' will be used as the default path.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1423
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1424
MAN_OUTPUT             = man
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1425
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1426
# The MAN_EXTENSION tag determines the extension that is added to 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1427
# the generated man pages (default is the subroutine's section .3)
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1428
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1429
MAN_EXTENSION          = .3
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1430
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1431
# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1432
# then it will generate one additional man file for each entity 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1433
# documented in the real man page(s). These additional files 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1434
# only source the real man page, but without them the man command 
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1435
# would be unable to find the correct page. The default is NO.
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1436
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1437
MAN_LINKS              = NO
f01702bfb764 fix some comments and add basic doxygen file
sheepluva
parents:
diff changeset
  1438