Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

features/FEATURE_BLE/ble.doxyfile@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
Parent:
0:5b88d5760320 
updated based on mbed-os5.15.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 0:5b88d5760320 1 # Doxyfile 1.8.10
kenjiArai 0:5b88d5760320 2
kenjiArai 0:5b88d5760320 3 # This file describes the settings to be used by the documentation system
kenjiArai 0:5b88d5760320 4 # doxygen (www.doxygen.org) for a project.
kenjiArai 0:5b88d5760320 5 #
kenjiArai 0:5b88d5760320 6 # All text after a double hash (##) is considered a comment and is placed in
kenjiArai 0:5b88d5760320 7 # front of the TAG it is preceding.
kenjiArai 0:5b88d5760320 8 #
kenjiArai 0:5b88d5760320 9 # All text after a single hash (#) is considered a comment and will be ignored.
kenjiArai 0:5b88d5760320 10 # The format is:
kenjiArai 0:5b88d5760320 11 # TAG = value [value, ...]
kenjiArai 0:5b88d5760320 12 # For lists, items can also be appended using:
kenjiArai 0:5b88d5760320 13 # TAG += value [value, ...]
kenjiArai 0:5b88d5760320 14 # Values that contain spaces should be placed between quotes (\" \").
kenjiArai 0:5b88d5760320 15
kenjiArai 0:5b88d5760320 16 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 17 # Project related configuration options
kenjiArai 0:5b88d5760320 18 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 19
kenjiArai 0:5b88d5760320 20 # This tag specifies the encoding used for all characters in the config file
kenjiArai 0:5b88d5760320 21 # that follow. The default is UTF-8 which is also the encoding used for all text
kenjiArai 0:5b88d5760320 22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
kenjiArai 0:5b88d5760320 23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
kenjiArai 0:5b88d5760320 24 # for the list of possible encodings.
kenjiArai 0:5b88d5760320 25 # The default value is: UTF-8.
kenjiArai 0:5b88d5760320 26
kenjiArai 0:5b88d5760320 27 DOXYFILE_ENCODING = UTF-8
kenjiArai 0:5b88d5760320 28
kenjiArai 0:5b88d5760320 29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
kenjiArai 0:5b88d5760320 30 # double-quotes, unless you are using Doxywizard) that should identify the
kenjiArai 0:5b88d5760320 31 # project for which the documentation is generated. This name is used in the
kenjiArai 0:5b88d5760320 32 # title of most generated pages and in a few other places.
kenjiArai 0:5b88d5760320 33 # The default value is: My Project.
kenjiArai 0:5b88d5760320 34
kenjiArai 0:5b88d5760320 35 PROJECT_NAME = "BLE API"
kenjiArai 0:5b88d5760320 36
kenjiArai 0:5b88d5760320 37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
kenjiArai 0:5b88d5760320 38 # could be handy for archiving the generated documentation or if some version
kenjiArai 0:5b88d5760320 39 # control system is used.
kenjiArai 0:5b88d5760320 40
kenjiArai 0:5b88d5760320 41 PROJECT_NUMBER = v2
kenjiArai 0:5b88d5760320 42
kenjiArai 0:5b88d5760320 43 # Using the PROJECT_BRIEF tag one can provide an optional one line description
kenjiArai 0:5b88d5760320 44 # for a project that appears at the top of each page and should give viewer a
kenjiArai 0:5b88d5760320 45 # quick idea about the purpose of the project. Keep the description short.
kenjiArai 0:5b88d5760320 46
kenjiArai 0:5b88d5760320 47 PROJECT_BRIEF = "An abstraction for using Bluetooth Low Energy."
kenjiArai 0:5b88d5760320 48
kenjiArai 0:5b88d5760320 49 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
kenjiArai 0:5b88d5760320 50 # in the documentation. The maximum height of the logo should not exceed 55
kenjiArai 0:5b88d5760320 51 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
kenjiArai 0:5b88d5760320 52 # the logo to the output directory.
kenjiArai 0:5b88d5760320 53
kenjiArai 0:5b88d5760320 54 PROJECT_LOGO =
kenjiArai 0:5b88d5760320 55
kenjiArai 0:5b88d5760320 56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
kenjiArai 0:5b88d5760320 57 # into which the generated documentation will be written. If a relative path is
kenjiArai 0:5b88d5760320 58 # entered, it will be relative to the location where doxygen was started. If
kenjiArai 0:5b88d5760320 59 # left blank the current directory will be used.
kenjiArai 0:5b88d5760320 60
kenjiArai 0:5b88d5760320 61 OUTPUT_DIRECTORY = apidoc/
kenjiArai 0:5b88d5760320 62
kenjiArai 0:5b88d5760320 63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
kenjiArai 0:5b88d5760320 64 # directories (in 2 levels) under the output directory of each output format and
kenjiArai 0:5b88d5760320 65 # will distribute the generated files over these directories. Enabling this
kenjiArai 0:5b88d5760320 66 # option can be useful when feeding doxygen a huge amount of source files, where
kenjiArai 0:5b88d5760320 67 # putting all generated files in the same directory would otherwise causes
kenjiArai 0:5b88d5760320 68 # performance problems for the file system.
kenjiArai 0:5b88d5760320 69 # The default value is: NO.
kenjiArai 0:5b88d5760320 70
kenjiArai 0:5b88d5760320 71 CREATE_SUBDIRS = NO
kenjiArai 0:5b88d5760320 72
kenjiArai 0:5b88d5760320 73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
kenjiArai 0:5b88d5760320 74 # characters to appear in the names of generated files. If set to NO, non-ASCII
kenjiArai 0:5b88d5760320 75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
kenjiArai 0:5b88d5760320 76 # U+3044.
kenjiArai 0:5b88d5760320 77 # The default value is: NO.
kenjiArai 0:5b88d5760320 78
kenjiArai 0:5b88d5760320 79 ALLOW_UNICODE_NAMES = NO
kenjiArai 0:5b88d5760320 80
kenjiArai 0:5b88d5760320 81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
kenjiArai 0:5b88d5760320 82 # documentation generated by doxygen is written. Doxygen will use this
kenjiArai 0:5b88d5760320 83 # information to generate all constant output in the proper language.
kenjiArai 0:5b88d5760320 84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
kenjiArai 0:5b88d5760320 85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
kenjiArai 0:5b88d5760320 86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
kenjiArai 0:5b88d5760320 87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
kenjiArai 0:5b88d5760320 88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
kenjiArai 0:5b88d5760320 89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
kenjiArai 0:5b88d5760320 90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
kenjiArai 0:5b88d5760320 91 # Ukrainian and Vietnamese.
kenjiArai 0:5b88d5760320 92 # The default value is: English.
kenjiArai 0:5b88d5760320 93
kenjiArai 0:5b88d5760320 94 OUTPUT_LANGUAGE = English
kenjiArai 0:5b88d5760320 95
kenjiArai 0:5b88d5760320 96 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
kenjiArai 0:5b88d5760320 97 # descriptions after the members that are listed in the file and class
kenjiArai 0:5b88d5760320 98 # documentation (similar to Javadoc). Set to NO to disable this.
kenjiArai 0:5b88d5760320 99 # The default value is: YES.
kenjiArai 0:5b88d5760320 100
kenjiArai 0:5b88d5760320 101 BRIEF_MEMBER_DESC = YES
kenjiArai 0:5b88d5760320 102
kenjiArai 0:5b88d5760320 103 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
kenjiArai 0:5b88d5760320 104 # description of a member or function before the detailed description
kenjiArai 0:5b88d5760320 105 #
kenjiArai 0:5b88d5760320 106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
kenjiArai 0:5b88d5760320 107 # brief descriptions will be completely suppressed.
kenjiArai 0:5b88d5760320 108 # The default value is: YES.
kenjiArai 0:5b88d5760320 109
kenjiArai 0:5b88d5760320 110 REPEAT_BRIEF = YES
kenjiArai 0:5b88d5760320 111
kenjiArai 0:5b88d5760320 112 # This tag implements a quasi-intelligent brief description abbreviator that is
kenjiArai 0:5b88d5760320 113 # used to form the text in various listings. Each string in this list, if found
kenjiArai 0:5b88d5760320 114 # as the leading text of the brief description, will be stripped from the text
kenjiArai 0:5b88d5760320 115 # and the result, after processing the whole list, is used as the annotated
kenjiArai 0:5b88d5760320 116 # text. Otherwise, the brief description is used as-is. If left blank, the
kenjiArai 0:5b88d5760320 117 # following values are used ($name is automatically replaced with the name of
kenjiArai 0:5b88d5760320 118 # the entity):The $name class, The $name widget, The $name file, is, provides,
kenjiArai 0:5b88d5760320 119 # specifies, contains, represents, a, an and the.
kenjiArai 0:5b88d5760320 120
kenjiArai 0:5b88d5760320 121 ABBREVIATE_BRIEF = "The $name class" \
kenjiArai 0:5b88d5760320 122 "The $name widget" \
kenjiArai 0:5b88d5760320 123 "The $name file" \
kenjiArai 0:5b88d5760320 124 is \
kenjiArai 0:5b88d5760320 125 provides \
kenjiArai 0:5b88d5760320 126 specifies \
kenjiArai 0:5b88d5760320 127 contains \
kenjiArai 0:5b88d5760320 128 represents \
kenjiArai 0:5b88d5760320 129 a \
kenjiArai 0:5b88d5760320 130 an \
kenjiArai 0:5b88d5760320 131 the
kenjiArai 0:5b88d5760320 132
kenjiArai 0:5b88d5760320 133 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
kenjiArai 0:5b88d5760320 134 # doxygen will generate a detailed section even if there is only a brief
kenjiArai 0:5b88d5760320 135 # description.
kenjiArai 0:5b88d5760320 136 # The default value is: NO.
kenjiArai 0:5b88d5760320 137
kenjiArai 0:5b88d5760320 138 ALWAYS_DETAILED_SEC = NO
kenjiArai 0:5b88d5760320 139
kenjiArai 0:5b88d5760320 140 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
kenjiArai 0:5b88d5760320 141 # inherited members of a class in the documentation of that class as if those
kenjiArai 0:5b88d5760320 142 # members were ordinary class members. Constructors, destructors and assignment
kenjiArai 0:5b88d5760320 143 # operators of the base classes will not be shown.
kenjiArai 0:5b88d5760320 144 # The default value is: NO.
kenjiArai 0:5b88d5760320 145
kenjiArai 0:5b88d5760320 146 INLINE_INHERITED_MEMB = NO
kenjiArai 0:5b88d5760320 147
kenjiArai 0:5b88d5760320 148 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
kenjiArai 0:5b88d5760320 149 # before files name in the file list and in the header files. If set to NO the
kenjiArai 0:5b88d5760320 150 # shortest path that makes the file name unique will be used
kenjiArai 0:5b88d5760320 151 # The default value is: YES.
kenjiArai 0:5b88d5760320 152
kenjiArai 0:5b88d5760320 153 FULL_PATH_NAMES = YES
kenjiArai 0:5b88d5760320 154
kenjiArai 0:5b88d5760320 155 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
kenjiArai 0:5b88d5760320 156 # Stripping is only done if one of the specified strings matches the left-hand
kenjiArai 0:5b88d5760320 157 # part of the path. The tag can be used to show relative paths in the file list.
kenjiArai 0:5b88d5760320 158 # If left blank the directory from which doxygen is run is used as the path to
kenjiArai 0:5b88d5760320 159 # strip.
kenjiArai 0:5b88d5760320 160 #
kenjiArai 0:5b88d5760320 161 # Note that you can specify absolute paths here, but also relative paths, which
kenjiArai 0:5b88d5760320 162 # will be relative from the directory where doxygen is started.
kenjiArai 0:5b88d5760320 163 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
kenjiArai 0:5b88d5760320 164
kenjiArai 0:5b88d5760320 165 STRIP_FROM_PATH =
kenjiArai 0:5b88d5760320 166
kenjiArai 0:5b88d5760320 167 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
kenjiArai 0:5b88d5760320 168 # path mentioned in the documentation of a class, which tells the reader which
kenjiArai 0:5b88d5760320 169 # header file to include in order to use a class. If left blank only the name of
kenjiArai 0:5b88d5760320 170 # the header file containing the class definition is used. Otherwise one should
kenjiArai 0:5b88d5760320 171 # specify the list of include paths that are normally passed to the compiler
kenjiArai 0:5b88d5760320 172 # using the -I flag.
kenjiArai 0:5b88d5760320 173
kenjiArai 0:5b88d5760320 174 STRIP_FROM_INC_PATH =
kenjiArai 0:5b88d5760320 175
kenjiArai 0:5b88d5760320 176 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
kenjiArai 0:5b88d5760320 177 # less readable) file names. This can be useful is your file systems doesn't
kenjiArai 0:5b88d5760320 178 # support long names like on DOS, Mac, or CD-ROM.
kenjiArai 0:5b88d5760320 179 # The default value is: NO.
kenjiArai 0:5b88d5760320 180
kenjiArai 0:5b88d5760320 181 SHORT_NAMES = NO
kenjiArai 0:5b88d5760320 182
kenjiArai 0:5b88d5760320 183 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
kenjiArai 0:5b88d5760320 184 # first line (until the first dot) of a Javadoc-style comment as the brief
kenjiArai 0:5b88d5760320 185 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
kenjiArai 0:5b88d5760320 186 # style comments (thus requiring an explicit @brief command for a brief
kenjiArai 0:5b88d5760320 187 # description.)
kenjiArai 0:5b88d5760320 188 # The default value is: NO.
kenjiArai 0:5b88d5760320 189
kenjiArai 0:5b88d5760320 190 JAVADOC_AUTOBRIEF = YES
kenjiArai 0:5b88d5760320 191
kenjiArai 0:5b88d5760320 192 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
kenjiArai 0:5b88d5760320 193 # line (until the first dot) of a Qt-style comment as the brief description. If
kenjiArai 0:5b88d5760320 194 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
kenjiArai 0:5b88d5760320 195 # requiring an explicit \brief command for a brief description.)
kenjiArai 0:5b88d5760320 196 # The default value is: NO.
kenjiArai 0:5b88d5760320 197
kenjiArai 0:5b88d5760320 198 QT_AUTOBRIEF = NO
kenjiArai 0:5b88d5760320 199
kenjiArai 0:5b88d5760320 200 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
kenjiArai 0:5b88d5760320 201 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
kenjiArai 0:5b88d5760320 202 # a brief description. This used to be the default behavior. The new default is
kenjiArai 0:5b88d5760320 203 # to treat a multi-line C++ comment block as a detailed description. Set this
kenjiArai 0:5b88d5760320 204 # tag to YES if you prefer the old behavior instead.
kenjiArai 0:5b88d5760320 205 #
kenjiArai 0:5b88d5760320 206 # Note that setting this tag to YES also means that rational rose comments are
kenjiArai 0:5b88d5760320 207 # not recognized any more.
kenjiArai 0:5b88d5760320 208 # The default value is: NO.
kenjiArai 0:5b88d5760320 209
kenjiArai 0:5b88d5760320 210 MULTILINE_CPP_IS_BRIEF = NO
kenjiArai 0:5b88d5760320 211
kenjiArai 0:5b88d5760320 212 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
kenjiArai 0:5b88d5760320 213 # documentation from any documented member that it re-implements.
kenjiArai 0:5b88d5760320 214 # The default value is: YES.
kenjiArai 0:5b88d5760320 215
kenjiArai 0:5b88d5760320 216 INHERIT_DOCS = YES
kenjiArai 0:5b88d5760320 217
kenjiArai 0:5b88d5760320 218 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
kenjiArai 0:5b88d5760320 219 # page for each member. If set to NO, the documentation of a member will be part
kenjiArai 0:5b88d5760320 220 # of the file/class/namespace that contains it.
kenjiArai 0:5b88d5760320 221 # The default value is: NO.
kenjiArai 0:5b88d5760320 222
kenjiArai 0:5b88d5760320 223 SEPARATE_MEMBER_PAGES = NO
kenjiArai 0:5b88d5760320 224
kenjiArai 0:5b88d5760320 225 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
kenjiArai 0:5b88d5760320 226 # uses this value to replace tabs by spaces in code fragments.
kenjiArai 0:5b88d5760320 227 # Minimum value: 1, maximum value: 16, default value: 4.
kenjiArai 0:5b88d5760320 228
kenjiArai 0:5b88d5760320 229 TAB_SIZE = 4
kenjiArai 0:5b88d5760320 230
kenjiArai 0:5b88d5760320 231 # This tag can be used to specify a number of aliases that act as commands in
kenjiArai 0:5b88d5760320 232 # the documentation. An alias has the form:
kenjiArai 0:5b88d5760320 233 # name=value
kenjiArai 0:5b88d5760320 234 # For example adding
kenjiArai 0:5b88d5760320 235 # "sideeffect=@par Side Effects:\n"
kenjiArai 0:5b88d5760320 236 # will allow you to put the command \sideeffect (or @sideeffect) in the
kenjiArai 0:5b88d5760320 237 # documentation, which will result in a user-defined paragraph with heading
kenjiArai 0:5b88d5760320 238 # "Side Effects:". You can put \n's in the value part of an alias to insert
kenjiArai 0:5b88d5760320 239 # newlines.
kenjiArai 0:5b88d5760320 240
kenjiArai 0:5b88d5760320 241 ALIASES = "experimental=\n<dl compact\n><dt> <b style=\"color:#ff0000\">Experimental:</b></dt> <dd style=\"color:#ff0000\">This feature is marked as <i>experimental</i>.</dd></dl>\n" \
kenjiArai 0:5b88d5760320 242 "experimental{1}=\n<dl compact\n><dt> <b style=\"color:#ff0000\">Experimental:</b></dt> <dd style=\"color:#ff0000\">\1</dd></dl>\n"
kenjiArai 0:5b88d5760320 243
kenjiArai 0:5b88d5760320 244 # This tag can be used to specify a number of word-keyword mappings (TCL only).
kenjiArai 0:5b88d5760320 245 # A mapping has the form "name=value". For example adding "class=itcl::class"
kenjiArai 0:5b88d5760320 246 # will allow you to use the command class in the itcl::class meaning.
kenjiArai 0:5b88d5760320 247
kenjiArai 0:5b88d5760320 248 TCL_SUBST =
kenjiArai 0:5b88d5760320 249
kenjiArai 0:5b88d5760320 250 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
kenjiArai 0:5b88d5760320 251 # only. Doxygen will then generate output that is more tailored for C. For
kenjiArai 0:5b88d5760320 252 # instance, some of the names that are used will be different. The list of all
kenjiArai 0:5b88d5760320 253 # members will be omitted, etc.
kenjiArai 0:5b88d5760320 254 # The default value is: NO.
kenjiArai 0:5b88d5760320 255
kenjiArai 0:5b88d5760320 256 OPTIMIZE_OUTPUT_FOR_C = NO
kenjiArai 0:5b88d5760320 257
kenjiArai 0:5b88d5760320 258 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
kenjiArai 0:5b88d5760320 259 # Python sources only. Doxygen will then generate output that is more tailored
kenjiArai 0:5b88d5760320 260 # for that language. For instance, namespaces will be presented as packages,
kenjiArai 0:5b88d5760320 261 # qualified scopes will look different, etc.
kenjiArai 0:5b88d5760320 262 # The default value is: NO.
kenjiArai 0:5b88d5760320 263
kenjiArai 0:5b88d5760320 264 OPTIMIZE_OUTPUT_JAVA = NO
kenjiArai 0:5b88d5760320 265
kenjiArai 0:5b88d5760320 266 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
kenjiArai 0:5b88d5760320 267 # sources. Doxygen will then generate output that is tailored for Fortran.
kenjiArai 0:5b88d5760320 268 # The default value is: NO.
kenjiArai 0:5b88d5760320 269
kenjiArai 0:5b88d5760320 270 OPTIMIZE_FOR_FORTRAN = NO
kenjiArai 0:5b88d5760320 271
kenjiArai 0:5b88d5760320 272 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
kenjiArai 0:5b88d5760320 273 # sources. Doxygen will then generate output that is tailored for VHDL.
kenjiArai 0:5b88d5760320 274 # The default value is: NO.
kenjiArai 0:5b88d5760320 275
kenjiArai 0:5b88d5760320 276 OPTIMIZE_OUTPUT_VHDL = NO
kenjiArai 0:5b88d5760320 277
kenjiArai 0:5b88d5760320 278 # Doxygen selects the parser to use depending on the extension of the files it
kenjiArai 0:5b88d5760320 279 # parses. With this tag you can assign which parser to use for a given
kenjiArai 0:5b88d5760320 280 # extension. Doxygen has a built-in mapping, but you can override or extend it
kenjiArai 0:5b88d5760320 281 # using this tag. The format is ext=language, where ext is a file extension, and
kenjiArai 0:5b88d5760320 282 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
kenjiArai 0:5b88d5760320 283 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
kenjiArai 0:5b88d5760320 284 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
kenjiArai 0:5b88d5760320 285 # Fortran. In the later case the parser tries to guess whether the code is fixed
kenjiArai 0:5b88d5760320 286 # or free formatted code, this is the default for Fortran type files), VHDL. For
kenjiArai 0:5b88d5760320 287 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
kenjiArai 0:5b88d5760320 288 # and .f files as C (default is Fortran), use: inc=Fortran f=C.
kenjiArai 0:5b88d5760320 289 #
kenjiArai 0:5b88d5760320 290 # Note: For files without extension you can use no_extension as a placeholder.
kenjiArai 0:5b88d5760320 291 #
kenjiArai 0:5b88d5760320 292 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
kenjiArai 0:5b88d5760320 293 # the files are not read by doxygen.
kenjiArai 0:5b88d5760320 294
kenjiArai 0:5b88d5760320 295 EXTENSION_MAPPING = h=C++
kenjiArai 0:5b88d5760320 296
kenjiArai 0:5b88d5760320 297 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
kenjiArai 0:5b88d5760320 298 # according to the Markdown format, which allows for more readable
kenjiArai 0:5b88d5760320 299 # documentation. See http://daringfireball.net/projects/markdown/ for details.
kenjiArai 0:5b88d5760320 300 # The output of markdown processing is further processed by doxygen, so you can
kenjiArai 0:5b88d5760320 301 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
kenjiArai 0:5b88d5760320 302 # case of backward compatibilities issues.
kenjiArai 0:5b88d5760320 303 # The default value is: YES.
kenjiArai 0:5b88d5760320 304
kenjiArai 0:5b88d5760320 305 MARKDOWN_SUPPORT = YES
kenjiArai 0:5b88d5760320 306
kenjiArai 0:5b88d5760320 307 # When enabled doxygen tries to link words that correspond to documented
kenjiArai 0:5b88d5760320 308 # classes, or namespaces to their corresponding documentation. Such a link can
kenjiArai 0:5b88d5760320 309 # be prevented in individual cases by putting a % sign in front of the word or
kenjiArai 0:5b88d5760320 310 # globally by setting AUTOLINK_SUPPORT to NO.
kenjiArai 0:5b88d5760320 311 # The default value is: YES.
kenjiArai 0:5b88d5760320 312
kenjiArai 0:5b88d5760320 313 AUTOLINK_SUPPORT = YES
kenjiArai 0:5b88d5760320 314
kenjiArai 0:5b88d5760320 315 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
kenjiArai 0:5b88d5760320 316 # to include (a tag file for) the STL sources as input, then you should set this
kenjiArai 0:5b88d5760320 317 # tag to YES in order to let doxygen match functions declarations and
kenjiArai 0:5b88d5760320 318 # definitions whose arguments contain STL classes (e.g. func(std::string);
kenjiArai 0:5b88d5760320 319 # versus func(std::string) {}). This also make the inheritance and collaboration
kenjiArai 0:5b88d5760320 320 # diagrams that involve STL classes more complete and accurate.
kenjiArai 0:5b88d5760320 321 # The default value is: NO.
kenjiArai 0:5b88d5760320 322
kenjiArai 0:5b88d5760320 323 BUILTIN_STL_SUPPORT = NO
kenjiArai 0:5b88d5760320 324
kenjiArai 0:5b88d5760320 325 # If you use Microsoft's C++/CLI language, you should set this option to YES to
kenjiArai 0:5b88d5760320 326 # enable parsing support.
kenjiArai 0:5b88d5760320 327 # The default value is: NO.
kenjiArai 0:5b88d5760320 328
kenjiArai 0:5b88d5760320 329 CPP_CLI_SUPPORT = NO
kenjiArai 0:5b88d5760320 330
kenjiArai 0:5b88d5760320 331 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
kenjiArai 0:5b88d5760320 332 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
kenjiArai 0:5b88d5760320 333 # will parse them like normal C++ but will assume all classes use public instead
kenjiArai 0:5b88d5760320 334 # of private inheritance when no explicit protection keyword is present.
kenjiArai 0:5b88d5760320 335 # The default value is: NO.
kenjiArai 0:5b88d5760320 336
kenjiArai 0:5b88d5760320 337 SIP_SUPPORT = NO
kenjiArai 0:5b88d5760320 338
kenjiArai 0:5b88d5760320 339 # For Microsoft's IDL there are propget and propput attributes to indicate
kenjiArai 0:5b88d5760320 340 # getter and setter methods for a property. Setting this option to YES will make
kenjiArai 0:5b88d5760320 341 # doxygen to replace the get and set methods by a property in the documentation.
kenjiArai 0:5b88d5760320 342 # This will only work if the methods are indeed getting or setting a simple
kenjiArai 0:5b88d5760320 343 # type. If this is not the case, or you want to show the methods anyway, you
kenjiArai 0:5b88d5760320 344 # should set this option to NO.
kenjiArai 0:5b88d5760320 345 # The default value is: YES.
kenjiArai 0:5b88d5760320 346
kenjiArai 0:5b88d5760320 347 IDL_PROPERTY_SUPPORT = YES
kenjiArai 0:5b88d5760320 348
kenjiArai 0:5b88d5760320 349 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
kenjiArai 0:5b88d5760320 350 # tag is set to YES then doxygen will reuse the documentation of the first
kenjiArai 0:5b88d5760320 351 # member in the group (if any) for the other members of the group. By default
kenjiArai 0:5b88d5760320 352 # all members of a group must be documented explicitly.
kenjiArai 0:5b88d5760320 353 # The default value is: NO.
kenjiArai 0:5b88d5760320 354
kenjiArai 0:5b88d5760320 355 DISTRIBUTE_GROUP_DOC = NO
kenjiArai 0:5b88d5760320 356
kenjiArai 0:5b88d5760320 357 # If one adds a struct or class to a group and this option is enabled, then also
kenjiArai 0:5b88d5760320 358 # any nested class or struct is added to the same group. By default this option
kenjiArai 0:5b88d5760320 359 # is disabled and one has to add nested compounds explicitly via \ingroup.
kenjiArai 0:5b88d5760320 360 # The default value is: NO.
kenjiArai 0:5b88d5760320 361
kenjiArai 0:5b88d5760320 362 GROUP_NESTED_COMPOUNDS = NO
kenjiArai 0:5b88d5760320 363
kenjiArai 0:5b88d5760320 364 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
kenjiArai 0:5b88d5760320 365 # (for instance a group of public functions) to be put as a subgroup of that
kenjiArai 0:5b88d5760320 366 # type (e.g. under the Public Functions section). Set it to NO to prevent
kenjiArai 0:5b88d5760320 367 # subgrouping. Alternatively, this can be done per class using the
kenjiArai 0:5b88d5760320 368 # \nosubgrouping command.
kenjiArai 0:5b88d5760320 369 # The default value is: YES.
kenjiArai 0:5b88d5760320 370
kenjiArai 0:5b88d5760320 371 SUBGROUPING = YES
kenjiArai 0:5b88d5760320 372
kenjiArai 0:5b88d5760320 373 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
kenjiArai 0:5b88d5760320 374 # are shown inside the group in which they are included (e.g. using \ingroup)
kenjiArai 0:5b88d5760320 375 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
kenjiArai 0:5b88d5760320 376 # and RTF).
kenjiArai 0:5b88d5760320 377 #
kenjiArai 0:5b88d5760320 378 # Note that this feature does not work in combination with
kenjiArai 0:5b88d5760320 379 # SEPARATE_MEMBER_PAGES.
kenjiArai 0:5b88d5760320 380 # The default value is: NO.
kenjiArai 0:5b88d5760320 381
kenjiArai 0:5b88d5760320 382 INLINE_GROUPED_CLASSES = NO
kenjiArai 0:5b88d5760320 383
kenjiArai 0:5b88d5760320 384 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
kenjiArai 0:5b88d5760320 385 # with only public data fields or simple typedef fields will be shown inline in
kenjiArai 0:5b88d5760320 386 # the documentation of the scope in which they are defined (i.e. file,
kenjiArai 0:5b88d5760320 387 # namespace, or group documentation), provided this scope is documented. If set
kenjiArai 0:5b88d5760320 388 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
kenjiArai 0:5b88d5760320 389 # Man pages) or section (for LaTeX and RTF).
kenjiArai 0:5b88d5760320 390 # The default value is: NO.
kenjiArai 0:5b88d5760320 391
kenjiArai 0:5b88d5760320 392 INLINE_SIMPLE_STRUCTS = YES
kenjiArai 0:5b88d5760320 393
kenjiArai 0:5b88d5760320 394 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
kenjiArai 0:5b88d5760320 395 # enum is documented as struct, union, or enum with the name of the typedef. So
kenjiArai 0:5b88d5760320 396 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
kenjiArai 0:5b88d5760320 397 # with name TypeT. When disabled the typedef will appear as a member of a file,
kenjiArai 0:5b88d5760320 398 # namespace, or class. And the struct will be named TypeS. This can typically be
kenjiArai 0:5b88d5760320 399 # useful for C code in case the coding convention dictates that all compound
kenjiArai 0:5b88d5760320 400 # types are typedef'ed and only the typedef is referenced, never the tag name.
kenjiArai 0:5b88d5760320 401 # The default value is: NO.
kenjiArai 0:5b88d5760320 402
kenjiArai 0:5b88d5760320 403 TYPEDEF_HIDES_STRUCT = NO
kenjiArai 0:5b88d5760320 404
kenjiArai 0:5b88d5760320 405 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
kenjiArai 0:5b88d5760320 406 # cache is used to resolve symbols given their name and scope. Since this can be
kenjiArai 0:5b88d5760320 407 # an expensive process and often the same symbol appears multiple times in the
kenjiArai 0:5b88d5760320 408 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
kenjiArai 0:5b88d5760320 409 # doxygen will become slower. If the cache is too large, memory is wasted. The
kenjiArai 0:5b88d5760320 410 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
kenjiArai 0:5b88d5760320 411 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
kenjiArai 0:5b88d5760320 412 # symbols. At the end of a run doxygen will report the cache usage and suggest
kenjiArai 0:5b88d5760320 413 # the optimal cache size from a speed point of view.
kenjiArai 0:5b88d5760320 414 # Minimum value: 0, maximum value: 9, default value: 0.
kenjiArai 0:5b88d5760320 415
kenjiArai 0:5b88d5760320 416 LOOKUP_CACHE_SIZE = 0
kenjiArai 0:5b88d5760320 417
kenjiArai 0:5b88d5760320 418 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 419 # Build related configuration options
kenjiArai 0:5b88d5760320 420 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 421
kenjiArai 0:5b88d5760320 422 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
kenjiArai 0:5b88d5760320 423 # documentation are documented, even if no documentation was available. Private
kenjiArai 0:5b88d5760320 424 # class members and static file members will be hidden unless the
kenjiArai 0:5b88d5760320 425 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
kenjiArai 0:5b88d5760320 426 # Note: This will also disable the warnings about undocumented members that are
kenjiArai 0:5b88d5760320 427 # normally produced when WARNINGS is set to YES.
kenjiArai 0:5b88d5760320 428 # The default value is: NO.
kenjiArai 0:5b88d5760320 429
kenjiArai 0:5b88d5760320 430 EXTRACT_ALL = NO
kenjiArai 0:5b88d5760320 431
kenjiArai 0:5b88d5760320 432 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
kenjiArai 0:5b88d5760320 433 # be included in the documentation.
kenjiArai 0:5b88d5760320 434 # The default value is: NO.
kenjiArai 0:5b88d5760320 435
kenjiArai 0:5b88d5760320 436 EXTRACT_PRIVATE = NO
kenjiArai 0:5b88d5760320 437
kenjiArai 0:5b88d5760320 438 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
kenjiArai 0:5b88d5760320 439 # scope will be included in the documentation.
kenjiArai 0:5b88d5760320 440 # The default value is: NO.
kenjiArai 0:5b88d5760320 441
kenjiArai 0:5b88d5760320 442 EXTRACT_PACKAGE = NO
kenjiArai 0:5b88d5760320 443
kenjiArai 0:5b88d5760320 444 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
kenjiArai 0:5b88d5760320 445 # included in the documentation.
kenjiArai 0:5b88d5760320 446 # The default value is: NO.
kenjiArai 0:5b88d5760320 447
kenjiArai 0:5b88d5760320 448 EXTRACT_STATIC = NO
kenjiArai 0:5b88d5760320 449
kenjiArai 0:5b88d5760320 450 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
kenjiArai 0:5b88d5760320 451 # locally in source files will be included in the documentation. If set to NO,
kenjiArai 0:5b88d5760320 452 # only classes defined in header files are included. Does not have any effect
kenjiArai 0:5b88d5760320 453 # for Java sources.
kenjiArai 0:5b88d5760320 454 # The default value is: YES.
kenjiArai 0:5b88d5760320 455
kenjiArai 0:5b88d5760320 456 EXTRACT_LOCAL_CLASSES = YES
kenjiArai 0:5b88d5760320 457
kenjiArai 0:5b88d5760320 458 # This flag is only useful for Objective-C code. If set to YES, local methods,
kenjiArai 0:5b88d5760320 459 # which are defined in the implementation section but not in the interface are
kenjiArai 0:5b88d5760320 460 # included in the documentation. If set to NO, only methods in the interface are
kenjiArai 0:5b88d5760320 461 # included.
kenjiArai 0:5b88d5760320 462 # The default value is: NO.
kenjiArai 0:5b88d5760320 463
kenjiArai 0:5b88d5760320 464 EXTRACT_LOCAL_METHODS = NO
kenjiArai 0:5b88d5760320 465
kenjiArai 0:5b88d5760320 466 # If this flag is set to YES, the members of anonymous namespaces will be
kenjiArai 0:5b88d5760320 467 # extracted and appear in the documentation as a namespace called
kenjiArai 0:5b88d5760320 468 # 'anonymous_namespace{file}', where file will be replaced with the base name of
kenjiArai 0:5b88d5760320 469 # the file that contains the anonymous namespace. By default anonymous namespace
kenjiArai 0:5b88d5760320 470 # are hidden.
kenjiArai 0:5b88d5760320 471 # The default value is: NO.
kenjiArai 0:5b88d5760320 472
kenjiArai 0:5b88d5760320 473 EXTRACT_ANON_NSPACES = YES
kenjiArai 0:5b88d5760320 474
kenjiArai 0:5b88d5760320 475 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
kenjiArai 0:5b88d5760320 476 # undocumented members inside documented classes or files. If set to NO these
kenjiArai 0:5b88d5760320 477 # members will be included in the various overviews, but no documentation
kenjiArai 0:5b88d5760320 478 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
kenjiArai 0:5b88d5760320 479 # The default value is: NO.
kenjiArai 0:5b88d5760320 480
kenjiArai 0:5b88d5760320 481 HIDE_UNDOC_MEMBERS = NO
kenjiArai 0:5b88d5760320 482
kenjiArai 0:5b88d5760320 483 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
kenjiArai 0:5b88d5760320 484 # undocumented classes that are normally visible in the class hierarchy. If set
kenjiArai 0:5b88d5760320 485 # to NO, these classes will be included in the various overviews. This option
kenjiArai 0:5b88d5760320 486 # has no effect if EXTRACT_ALL is enabled.
kenjiArai 0:5b88d5760320 487 # The default value is: NO.
kenjiArai 0:5b88d5760320 488
kenjiArai 0:5b88d5760320 489 HIDE_UNDOC_CLASSES = NO
kenjiArai 0:5b88d5760320 490
kenjiArai 0:5b88d5760320 491 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
kenjiArai 0:5b88d5760320 492 # (class|struct|union) declarations. If set to NO, these declarations will be
kenjiArai 0:5b88d5760320 493 # included in the documentation.
kenjiArai 0:5b88d5760320 494 # The default value is: NO.
kenjiArai 0:5b88d5760320 495
kenjiArai 0:5b88d5760320 496 HIDE_FRIEND_COMPOUNDS = NO
kenjiArai 0:5b88d5760320 497
kenjiArai 0:5b88d5760320 498 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
kenjiArai 0:5b88d5760320 499 # documentation blocks found inside the body of a function. If set to NO, these
kenjiArai 0:5b88d5760320 500 # blocks will be appended to the function's detailed documentation block.
kenjiArai 0:5b88d5760320 501 # The default value is: NO.
kenjiArai 0:5b88d5760320 502
kenjiArai 0:5b88d5760320 503 HIDE_IN_BODY_DOCS = NO
kenjiArai 0:5b88d5760320 504
kenjiArai 0:5b88d5760320 505 # The INTERNAL_DOCS tag determines if documentation that is typed after a
kenjiArai 0:5b88d5760320 506 # \internal command is included. If the tag is set to NO then the documentation
kenjiArai 0:5b88d5760320 507 # will be excluded. Set it to YES to include the internal documentation.
kenjiArai 0:5b88d5760320 508 # The default value is: NO.
kenjiArai 0:5b88d5760320 509
kenjiArai 0:5b88d5760320 510 INTERNAL_DOCS = NO
kenjiArai 0:5b88d5760320 511
kenjiArai 0:5b88d5760320 512 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
kenjiArai 0:5b88d5760320 513 # names in lower-case letters. If set to YES, upper-case letters are also
kenjiArai 0:5b88d5760320 514 # allowed. This is useful if you have classes or files whose names only differ
kenjiArai 0:5b88d5760320 515 # in case and if your file system supports case sensitive file names. Windows
kenjiArai 0:5b88d5760320 516 # and Mac users are advised to set this option to NO.
kenjiArai 0:5b88d5760320 517 # The default value is: system dependent.
kenjiArai 0:5b88d5760320 518
kenjiArai 0:5b88d5760320 519 CASE_SENSE_NAMES = NO
kenjiArai 0:5b88d5760320 520
kenjiArai 0:5b88d5760320 521 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
kenjiArai 0:5b88d5760320 522 # their full class and namespace scopes in the documentation. If set to YES, the
kenjiArai 0:5b88d5760320 523 # scope will be hidden.
kenjiArai 0:5b88d5760320 524 # The default value is: NO.
kenjiArai 0:5b88d5760320 525
kenjiArai 0:5b88d5760320 526 HIDE_SCOPE_NAMES = NO
kenjiArai 0:5b88d5760320 527
kenjiArai 0:5b88d5760320 528 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
kenjiArai 0:5b88d5760320 529 # append additional text to a page's title, such as Class Reference. If set to
kenjiArai 0:5b88d5760320 530 # YES the compound reference will be hidden.
kenjiArai 0:5b88d5760320 531 # The default value is: NO.
kenjiArai 0:5b88d5760320 532
kenjiArai 0:5b88d5760320 533 HIDE_COMPOUND_REFERENCE= NO
kenjiArai 0:5b88d5760320 534
kenjiArai 0:5b88d5760320 535 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
kenjiArai 0:5b88d5760320 536 # the files that are included by a file in the documentation of that file.
kenjiArai 0:5b88d5760320 537 # The default value is: YES.
kenjiArai 0:5b88d5760320 538
kenjiArai 0:5b88d5760320 539 SHOW_INCLUDE_FILES = YES
kenjiArai 0:5b88d5760320 540
kenjiArai 0:5b88d5760320 541 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
kenjiArai 0:5b88d5760320 542 # grouped member an include statement to the documentation, telling the reader
kenjiArai 0:5b88d5760320 543 # which file to include in order to use the member.
kenjiArai 0:5b88d5760320 544 # The default value is: NO.
kenjiArai 0:5b88d5760320 545
kenjiArai 0:5b88d5760320 546 SHOW_GROUPED_MEMB_INC = NO
kenjiArai 0:5b88d5760320 547
kenjiArai 0:5b88d5760320 548 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
kenjiArai 0:5b88d5760320 549 # files with double quotes in the documentation rather than with sharp brackets.
kenjiArai 0:5b88d5760320 550 # The default value is: NO.
kenjiArai 0:5b88d5760320 551
kenjiArai 0:5b88d5760320 552 FORCE_LOCAL_INCLUDES = NO
kenjiArai 0:5b88d5760320 553
kenjiArai 0:5b88d5760320 554 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
kenjiArai 0:5b88d5760320 555 # documentation for inline members.
kenjiArai 0:5b88d5760320 556 # The default value is: YES.
kenjiArai 0:5b88d5760320 557
kenjiArai 0:5b88d5760320 558 INLINE_INFO = YES
kenjiArai 0:5b88d5760320 559
kenjiArai 0:5b88d5760320 560 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
kenjiArai 0:5b88d5760320 561 # (detailed) documentation of file and class members alphabetically by member
kenjiArai 0:5b88d5760320 562 # name. If set to NO, the members will appear in declaration order.
kenjiArai 0:5b88d5760320 563 # The default value is: YES.
kenjiArai 0:5b88d5760320 564
kenjiArai 0:5b88d5760320 565 SORT_MEMBER_DOCS = YES
kenjiArai 0:5b88d5760320 566
kenjiArai 0:5b88d5760320 567 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
kenjiArai 0:5b88d5760320 568 # descriptions of file, namespace and class members alphabetically by member
kenjiArai 0:5b88d5760320 569 # name. If set to NO, the members will appear in declaration order. Note that
kenjiArai 0:5b88d5760320 570 # this will also influence the order of the classes in the class list.
kenjiArai 0:5b88d5760320 571 # The default value is: NO.
kenjiArai 0:5b88d5760320 572
kenjiArai 0:5b88d5760320 573 SORT_BRIEF_DOCS = NO
kenjiArai 0:5b88d5760320 574
kenjiArai 0:5b88d5760320 575 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
kenjiArai 0:5b88d5760320 576 # (brief and detailed) documentation of class members so that constructors and
kenjiArai 0:5b88d5760320 577 # destructors are listed first. If set to NO the constructors will appear in the
kenjiArai 0:5b88d5760320 578 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
kenjiArai 0:5b88d5760320 579 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
kenjiArai 0:5b88d5760320 580 # member documentation.
kenjiArai 0:5b88d5760320 581 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
kenjiArai 0:5b88d5760320 582 # detailed member documentation.
kenjiArai 0:5b88d5760320 583 # The default value is: NO.
kenjiArai 0:5b88d5760320 584
kenjiArai 0:5b88d5760320 585 SORT_MEMBERS_CTORS_1ST = YES
kenjiArai 0:5b88d5760320 586
kenjiArai 0:5b88d5760320 587 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
kenjiArai 0:5b88d5760320 588 # of group names into alphabetical order. If set to NO the group names will
kenjiArai 0:5b88d5760320 589 # appear in their defined order.
kenjiArai 0:5b88d5760320 590 # The default value is: NO.
kenjiArai 0:5b88d5760320 591
kenjiArai 0:5b88d5760320 592 SORT_GROUP_NAMES = NO
kenjiArai 0:5b88d5760320 593
kenjiArai 0:5b88d5760320 594 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
kenjiArai 0:5b88d5760320 595 # fully-qualified names, including namespaces. If set to NO, the class list will
kenjiArai 0:5b88d5760320 596 # be sorted only by class name, not including the namespace part.
kenjiArai 0:5b88d5760320 597 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
kenjiArai 0:5b88d5760320 598 # Note: This option applies only to the class list, not to the alphabetical
kenjiArai 0:5b88d5760320 599 # list.
kenjiArai 0:5b88d5760320 600 # The default value is: NO.
kenjiArai 0:5b88d5760320 601
kenjiArai 0:5b88d5760320 602 SORT_BY_SCOPE_NAME = NO
kenjiArai 0:5b88d5760320 603
kenjiArai 0:5b88d5760320 604 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
kenjiArai 0:5b88d5760320 605 # type resolution of all parameters of a function it will reject a match between
kenjiArai 0:5b88d5760320 606 # the prototype and the implementation of a member function even if there is
kenjiArai 0:5b88d5760320 607 # only one candidate or it is obvious which candidate to choose by doing a
kenjiArai 0:5b88d5760320 608 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
kenjiArai 0:5b88d5760320 609 # accept a match between prototype and implementation in such cases.
kenjiArai 0:5b88d5760320 610 # The default value is: NO.
kenjiArai 0:5b88d5760320 611
kenjiArai 0:5b88d5760320 612 STRICT_PROTO_MATCHING = NO
kenjiArai 0:5b88d5760320 613
kenjiArai 0:5b88d5760320 614 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
kenjiArai 0:5b88d5760320 615 # list. This list is created by putting \todo commands in the documentation.
kenjiArai 0:5b88d5760320 616 # The default value is: YES.
kenjiArai 0:5b88d5760320 617
kenjiArai 0:5b88d5760320 618 GENERATE_TODOLIST = YES
kenjiArai 0:5b88d5760320 619
kenjiArai 0:5b88d5760320 620 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
kenjiArai 0:5b88d5760320 621 # list. This list is created by putting \test commands in the documentation.
kenjiArai 0:5b88d5760320 622 # The default value is: YES.
kenjiArai 0:5b88d5760320 623
kenjiArai 0:5b88d5760320 624 GENERATE_TESTLIST = YES
kenjiArai 0:5b88d5760320 625
kenjiArai 0:5b88d5760320 626 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
kenjiArai 0:5b88d5760320 627 # list. This list is created by putting \bug commands in the documentation.
kenjiArai 0:5b88d5760320 628 # The default value is: YES.
kenjiArai 0:5b88d5760320 629
kenjiArai 0:5b88d5760320 630 GENERATE_BUGLIST = YES
kenjiArai 0:5b88d5760320 631
kenjiArai 0:5b88d5760320 632 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
kenjiArai 0:5b88d5760320 633 # the deprecated list. This list is created by putting \deprecated commands in
kenjiArai 0:5b88d5760320 634 # the documentation.
kenjiArai 0:5b88d5760320 635 # The default value is: YES.
kenjiArai 0:5b88d5760320 636
kenjiArai 0:5b88d5760320 637 GENERATE_DEPRECATEDLIST= YES
kenjiArai 0:5b88d5760320 638
kenjiArai 0:5b88d5760320 639 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
kenjiArai 0:5b88d5760320 640 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
kenjiArai 0:5b88d5760320 641 # ... \endcond blocks.
kenjiArai 0:5b88d5760320 642
kenjiArai 0:5b88d5760320 643 ENABLED_SECTIONS =
kenjiArai 0:5b88d5760320 644
kenjiArai 0:5b88d5760320 645 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
kenjiArai 0:5b88d5760320 646 # initial value of a variable or macro / define can have for it to appear in the
kenjiArai 0:5b88d5760320 647 # documentation. If the initializer consists of more lines than specified here
kenjiArai 0:5b88d5760320 648 # it will be hidden. Use a value of 0 to hide initializers completely. The
kenjiArai 0:5b88d5760320 649 # appearance of the value of individual variables and macros / defines can be
kenjiArai 0:5b88d5760320 650 # controlled using \showinitializer or \hideinitializer command in the
kenjiArai 0:5b88d5760320 651 # documentation regardless of this setting.
kenjiArai 0:5b88d5760320 652 # Minimum value: 0, maximum value: 10000, default value: 30.
kenjiArai 0:5b88d5760320 653
kenjiArai 0:5b88d5760320 654 MAX_INITIALIZER_LINES = 30
kenjiArai 0:5b88d5760320 655
kenjiArai 0:5b88d5760320 656 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
kenjiArai 0:5b88d5760320 657 # the bottom of the documentation of classes and structs. If set to YES, the
kenjiArai 0:5b88d5760320 658 # list will mention the files that were used to generate the documentation.
kenjiArai 0:5b88d5760320 659 # The default value is: YES.
kenjiArai 0:5b88d5760320 660
kenjiArai 0:5b88d5760320 661 SHOW_USED_FILES = YES
kenjiArai 0:5b88d5760320 662
kenjiArai 0:5b88d5760320 663 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
kenjiArai 0:5b88d5760320 664 # will remove the Files entry from the Quick Index and from the Folder Tree View
kenjiArai 0:5b88d5760320 665 # (if specified).
kenjiArai 0:5b88d5760320 666 # The default value is: YES.
kenjiArai 0:5b88d5760320 667
kenjiArai 0:5b88d5760320 668 SHOW_FILES = YES
kenjiArai 0:5b88d5760320 669
kenjiArai 0:5b88d5760320 670 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
kenjiArai 0:5b88d5760320 671 # page. This will remove the Namespaces entry from the Quick Index and from the
kenjiArai 0:5b88d5760320 672 # Folder Tree View (if specified).
kenjiArai 0:5b88d5760320 673 # The default value is: YES.
kenjiArai 0:5b88d5760320 674
kenjiArai 0:5b88d5760320 675 SHOW_NAMESPACES = YES
kenjiArai 0:5b88d5760320 676
kenjiArai 0:5b88d5760320 677 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
kenjiArai 0:5b88d5760320 678 # doxygen should invoke to get the current version for each file (typically from
kenjiArai 0:5b88d5760320 679 # the version control system). Doxygen will invoke the program by executing (via
kenjiArai 0:5b88d5760320 680 # popen()) the command command input-file, where command is the value of the
kenjiArai 0:5b88d5760320 681 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
kenjiArai 0:5b88d5760320 682 # by doxygen. Whatever the program writes to standard output is used as the file
kenjiArai 0:5b88d5760320 683 # version. For an example see the documentation.
kenjiArai 0:5b88d5760320 684
kenjiArai 0:5b88d5760320 685 FILE_VERSION_FILTER =
kenjiArai 0:5b88d5760320 686
kenjiArai 0:5b88d5760320 687 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
kenjiArai 0:5b88d5760320 688 # by doxygen. The layout file controls the global structure of the generated
kenjiArai 0:5b88d5760320 689 # output files in an output format independent way. To create the layout file
kenjiArai 0:5b88d5760320 690 # that represents doxygen's defaults, run doxygen with the -l option. You can
kenjiArai 0:5b88d5760320 691 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
kenjiArai 0:5b88d5760320 692 # will be used as the name of the layout file.
kenjiArai 0:5b88d5760320 693 #
kenjiArai 0:5b88d5760320 694 # Note that if you run doxygen from a directory containing a file called
kenjiArai 0:5b88d5760320 695 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
kenjiArai 0:5b88d5760320 696 # tag is left empty.
kenjiArai 0:5b88d5760320 697
kenjiArai 0:5b88d5760320 698 LAYOUT_FILE =
kenjiArai 0:5b88d5760320 699
kenjiArai 0:5b88d5760320 700 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
kenjiArai 0:5b88d5760320 701 # the reference definitions. This must be a list of .bib files. The .bib
kenjiArai 0:5b88d5760320 702 # extension is automatically appended if omitted. This requires the bibtex tool
kenjiArai 0:5b88d5760320 703 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
kenjiArai 0:5b88d5760320 704 # For LaTeX the style of the bibliography can be controlled using
kenjiArai 0:5b88d5760320 705 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
kenjiArai 0:5b88d5760320 706 # search path. See also \cite for info how to create references.
kenjiArai 0:5b88d5760320 707
kenjiArai 0:5b88d5760320 708 CITE_BIB_FILES =
kenjiArai 0:5b88d5760320 709
kenjiArai 0:5b88d5760320 710 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 711 # Configuration options related to warning and progress messages
kenjiArai 0:5b88d5760320 712 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 713
kenjiArai 0:5b88d5760320 714 # The QUIET tag can be used to turn on/off the messages that are generated to
kenjiArai 0:5b88d5760320 715 # standard output by doxygen. If QUIET is set to YES this implies that the
kenjiArai 0:5b88d5760320 716 # messages are off.
kenjiArai 0:5b88d5760320 717 # The default value is: NO.
kenjiArai 0:5b88d5760320 718
kenjiArai 0:5b88d5760320 719 QUIET = NO
kenjiArai 0:5b88d5760320 720
kenjiArai 0:5b88d5760320 721 # The WARNINGS tag can be used to turn on/off the warning messages that are
kenjiArai 0:5b88d5760320 722 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
kenjiArai 0:5b88d5760320 723 # this implies that the warnings are on.
kenjiArai 0:5b88d5760320 724 #
kenjiArai 0:5b88d5760320 725 # Tip: Turn warnings on while writing the documentation.
kenjiArai 0:5b88d5760320 726 # The default value is: YES.
kenjiArai 0:5b88d5760320 727
kenjiArai 0:5b88d5760320 728 WARNINGS = YES
kenjiArai 0:5b88d5760320 729
kenjiArai 0:5b88d5760320 730 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
kenjiArai 0:5b88d5760320 731 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
kenjiArai 0:5b88d5760320 732 # will automatically be disabled.
kenjiArai 0:5b88d5760320 733 # The default value is: YES.
kenjiArai 0:5b88d5760320 734
kenjiArai 0:5b88d5760320 735 WARN_IF_UNDOCUMENTED = YES
kenjiArai 0:5b88d5760320 736
kenjiArai 0:5b88d5760320 737 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
kenjiArai 0:5b88d5760320 738 # potential errors in the documentation, such as not documenting some parameters
kenjiArai 0:5b88d5760320 739 # in a documented function, or documenting parameters that don't exist or using
kenjiArai 0:5b88d5760320 740 # markup commands wrongly.
kenjiArai 0:5b88d5760320 741 # The default value is: YES.
kenjiArai 0:5b88d5760320 742
kenjiArai 0:5b88d5760320 743 WARN_IF_DOC_ERROR = YES
kenjiArai 0:5b88d5760320 744
kenjiArai 0:5b88d5760320 745 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
kenjiArai 0:5b88d5760320 746 # are documented, but have no documentation for their parameters or return
kenjiArai 0:5b88d5760320 747 # value. If set to NO, doxygen will only warn about wrong or incomplete
kenjiArai 0:5b88d5760320 748 # parameter documentation, but not about the absence of documentation.
kenjiArai 0:5b88d5760320 749 # The default value is: NO.
kenjiArai 0:5b88d5760320 750
kenjiArai 0:5b88d5760320 751 WARN_NO_PARAMDOC = YES
kenjiArai 0:5b88d5760320 752
kenjiArai 0:5b88d5760320 753 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
kenjiArai 0:5b88d5760320 754 # can produce. The string should contain the $file, $line, and $text tags, which
kenjiArai 0:5b88d5760320 755 # will be replaced by the file and line number from which the warning originated
kenjiArai 0:5b88d5760320 756 # and the warning text. Optionally the format may contain $version, which will
kenjiArai 0:5b88d5760320 757 # be replaced by the version of the file (if it could be obtained via
kenjiArai 0:5b88d5760320 758 # FILE_VERSION_FILTER)
kenjiArai 0:5b88d5760320 759 # The default value is: $file:$line: $text.
kenjiArai 0:5b88d5760320 760
kenjiArai 0:5b88d5760320 761 WARN_FORMAT = "$file:$line: $text"
kenjiArai 0:5b88d5760320 762
kenjiArai 0:5b88d5760320 763 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
kenjiArai 0:5b88d5760320 764 # messages should be written. If left blank the output is written to standard
kenjiArai 0:5b88d5760320 765 # error (stderr).
kenjiArai 0:5b88d5760320 766
kenjiArai 0:5b88d5760320 767 WARN_LOGFILE = doxygen_warn.log
kenjiArai 0:5b88d5760320 768
kenjiArai 0:5b88d5760320 769 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 770 # Configuration options related to the input files
kenjiArai 0:5b88d5760320 771 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 772
kenjiArai 0:5b88d5760320 773 # The INPUT tag is used to specify the files and/or directories that contain
kenjiArai 0:5b88d5760320 774 # documented source files. You may enter file names like myfile.cpp or
kenjiArai 0:5b88d5760320 775 # directories like /usr/src/myproject. Separate the files or directories with
kenjiArai 0:5b88d5760320 776 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
kenjiArai 0:5b88d5760320 777 # Note: If this tag is empty the current directory is searched.
kenjiArai 0:5b88d5760320 778
kenjiArai 0:5b88d5760320 779 INPUT =
kenjiArai 0:5b88d5760320 780
kenjiArai 0:5b88d5760320 781 # This tag can be used to specify the character encoding of the source files
kenjiArai 0:5b88d5760320 782 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
kenjiArai 0:5b88d5760320 783 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
kenjiArai 0:5b88d5760320 784 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
kenjiArai 0:5b88d5760320 785 # possible encodings.
kenjiArai 0:5b88d5760320 786 # The default value is: UTF-8.
kenjiArai 0:5b88d5760320 787
kenjiArai 0:5b88d5760320 788 INPUT_ENCODING = UTF-8
kenjiArai 0:5b88d5760320 789
kenjiArai 0:5b88d5760320 790 # If the value of the INPUT tag contains directories, you can use the
kenjiArai 0:5b88d5760320 791 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
kenjiArai 0:5b88d5760320 792 # *.h) to filter out the source-files in the directories.
kenjiArai 0:5b88d5760320 793 #
kenjiArai 0:5b88d5760320 794 # Note that for custom extensions or not directly supported extensions you also
kenjiArai 0:5b88d5760320 795 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
kenjiArai 0:5b88d5760320 796 # read by doxygen.
kenjiArai 0:5b88d5760320 797 #
kenjiArai 0:5b88d5760320 798 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
kenjiArai 0:5b88d5760320 799 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
kenjiArai 0:5b88d5760320 800 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
kenjiArai 0:5b88d5760320 801 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd,
kenjiArai 0:5b88d5760320 802 # *.vhdl, *.ucf, *.qsf, *.as and *.js.
kenjiArai 0:5b88d5760320 803
kenjiArai 0:5b88d5760320 804 FILE_PATTERNS = *.h \
kenjiArai 0:5b88d5760320 805 *.cpp \
kenjiArai 0:5b88d5760320 806 *.md
kenjiArai 0:5b88d5760320 807
kenjiArai 0:5b88d5760320 808 # The RECURSIVE tag can be used to specify whether or not subdirectories should
kenjiArai 0:5b88d5760320 809 # be searched for input files as well.
kenjiArai 0:5b88d5760320 810 # The default value is: NO.
kenjiArai 0:5b88d5760320 811
kenjiArai 0:5b88d5760320 812 RECURSIVE = YES
kenjiArai 0:5b88d5760320 813
kenjiArai 0:5b88d5760320 814 # The EXCLUDE tag can be used to specify files and/or directories that should be
kenjiArai 0:5b88d5760320 815 # excluded from the INPUT source files. This way you can easily exclude a
kenjiArai 0:5b88d5760320 816 # subdirectory from a directory tree whose root is specified with the INPUT tag.
kenjiArai 0:5b88d5760320 817 #
kenjiArai 0:5b88d5760320 818 # Note that relative paths are relative to the directory from which doxygen is
kenjiArai 0:5b88d5760320 819 # run.
kenjiArai 0:5b88d5760320 820
kenjiArai 0:5b88d5760320 821 EXCLUDE = configs \
kenjiArai 0:5b88d5760320 822 CONTRIBUTING.md \
kenjiArai 0:5b88d5760320 823 README.md
kenjiArai 0:5b88d5760320 824
kenjiArai 0:5b88d5760320 825 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
kenjiArai 0:5b88d5760320 826 # directories that are symbolic links (a Unix file system feature) are excluded
kenjiArai 0:5b88d5760320 827 # from the input.
kenjiArai 0:5b88d5760320 828 # The default value is: NO.
kenjiArai 0:5b88d5760320 829
kenjiArai 0:5b88d5760320 830 EXCLUDE_SYMLINKS = NO
kenjiArai 0:5b88d5760320 831
kenjiArai 0:5b88d5760320 832 # If the value of the INPUT tag contains directories, you can use the
kenjiArai 0:5b88d5760320 833 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
kenjiArai 0:5b88d5760320 834 # certain files from those directories.
kenjiArai 0:5b88d5760320 835 #
kenjiArai 0:5b88d5760320 836 # Note that the wildcards are matched against the file with absolute path, so to
kenjiArai 0:5b88d5760320 837 # exclude all test directories for example use the pattern */test/*
kenjiArai 0:5b88d5760320 838
kenjiArai 0:5b88d5760320 839 EXCLUDE_PATTERNS =
kenjiArai 0:5b88d5760320 840
kenjiArai 0:5b88d5760320 841 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
kenjiArai 0:5b88d5760320 842 # (namespaces, classes, functions, etc.) that should be excluded from the
kenjiArai 0:5b88d5760320 843 # output. The symbol name can be a fully qualified name, a word, or if the
kenjiArai 0:5b88d5760320 844 # wildcard * is used, a substring. Examples: ANamespace, AClass,
kenjiArai 0:5b88d5760320 845 # AClass::ANamespace, ANamespace::*Test
kenjiArai 0:5b88d5760320 846 #
kenjiArai 0:5b88d5760320 847 # Note that the wildcards are matched against the file with absolute path, so to
kenjiArai 0:5b88d5760320 848 # exclude all test directories use the pattern */test/*
kenjiArai 0:5b88d5760320 849
kenjiArai 0:5b88d5760320 850 EXCLUDE_SYMBOLS =
kenjiArai 0:5b88d5760320 851
kenjiArai 0:5b88d5760320 852 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
kenjiArai 0:5b88d5760320 853 # that contain example code fragments that are included (see the \include
kenjiArai 0:5b88d5760320 854 # command).
kenjiArai 0:5b88d5760320 855
kenjiArai 0:5b88d5760320 856 EXAMPLE_PATH =
kenjiArai 0:5b88d5760320 857
kenjiArai 0:5b88d5760320 858 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
kenjiArai 0:5b88d5760320 859 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
kenjiArai 0:5b88d5760320 860 # *.h) to filter out the source-files in the directories. If left blank all
kenjiArai 0:5b88d5760320 861 # files are included.
kenjiArai 0:5b88d5760320 862
kenjiArai 0:5b88d5760320 863 EXAMPLE_PATTERNS =
kenjiArai 0:5b88d5760320 864
kenjiArai 0:5b88d5760320 865 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
kenjiArai 0:5b88d5760320 866 # searched for input files to be used with the \include or \dontinclude commands
kenjiArai 0:5b88d5760320 867 # irrespective of the value of the RECURSIVE tag.
kenjiArai 0:5b88d5760320 868 # The default value is: NO.
kenjiArai 0:5b88d5760320 869
kenjiArai 0:5b88d5760320 870 EXAMPLE_RECURSIVE = NO
kenjiArai 0:5b88d5760320 871
kenjiArai 0:5b88d5760320 872 # The IMAGE_PATH tag can be used to specify one or more files or directories
kenjiArai 0:5b88d5760320 873 # that contain images that are to be included in the documentation (see the
kenjiArai 0:5b88d5760320 874 # \image command).
kenjiArai 0:5b88d5760320 875
kenjiArai 0:5b88d5760320 876 IMAGE_PATH =
kenjiArai 0:5b88d5760320 877
kenjiArai 0:5b88d5760320 878 # The INPUT_FILTER tag can be used to specify a program that doxygen should
kenjiArai 0:5b88d5760320 879 # invoke to filter for each input file. Doxygen will invoke the filter program
kenjiArai 0:5b88d5760320 880 # by executing (via popen()) the command:
kenjiArai 0:5b88d5760320 881 #
kenjiArai 0:5b88d5760320 882 # <filter> <input-file>
kenjiArai 0:5b88d5760320 883 #
kenjiArai 0:5b88d5760320 884 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
kenjiArai 0:5b88d5760320 885 # name of an input file. Doxygen will then use the output that the filter
kenjiArai 0:5b88d5760320 886 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
kenjiArai 0:5b88d5760320 887 # will be ignored.
kenjiArai 0:5b88d5760320 888 #
kenjiArai 0:5b88d5760320 889 # Note that the filter must not add or remove lines; it is applied before the
kenjiArai 0:5b88d5760320 890 # code is scanned, but not when the output code is generated. If lines are added
kenjiArai 0:5b88d5760320 891 # or removed, the anchors will not be placed correctly.
kenjiArai 0:5b88d5760320 892
kenjiArai 0:5b88d5760320 893 INPUT_FILTER =
kenjiArai 0:5b88d5760320 894
kenjiArai 0:5b88d5760320 895 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
kenjiArai 0:5b88d5760320 896 # basis. Doxygen will compare the file name with each pattern and apply the
kenjiArai 0:5b88d5760320 897 # filter if there is a match. The filters are a list of the form: pattern=filter
kenjiArai 0:5b88d5760320 898 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
kenjiArai 0:5b88d5760320 899 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
kenjiArai 0:5b88d5760320 900 # patterns match the file name, INPUT_FILTER is applied.
kenjiArai 0:5b88d5760320 901
kenjiArai 0:5b88d5760320 902 FILTER_PATTERNS =
kenjiArai 0:5b88d5760320 903
kenjiArai 0:5b88d5760320 904 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
kenjiArai 0:5b88d5760320 905 # INPUT_FILTER) will also be used to filter the input files that are used for
kenjiArai 0:5b88d5760320 906 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
kenjiArai 0:5b88d5760320 907 # The default value is: NO.
kenjiArai 0:5b88d5760320 908
kenjiArai 0:5b88d5760320 909 FILTER_SOURCE_FILES = NO
kenjiArai 0:5b88d5760320 910
kenjiArai 0:5b88d5760320 911 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
kenjiArai 0:5b88d5760320 912 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
kenjiArai 0:5b88d5760320 913 # it is also possible to disable source filtering for a specific pattern using
kenjiArai 0:5b88d5760320 914 # *.ext= (so without naming a filter).
kenjiArai 0:5b88d5760320 915 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
kenjiArai 0:5b88d5760320 916
kenjiArai 0:5b88d5760320 917 FILTER_SOURCE_PATTERNS =
kenjiArai 0:5b88d5760320 918
kenjiArai 0:5b88d5760320 919 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
kenjiArai 0:5b88d5760320 920 # is part of the input, its contents will be placed on the main page
kenjiArai 0:5b88d5760320 921 # (index.html). This can be useful if you have a project on for instance GitHub
kenjiArai 0:5b88d5760320 922 # and want to reuse the introduction page also for the doxygen output.
kenjiArai 0:5b88d5760320 923
kenjiArai 0:5b88d5760320 924 USE_MDFILE_AS_MAINPAGE = DOXYGEN_FRONTPAGE.md
kenjiArai 0:5b88d5760320 925
kenjiArai 0:5b88d5760320 926 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 927 # Configuration options related to source browsing
kenjiArai 0:5b88d5760320 928 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 929
kenjiArai 0:5b88d5760320 930 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
kenjiArai 0:5b88d5760320 931 # generated. Documented entities will be cross-referenced with these sources.
kenjiArai 0:5b88d5760320 932 #
kenjiArai 0:5b88d5760320 933 # Note: To get rid of all source code in the generated output, make sure that
kenjiArai 0:5b88d5760320 934 # also VERBATIM_HEADERS is set to NO.
kenjiArai 0:5b88d5760320 935 # The default value is: NO.
kenjiArai 0:5b88d5760320 936
kenjiArai 0:5b88d5760320 937 SOURCE_BROWSER = YES
kenjiArai 0:5b88d5760320 938
kenjiArai 0:5b88d5760320 939 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
kenjiArai 0:5b88d5760320 940 # classes and enums directly into the documentation.
kenjiArai 0:5b88d5760320 941 # The default value is: NO.
kenjiArai 0:5b88d5760320 942
kenjiArai 0:5b88d5760320 943 INLINE_SOURCES = NO
kenjiArai 0:5b88d5760320 944
kenjiArai 0:5b88d5760320 945 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
kenjiArai 0:5b88d5760320 946 # special comment blocks from generated source code fragments. Normal C, C++ and
kenjiArai 0:5b88d5760320 947 # Fortran comments will always remain visible.
kenjiArai 0:5b88d5760320 948 # The default value is: YES.
kenjiArai 0:5b88d5760320 949
kenjiArai 0:5b88d5760320 950 STRIP_CODE_COMMENTS = YES
kenjiArai 0:5b88d5760320 951
kenjiArai 0:5b88d5760320 952 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
kenjiArai 0:5b88d5760320 953 # function all documented functions referencing it will be listed.
kenjiArai 0:5b88d5760320 954 # The default value is: NO.
kenjiArai 0:5b88d5760320 955
kenjiArai 0:5b88d5760320 956 REFERENCED_BY_RELATION = YES
kenjiArai 0:5b88d5760320 957
kenjiArai 0:5b88d5760320 958 # If the REFERENCES_RELATION tag is set to YES then for each documented function
kenjiArai 0:5b88d5760320 959 # all documented entities called/used by that function will be listed.
kenjiArai 0:5b88d5760320 960 # The default value is: NO.
kenjiArai 0:5b88d5760320 961
kenjiArai 0:5b88d5760320 962 REFERENCES_RELATION = YES
kenjiArai 0:5b88d5760320 963
kenjiArai 0:5b88d5760320 964 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
kenjiArai 0:5b88d5760320 965 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
kenjiArai 0:5b88d5760320 966 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
kenjiArai 0:5b88d5760320 967 # link to the documentation.
kenjiArai 0:5b88d5760320 968 # The default value is: YES.
kenjiArai 0:5b88d5760320 969
kenjiArai 0:5b88d5760320 970 REFERENCES_LINK_SOURCE = YES
kenjiArai 0:5b88d5760320 971
kenjiArai 0:5b88d5760320 972 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
kenjiArai 0:5b88d5760320 973 # source code will show a tooltip with additional information such as prototype,
kenjiArai 0:5b88d5760320 974 # brief description and links to the definition and documentation. Since this
kenjiArai 0:5b88d5760320 975 # will make the HTML file larger and loading of large files a bit slower, you
kenjiArai 0:5b88d5760320 976 # can opt to disable this feature.
kenjiArai 0:5b88d5760320 977 # The default value is: YES.
kenjiArai 0:5b88d5760320 978 # This tag requires that the tag SOURCE_BROWSER is set to YES.
kenjiArai 0:5b88d5760320 979
kenjiArai 0:5b88d5760320 980 SOURCE_TOOLTIPS = YES
kenjiArai 0:5b88d5760320 981
kenjiArai 0:5b88d5760320 982 # If the USE_HTAGS tag is set to YES then the references to source code will
kenjiArai 0:5b88d5760320 983 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
kenjiArai 0:5b88d5760320 984 # source browser. The htags tool is part of GNU's global source tagging system
kenjiArai 0:5b88d5760320 985 # (see http://www.gnu.org/software/global/global.html). You will need version
kenjiArai 0:5b88d5760320 986 # 4.8.6 or higher.
kenjiArai 0:5b88d5760320 987 #
kenjiArai 0:5b88d5760320 988 # To use it do the following:
kenjiArai 0:5b88d5760320 989 # - Install the latest version of global
kenjiArai 0:5b88d5760320 990 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
kenjiArai 0:5b88d5760320 991 # - Make sure the INPUT points to the root of the source tree
kenjiArai 0:5b88d5760320 992 # - Run doxygen as normal
kenjiArai 0:5b88d5760320 993 #
kenjiArai 0:5b88d5760320 994 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
kenjiArai 0:5b88d5760320 995 # tools must be available from the command line (i.e. in the search path).
kenjiArai 0:5b88d5760320 996 #
kenjiArai 0:5b88d5760320 997 # The result: instead of the source browser generated by doxygen, the links to
kenjiArai 0:5b88d5760320 998 # source code will now point to the output of htags.
kenjiArai 0:5b88d5760320 999 # The default value is: NO.
kenjiArai 0:5b88d5760320 1000 # This tag requires that the tag SOURCE_BROWSER is set to YES.
kenjiArai 0:5b88d5760320 1001
kenjiArai 0:5b88d5760320 1002 USE_HTAGS = NO
kenjiArai 0:5b88d5760320 1003
kenjiArai 0:5b88d5760320 1004 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
kenjiArai 0:5b88d5760320 1005 # verbatim copy of the header file for each class for which an include is
kenjiArai 0:5b88d5760320 1006 # specified. Set to NO to disable this.
kenjiArai 0:5b88d5760320 1007 # See also: Section \class.
kenjiArai 0:5b88d5760320 1008 # The default value is: YES.
kenjiArai 0:5b88d5760320 1009
kenjiArai 0:5b88d5760320 1010 VERBATIM_HEADERS = YES
kenjiArai 0:5b88d5760320 1011
kenjiArai 0:5b88d5760320 1012 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
kenjiArai 0:5b88d5760320 1013 # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
kenjiArai 0:5b88d5760320 1014 # cost of reduced performance. This can be particularly helpful with template
kenjiArai 0:5b88d5760320 1015 # rich C++ code for which doxygen's built-in parser lacks the necessary type
kenjiArai 0:5b88d5760320 1016 # information.
kenjiArai 0:5b88d5760320 1017 # Note: The availability of this option depends on whether or not doxygen was
kenjiArai 0:5b88d5760320 1018 # compiled with the --with-libclang option.
kenjiArai 0:5b88d5760320 1019 # The default value is: NO.
kenjiArai 0:5b88d5760320 1020
kenjiArai 0:5b88d5760320 1021 CLANG_ASSISTED_PARSING = NO
kenjiArai 0:5b88d5760320 1022
kenjiArai 0:5b88d5760320 1023 # If clang assisted parsing is enabled you can provide the compiler with command
kenjiArai 0:5b88d5760320 1024 # line options that you would normally use when invoking the compiler. Note that
kenjiArai 0:5b88d5760320 1025 # the include paths will already be set by doxygen for the files and directories
kenjiArai 0:5b88d5760320 1026 # specified with INPUT and INCLUDE_PATH.
kenjiArai 0:5b88d5760320 1027 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
kenjiArai 0:5b88d5760320 1028
kenjiArai 0:5b88d5760320 1029 CLANG_OPTIONS =
kenjiArai 0:5b88d5760320 1030
kenjiArai 0:5b88d5760320 1031 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 1032 # Configuration options related to the alphabetical class index
kenjiArai 0:5b88d5760320 1033 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 1034
kenjiArai 0:5b88d5760320 1035 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
kenjiArai 0:5b88d5760320 1036 # compounds will be generated. Enable this if the project contains a lot of
kenjiArai 0:5b88d5760320 1037 # classes, structs, unions or interfaces.
kenjiArai 0:5b88d5760320 1038 # The default value is: YES.
kenjiArai 0:5b88d5760320 1039
kenjiArai 0:5b88d5760320 1040 ALPHABETICAL_INDEX = YES
kenjiArai 0:5b88d5760320 1041
kenjiArai 0:5b88d5760320 1042 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
kenjiArai 0:5b88d5760320 1043 # which the alphabetical index list will be split.
kenjiArai 0:5b88d5760320 1044 # Minimum value: 1, maximum value: 20, default value: 5.
kenjiArai 0:5b88d5760320 1045 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
kenjiArai 0:5b88d5760320 1046
kenjiArai 0:5b88d5760320 1047 COLS_IN_ALPHA_INDEX = 5
kenjiArai 0:5b88d5760320 1048
kenjiArai 0:5b88d5760320 1049 # In case all classes in a project start with a common prefix, all classes will
kenjiArai 0:5b88d5760320 1050 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
kenjiArai 0:5b88d5760320 1051 # can be used to specify a prefix (or a list of prefixes) that should be ignored
kenjiArai 0:5b88d5760320 1052 # while generating the index headers.
kenjiArai 0:5b88d5760320 1053 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
kenjiArai 0:5b88d5760320 1054
kenjiArai 0:5b88d5760320 1055 IGNORE_PREFIX =
kenjiArai 0:5b88d5760320 1056
kenjiArai 0:5b88d5760320 1057 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 1058 # Configuration options related to the HTML output
kenjiArai 0:5b88d5760320 1059 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 1060
kenjiArai 0:5b88d5760320 1061 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
kenjiArai 0:5b88d5760320 1062 # The default value is: YES.
kenjiArai 0:5b88d5760320 1063
kenjiArai 0:5b88d5760320 1064 GENERATE_HTML = YES
kenjiArai 0:5b88d5760320 1065
kenjiArai 0:5b88d5760320 1066 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
kenjiArai 0:5b88d5760320 1067 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
kenjiArai 0:5b88d5760320 1068 # it.
kenjiArai 0:5b88d5760320 1069 # The default directory is: html.
kenjiArai 0:5b88d5760320 1070 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1071
kenjiArai 0:5b88d5760320 1072 HTML_OUTPUT = .
kenjiArai 0:5b88d5760320 1073
kenjiArai 0:5b88d5760320 1074 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
kenjiArai 0:5b88d5760320 1075 # generated HTML page (for example: .htm, .php, .asp).
kenjiArai 0:5b88d5760320 1076 # The default value is: .html.
kenjiArai 0:5b88d5760320 1077 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1078
kenjiArai 0:5b88d5760320 1079 HTML_FILE_EXTENSION = .html
kenjiArai 0:5b88d5760320 1080
kenjiArai 0:5b88d5760320 1081 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
kenjiArai 0:5b88d5760320 1082 # each generated HTML page. If the tag is left blank doxygen will generate a
kenjiArai 0:5b88d5760320 1083 # standard header.
kenjiArai 0:5b88d5760320 1084 #
kenjiArai 0:5b88d5760320 1085 # To get valid HTML the header file that includes any scripts and style sheets
kenjiArai 0:5b88d5760320 1086 # that doxygen needs, which is dependent on the configuration options used (e.g.
kenjiArai 0:5b88d5760320 1087 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
kenjiArai 0:5b88d5760320 1088 # default header using
kenjiArai 0:5b88d5760320 1089 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
kenjiArai 0:5b88d5760320 1090 # YourConfigFile
kenjiArai 0:5b88d5760320 1091 # and then modify the file new_header.html. See also section "Doxygen usage"
kenjiArai 0:5b88d5760320 1092 # for information on how to generate the default header that doxygen normally
kenjiArai 0:5b88d5760320 1093 # uses.
kenjiArai 0:5b88d5760320 1094 # Note: The header is subject to change so you typically have to regenerate the
kenjiArai 0:5b88d5760320 1095 # default header when upgrading to a newer version of doxygen. For a description
kenjiArai 0:5b88d5760320 1096 # of the possible markers and block names see the documentation.
kenjiArai 0:5b88d5760320 1097 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1098
kenjiArai 0:5b88d5760320 1099 HTML_HEADER =
kenjiArai 0:5b88d5760320 1100
kenjiArai 0:5b88d5760320 1101 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
kenjiArai 0:5b88d5760320 1102 # generated HTML page. If the tag is left blank doxygen will generate a standard
kenjiArai 0:5b88d5760320 1103 # footer. See HTML_HEADER for more information on how to generate a default
kenjiArai 0:5b88d5760320 1104 # footer and what special commands can be used inside the footer. See also
kenjiArai 0:5b88d5760320 1105 # section "Doxygen usage" for information on how to generate the default footer
kenjiArai 0:5b88d5760320 1106 # that doxygen normally uses.
kenjiArai 0:5b88d5760320 1107 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1108
kenjiArai 0:5b88d5760320 1109 HTML_FOOTER =
kenjiArai 0:5b88d5760320 1110
kenjiArai 0:5b88d5760320 1111 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
kenjiArai 0:5b88d5760320 1112 # sheet that is used by each HTML page. It can be used to fine-tune the look of
kenjiArai 0:5b88d5760320 1113 # the HTML output. If left blank doxygen will generate a default style sheet.
kenjiArai 0:5b88d5760320 1114 # See also section "Doxygen usage" for information on how to generate the style
kenjiArai 0:5b88d5760320 1115 # sheet that doxygen normally uses.
kenjiArai 0:5b88d5760320 1116 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
kenjiArai 0:5b88d5760320 1117 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
kenjiArai 0:5b88d5760320 1118 # obsolete.
kenjiArai 0:5b88d5760320 1119 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1120
kenjiArai 0:5b88d5760320 1121 HTML_STYLESHEET =
kenjiArai 0:5b88d5760320 1122
kenjiArai 0:5b88d5760320 1123 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
kenjiArai 0:5b88d5760320 1124 # cascading style sheets that are included after the standard style sheets
kenjiArai 0:5b88d5760320 1125 # created by doxygen. Using this option one can overrule certain style aspects.
kenjiArai 0:5b88d5760320 1126 # This is preferred over using HTML_STYLESHEET since it does not replace the
kenjiArai 0:5b88d5760320 1127 # standard style sheet and is therefore more robust against future updates.
kenjiArai 0:5b88d5760320 1128 # Doxygen will copy the style sheet files to the output directory.
kenjiArai 0:5b88d5760320 1129 # Note: The order of the extra style sheet files is of importance (e.g. the last
kenjiArai 0:5b88d5760320 1130 # style sheet in the list overrules the setting of the previous ones in the
kenjiArai 0:5b88d5760320 1131 # list). For an example see the documentation.
kenjiArai 0:5b88d5760320 1132 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1133
kenjiArai 0:5b88d5760320 1134 HTML_EXTRA_STYLESHEET =
kenjiArai 0:5b88d5760320 1135
kenjiArai 0:5b88d5760320 1136 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
kenjiArai 0:5b88d5760320 1137 # other source files which should be copied to the HTML output directory. Note
kenjiArai 0:5b88d5760320 1138 # that these files will be copied to the base HTML output directory. Use the
kenjiArai 0:5b88d5760320 1139 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
kenjiArai 0:5b88d5760320 1140 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
kenjiArai 0:5b88d5760320 1141 # files will be copied as-is; there are no commands or markers available.
kenjiArai 0:5b88d5760320 1142 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1143
kenjiArai 0:5b88d5760320 1144 HTML_EXTRA_FILES =
kenjiArai 0:5b88d5760320 1145
kenjiArai 0:5b88d5760320 1146 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
kenjiArai 0:5b88d5760320 1147 # will adjust the colors in the style sheet and background images according to
kenjiArai 0:5b88d5760320 1148 # this color. Hue is specified as an angle on a colorwheel, see
kenjiArai 0:5b88d5760320 1149 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
kenjiArai 0:5b88d5760320 1150 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
kenjiArai 0:5b88d5760320 1151 # purple, and 360 is red again.
kenjiArai 0:5b88d5760320 1152 # Minimum value: 0, maximum value: 359, default value: 220.
kenjiArai 0:5b88d5760320 1153 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1154
kenjiArai 0:5b88d5760320 1155 HTML_COLORSTYLE_HUE = 220
kenjiArai 0:5b88d5760320 1156
kenjiArai 0:5b88d5760320 1157 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
kenjiArai 0:5b88d5760320 1158 # in the HTML output. For a value of 0 the output will use grayscales only. A
kenjiArai 0:5b88d5760320 1159 # value of 255 will produce the most vivid colors.
kenjiArai 0:5b88d5760320 1160 # Minimum value: 0, maximum value: 255, default value: 100.
kenjiArai 0:5b88d5760320 1161 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1162
kenjiArai 0:5b88d5760320 1163 HTML_COLORSTYLE_SAT = 100
kenjiArai 0:5b88d5760320 1164
kenjiArai 0:5b88d5760320 1165 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
kenjiArai 0:5b88d5760320 1166 # luminance component of the colors in the HTML output. Values below 100
kenjiArai 0:5b88d5760320 1167 # gradually make the output lighter, whereas values above 100 make the output
kenjiArai 0:5b88d5760320 1168 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
kenjiArai 0:5b88d5760320 1169 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
kenjiArai 0:5b88d5760320 1170 # change the gamma.
kenjiArai 0:5b88d5760320 1171 # Minimum value: 40, maximum value: 240, default value: 80.
kenjiArai 0:5b88d5760320 1172 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1173
kenjiArai 0:5b88d5760320 1174 HTML_COLORSTYLE_GAMMA = 80
kenjiArai 0:5b88d5760320 1175
kenjiArai 0:5b88d5760320 1176 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
kenjiArai 0:5b88d5760320 1177 # page will contain the date and time when the page was generated. Setting this
kenjiArai 0:5b88d5760320 1178 # to YES can help to show when doxygen was last run and thus if the
kenjiArai 0:5b88d5760320 1179 # documentation is up to date.
kenjiArai 0:5b88d5760320 1180 # The default value is: NO.
kenjiArai 0:5b88d5760320 1181 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1182
kenjiArai 0:5b88d5760320 1183 HTML_TIMESTAMP = YES
kenjiArai 0:5b88d5760320 1184
kenjiArai 0:5b88d5760320 1185 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
kenjiArai 0:5b88d5760320 1186 # documentation will contain sections that can be hidden and shown after the
kenjiArai 0:5b88d5760320 1187 # page has loaded.
kenjiArai 0:5b88d5760320 1188 # The default value is: NO.
kenjiArai 0:5b88d5760320 1189 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1190
kenjiArai 0:5b88d5760320 1191 HTML_DYNAMIC_SECTIONS = NO
kenjiArai 0:5b88d5760320 1192
kenjiArai 0:5b88d5760320 1193 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
kenjiArai 0:5b88d5760320 1194 # shown in the various tree structured indices initially; the user can expand
kenjiArai 0:5b88d5760320 1195 # and collapse entries dynamically later on. Doxygen will expand the tree to
kenjiArai 0:5b88d5760320 1196 # such a level that at most the specified number of entries are visible (unless
kenjiArai 0:5b88d5760320 1197 # a fully collapsed tree already exceeds this amount). So setting the number of
kenjiArai 0:5b88d5760320 1198 # entries 1 will produce a full collapsed tree by default. 0 is a special value
kenjiArai 0:5b88d5760320 1199 # representing an infinite number of entries and will result in a full expanded
kenjiArai 0:5b88d5760320 1200 # tree by default.
kenjiArai 0:5b88d5760320 1201 # Minimum value: 0, maximum value: 9999, default value: 100.
kenjiArai 0:5b88d5760320 1202 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1203
kenjiArai 0:5b88d5760320 1204 HTML_INDEX_NUM_ENTRIES = 100
kenjiArai 0:5b88d5760320 1205
kenjiArai 0:5b88d5760320 1206 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
kenjiArai 0:5b88d5760320 1207 # generated that can be used as input for Apple's Xcode 3 integrated development
kenjiArai 0:5b88d5760320 1208 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
kenjiArai 0:5b88d5760320 1209 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
kenjiArai 0:5b88d5760320 1210 # Makefile in the HTML output directory. Running make will produce the docset in
kenjiArai 0:5b88d5760320 1211 # that directory and running make install will install the docset in
kenjiArai 0:5b88d5760320 1212 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
kenjiArai 0:5b88d5760320 1213 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
kenjiArai 0:5b88d5760320 1214 # for more information.
kenjiArai 0:5b88d5760320 1215 # The default value is: NO.
kenjiArai 0:5b88d5760320 1216 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1217
kenjiArai 0:5b88d5760320 1218 GENERATE_DOCSET = NO
kenjiArai 0:5b88d5760320 1219
kenjiArai 0:5b88d5760320 1220 # This tag determines the name of the docset feed. A documentation feed provides
kenjiArai 0:5b88d5760320 1221 # an umbrella under which multiple documentation sets from a single provider
kenjiArai 0:5b88d5760320 1222 # (such as a company or product suite) can be grouped.
kenjiArai 0:5b88d5760320 1223 # The default value is: Doxygen generated docs.
kenjiArai 0:5b88d5760320 1224 # This tag requires that the tag GENERATE_DOCSET is set to YES.
kenjiArai 0:5b88d5760320 1225
kenjiArai 0:5b88d5760320 1226 DOCSET_FEEDNAME = "Doxygen generated docs"
kenjiArai 0:5b88d5760320 1227
kenjiArai 0:5b88d5760320 1228 # This tag specifies a string that should uniquely identify the documentation
kenjiArai 0:5b88d5760320 1229 # set bundle. This should be a reverse domain-name style string, e.g.
kenjiArai 0:5b88d5760320 1230 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
kenjiArai 0:5b88d5760320 1231 # The default value is: org.doxygen.Project.
kenjiArai 0:5b88d5760320 1232 # This tag requires that the tag GENERATE_DOCSET is set to YES.
kenjiArai 0:5b88d5760320 1233
kenjiArai 0:5b88d5760320 1234 DOCSET_BUNDLE_ID = org.doxygen.Project
kenjiArai 0:5b88d5760320 1235
kenjiArai 0:5b88d5760320 1236 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
kenjiArai 0:5b88d5760320 1237 # the documentation publisher. This should be a reverse domain-name style
kenjiArai 0:5b88d5760320 1238 # string, e.g. com.mycompany.MyDocSet.documentation.
kenjiArai 0:5b88d5760320 1239 # The default value is: org.doxygen.Publisher.
kenjiArai 0:5b88d5760320 1240 # This tag requires that the tag GENERATE_DOCSET is set to YES.
kenjiArai 0:5b88d5760320 1241
kenjiArai 0:5b88d5760320 1242 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
kenjiArai 0:5b88d5760320 1243
kenjiArai 0:5b88d5760320 1244 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
kenjiArai 0:5b88d5760320 1245 # The default value is: Publisher.
kenjiArai 0:5b88d5760320 1246 # This tag requires that the tag GENERATE_DOCSET is set to YES.
kenjiArai 0:5b88d5760320 1247
kenjiArai 0:5b88d5760320 1248 DOCSET_PUBLISHER_NAME = Publisher
kenjiArai 0:5b88d5760320 1249
kenjiArai 0:5b88d5760320 1250 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
kenjiArai 0:5b88d5760320 1251 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
kenjiArai 0:5b88d5760320 1252 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
kenjiArai 0:5b88d5760320 1253 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
kenjiArai 0:5b88d5760320 1254 # Windows.
kenjiArai 0:5b88d5760320 1255 #
kenjiArai 0:5b88d5760320 1256 # The HTML Help Workshop contains a compiler that can convert all HTML output
kenjiArai 0:5b88d5760320 1257 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
kenjiArai 0:5b88d5760320 1258 # files are now used as the Windows 98 help format, and will replace the old
kenjiArai 0:5b88d5760320 1259 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
kenjiArai 0:5b88d5760320 1260 # HTML files also contain an index, a table of contents, and you can search for
kenjiArai 0:5b88d5760320 1261 # words in the documentation. The HTML workshop also contains a viewer for
kenjiArai 0:5b88d5760320 1262 # compressed HTML files.
kenjiArai 0:5b88d5760320 1263 # The default value is: NO.
kenjiArai 0:5b88d5760320 1264 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1265
kenjiArai 0:5b88d5760320 1266 GENERATE_HTMLHELP = NO
kenjiArai 0:5b88d5760320 1267
kenjiArai 0:5b88d5760320 1268 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
kenjiArai 0:5b88d5760320 1269 # file. You can add a path in front of the file if the result should not be
kenjiArai 0:5b88d5760320 1270 # written to the html output directory.
kenjiArai 0:5b88d5760320 1271 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
kenjiArai 0:5b88d5760320 1272
kenjiArai 0:5b88d5760320 1273 CHM_FILE =
kenjiArai 0:5b88d5760320 1274
kenjiArai 0:5b88d5760320 1275 # The HHC_LOCATION tag can be used to specify the location (absolute path
kenjiArai 0:5b88d5760320 1276 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
kenjiArai 0:5b88d5760320 1277 # doxygen will try to run the HTML help compiler on the generated index.hhp.
kenjiArai 0:5b88d5760320 1278 # The file has to be specified with full path.
kenjiArai 0:5b88d5760320 1279 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
kenjiArai 0:5b88d5760320 1280
kenjiArai 0:5b88d5760320 1281 HHC_LOCATION =
kenjiArai 0:5b88d5760320 1282
kenjiArai 0:5b88d5760320 1283 # The GENERATE_CHI flag controls if a separate .chi index file is generated
kenjiArai 0:5b88d5760320 1284 # (YES) or that it should be included in the master .chm file (NO).
kenjiArai 0:5b88d5760320 1285 # The default value is: NO.
kenjiArai 0:5b88d5760320 1286 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
kenjiArai 0:5b88d5760320 1287
kenjiArai 0:5b88d5760320 1288 GENERATE_CHI = NO
kenjiArai 0:5b88d5760320 1289
kenjiArai 0:5b88d5760320 1290 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
kenjiArai 0:5b88d5760320 1291 # and project file content.
kenjiArai 0:5b88d5760320 1292 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
kenjiArai 0:5b88d5760320 1293
kenjiArai 0:5b88d5760320 1294 CHM_INDEX_ENCODING =
kenjiArai 0:5b88d5760320 1295
kenjiArai 0:5b88d5760320 1296 # The BINARY_TOC flag controls whether a binary table of contents is generated
kenjiArai 0:5b88d5760320 1297 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
kenjiArai 0:5b88d5760320 1298 # enables the Previous and Next buttons.
kenjiArai 0:5b88d5760320 1299 # The default value is: NO.
kenjiArai 0:5b88d5760320 1300 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
kenjiArai 0:5b88d5760320 1301
kenjiArai 0:5b88d5760320 1302 BINARY_TOC = NO
kenjiArai 0:5b88d5760320 1303
kenjiArai 0:5b88d5760320 1304 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
kenjiArai 0:5b88d5760320 1305 # the table of contents of the HTML help documentation and to the tree view.
kenjiArai 0:5b88d5760320 1306 # The default value is: NO.
kenjiArai 0:5b88d5760320 1307 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
kenjiArai 0:5b88d5760320 1308
kenjiArai 0:5b88d5760320 1309 TOC_EXPAND = NO
kenjiArai 0:5b88d5760320 1310
kenjiArai 0:5b88d5760320 1311 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
kenjiArai 0:5b88d5760320 1312 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
kenjiArai 0:5b88d5760320 1313 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
kenjiArai 0:5b88d5760320 1314 # (.qch) of the generated HTML documentation.
kenjiArai 0:5b88d5760320 1315 # The default value is: NO.
kenjiArai 0:5b88d5760320 1316 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1317
kenjiArai 0:5b88d5760320 1318 GENERATE_QHP = NO
kenjiArai 0:5b88d5760320 1319
kenjiArai 0:5b88d5760320 1320 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
kenjiArai 0:5b88d5760320 1321 # the file name of the resulting .qch file. The path specified is relative to
kenjiArai 0:5b88d5760320 1322 # the HTML output folder.
kenjiArai 0:5b88d5760320 1323 # This tag requires that the tag GENERATE_QHP is set to YES.
kenjiArai 0:5b88d5760320 1324
kenjiArai 0:5b88d5760320 1325 QCH_FILE =
kenjiArai 0:5b88d5760320 1326
kenjiArai 0:5b88d5760320 1327 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
kenjiArai 0:5b88d5760320 1328 # Project output. For more information please see Qt Help Project / Namespace
kenjiArai 0:5b88d5760320 1329 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
kenjiArai 0:5b88d5760320 1330 # The default value is: org.doxygen.Project.
kenjiArai 0:5b88d5760320 1331 # This tag requires that the tag GENERATE_QHP is set to YES.
kenjiArai 0:5b88d5760320 1332
kenjiArai 0:5b88d5760320 1333 QHP_NAMESPACE = org.doxygen.Project
kenjiArai 0:5b88d5760320 1334
kenjiArai 0:5b88d5760320 1335 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
kenjiArai 0:5b88d5760320 1336 # Help Project output. For more information please see Qt Help Project / Virtual
kenjiArai 0:5b88d5760320 1337 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
kenjiArai 0:5b88d5760320 1338 # folders).
kenjiArai 0:5b88d5760320 1339 # The default value is: doc.
kenjiArai 0:5b88d5760320 1340 # This tag requires that the tag GENERATE_QHP is set to YES.
kenjiArai 0:5b88d5760320 1341
kenjiArai 0:5b88d5760320 1342 QHP_VIRTUAL_FOLDER = doc
kenjiArai 0:5b88d5760320 1343
kenjiArai 0:5b88d5760320 1344 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
kenjiArai 0:5b88d5760320 1345 # filter to add. For more information please see Qt Help Project / Custom
kenjiArai 0:5b88d5760320 1346 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
kenjiArai 0:5b88d5760320 1347 # filters).
kenjiArai 0:5b88d5760320 1348 # This tag requires that the tag GENERATE_QHP is set to YES.
kenjiArai 0:5b88d5760320 1349
kenjiArai 0:5b88d5760320 1350 QHP_CUST_FILTER_NAME =
kenjiArai 0:5b88d5760320 1351
kenjiArai 0:5b88d5760320 1352 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
kenjiArai 0:5b88d5760320 1353 # custom filter to add. For more information please see Qt Help Project / Custom
kenjiArai 0:5b88d5760320 1354 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
kenjiArai 0:5b88d5760320 1355 # filters).
kenjiArai 0:5b88d5760320 1356 # This tag requires that the tag GENERATE_QHP is set to YES.
kenjiArai 0:5b88d5760320 1357
kenjiArai 0:5b88d5760320 1358 QHP_CUST_FILTER_ATTRS =
kenjiArai 0:5b88d5760320 1359
kenjiArai 0:5b88d5760320 1360 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
kenjiArai 0:5b88d5760320 1361 # project's filter section matches. Qt Help Project / Filter Attributes (see:
kenjiArai 0:5b88d5760320 1362 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
kenjiArai 0:5b88d5760320 1363 # This tag requires that the tag GENERATE_QHP is set to YES.
kenjiArai 0:5b88d5760320 1364
kenjiArai 0:5b88d5760320 1365 QHP_SECT_FILTER_ATTRS =
kenjiArai 0:5b88d5760320 1366
kenjiArai 0:5b88d5760320 1367 # The QHG_LOCATION tag can be used to specify the location of Qt's
kenjiArai 0:5b88d5760320 1368 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
kenjiArai 0:5b88d5760320 1369 # generated .qhp file.
kenjiArai 0:5b88d5760320 1370 # This tag requires that the tag GENERATE_QHP is set to YES.
kenjiArai 0:5b88d5760320 1371
kenjiArai 0:5b88d5760320 1372 QHG_LOCATION =
kenjiArai 0:5b88d5760320 1373
kenjiArai 0:5b88d5760320 1374 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
kenjiArai 0:5b88d5760320 1375 # generated, together with the HTML files, they form an Eclipse help plugin. To
kenjiArai 0:5b88d5760320 1376 # install this plugin and make it available under the help contents menu in
kenjiArai 0:5b88d5760320 1377 # Eclipse, the contents of the directory containing the HTML and XML files needs
kenjiArai 0:5b88d5760320 1378 # to be copied into the plugins directory of eclipse. The name of the directory
kenjiArai 0:5b88d5760320 1379 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
kenjiArai 0:5b88d5760320 1380 # After copying Eclipse needs to be restarted before the help appears.
kenjiArai 0:5b88d5760320 1381 # The default value is: NO.
kenjiArai 0:5b88d5760320 1382 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1383
kenjiArai 0:5b88d5760320 1384 GENERATE_ECLIPSEHELP = NO
kenjiArai 0:5b88d5760320 1385
kenjiArai 0:5b88d5760320 1386 # A unique identifier for the Eclipse help plugin. When installing the plugin
kenjiArai 0:5b88d5760320 1387 # the directory name containing the HTML and XML files should also have this
kenjiArai 0:5b88d5760320 1388 # name. Each documentation set should have its own identifier.
kenjiArai 0:5b88d5760320 1389 # The default value is: org.doxygen.Project.
kenjiArai 0:5b88d5760320 1390 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
kenjiArai 0:5b88d5760320 1391
kenjiArai 0:5b88d5760320 1392 ECLIPSE_DOC_ID = org.doxygen.Project
kenjiArai 0:5b88d5760320 1393
kenjiArai 0:5b88d5760320 1394 # If you want full control over the layout of the generated HTML pages it might
kenjiArai 0:5b88d5760320 1395 # be necessary to disable the index and replace it with your own. The
kenjiArai 0:5b88d5760320 1396 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
kenjiArai 0:5b88d5760320 1397 # of each HTML page. A value of NO enables the index and the value YES disables
kenjiArai 0:5b88d5760320 1398 # it. Since the tabs in the index contain the same information as the navigation
kenjiArai 0:5b88d5760320 1399 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
kenjiArai 0:5b88d5760320 1400 # The default value is: NO.
kenjiArai 0:5b88d5760320 1401 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1402
kenjiArai 0:5b88d5760320 1403 DISABLE_INDEX = NO
kenjiArai 0:5b88d5760320 1404
kenjiArai 0:5b88d5760320 1405 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
kenjiArai 0:5b88d5760320 1406 # structure should be generated to display hierarchical information. If the tag
kenjiArai 0:5b88d5760320 1407 # value is set to YES, a side panel will be generated containing a tree-like
kenjiArai 0:5b88d5760320 1408 # index structure (just like the one that is generated for HTML Help). For this
kenjiArai 0:5b88d5760320 1409 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
kenjiArai 0:5b88d5760320 1410 # (i.e. any modern browser). Windows users are probably better off using the
kenjiArai 0:5b88d5760320 1411 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
kenjiArai 0:5b88d5760320 1412 # further fine-tune the look of the index. As an example, the default style
kenjiArai 0:5b88d5760320 1413 # sheet generated by doxygen has an example that shows how to put an image at
kenjiArai 0:5b88d5760320 1414 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
kenjiArai 0:5b88d5760320 1415 # the same information as the tab index, you could consider setting
kenjiArai 0:5b88d5760320 1416 # DISABLE_INDEX to YES when enabling this option.
kenjiArai 0:5b88d5760320 1417 # The default value is: NO.
kenjiArai 0:5b88d5760320 1418 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1419
kenjiArai 0:5b88d5760320 1420 GENERATE_TREEVIEW = NO
kenjiArai 0:5b88d5760320 1421
kenjiArai 0:5b88d5760320 1422 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
kenjiArai 0:5b88d5760320 1423 # doxygen will group on one line in the generated HTML documentation.
kenjiArai 0:5b88d5760320 1424 #
kenjiArai 0:5b88d5760320 1425 # Note that a value of 0 will completely suppress the enum values from appearing
kenjiArai 0:5b88d5760320 1426 # in the overview section.
kenjiArai 0:5b88d5760320 1427 # Minimum value: 0, maximum value: 20, default value: 4.
kenjiArai 0:5b88d5760320 1428 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1429
kenjiArai 0:5b88d5760320 1430 ENUM_VALUES_PER_LINE = 4
kenjiArai 0:5b88d5760320 1431
kenjiArai 0:5b88d5760320 1432 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
kenjiArai 0:5b88d5760320 1433 # to set the initial width (in pixels) of the frame in which the tree is shown.
kenjiArai 0:5b88d5760320 1434 # Minimum value: 0, maximum value: 1500, default value: 250.
kenjiArai 0:5b88d5760320 1435 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1436
kenjiArai 0:5b88d5760320 1437 TREEVIEW_WIDTH = 250
kenjiArai 0:5b88d5760320 1438
kenjiArai 0:5b88d5760320 1439 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
kenjiArai 0:5b88d5760320 1440 # external symbols imported via tag files in a separate window.
kenjiArai 0:5b88d5760320 1441 # The default value is: NO.
kenjiArai 0:5b88d5760320 1442 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1443
kenjiArai 0:5b88d5760320 1444 EXT_LINKS_IN_WINDOW = NO
kenjiArai 0:5b88d5760320 1445
kenjiArai 0:5b88d5760320 1446 # Use this tag to change the font size of LaTeX formulas included as images in
kenjiArai 0:5b88d5760320 1447 # the HTML documentation. When you change the font size after a successful
kenjiArai 0:5b88d5760320 1448 # doxygen run you need to manually remove any form_*.png images from the HTML
kenjiArai 0:5b88d5760320 1449 # output directory to force them to be regenerated.
kenjiArai 0:5b88d5760320 1450 # Minimum value: 8, maximum value: 50, default value: 10.
kenjiArai 0:5b88d5760320 1451 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1452
kenjiArai 0:5b88d5760320 1453 FORMULA_FONTSIZE = 10
kenjiArai 0:5b88d5760320 1454
kenjiArai 0:5b88d5760320 1455 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
kenjiArai 0:5b88d5760320 1456 # generated for formulas are transparent PNGs. Transparent PNGs are not
kenjiArai 0:5b88d5760320 1457 # supported properly for IE 6.0, but are supported on all modern browsers.
kenjiArai 0:5b88d5760320 1458 #
kenjiArai 0:5b88d5760320 1459 # Note that when changing this option you need to delete any form_*.png files in
kenjiArai 0:5b88d5760320 1460 # the HTML output directory before the changes have effect.
kenjiArai 0:5b88d5760320 1461 # The default value is: YES.
kenjiArai 0:5b88d5760320 1462 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1463
kenjiArai 0:5b88d5760320 1464 FORMULA_TRANSPARENT = YES
kenjiArai 0:5b88d5760320 1465
kenjiArai 0:5b88d5760320 1466 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
kenjiArai 0:5b88d5760320 1467 # http://www.mathjax.org) which uses client side Javascript for the rendering
kenjiArai 0:5b88d5760320 1468 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
kenjiArai 0:5b88d5760320 1469 # installed or if you want to formulas look prettier in the HTML output. When
kenjiArai 0:5b88d5760320 1470 # enabled you may also need to install MathJax separately and configure the path
kenjiArai 0:5b88d5760320 1471 # to it using the MATHJAX_RELPATH option.
kenjiArai 0:5b88d5760320 1472 # The default value is: NO.
kenjiArai 0:5b88d5760320 1473 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1474
kenjiArai 0:5b88d5760320 1475 USE_MATHJAX = NO
kenjiArai 0:5b88d5760320 1476
kenjiArai 0:5b88d5760320 1477 # When MathJax is enabled you can set the default output format to be used for
kenjiArai 0:5b88d5760320 1478 # the MathJax output. See the MathJax site (see:
kenjiArai 0:5b88d5760320 1479 # http://docs.mathjax.org/en/latest/output.html) for more details.
kenjiArai 0:5b88d5760320 1480 # Possible values are: HTML-CSS (which is slower, but has the best
kenjiArai 0:5b88d5760320 1481 # compatibility), NativeMML (i.e. MathML) and SVG.
kenjiArai 0:5b88d5760320 1482 # The default value is: HTML-CSS.
kenjiArai 0:5b88d5760320 1483 # This tag requires that the tag USE_MATHJAX is set to YES.
kenjiArai 0:5b88d5760320 1484
kenjiArai 0:5b88d5760320 1485 MATHJAX_FORMAT = HTML-CSS
kenjiArai 0:5b88d5760320 1486
kenjiArai 0:5b88d5760320 1487 # When MathJax is enabled you need to specify the location relative to the HTML
kenjiArai 0:5b88d5760320 1488 # output directory using the MATHJAX_RELPATH option. The destination directory
kenjiArai 0:5b88d5760320 1489 # should contain the MathJax.js script. For instance, if the mathjax directory
kenjiArai 0:5b88d5760320 1490 # is located at the same level as the HTML output directory, then
kenjiArai 0:5b88d5760320 1491 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
kenjiArai 0:5b88d5760320 1492 # Content Delivery Network so you can quickly see the result without installing
kenjiArai 0:5b88d5760320 1493 # MathJax. However, it is strongly recommended to install a local copy of
kenjiArai 0:5b88d5760320 1494 # MathJax from http://www.mathjax.org before deployment.
kenjiArai 0:5b88d5760320 1495 # The default value is: http://cdn.mathjax.org/mathjax/latest.
kenjiArai 0:5b88d5760320 1496 # This tag requires that the tag USE_MATHJAX is set to YES.
kenjiArai 0:5b88d5760320 1497
kenjiArai 0:5b88d5760320 1498 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
kenjiArai 0:5b88d5760320 1499
kenjiArai 0:5b88d5760320 1500 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
kenjiArai 0:5b88d5760320 1501 # extension names that should be enabled during MathJax rendering. For example
kenjiArai 0:5b88d5760320 1502 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
kenjiArai 0:5b88d5760320 1503 # This tag requires that the tag USE_MATHJAX is set to YES.
kenjiArai 0:5b88d5760320 1504
kenjiArai 0:5b88d5760320 1505 MATHJAX_EXTENSIONS =
kenjiArai 0:5b88d5760320 1506
kenjiArai 0:5b88d5760320 1507 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
kenjiArai 0:5b88d5760320 1508 # of code that will be used on startup of the MathJax code. See the MathJax site
kenjiArai 0:5b88d5760320 1509 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
kenjiArai 0:5b88d5760320 1510 # example see the documentation.
kenjiArai 0:5b88d5760320 1511 # This tag requires that the tag USE_MATHJAX is set to YES.
kenjiArai 0:5b88d5760320 1512
kenjiArai 0:5b88d5760320 1513 MATHJAX_CODEFILE =
kenjiArai 0:5b88d5760320 1514
kenjiArai 0:5b88d5760320 1515 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
kenjiArai 0:5b88d5760320 1516 # the HTML output. The underlying search engine uses javascript and DHTML and
kenjiArai 0:5b88d5760320 1517 # should work on any modern browser. Note that when using HTML help
kenjiArai 0:5b88d5760320 1518 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
kenjiArai 0:5b88d5760320 1519 # there is already a search function so this one should typically be disabled.
kenjiArai 0:5b88d5760320 1520 # For large projects the javascript based search engine can be slow, then
kenjiArai 0:5b88d5760320 1521 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
kenjiArai 0:5b88d5760320 1522 # search using the keyboard; to jump to the search box use <access key> + S
kenjiArai 0:5b88d5760320 1523 # (what the <access key> is depends on the OS and browser, but it is typically
kenjiArai 0:5b88d5760320 1524 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
kenjiArai 0:5b88d5760320 1525 # key> to jump into the search results window, the results can be navigated
kenjiArai 0:5b88d5760320 1526 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
kenjiArai 0:5b88d5760320 1527 # the search. The filter options can be selected when the cursor is inside the
kenjiArai 0:5b88d5760320 1528 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
kenjiArai 0:5b88d5760320 1529 # to select a filter and <Enter> or <escape> to activate or cancel the filter
kenjiArai 0:5b88d5760320 1530 # option.
kenjiArai 0:5b88d5760320 1531 # The default value is: YES.
kenjiArai 0:5b88d5760320 1532 # This tag requires that the tag GENERATE_HTML is set to YES.
kenjiArai 0:5b88d5760320 1533
kenjiArai 0:5b88d5760320 1534 SEARCHENGINE = YES
kenjiArai 0:5b88d5760320 1535
kenjiArai 0:5b88d5760320 1536 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
kenjiArai 0:5b88d5760320 1537 # implemented using a web server instead of a web client using Javascript. There
kenjiArai 0:5b88d5760320 1538 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
kenjiArai 0:5b88d5760320 1539 # setting. When disabled, doxygen will generate a PHP script for searching and
kenjiArai 0:5b88d5760320 1540 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
kenjiArai 0:5b88d5760320 1541 # and searching needs to be provided by external tools. See the section
kenjiArai 0:5b88d5760320 1542 # "External Indexing and Searching" for details.
kenjiArai 0:5b88d5760320 1543 # The default value is: NO.
kenjiArai 0:5b88d5760320 1544 # This tag requires that the tag SEARCHENGINE is set to YES.
kenjiArai 0:5b88d5760320 1545
kenjiArai 0:5b88d5760320 1546 SERVER_BASED_SEARCH = NO
kenjiArai 0:5b88d5760320 1547
kenjiArai 0:5b88d5760320 1548 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
kenjiArai 0:5b88d5760320 1549 # script for searching. Instead the search results are written to an XML file
kenjiArai 0:5b88d5760320 1550 # which needs to be processed by an external indexer. Doxygen will invoke an
kenjiArai 0:5b88d5760320 1551 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
kenjiArai 0:5b88d5760320 1552 # search results.
kenjiArai 0:5b88d5760320 1553 #
kenjiArai 0:5b88d5760320 1554 # Doxygen ships with an example indexer (doxyindexer) and search engine
kenjiArai 0:5b88d5760320 1555 # (doxysearch.cgi) which are based on the open source search engine library
kenjiArai 0:5b88d5760320 1556 # Xapian (see: http://xapian.org/).
kenjiArai 0:5b88d5760320 1557 #
kenjiArai 0:5b88d5760320 1558 # See the section "External Indexing and Searching" for details.
kenjiArai 0:5b88d5760320 1559 # The default value is: NO.
kenjiArai 0:5b88d5760320 1560 # This tag requires that the tag SEARCHENGINE is set to YES.
kenjiArai 0:5b88d5760320 1561
kenjiArai 0:5b88d5760320 1562 EXTERNAL_SEARCH = NO
kenjiArai 0:5b88d5760320 1563
kenjiArai 0:5b88d5760320 1564 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
kenjiArai 0:5b88d5760320 1565 # which will return the search results when EXTERNAL_SEARCH is enabled.
kenjiArai 0:5b88d5760320 1566 #
kenjiArai 0:5b88d5760320 1567 # Doxygen ships with an example indexer (doxyindexer) and search engine
kenjiArai 0:5b88d5760320 1568 # (doxysearch.cgi) which are based on the open source search engine library
kenjiArai 0:5b88d5760320 1569 # Xapian (see: http://xapian.org/). See the section "External Indexing and
kenjiArai 0:5b88d5760320 1570 # Searching" for details.
kenjiArai 0:5b88d5760320 1571 # This tag requires that the tag SEARCHENGINE is set to YES.
kenjiArai 0:5b88d5760320 1572
kenjiArai 0:5b88d5760320 1573 SEARCHENGINE_URL =
kenjiArai 0:5b88d5760320 1574
kenjiArai 0:5b88d5760320 1575 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
kenjiArai 0:5b88d5760320 1576 # search data is written to a file for indexing by an external tool. With the
kenjiArai 0:5b88d5760320 1577 # SEARCHDATA_FILE tag the name of this file can be specified.
kenjiArai 0:5b88d5760320 1578 # The default file is: searchdata.xml.
kenjiArai 0:5b88d5760320 1579 # This tag requires that the tag SEARCHENGINE is set to YES.
kenjiArai 0:5b88d5760320 1580
kenjiArai 0:5b88d5760320 1581 SEARCHDATA_FILE = searchdata.xml
kenjiArai 0:5b88d5760320 1582
kenjiArai 0:5b88d5760320 1583 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
kenjiArai 0:5b88d5760320 1584 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
kenjiArai 0:5b88d5760320 1585 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
kenjiArai 0:5b88d5760320 1586 # projects and redirect the results back to the right project.
kenjiArai 0:5b88d5760320 1587 # This tag requires that the tag SEARCHENGINE is set to YES.
kenjiArai 0:5b88d5760320 1588
kenjiArai 0:5b88d5760320 1589 EXTERNAL_SEARCH_ID =
kenjiArai 0:5b88d5760320 1590
kenjiArai 0:5b88d5760320 1591 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
kenjiArai 0:5b88d5760320 1592 # projects other than the one defined by this configuration file, but that are
kenjiArai 0:5b88d5760320 1593 # all added to the same external search index. Each project needs to have a
kenjiArai 0:5b88d5760320 1594 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
kenjiArai 0:5b88d5760320 1595 # to a relative location where the documentation can be found. The format is:
kenjiArai 0:5b88d5760320 1596 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
kenjiArai 0:5b88d5760320 1597 # This tag requires that the tag SEARCHENGINE is set to YES.
kenjiArai 0:5b88d5760320 1598
kenjiArai 0:5b88d5760320 1599 EXTRA_SEARCH_MAPPINGS =
kenjiArai 0:5b88d5760320 1600
kenjiArai 0:5b88d5760320 1601 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 1602 # Configuration options related to the LaTeX output
kenjiArai 0:5b88d5760320 1603 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 1604
kenjiArai 0:5b88d5760320 1605 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
kenjiArai 0:5b88d5760320 1606 # The default value is: YES.
kenjiArai 0:5b88d5760320 1607
kenjiArai 0:5b88d5760320 1608 GENERATE_LATEX = NO
kenjiArai 0:5b88d5760320 1609
kenjiArai 0:5b88d5760320 1610 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
kenjiArai 0:5b88d5760320 1611 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
kenjiArai 0:5b88d5760320 1612 # it.
kenjiArai 0:5b88d5760320 1613 # The default directory is: latex.
kenjiArai 0:5b88d5760320 1614 # This tag requires that the tag GENERATE_LATEX is set to YES.
kenjiArai 0:5b88d5760320 1615
kenjiArai 0:5b88d5760320 1616 LATEX_OUTPUT = latex
kenjiArai 0:5b88d5760320 1617
kenjiArai 0:5b88d5760320 1618 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
kenjiArai 0:5b88d5760320 1619 # invoked.
kenjiArai 0:5b88d5760320 1620 #
kenjiArai 0:5b88d5760320 1621 # Note that when enabling USE_PDFLATEX this option is only used for generating
kenjiArai 0:5b88d5760320 1622 # bitmaps for formulas in the HTML output, but not in the Makefile that is
kenjiArai 0:5b88d5760320 1623 # written to the output directory.
kenjiArai 0:5b88d5760320 1624 # The default file is: latex.
kenjiArai 0:5b88d5760320 1625 # This tag requires that the tag GENERATE_LATEX is set to YES.
kenjiArai 0:5b88d5760320 1626
kenjiArai 0:5b88d5760320 1627 LATEX_CMD_NAME = latex
kenjiArai 0:5b88d5760320 1628
kenjiArai 0:5b88d5760320 1629 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
kenjiArai 0:5b88d5760320 1630 # index for LaTeX.
kenjiArai 0:5b88d5760320 1631 # The default file is: makeindex.
kenjiArai 0:5b88d5760320 1632 # This tag requires that the tag GENERATE_LATEX is set to YES.
kenjiArai 0:5b88d5760320 1633
kenjiArai 0:5b88d5760320 1634 MAKEINDEX_CMD_NAME = makeindex
kenjiArai 0:5b88d5760320 1635
kenjiArai 0:5b88d5760320 1636 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
kenjiArai 0:5b88d5760320 1637 # documents. This may be useful for small projects and may help to save some
kenjiArai 0:5b88d5760320 1638 # trees in general.
kenjiArai 0:5b88d5760320 1639 # The default value is: NO.
kenjiArai 0:5b88d5760320 1640 # This tag requires that the tag GENERATE_LATEX is set to YES.
kenjiArai 0:5b88d5760320 1641
kenjiArai 0:5b88d5760320 1642 COMPACT_LATEX = YES
kenjiArai 0:5b88d5760320 1643
kenjiArai 0:5b88d5760320 1644 # The PAPER_TYPE tag can be used to set the paper type that is used by the
kenjiArai 0:5b88d5760320 1645 # printer.
kenjiArai 0:5b88d5760320 1646 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
kenjiArai 0:5b88d5760320 1647 # 14 inches) and executive (7.25 x 10.5 inches).
kenjiArai 0:5b88d5760320 1648 # The default value is: a4.
kenjiArai 0:5b88d5760320 1649 # This tag requires that the tag GENERATE_LATEX is set to YES.
kenjiArai 0:5b88d5760320 1650
kenjiArai 0:5b88d5760320 1651 PAPER_TYPE = a4wide
kenjiArai 0:5b88d5760320 1652
kenjiArai 0:5b88d5760320 1653 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
kenjiArai 0:5b88d5760320 1654 # that should be included in the LaTeX output. The package can be specified just
kenjiArai 0:5b88d5760320 1655 # by its name or with the correct syntax as to be used with the LaTeX
kenjiArai 0:5b88d5760320 1656 # \usepackage command. To get the times font for instance you can specify :
kenjiArai 0:5b88d5760320 1657 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
kenjiArai 0:5b88d5760320 1658 # To use the option intlimits with the amsmath package you can specify:
kenjiArai 0:5b88d5760320 1659 # EXTRA_PACKAGES=[intlimits]{amsmath}
kenjiArai 0:5b88d5760320 1660 # If left blank no extra packages will be included.
kenjiArai 0:5b88d5760320 1661 # This tag requires that the tag GENERATE_LATEX is set to YES.
kenjiArai 0:5b88d5760320 1662
kenjiArai 0:5b88d5760320 1663 EXTRA_PACKAGES =
kenjiArai 0:5b88d5760320 1664
kenjiArai 0:5b88d5760320 1665 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
kenjiArai 0:5b88d5760320 1666 # generated LaTeX document. The header should contain everything until the first
kenjiArai 0:5b88d5760320 1667 # chapter. If it is left blank doxygen will generate a standard header. See
kenjiArai 0:5b88d5760320 1668 # section "Doxygen usage" for information on how to let doxygen write the
kenjiArai 0:5b88d5760320 1669 # default header to a separate file.
kenjiArai 0:5b88d5760320 1670 #
kenjiArai 0:5b88d5760320 1671 # Note: Only use a user-defined header if you know what you are doing! The
kenjiArai 0:5b88d5760320 1672 # following commands have a special meaning inside the header: $title,
kenjiArai 0:5b88d5760320 1673 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
kenjiArai 0:5b88d5760320 1674 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
kenjiArai 0:5b88d5760320 1675 # string, for the replacement values of the other commands the user is referred
kenjiArai 0:5b88d5760320 1676 # to HTML_HEADER.
kenjiArai 0:5b88d5760320 1677 # This tag requires that the tag GENERATE_LATEX is set to YES.
kenjiArai 0:5b88d5760320 1678
kenjiArai 0:5b88d5760320 1679 LATEX_HEADER =
kenjiArai 0:5b88d5760320 1680
kenjiArai 0:5b88d5760320 1681 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
kenjiArai 0:5b88d5760320 1682 # generated LaTeX document. The footer should contain everything after the last
kenjiArai 0:5b88d5760320 1683 # chapter. If it is left blank doxygen will generate a standard footer. See
kenjiArai 0:5b88d5760320 1684 # LATEX_HEADER for more information on how to generate a default footer and what
kenjiArai 0:5b88d5760320 1685 # special commands can be used inside the footer.
kenjiArai 0:5b88d5760320 1686 #
kenjiArai 0:5b88d5760320 1687 # Note: Only use a user-defined footer if you know what you are doing!
kenjiArai 0:5b88d5760320 1688 # This tag requires that the tag GENERATE_LATEX is set to YES.
kenjiArai 0:5b88d5760320 1689
kenjiArai 0:5b88d5760320 1690 LATEX_FOOTER =
kenjiArai 0:5b88d5760320 1691
kenjiArai 0:5b88d5760320 1692 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
kenjiArai 0:5b88d5760320 1693 # LaTeX style sheets that are included after the standard style sheets created
kenjiArai 0:5b88d5760320 1694 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
kenjiArai 0:5b88d5760320 1695 # will copy the style sheet files to the output directory.
kenjiArai 0:5b88d5760320 1696 # Note: The order of the extra style sheet files is of importance (e.g. the last
kenjiArai 0:5b88d5760320 1697 # style sheet in the list overrules the setting of the previous ones in the
kenjiArai 0:5b88d5760320 1698 # list).
kenjiArai 0:5b88d5760320 1699 # This tag requires that the tag GENERATE_LATEX is set to YES.
kenjiArai 0:5b88d5760320 1700
kenjiArai 0:5b88d5760320 1701 LATEX_EXTRA_STYLESHEET =
kenjiArai 0:5b88d5760320 1702
kenjiArai 0:5b88d5760320 1703 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
kenjiArai 0:5b88d5760320 1704 # other source files which should be copied to the LATEX_OUTPUT output
kenjiArai 0:5b88d5760320 1705 # directory. Note that the files will be copied as-is; there are no commands or
kenjiArai 0:5b88d5760320 1706 # markers available.
kenjiArai 0:5b88d5760320 1707 # This tag requires that the tag GENERATE_LATEX is set to YES.
kenjiArai 0:5b88d5760320 1708
kenjiArai 0:5b88d5760320 1709 LATEX_EXTRA_FILES =
kenjiArai 0:5b88d5760320 1710
kenjiArai 0:5b88d5760320 1711 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
kenjiArai 0:5b88d5760320 1712 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
kenjiArai 0:5b88d5760320 1713 # contain links (just like the HTML output) instead of page references. This
kenjiArai 0:5b88d5760320 1714 # makes the output suitable for online browsing using a PDF viewer.
kenjiArai 0:5b88d5760320 1715 # The default value is: YES.
kenjiArai 0:5b88d5760320 1716 # This tag requires that the tag GENERATE_LATEX is set to YES.
kenjiArai 0:5b88d5760320 1717
kenjiArai 0:5b88d5760320 1718 PDF_HYPERLINKS = YES
kenjiArai 0:5b88d5760320 1719
kenjiArai 0:5b88d5760320 1720 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
kenjiArai 0:5b88d5760320 1721 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
kenjiArai 0:5b88d5760320 1722 # higher quality PDF documentation.
kenjiArai 0:5b88d5760320 1723 # The default value is: YES.
kenjiArai 0:5b88d5760320 1724 # This tag requires that the tag GENERATE_LATEX is set to YES.
kenjiArai 0:5b88d5760320 1725
kenjiArai 0:5b88d5760320 1726 USE_PDFLATEX = YES
kenjiArai 0:5b88d5760320 1727
kenjiArai 0:5b88d5760320 1728 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
kenjiArai 0:5b88d5760320 1729 # command to the generated LaTeX files. This will instruct LaTeX to keep running
kenjiArai 0:5b88d5760320 1730 # if errors occur, instead of asking the user for help. This option is also used
kenjiArai 0:5b88d5760320 1731 # when generating formulas in HTML.
kenjiArai 0:5b88d5760320 1732 # The default value is: NO.
kenjiArai 0:5b88d5760320 1733 # This tag requires that the tag GENERATE_LATEX is set to YES.
kenjiArai 0:5b88d5760320 1734
kenjiArai 0:5b88d5760320 1735 LATEX_BATCHMODE = NO
kenjiArai 0:5b88d5760320 1736
kenjiArai 0:5b88d5760320 1737 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
kenjiArai 0:5b88d5760320 1738 # index chapters (such as File Index, Compound Index, etc.) in the output.
kenjiArai 0:5b88d5760320 1739 # The default value is: NO.
kenjiArai 0:5b88d5760320 1740 # This tag requires that the tag GENERATE_LATEX is set to YES.
kenjiArai 0:5b88d5760320 1741
kenjiArai 0:5b88d5760320 1742 LATEX_HIDE_INDICES = NO
kenjiArai 0:5b88d5760320 1743
kenjiArai 0:5b88d5760320 1744 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
kenjiArai 0:5b88d5760320 1745 # code with syntax highlighting in the LaTeX output.
kenjiArai 0:5b88d5760320 1746 #
kenjiArai 0:5b88d5760320 1747 # Note that which sources are shown also depends on other settings such as
kenjiArai 0:5b88d5760320 1748 # SOURCE_BROWSER.
kenjiArai 0:5b88d5760320 1749 # The default value is: NO.
kenjiArai 0:5b88d5760320 1750 # This tag requires that the tag GENERATE_LATEX is set to YES.
kenjiArai 0:5b88d5760320 1751
kenjiArai 0:5b88d5760320 1752 LATEX_SOURCE_CODE = NO
kenjiArai 0:5b88d5760320 1753
kenjiArai 0:5b88d5760320 1754 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
kenjiArai 0:5b88d5760320 1755 # bibliography, e.g. plainnat, or ieeetr. See
kenjiArai 0:5b88d5760320 1756 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
kenjiArai 0:5b88d5760320 1757 # The default value is: plain.
kenjiArai 0:5b88d5760320 1758 # This tag requires that the tag GENERATE_LATEX is set to YES.
kenjiArai 0:5b88d5760320 1759
kenjiArai 0:5b88d5760320 1760 LATEX_BIB_STYLE = plain
kenjiArai 0:5b88d5760320 1761
kenjiArai 0:5b88d5760320 1762 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 1763 # Configuration options related to the RTF output
kenjiArai 0:5b88d5760320 1764 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 1765
kenjiArai 0:5b88d5760320 1766 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
kenjiArai 0:5b88d5760320 1767 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
kenjiArai 0:5b88d5760320 1768 # readers/editors.
kenjiArai 0:5b88d5760320 1769 # The default value is: NO.
kenjiArai 0:5b88d5760320 1770
kenjiArai 0:5b88d5760320 1771 GENERATE_RTF = NO
kenjiArai 0:5b88d5760320 1772
kenjiArai 0:5b88d5760320 1773 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
kenjiArai 0:5b88d5760320 1774 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
kenjiArai 0:5b88d5760320 1775 # it.
kenjiArai 0:5b88d5760320 1776 # The default directory is: rtf.
kenjiArai 0:5b88d5760320 1777 # This tag requires that the tag GENERATE_RTF is set to YES.
kenjiArai 0:5b88d5760320 1778
kenjiArai 0:5b88d5760320 1779 RTF_OUTPUT = rtf
kenjiArai 0:5b88d5760320 1780
kenjiArai 0:5b88d5760320 1781 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
kenjiArai 0:5b88d5760320 1782 # documents. This may be useful for small projects and may help to save some
kenjiArai 0:5b88d5760320 1783 # trees in general.
kenjiArai 0:5b88d5760320 1784 # The default value is: NO.
kenjiArai 0:5b88d5760320 1785 # This tag requires that the tag GENERATE_RTF is set to YES.
kenjiArai 0:5b88d5760320 1786
kenjiArai 0:5b88d5760320 1787 COMPACT_RTF = NO
kenjiArai 0:5b88d5760320 1788
kenjiArai 0:5b88d5760320 1789 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
kenjiArai 0:5b88d5760320 1790 # contain hyperlink fields. The RTF file will contain links (just like the HTML
kenjiArai 0:5b88d5760320 1791 # output) instead of page references. This makes the output suitable for online
kenjiArai 0:5b88d5760320 1792 # browsing using Word or some other Word compatible readers that support those
kenjiArai 0:5b88d5760320 1793 # fields.
kenjiArai 0:5b88d5760320 1794 #
kenjiArai 0:5b88d5760320 1795 # Note: WordPad (write) and others do not support links.
kenjiArai 0:5b88d5760320 1796 # The default value is: NO.
kenjiArai 0:5b88d5760320 1797 # This tag requires that the tag GENERATE_RTF is set to YES.
kenjiArai 0:5b88d5760320 1798
kenjiArai 0:5b88d5760320 1799 RTF_HYPERLINKS = NO
kenjiArai 0:5b88d5760320 1800
kenjiArai 0:5b88d5760320 1801 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
kenjiArai 0:5b88d5760320 1802 # file, i.e. a series of assignments. You only have to provide replacements,
kenjiArai 0:5b88d5760320 1803 # missing definitions are set to their default value.
kenjiArai 0:5b88d5760320 1804 #
kenjiArai 0:5b88d5760320 1805 # See also section "Doxygen usage" for information on how to generate the
kenjiArai 0:5b88d5760320 1806 # default style sheet that doxygen normally uses.
kenjiArai 0:5b88d5760320 1807 # This tag requires that the tag GENERATE_RTF is set to YES.
kenjiArai 0:5b88d5760320 1808
kenjiArai 0:5b88d5760320 1809 RTF_STYLESHEET_FILE =
kenjiArai 0:5b88d5760320 1810
kenjiArai 0:5b88d5760320 1811 # Set optional variables used in the generation of an RTF document. Syntax is
kenjiArai 0:5b88d5760320 1812 # similar to doxygen's config file. A template extensions file can be generated
kenjiArai 0:5b88d5760320 1813 # using doxygen -e rtf extensionFile.
kenjiArai 0:5b88d5760320 1814 # This tag requires that the tag GENERATE_RTF is set to YES.
kenjiArai 0:5b88d5760320 1815
kenjiArai 0:5b88d5760320 1816 RTF_EXTENSIONS_FILE =
kenjiArai 0:5b88d5760320 1817
kenjiArai 0:5b88d5760320 1818 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
kenjiArai 0:5b88d5760320 1819 # with syntax highlighting in the RTF output.
kenjiArai 0:5b88d5760320 1820 #
kenjiArai 0:5b88d5760320 1821 # Note that which sources are shown also depends on other settings such as
kenjiArai 0:5b88d5760320 1822 # SOURCE_BROWSER.
kenjiArai 0:5b88d5760320 1823 # The default value is: NO.
kenjiArai 0:5b88d5760320 1824 # This tag requires that the tag GENERATE_RTF is set to YES.
kenjiArai 0:5b88d5760320 1825
kenjiArai 0:5b88d5760320 1826 RTF_SOURCE_CODE = NO
kenjiArai 0:5b88d5760320 1827
kenjiArai 0:5b88d5760320 1828 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 1829 # Configuration options related to the man page output
kenjiArai 0:5b88d5760320 1830 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 1831
kenjiArai 0:5b88d5760320 1832 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
kenjiArai 0:5b88d5760320 1833 # classes and files.
kenjiArai 0:5b88d5760320 1834 # The default value is: NO.
kenjiArai 0:5b88d5760320 1835
kenjiArai 0:5b88d5760320 1836 GENERATE_MAN = NO
kenjiArai 0:5b88d5760320 1837
kenjiArai 0:5b88d5760320 1838 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
kenjiArai 0:5b88d5760320 1839 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
kenjiArai 0:5b88d5760320 1840 # it. A directory man3 will be created inside the directory specified by
kenjiArai 0:5b88d5760320 1841 # MAN_OUTPUT.
kenjiArai 0:5b88d5760320 1842 # The default directory is: man.
kenjiArai 0:5b88d5760320 1843 # This tag requires that the tag GENERATE_MAN is set to YES.
kenjiArai 0:5b88d5760320 1844
kenjiArai 0:5b88d5760320 1845 MAN_OUTPUT = man
kenjiArai 0:5b88d5760320 1846
kenjiArai 0:5b88d5760320 1847 # The MAN_EXTENSION tag determines the extension that is added to the generated
kenjiArai 0:5b88d5760320 1848 # man pages. In case the manual section does not start with a number, the number
kenjiArai 0:5b88d5760320 1849 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
kenjiArai 0:5b88d5760320 1850 # optional.
kenjiArai 0:5b88d5760320 1851 # The default value is: .3.
kenjiArai 0:5b88d5760320 1852 # This tag requires that the tag GENERATE_MAN is set to YES.
kenjiArai 0:5b88d5760320 1853
kenjiArai 0:5b88d5760320 1854 MAN_EXTENSION = .3
kenjiArai 0:5b88d5760320 1855
kenjiArai 0:5b88d5760320 1856 # The MAN_SUBDIR tag determines the name of the directory created within
kenjiArai 0:5b88d5760320 1857 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
kenjiArai 0:5b88d5760320 1858 # MAN_EXTENSION with the initial . removed.
kenjiArai 0:5b88d5760320 1859 # This tag requires that the tag GENERATE_MAN is set to YES.
kenjiArai 0:5b88d5760320 1860
kenjiArai 0:5b88d5760320 1861 MAN_SUBDIR =
kenjiArai 0:5b88d5760320 1862
kenjiArai 0:5b88d5760320 1863 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
kenjiArai 0:5b88d5760320 1864 # will generate one additional man file for each entity documented in the real
kenjiArai 0:5b88d5760320 1865 # man page(s). These additional files only source the real man page, but without
kenjiArai 0:5b88d5760320 1866 # them the man command would be unable to find the correct page.
kenjiArai 0:5b88d5760320 1867 # The default value is: NO.
kenjiArai 0:5b88d5760320 1868 # This tag requires that the tag GENERATE_MAN is set to YES.
kenjiArai 0:5b88d5760320 1869
kenjiArai 0:5b88d5760320 1870 MAN_LINKS = NO
kenjiArai 0:5b88d5760320 1871
kenjiArai 0:5b88d5760320 1872 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 1873 # Configuration options related to the XML output
kenjiArai 0:5b88d5760320 1874 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 1875
kenjiArai 0:5b88d5760320 1876 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
kenjiArai 0:5b88d5760320 1877 # captures the structure of the code including all documentation.
kenjiArai 0:5b88d5760320 1878 # The default value is: NO.
kenjiArai 0:5b88d5760320 1879
kenjiArai 0:5b88d5760320 1880 GENERATE_XML = NO
kenjiArai 0:5b88d5760320 1881
kenjiArai 0:5b88d5760320 1882 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
kenjiArai 0:5b88d5760320 1883 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
kenjiArai 0:5b88d5760320 1884 # it.
kenjiArai 0:5b88d5760320 1885 # The default directory is: xml.
kenjiArai 0:5b88d5760320 1886 # This tag requires that the tag GENERATE_XML is set to YES.
kenjiArai 0:5b88d5760320 1887
kenjiArai 0:5b88d5760320 1888 XML_OUTPUT = xml
kenjiArai 0:5b88d5760320 1889
kenjiArai 0:5b88d5760320 1890 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
kenjiArai 0:5b88d5760320 1891 # listings (including syntax highlighting and cross-referencing information) to
kenjiArai 0:5b88d5760320 1892 # the XML output. Note that enabling this will significantly increase the size
kenjiArai 0:5b88d5760320 1893 # of the XML output.
kenjiArai 0:5b88d5760320 1894 # The default value is: YES.
kenjiArai 0:5b88d5760320 1895 # This tag requires that the tag GENERATE_XML is set to YES.
kenjiArai 0:5b88d5760320 1896
kenjiArai 0:5b88d5760320 1897 XML_PROGRAMLISTING = YES
kenjiArai 0:5b88d5760320 1898
kenjiArai 0:5b88d5760320 1899 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 1900 # Configuration options related to the DOCBOOK output
kenjiArai 0:5b88d5760320 1901 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 1902
kenjiArai 0:5b88d5760320 1903 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
kenjiArai 0:5b88d5760320 1904 # that can be used to generate PDF.
kenjiArai 0:5b88d5760320 1905 # The default value is: NO.
kenjiArai 0:5b88d5760320 1906
kenjiArai 0:5b88d5760320 1907 GENERATE_DOCBOOK = NO
kenjiArai 0:5b88d5760320 1908
kenjiArai 0:5b88d5760320 1909 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
kenjiArai 0:5b88d5760320 1910 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
kenjiArai 0:5b88d5760320 1911 # front of it.
kenjiArai 0:5b88d5760320 1912 # The default directory is: docbook.
kenjiArai 0:5b88d5760320 1913 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
kenjiArai 0:5b88d5760320 1914
kenjiArai 0:5b88d5760320 1915 DOCBOOK_OUTPUT = docbook
kenjiArai 0:5b88d5760320 1916
kenjiArai 0:5b88d5760320 1917 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
kenjiArai 0:5b88d5760320 1918 # program listings (including syntax highlighting and cross-referencing
kenjiArai 0:5b88d5760320 1919 # information) to the DOCBOOK output. Note that enabling this will significantly
kenjiArai 0:5b88d5760320 1920 # increase the size of the DOCBOOK output.
kenjiArai 0:5b88d5760320 1921 # The default value is: NO.
kenjiArai 0:5b88d5760320 1922 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
kenjiArai 0:5b88d5760320 1923
kenjiArai 0:5b88d5760320 1924 DOCBOOK_PROGRAMLISTING = NO
kenjiArai 0:5b88d5760320 1925
kenjiArai 0:5b88d5760320 1926 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 1927 # Configuration options for the AutoGen Definitions output
kenjiArai 0:5b88d5760320 1928 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 1929
kenjiArai 0:5b88d5760320 1930 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
kenjiArai 0:5b88d5760320 1931 # AutoGen Definitions (see http://autogen.sf.net) file that captures the
kenjiArai 0:5b88d5760320 1932 # structure of the code including all documentation. Note that this feature is
kenjiArai 0:5b88d5760320 1933 # still experimental and incomplete at the moment.
kenjiArai 0:5b88d5760320 1934 # The default value is: NO.
kenjiArai 0:5b88d5760320 1935
kenjiArai 0:5b88d5760320 1936 GENERATE_AUTOGEN_DEF = NO
kenjiArai 0:5b88d5760320 1937
kenjiArai 0:5b88d5760320 1938 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 1939 # Configuration options related to the Perl module output
kenjiArai 0:5b88d5760320 1940 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 1941
kenjiArai 0:5b88d5760320 1942 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
kenjiArai 0:5b88d5760320 1943 # file that captures the structure of the code including all documentation.
kenjiArai 0:5b88d5760320 1944 #
kenjiArai 0:5b88d5760320 1945 # Note that this feature is still experimental and incomplete at the moment.
kenjiArai 0:5b88d5760320 1946 # The default value is: NO.
kenjiArai 0:5b88d5760320 1947
kenjiArai 0:5b88d5760320 1948 GENERATE_PERLMOD = NO
kenjiArai 0:5b88d5760320 1949
kenjiArai 0:5b88d5760320 1950 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
kenjiArai 0:5b88d5760320 1951 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
kenjiArai 0:5b88d5760320 1952 # output from the Perl module output.
kenjiArai 0:5b88d5760320 1953 # The default value is: NO.
kenjiArai 0:5b88d5760320 1954 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
kenjiArai 0:5b88d5760320 1955
kenjiArai 0:5b88d5760320 1956 PERLMOD_LATEX = NO
kenjiArai 0:5b88d5760320 1957
kenjiArai 0:5b88d5760320 1958 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
kenjiArai 0:5b88d5760320 1959 # formatted so it can be parsed by a human reader. This is useful if you want to
kenjiArai 0:5b88d5760320 1960 # understand what is going on. On the other hand, if this tag is set to NO, the
kenjiArai 0:5b88d5760320 1961 # size of the Perl module output will be much smaller and Perl will parse it
kenjiArai 0:5b88d5760320 1962 # just the same.
kenjiArai 0:5b88d5760320 1963 # The default value is: YES.
kenjiArai 0:5b88d5760320 1964 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
kenjiArai 0:5b88d5760320 1965
kenjiArai 0:5b88d5760320 1966 PERLMOD_PRETTY = YES
kenjiArai 0:5b88d5760320 1967
kenjiArai 0:5b88d5760320 1968 # The names of the make variables in the generated doxyrules.make file are
kenjiArai 0:5b88d5760320 1969 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
kenjiArai 0:5b88d5760320 1970 # so different doxyrules.make files included by the same Makefile don't
kenjiArai 0:5b88d5760320 1971 # overwrite each other's variables.
kenjiArai 0:5b88d5760320 1972 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
kenjiArai 0:5b88d5760320 1973
kenjiArai 0:5b88d5760320 1974 PERLMOD_MAKEVAR_PREFIX =
kenjiArai 0:5b88d5760320 1975
kenjiArai 0:5b88d5760320 1976 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 1977 # Configuration options related to the preprocessor
kenjiArai 0:5b88d5760320 1978 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 1979
kenjiArai 0:5b88d5760320 1980 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
kenjiArai 0:5b88d5760320 1981 # C-preprocessor directives found in the sources and include files.
kenjiArai 0:5b88d5760320 1982 # The default value is: YES.
kenjiArai 0:5b88d5760320 1983
kenjiArai 0:5b88d5760320 1984 ENABLE_PREPROCESSING = YES
kenjiArai 0:5b88d5760320 1985
kenjiArai 0:5b88d5760320 1986 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
kenjiArai 0:5b88d5760320 1987 # in the source code. If set to NO, only conditional compilation will be
kenjiArai 0:5b88d5760320 1988 # performed. Macro expansion can be done in a controlled way by setting
kenjiArai 0:5b88d5760320 1989 # EXPAND_ONLY_PREDEF to YES.
kenjiArai 0:5b88d5760320 1990 # The default value is: NO.
kenjiArai 0:5b88d5760320 1991 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
kenjiArai 0:5b88d5760320 1992
kenjiArai 0:5b88d5760320 1993 MACRO_EXPANSION = YES
kenjiArai 0:5b88d5760320 1994
kenjiArai 0:5b88d5760320 1995 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
kenjiArai 0:5b88d5760320 1996 # the macro expansion is limited to the macros specified with the PREDEFINED and
kenjiArai 0:5b88d5760320 1997 # EXPAND_AS_DEFINED tags.
kenjiArai 0:5b88d5760320 1998 # The default value is: NO.
kenjiArai 0:5b88d5760320 1999 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
kenjiArai 0:5b88d5760320 2000
kenjiArai 0:5b88d5760320 2001 EXPAND_ONLY_PREDEF = NO
kenjiArai 0:5b88d5760320 2002
kenjiArai 0:5b88d5760320 2003 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
kenjiArai 0:5b88d5760320 2004 # INCLUDE_PATH will be searched if a #include is found.
kenjiArai 0:5b88d5760320 2005 # The default value is: YES.
kenjiArai 0:5b88d5760320 2006 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
kenjiArai 0:5b88d5760320 2007
kenjiArai 0:5b88d5760320 2008 SEARCH_INCLUDES = YES
kenjiArai 0:5b88d5760320 2009
kenjiArai 0:5b88d5760320 2010 # The INCLUDE_PATH tag can be used to specify one or more directories that
kenjiArai 0:5b88d5760320 2011 # contain include files that are not input files but should be processed by the
kenjiArai 0:5b88d5760320 2012 # preprocessor.
kenjiArai 0:5b88d5760320 2013 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
kenjiArai 0:5b88d5760320 2014
kenjiArai 0:5b88d5760320 2015 INCLUDE_PATH =
kenjiArai 0:5b88d5760320 2016
kenjiArai 0:5b88d5760320 2017 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
kenjiArai 0:5b88d5760320 2018 # patterns (like *.h and *.hpp) to filter out the header-files in the
kenjiArai 0:5b88d5760320 2019 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
kenjiArai 0:5b88d5760320 2020 # used.
kenjiArai 0:5b88d5760320 2021 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
kenjiArai 0:5b88d5760320 2022
kenjiArai 0:5b88d5760320 2023 INCLUDE_FILE_PATTERNS =
kenjiArai 0:5b88d5760320 2024
kenjiArai 0:5b88d5760320 2025 # The PREDEFINED tag can be used to specify one or more macro names that are
kenjiArai 0:5b88d5760320 2026 # defined before the preprocessor is started (similar to the -D option of e.g.
kenjiArai 0:5b88d5760320 2027 # gcc). The argument of the tag is a list of macros of the form: name or
kenjiArai 0:5b88d5760320 2028 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
kenjiArai 0:5b88d5760320 2029 # is assumed. To prevent a macro definition from being undefined via #undef or
kenjiArai 0:5b88d5760320 2030 # recursively expanded use the := operator instead of the = operator.
kenjiArai 0:5b88d5760320 2031 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
kenjiArai 0:5b88d5760320 2032
kenjiArai 0:5b88d5760320 2033 PREDEFINED = TARGET_NRF51822
kenjiArai 0:5b88d5760320 2034
kenjiArai 0:5b88d5760320 2035 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
kenjiArai 0:5b88d5760320 2036 # tag can be used to specify a list of macro names that should be expanded. The
kenjiArai 0:5b88d5760320 2037 # macro definition that is found in the sources will be used. Use the PREDEFINED
kenjiArai 0:5b88d5760320 2038 # tag if you want to use a different macro definition that overrules the
kenjiArai 0:5b88d5760320 2039 # definition found in the source code.
kenjiArai 0:5b88d5760320 2040 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
kenjiArai 0:5b88d5760320 2041
kenjiArai 0:5b88d5760320 2042 EXPAND_AS_DEFINED =
kenjiArai 0:5b88d5760320 2043
kenjiArai 0:5b88d5760320 2044 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
kenjiArai 0:5b88d5760320 2045 # remove all references to function-like macros that are alone on a line, have
kenjiArai 0:5b88d5760320 2046 # an all uppercase name, and do not end with a semicolon. Such function macros
kenjiArai 0:5b88d5760320 2047 # are typically used for boiler-plate code, and will confuse the parser if not
kenjiArai 0:5b88d5760320 2048 # removed.
kenjiArai 0:5b88d5760320 2049 # The default value is: YES.
kenjiArai 0:5b88d5760320 2050 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
kenjiArai 0:5b88d5760320 2051
kenjiArai 0:5b88d5760320 2052 SKIP_FUNCTION_MACROS = YES
kenjiArai 0:5b88d5760320 2053
kenjiArai 0:5b88d5760320 2054 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 2055 # Configuration options related to external references
kenjiArai 0:5b88d5760320 2056 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 2057
kenjiArai 0:5b88d5760320 2058 # The TAGFILES tag can be used to specify one or more tag files. For each tag
kenjiArai 0:5b88d5760320 2059 # file the location of the external documentation should be added. The format of
kenjiArai 0:5b88d5760320 2060 # a tag file without this location is as follows:
kenjiArai 0:5b88d5760320 2061 # TAGFILES = file1 file2 ...
kenjiArai 0:5b88d5760320 2062 # Adding location for the tag files is done as follows:
kenjiArai 0:5b88d5760320 2063 # TAGFILES = file1=loc1 "file2 = loc2" ...
kenjiArai 0:5b88d5760320 2064 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
kenjiArai 0:5b88d5760320 2065 # section "Linking to external documentation" for more information about the use
kenjiArai 0:5b88d5760320 2066 # of tag files.
kenjiArai 0:5b88d5760320 2067 # Note: Each tag file must have a unique name (where the name does NOT include
kenjiArai 0:5b88d5760320 2068 # the path). If a tag file is not located in the directory in which doxygen is
kenjiArai 0:5b88d5760320 2069 # run, you must also specify the path to the tagfile here.
kenjiArai 0:5b88d5760320 2070
kenjiArai 0:5b88d5760320 2071 TAGFILES =
kenjiArai 0:5b88d5760320 2072
kenjiArai 0:5b88d5760320 2073 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
kenjiArai 0:5b88d5760320 2074 # tag file that is based on the input files it reads. See section "Linking to
kenjiArai 0:5b88d5760320 2075 # external documentation" for more information about the usage of tag files.
kenjiArai 0:5b88d5760320 2076
kenjiArai 0:5b88d5760320 2077 GENERATE_TAGFILE =
kenjiArai 0:5b88d5760320 2078
kenjiArai 0:5b88d5760320 2079 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
kenjiArai 0:5b88d5760320 2080 # the class index. If set to NO, only the inherited external classes will be
kenjiArai 0:5b88d5760320 2081 # listed.
kenjiArai 0:5b88d5760320 2082 # The default value is: NO.
kenjiArai 0:5b88d5760320 2083
kenjiArai 0:5b88d5760320 2084 ALLEXTERNALS = NO
kenjiArai 0:5b88d5760320 2085
kenjiArai 0:5b88d5760320 2086 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
kenjiArai 0:5b88d5760320 2087 # in the modules index. If set to NO, only the current project's groups will be
kenjiArai 0:5b88d5760320 2088 # listed.
kenjiArai 0:5b88d5760320 2089 # The default value is: YES.
kenjiArai 0:5b88d5760320 2090
kenjiArai 0:5b88d5760320 2091 EXTERNAL_GROUPS = YES
kenjiArai 0:5b88d5760320 2092
kenjiArai 0:5b88d5760320 2093 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
kenjiArai 0:5b88d5760320 2094 # the related pages index. If set to NO, only the current project's pages will
kenjiArai 0:5b88d5760320 2095 # be listed.
kenjiArai 0:5b88d5760320 2096 # The default value is: YES.
kenjiArai 0:5b88d5760320 2097
kenjiArai 0:5b88d5760320 2098 EXTERNAL_PAGES = YES
kenjiArai 0:5b88d5760320 2099
kenjiArai 0:5b88d5760320 2100 # The PERL_PATH should be the absolute path and name of the perl script
kenjiArai 0:5b88d5760320 2101 # interpreter (i.e. the result of 'which perl').
kenjiArai 0:5b88d5760320 2102 # The default file (with absolute path) is: /usr/bin/perl.
kenjiArai 0:5b88d5760320 2103
kenjiArai 0:5b88d5760320 2104 PERL_PATH = /usr/bin/perl
kenjiArai 0:5b88d5760320 2105
kenjiArai 0:5b88d5760320 2106 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 2107 # Configuration options related to the dot tool
kenjiArai 0:5b88d5760320 2108 #---------------------------------------------------------------------------
kenjiArai 0:5b88d5760320 2109
kenjiArai 0:5b88d5760320 2110 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
kenjiArai 0:5b88d5760320 2111 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
kenjiArai 0:5b88d5760320 2112 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
kenjiArai 0:5b88d5760320 2113 # disabled, but it is recommended to install and use dot, since it yields more
kenjiArai 0:5b88d5760320 2114 # powerful graphs.
kenjiArai 0:5b88d5760320 2115 # The default value is: YES.
kenjiArai 0:5b88d5760320 2116
kenjiArai 0:5b88d5760320 2117 CLASS_DIAGRAMS = YES
kenjiArai 0:5b88d5760320 2118
kenjiArai 0:5b88d5760320 2119 # You can define message sequence charts within doxygen comments using the \msc
kenjiArai 0:5b88d5760320 2120 # command. Doxygen will then run the mscgen tool (see:
kenjiArai 0:5b88d5760320 2121 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
kenjiArai 0:5b88d5760320 2122 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
kenjiArai 0:5b88d5760320 2123 # the mscgen tool resides. If left empty the tool is assumed to be found in the
kenjiArai 0:5b88d5760320 2124 # default search path.
kenjiArai 0:5b88d5760320 2125
kenjiArai 0:5b88d5760320 2126 MSCGEN_PATH =
kenjiArai 0:5b88d5760320 2127
kenjiArai 0:5b88d5760320 2128 # You can include diagrams made with dia in doxygen documentation. Doxygen will
kenjiArai 0:5b88d5760320 2129 # then run dia to produce the diagram and insert it in the documentation. The
kenjiArai 0:5b88d5760320 2130 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
kenjiArai 0:5b88d5760320 2131 # If left empty dia is assumed to be found in the default search path.
kenjiArai 0:5b88d5760320 2132
kenjiArai 0:5b88d5760320 2133 DIA_PATH =
kenjiArai 0:5b88d5760320 2134
kenjiArai 0:5b88d5760320 2135 # If set to YES the inheritance and collaboration graphs will hide inheritance
kenjiArai 0:5b88d5760320 2136 # and usage relations if the target is undocumented or is not a class.
kenjiArai 0:5b88d5760320 2137 # The default value is: YES.
kenjiArai 0:5b88d5760320 2138
kenjiArai 0:5b88d5760320 2139 HIDE_UNDOC_RELATIONS = YES
kenjiArai 0:5b88d5760320 2140
kenjiArai 0:5b88d5760320 2141 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
kenjiArai 0:5b88d5760320 2142 # available from the path. This tool is part of Graphviz (see:
kenjiArai 0:5b88d5760320 2143 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
kenjiArai 0:5b88d5760320 2144 # Bell Labs. The other options in this section have no effect if this option is
kenjiArai 0:5b88d5760320 2145 # set to NO
kenjiArai 0:5b88d5760320 2146 # The default value is: NO.
kenjiArai 0:5b88d5760320 2147
kenjiArai 0:5b88d5760320 2148 HAVE_DOT = YES
kenjiArai 0:5b88d5760320 2149
kenjiArai 0:5b88d5760320 2150 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
kenjiArai 0:5b88d5760320 2151 # to run in parallel. When set to 0 doxygen will base this on the number of
kenjiArai 0:5b88d5760320 2152 # processors available in the system. You can set it explicitly to a value
kenjiArai 0:5b88d5760320 2153 # larger than 0 to get control over the balance between CPU load and processing
kenjiArai 0:5b88d5760320 2154 # speed.
kenjiArai 0:5b88d5760320 2155 # Minimum value: 0, maximum value: 32, default value: 0.
kenjiArai 0:5b88d5760320 2156 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2157
kenjiArai 0:5b88d5760320 2158 DOT_NUM_THREADS = 0
kenjiArai 0:5b88d5760320 2159
kenjiArai 0:5b88d5760320 2160 # When you want a differently looking font in the dot files that doxygen
kenjiArai 0:5b88d5760320 2161 # generates you can specify the font name using DOT_FONTNAME. You need to make
kenjiArai 0:5b88d5760320 2162 # sure dot is able to find the font, which can be done by putting it in a
kenjiArai 0:5b88d5760320 2163 # standard location or by setting the DOTFONTPATH environment variable or by
kenjiArai 0:5b88d5760320 2164 # setting DOT_FONTPATH to the directory containing the font.
kenjiArai 0:5b88d5760320 2165 # The default value is: Helvetica.
kenjiArai 0:5b88d5760320 2166 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2167
kenjiArai 0:5b88d5760320 2168 DOT_FONTNAME = Helvetica
kenjiArai 0:5b88d5760320 2169
kenjiArai 0:5b88d5760320 2170 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
kenjiArai 0:5b88d5760320 2171 # dot graphs.
kenjiArai 0:5b88d5760320 2172 # Minimum value: 4, maximum value: 24, default value: 10.
kenjiArai 0:5b88d5760320 2173 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2174
kenjiArai 0:5b88d5760320 2175 DOT_FONTSIZE = 10
kenjiArai 0:5b88d5760320 2176
kenjiArai 0:5b88d5760320 2177 # By default doxygen will tell dot to use the default font as specified with
kenjiArai 0:5b88d5760320 2178 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
kenjiArai 0:5b88d5760320 2179 # the path where dot can find it using this tag.
kenjiArai 0:5b88d5760320 2180 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2181
kenjiArai 0:5b88d5760320 2182 DOT_FONTPATH =
kenjiArai 0:5b88d5760320 2183
kenjiArai 0:5b88d5760320 2184 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
kenjiArai 0:5b88d5760320 2185 # each documented class showing the direct and indirect inheritance relations.
kenjiArai 0:5b88d5760320 2186 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
kenjiArai 0:5b88d5760320 2187 # The default value is: YES.
kenjiArai 0:5b88d5760320 2188 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2189
kenjiArai 0:5b88d5760320 2190 CLASS_GRAPH = YES
kenjiArai 0:5b88d5760320 2191
kenjiArai 0:5b88d5760320 2192 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
kenjiArai 0:5b88d5760320 2193 # graph for each documented class showing the direct and indirect implementation
kenjiArai 0:5b88d5760320 2194 # dependencies (inheritance, containment, and class references variables) of the
kenjiArai 0:5b88d5760320 2195 # class with other documented classes.
kenjiArai 0:5b88d5760320 2196 # The default value is: YES.
kenjiArai 0:5b88d5760320 2197 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2198
kenjiArai 0:5b88d5760320 2199 COLLABORATION_GRAPH = YES
kenjiArai 0:5b88d5760320 2200
kenjiArai 0:5b88d5760320 2201 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
kenjiArai 0:5b88d5760320 2202 # groups, showing the direct groups dependencies.
kenjiArai 0:5b88d5760320 2203 # The default value is: YES.
kenjiArai 0:5b88d5760320 2204 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2205
kenjiArai 0:5b88d5760320 2206 GROUP_GRAPHS = YES
kenjiArai 0:5b88d5760320 2207
kenjiArai 0:5b88d5760320 2208 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
kenjiArai 0:5b88d5760320 2209 # collaboration diagrams in a style similar to the OMG's Unified Modeling
kenjiArai 0:5b88d5760320 2210 # Language.
kenjiArai 0:5b88d5760320 2211 # The default value is: NO.
kenjiArai 0:5b88d5760320 2212 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2213
kenjiArai 0:5b88d5760320 2214 UML_LOOK = NO
kenjiArai 0:5b88d5760320 2215
kenjiArai 0:5b88d5760320 2216 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
kenjiArai 0:5b88d5760320 2217 # class node. If there are many fields or methods and many nodes the graph may
kenjiArai 0:5b88d5760320 2218 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
kenjiArai 0:5b88d5760320 2219 # number of items for each type to make the size more manageable. Set this to 0
kenjiArai 0:5b88d5760320 2220 # for no limit. Note that the threshold may be exceeded by 50% before the limit
kenjiArai 0:5b88d5760320 2221 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
kenjiArai 0:5b88d5760320 2222 # but if the number exceeds 15, the total amount of fields shown is limited to
kenjiArai 0:5b88d5760320 2223 # 10.
kenjiArai 0:5b88d5760320 2224 # Minimum value: 0, maximum value: 100, default value: 10.
kenjiArai 0:5b88d5760320 2225 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2226
kenjiArai 0:5b88d5760320 2227 UML_LIMIT_NUM_FIELDS = 10
kenjiArai 0:5b88d5760320 2228
kenjiArai 0:5b88d5760320 2229 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
kenjiArai 0:5b88d5760320 2230 # collaboration graphs will show the relations between templates and their
kenjiArai 0:5b88d5760320 2231 # instances.
kenjiArai 0:5b88d5760320 2232 # The default value is: NO.
kenjiArai 0:5b88d5760320 2233 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2234
kenjiArai 0:5b88d5760320 2235 TEMPLATE_RELATIONS = NO
kenjiArai 0:5b88d5760320 2236
kenjiArai 0:5b88d5760320 2237 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
kenjiArai 0:5b88d5760320 2238 # YES then doxygen will generate a graph for each documented file showing the
kenjiArai 0:5b88d5760320 2239 # direct and indirect include dependencies of the file with other documented
kenjiArai 0:5b88d5760320 2240 # files.
kenjiArai 0:5b88d5760320 2241 # The default value is: YES.
kenjiArai 0:5b88d5760320 2242 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2243
kenjiArai 0:5b88d5760320 2244 INCLUDE_GRAPH = YES
kenjiArai 0:5b88d5760320 2245
kenjiArai 0:5b88d5760320 2246 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
kenjiArai 0:5b88d5760320 2247 # set to YES then doxygen will generate a graph for each documented file showing
kenjiArai 0:5b88d5760320 2248 # the direct and indirect include dependencies of the file with other documented
kenjiArai 0:5b88d5760320 2249 # files.
kenjiArai 0:5b88d5760320 2250 # The default value is: YES.
kenjiArai 0:5b88d5760320 2251 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2252
kenjiArai 0:5b88d5760320 2253 INCLUDED_BY_GRAPH = YES
kenjiArai 0:5b88d5760320 2254
kenjiArai 0:5b88d5760320 2255 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
kenjiArai 0:5b88d5760320 2256 # dependency graph for every global function or class method.
kenjiArai 0:5b88d5760320 2257 #
kenjiArai 0:5b88d5760320 2258 # Note that enabling this option will significantly increase the time of a run.
kenjiArai 0:5b88d5760320 2259 # So in most cases it will be better to enable call graphs for selected
kenjiArai 0:5b88d5760320 2260 # functions only using the \callgraph command. Disabling a call graph can be
kenjiArai 0:5b88d5760320 2261 # accomplished by means of the command \hidecallgraph.
kenjiArai 0:5b88d5760320 2262 # The default value is: NO.
kenjiArai 0:5b88d5760320 2263 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2264
kenjiArai 0:5b88d5760320 2265 CALL_GRAPH = NO
kenjiArai 0:5b88d5760320 2266
kenjiArai 0:5b88d5760320 2267 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
kenjiArai 0:5b88d5760320 2268 # dependency graph for every global function or class method.
kenjiArai 0:5b88d5760320 2269 #
kenjiArai 0:5b88d5760320 2270 # Note that enabling this option will significantly increase the time of a run.
kenjiArai 0:5b88d5760320 2271 # So in most cases it will be better to enable caller graphs for selected
kenjiArai 0:5b88d5760320 2272 # functions only using the \callergraph command. Disabling a caller graph can be
kenjiArai 0:5b88d5760320 2273 # accomplished by means of the command \hidecallergraph.
kenjiArai 0:5b88d5760320 2274 # The default value is: NO.
kenjiArai 0:5b88d5760320 2275 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2276
kenjiArai 0:5b88d5760320 2277 CALLER_GRAPH = NO
kenjiArai 0:5b88d5760320 2278
kenjiArai 0:5b88d5760320 2279 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
kenjiArai 0:5b88d5760320 2280 # hierarchy of all classes instead of a textual one.
kenjiArai 0:5b88d5760320 2281 # The default value is: YES.
kenjiArai 0:5b88d5760320 2282 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2283
kenjiArai 0:5b88d5760320 2284 GRAPHICAL_HIERARCHY = YES
kenjiArai 0:5b88d5760320 2285
kenjiArai 0:5b88d5760320 2286 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
kenjiArai 0:5b88d5760320 2287 # dependencies a directory has on other directories in a graphical way. The
kenjiArai 0:5b88d5760320 2288 # dependency relations are determined by the #include relations between the
kenjiArai 0:5b88d5760320 2289 # files in the directories.
kenjiArai 0:5b88d5760320 2290 # The default value is: YES.
kenjiArai 0:5b88d5760320 2291 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2292
kenjiArai 0:5b88d5760320 2293 DIRECTORY_GRAPH = YES
kenjiArai 0:5b88d5760320 2294
kenjiArai 0:5b88d5760320 2295 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
kenjiArai 0:5b88d5760320 2296 # generated by dot. For an explanation of the image formats see the section
kenjiArai 0:5b88d5760320 2297 # output formats in the documentation of the dot tool (Graphviz (see:
kenjiArai 0:5b88d5760320 2298 # http://www.graphviz.org/)).
kenjiArai 0:5b88d5760320 2299 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
kenjiArai 0:5b88d5760320 2300 # to make the SVG files visible in IE 9+ (other browsers do not have this
kenjiArai 0:5b88d5760320 2301 # requirement).
kenjiArai 0:5b88d5760320 2302 # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
kenjiArai 0:5b88d5760320 2303 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
kenjiArai 0:5b88d5760320 2304 # png:gdiplus:gdiplus.
kenjiArai 0:5b88d5760320 2305 # The default value is: png.
kenjiArai 0:5b88d5760320 2306 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2307
kenjiArai 0:5b88d5760320 2308 DOT_IMAGE_FORMAT = png
kenjiArai 0:5b88d5760320 2309
kenjiArai 0:5b88d5760320 2310 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
kenjiArai 0:5b88d5760320 2311 # enable generation of interactive SVG images that allow zooming and panning.
kenjiArai 0:5b88d5760320 2312 #
kenjiArai 0:5b88d5760320 2313 # Note that this requires a modern browser other than Internet Explorer. Tested
kenjiArai 0:5b88d5760320 2314 # and working are Firefox, Chrome, Safari, and Opera.
kenjiArai 0:5b88d5760320 2315 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
kenjiArai 0:5b88d5760320 2316 # the SVG files visible. Older versions of IE do not have SVG support.
kenjiArai 0:5b88d5760320 2317 # The default value is: NO.
kenjiArai 0:5b88d5760320 2318 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2319
kenjiArai 0:5b88d5760320 2320 INTERACTIVE_SVG = NO
kenjiArai 0:5b88d5760320 2321
kenjiArai 0:5b88d5760320 2322 # The DOT_PATH tag can be used to specify the path where the dot tool can be
kenjiArai 0:5b88d5760320 2323 # found. If left blank, it is assumed the dot tool can be found in the path.
kenjiArai 0:5b88d5760320 2324 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2325
kenjiArai 0:5b88d5760320 2326 DOT_PATH =
kenjiArai 0:5b88d5760320 2327
kenjiArai 0:5b88d5760320 2328 # The DOTFILE_DIRS tag can be used to specify one or more directories that
kenjiArai 0:5b88d5760320 2329 # contain dot files that are included in the documentation (see the \dotfile
kenjiArai 0:5b88d5760320 2330 # command).
kenjiArai 0:5b88d5760320 2331 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2332
kenjiArai 0:5b88d5760320 2333 DOTFILE_DIRS =
kenjiArai 0:5b88d5760320 2334
kenjiArai 0:5b88d5760320 2335 # The MSCFILE_DIRS tag can be used to specify one or more directories that
kenjiArai 0:5b88d5760320 2336 # contain msc files that are included in the documentation (see the \mscfile
kenjiArai 0:5b88d5760320 2337 # command).
kenjiArai 0:5b88d5760320 2338
kenjiArai 0:5b88d5760320 2339 MSCFILE_DIRS =
kenjiArai 0:5b88d5760320 2340
kenjiArai 0:5b88d5760320 2341 # The DIAFILE_DIRS tag can be used to specify one or more directories that
kenjiArai 0:5b88d5760320 2342 # contain dia files that are included in the documentation (see the \diafile
kenjiArai 0:5b88d5760320 2343 # command).
kenjiArai 0:5b88d5760320 2344
kenjiArai 0:5b88d5760320 2345 DIAFILE_DIRS =
kenjiArai 0:5b88d5760320 2346
kenjiArai 0:5b88d5760320 2347 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
kenjiArai 0:5b88d5760320 2348 # path where java can find the plantuml.jar file. If left blank, it is assumed
kenjiArai 0:5b88d5760320 2349 # PlantUML is not used or called during a preprocessing step. Doxygen will
kenjiArai 0:5b88d5760320 2350 # generate a warning when it encounters a \startuml command in this case and
kenjiArai 0:5b88d5760320 2351 # will not generate output for the diagram.
kenjiArai 0:5b88d5760320 2352
kenjiArai 0:5b88d5760320 2353 PLANTUML_JAR_PATH =
kenjiArai 0:5b88d5760320 2354
kenjiArai 0:5b88d5760320 2355 # When using plantuml, the specified paths are searched for files specified by
kenjiArai 0:5b88d5760320 2356 # the !include statement in a plantuml block.
kenjiArai 0:5b88d5760320 2357
kenjiArai 0:5b88d5760320 2358 PLANTUML_INCLUDE_PATH =
kenjiArai 0:5b88d5760320 2359
kenjiArai 0:5b88d5760320 2360 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
kenjiArai 0:5b88d5760320 2361 # that will be shown in the graph. If the number of nodes in a graph becomes
kenjiArai 0:5b88d5760320 2362 # larger than this value, doxygen will truncate the graph, which is visualized
kenjiArai 0:5b88d5760320 2363 # by representing a node as a red box. Note that doxygen if the number of direct
kenjiArai 0:5b88d5760320 2364 # children of the root node in a graph is already larger than
kenjiArai 0:5b88d5760320 2365 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
kenjiArai 0:5b88d5760320 2366 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
kenjiArai 0:5b88d5760320 2367 # Minimum value: 0, maximum value: 10000, default value: 50.
kenjiArai 0:5b88d5760320 2368 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2369
kenjiArai 0:5b88d5760320 2370 DOT_GRAPH_MAX_NODES = 200
kenjiArai 0:5b88d5760320 2371
kenjiArai 0:5b88d5760320 2372 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
kenjiArai 0:5b88d5760320 2373 # generated by dot. A depth value of 3 means that only nodes reachable from the
kenjiArai 0:5b88d5760320 2374 # root by following a path via at most 3 edges will be shown. Nodes that lay
kenjiArai 0:5b88d5760320 2375 # further from the root node will be omitted. Note that setting this option to 1
kenjiArai 0:5b88d5760320 2376 # or 2 may greatly reduce the computation time needed for large code bases. Also
kenjiArai 0:5b88d5760320 2377 # note that the size of a graph can be further restricted by
kenjiArai 0:5b88d5760320 2378 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
kenjiArai 0:5b88d5760320 2379 # Minimum value: 0, maximum value: 1000, default value: 0.
kenjiArai 0:5b88d5760320 2380 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2381
kenjiArai 0:5b88d5760320 2382 MAX_DOT_GRAPH_DEPTH = 1000
kenjiArai 0:5b88d5760320 2383
kenjiArai 0:5b88d5760320 2384 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
kenjiArai 0:5b88d5760320 2385 # background. This is disabled by default, because dot on Windows does not seem
kenjiArai 0:5b88d5760320 2386 # to support this out of the box.
kenjiArai 0:5b88d5760320 2387 #
kenjiArai 0:5b88d5760320 2388 # Warning: Depending on the platform used, enabling this option may lead to
kenjiArai 0:5b88d5760320 2389 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
kenjiArai 0:5b88d5760320 2390 # read).
kenjiArai 0:5b88d5760320 2391 # The default value is: NO.
kenjiArai 0:5b88d5760320 2392 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2393
kenjiArai 0:5b88d5760320 2394 DOT_TRANSPARENT = YES
kenjiArai 0:5b88d5760320 2395
kenjiArai 0:5b88d5760320 2396 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
kenjiArai 0:5b88d5760320 2397 # files in one run (i.e. multiple -o and -T options on the command line). This
kenjiArai 0:5b88d5760320 2398 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
kenjiArai 0:5b88d5760320 2399 # this, this feature is disabled by default.
kenjiArai 0:5b88d5760320 2400 # The default value is: NO.
kenjiArai 0:5b88d5760320 2401 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2402
kenjiArai 0:5b88d5760320 2403 DOT_MULTI_TARGETS = NO
kenjiArai 0:5b88d5760320 2404
kenjiArai 0:5b88d5760320 2405 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
kenjiArai 0:5b88d5760320 2406 # explaining the meaning of the various boxes and arrows in the dot generated
kenjiArai 0:5b88d5760320 2407 # graphs.
kenjiArai 0:5b88d5760320 2408 # The default value is: YES.
kenjiArai 0:5b88d5760320 2409 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2410
kenjiArai 0:5b88d5760320 2411 GENERATE_LEGEND = YES
kenjiArai 0:5b88d5760320 2412
kenjiArai 0:5b88d5760320 2413 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
kenjiArai 0:5b88d5760320 2414 # files that are used to generate the various graphs.
kenjiArai 0:5b88d5760320 2415 # The default value is: YES.
kenjiArai 0:5b88d5760320 2416 # This tag requires that the tag HAVE_DOT is set to YES.
kenjiArai 0:5b88d5760320 2417
kenjiArai 0:5b88d5760320 2418 DOT_CLEANUP = YES