Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

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