cd/3657acdbebd1fac623eb7927fedf5677d3b07c

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