1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/security/cryptoservices/certificateandkeymgmt/tpkixcert/doxygen.conf Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,806 @@
1.4 +# Doxyfile 1.2.8.1
1.5 +
1.6 +# This file describes the settings to be used by the documentation system
1.7 +# doxygen (www.doxygen.org) for a project
1.8 +#
1.9 +# All text after a hash (#) is considered a comment and will be ignored
1.10 +# The format is:
1.11 +# TAG = value [value, ...]
1.12 +# For lists items can also be appended using:
1.13 +# TAG += value [value, ...]
1.14 +# Values that contain spaces should be placed between quotes (" ")
1.15 +
1.16 +#---------------------------------------------------------------------------
1.17 +# General configuration options
1.18 +#---------------------------------------------------------------------------
1.19 +
1.20 +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
1.21 +# by quotes) that should identify the project.
1.22 +
1.23 +PROJECT_NAME = TPKIXCert
1.24 +# The PROJECT_NUMBER tag can be used to enter a project or revision number.
1.25 +# This could be handy for archiving the generated documentation or
1.26 +# if some version control system is used.
1.27 +
1.28 +PROJECT_NUMBER = 1.00
1.29 +
1.30 +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
1.31 +# base path where the generated documentation will be put.
1.32 +# If a relative path is entered, it will be relative to the location
1.33 +# where doxygen was started. If left blank the current directory will be used.
1.34 +
1.35 +OUTPUT_DIRECTORY = .
1.36 +
1.37 +# The OUTPUT_LANGUAGE tag is used to specify the language in which all
1.38 +# documentation generated by doxygen is written. Doxygen will use this
1.39 +# information to generate all constant output in the proper language.
1.40 +# The default language is English, other supported languages are:
1.41 +# Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
1.42 +# German, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
1.43 +# Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
1.44 +
1.45 +OUTPUT_LANGUAGE = English
1.46 +
1.47 +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
1.48 +# documentation are documented, even if no documentation was available.
1.49 +# Private class members and static file members will be hidden unless
1.50 +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
1.51 +
1.52 +EXTRACT_ALL = NO
1.53 +
1.54 +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
1.55 +# will be included in the documentation.
1.56 +
1.57 +EXTRACT_PRIVATE = YES
1.58 +
1.59 +# If the EXTRACT_STATIC tag is set to YES all static members of a file
1.60 +# will be included in the documentation.
1.61 +
1.62 +EXTRACT_STATIC = YES
1.63 +
1.64 +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
1.65 +# undocumented members of documented classes, files or namespaces.
1.66 +# If set to NO (the default) these members will be included in the
1.67 +# various overviews, but no documentation section is generated.
1.68 +# This option has no effect if EXTRACT_ALL is enabled.
1.69 +
1.70 +HIDE_UNDOC_MEMBERS = NO
1.71 +
1.72 +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
1.73 +# undocumented classes that are normally visible in the class hierarchy.
1.74 +# If set to NO (the default) these class will be included in the various
1.75 +# overviews. This option has no effect if EXTRACT_ALL is enabled.
1.76 +
1.77 +HIDE_UNDOC_CLASSES = NO
1.78 +
1.79 +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
1.80 +# include brief member descriptions after the members that are listed in
1.81 +# the file and class documentation (similar to JavaDoc).
1.82 +# Set to NO to disable this.
1.83 +
1.84 +BRIEF_MEMBER_DESC = YES
1.85 +
1.86 +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
1.87 +# the brief description of a member or function before the detailed description.
1.88 +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
1.89 +# brief descriptions will be completely suppressed.
1.90 +
1.91 +REPEAT_BRIEF = YES
1.92 +
1.93 +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
1.94 +# Doxygen will generate a detailed section even if there is only a brief
1.95 +# description.
1.96 +
1.97 +ALWAYS_DETAILED_SEC = NO
1.98 +
1.99 +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
1.100 +# path before files name in the file list and in the header files. If set
1.101 +# to NO the shortest path that makes the file name unique will be used.
1.102 +
1.103 +FULL_PATH_NAMES = NO
1.104 +
1.105 +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
1.106 +# can be used to strip a user defined part of the path. Stripping is
1.107 +# only done if one of the specified strings matches the left-hand part of
1.108 +# the path. It is allowed to use relative paths in the argument list.
1.109 +
1.110 +STRIP_FROM_PATH =
1.111 +
1.112 +# The INTERNAL_DOCS tag determines if documentation
1.113 +# that is typed after a \internal command is included. If the tag is set
1.114 +# to NO (the default) then the documentation will be excluded.
1.115 +# Set it to YES to include the internal documentation.
1.116 +
1.117 +INTERNAL_DOCS = NO
1.118 +
1.119 +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1.120 +# generate a class diagram (in Html and LaTeX) for classes with base or
1.121 +# super classes. Setting the tag to NO turns the diagrams off.
1.122 +
1.123 +CLASS_DIAGRAMS = YES
1.124 +
1.125 +# If the SOURCE_BROWSER tag is set to YES then a list of source files will
1.126 +# be generated. Documented entities will be cross-referenced with these sources.
1.127 +
1.128 +SOURCE_BROWSER = NO
1.129 +
1.130 +# Setting the INLINE_SOURCES tag to YES will include the body
1.131 +# of functions and classes directly in the documentation.
1.132 +
1.133 +INLINE_SOURCES = NO
1.134 +
1.135 +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
1.136 +# doxygen to hide any special comment blocks from generated source code
1.137 +# fragments. Normal C and C++ comments will always remain visible.
1.138 +
1.139 +STRIP_CODE_COMMENTS = YES
1.140 +
1.141 +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
1.142 +# file names in lower case letters. If set to YES upper case letters are also
1.143 +# allowed. This is useful if you have classes or files whose names only differ
1.144 +# in case and if your file system supports case sensitive file names. Windows
1.145 +# users are adviced to set this option to NO.
1.146 +
1.147 +CASE_SENSE_NAMES = YES
1.148 +
1.149 +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
1.150 +# (but less readable) file names. This can be useful is your file systems
1.151 +# doesn't support long names like on DOS, Mac, or CD-ROM.
1.152 +
1.153 +SHORT_NAMES = NO
1.154 +
1.155 +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
1.156 +# will show members with their full class and namespace scopes in the
1.157 +# documentation. If set to YES the scope will be hidden.
1.158 +
1.159 +HIDE_SCOPE_NAMES = NO
1.160 +
1.161 +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
1.162 +# will generate a verbatim copy of the header file for each class for
1.163 +# which an include is specified. Set to NO to disable this.
1.164 +
1.165 +VERBATIM_HEADERS = YES
1.166 +
1.167 +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
1.168 +# will put list of the files that are included by a file in the documentation
1.169 +# of that file.
1.170 +
1.171 +SHOW_INCLUDE_FILES = YES
1.172 +
1.173 +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
1.174 +# will interpret the first line (until the first dot) of a JavaDoc-style
1.175 +# comment as the brief description. If set to NO, the JavaDoc
1.176 +# comments will behave just like the Qt-style comments (thus requiring an
1.177 +# explict @brief command for a brief description.
1.178 +
1.179 +JAVADOC_AUTOBRIEF = NO
1.180 +
1.181 +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
1.182 +# member inherits the documentation from any documented member that it
1.183 +# reimplements.
1.184 +
1.185 +INHERIT_DOCS = YES
1.186 +
1.187 +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
1.188 +# is inserted in the documentation for inline members.
1.189 +
1.190 +INLINE_INFO = YES
1.191 +
1.192 +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
1.193 +# will sort the (detailed) documentation of file and class members
1.194 +# alphabetically by member name. If set to NO the members will appear in
1.195 +# declaration order.
1.196 +
1.197 +SORT_MEMBER_DOCS = YES
1.198 +
1.199 +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
1.200 +# tag is set to YES, then doxygen will reuse the documentation of the first
1.201 +# member in the group (if any) for the other members of the group. By default
1.202 +# all members of a group must be documented explicitly.
1.203 +
1.204 +DISTRIBUTE_GROUP_DOC = NO
1.205 +
1.206 +# The TAB_SIZE tag can be used to set the number of spaces in a tab.
1.207 +# Doxygen uses this value to replace tabs by spaces in code fragments.
1.208 +
1.209 +TAB_SIZE = 8
1.210 +
1.211 +# The ENABLED_SECTIONS tag can be used to enable conditional
1.212 +# documentation sections, marked by \if sectionname ... \endif.
1.213 +
1.214 +ENABLED_SECTIONS =
1.215 +
1.216 +# The GENERATE_TODOLIST tag can be used to enable (YES) or
1.217 +# disable (NO) the list. This list is created by putting keyword
1.218 +# commands in the documentation.
1.219 +
1.220 +GENERATE_TODOLIST = YES
1.221 +
1.222 +# The GENERATE_TESTLIST tag can be used to enable (YES) or
1.223 +# disable (NO) the test list. This list is created by putting \test
1.224 +# commands in the documentation.
1.225 +
1.226 +GENERATE_TESTLIST = YES
1.227 +
1.228 +# The GENERATE_BUGLIST tag can be used to enable (YES) or
1.229 +# disable (NO) the list. This list is created by putting keyword
1.230 +# commands in the documentation.
1.231 +
1.232 +GENERATE_BUGLIST = YES
1.233 +
1.234 +# This tag can be used to specify a number of aliases that acts
1.235 +# as commands in the documentation. An alias has the form "name=value".
1.236 +# For example adding "sideeffect=\par Side Effects:\n" will allow you to
1.237 +# put the command \sideeffect (or @sideeffect) in the documentation, which
1.238 +# will result in a user defined paragraph with heading "Side Effects:".
1.239 +# You can put \n's in the value part of an alias to insert newlines.
1.240 +
1.241 +ALIASES =
1.242 +
1.243 +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
1.244 +# the initial value of a variable or define consist of for it to appear in
1.245 +# the documentation. If the initializer consists of more lines than specified
1.246 +# here it will be hidden. Use a value of 0 to hide initializers completely.
1.247 +# The appearance of the initializer of individual variables and defines in the
1.248 +# documentation can be controlled using \showinitializer or \hideinitializer
1.249 +# command in the documentation regardless of this setting.
1.250 +
1.251 +MAX_INITIALIZER_LINES = 30
1.252 +
1.253 +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
1.254 +# only. Doxygen will then generate output that is more tailored for C.
1.255 +# For instance some of the names that are used will be different. The list
1.256 +# of all members will be omitted, etc.
1.257 +
1.258 +OPTIMIZE_OUTPUT_FOR_C = NO
1.259 +
1.260 +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
1.261 +# at the bottom of the documentation of classes and structs. If set to YES the
1.262 +# list will mention the files that were used to generate the documentation.
1.263 +
1.264 +SHOW_USED_FILES = YES
1.265 +
1.266 +#---------------------------------------------------------------------------
1.267 +# configuration options related to warning and progress messages
1.268 +#---------------------------------------------------------------------------
1.269 +
1.270 +# The QUIET tag can be used to turn on/off the messages that are generated
1.271 +# by doxygen. Possible values are YES and NO. If left blank NO is used.
1.272 +
1.273 +QUIET = NO
1.274 +
1.275 +# The WARNINGS tag can be used to turn on/off the warning messages that are
1.276 +# generated by doxygen. Possible values are YES and NO. If left blank
1.277 +# NO is used.
1.278 +
1.279 +WARNINGS = YES
1.280 +
1.281 +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
1.282 +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
1.283 +# automatically be disabled.
1.284 +
1.285 +WARN_IF_UNDOCUMENTED = YES
1.286 +
1.287 +# The WARN_FORMAT tag determines the format of the warning messages that
1.288 +# doxygen can produce. The string should contain the $file, $line, and $text
1.289 +# tags, which will be replaced by the file and line number from which the
1.290 +# warning originated and the warning text.
1.291 +
1.292 +WARN_FORMAT =
1.293 +
1.294 +# The WARN_LOGFILE tag can be used to specify a file to which warning
1.295 +# and error messages should be written. If left blank the output is written
1.296 +# to stderr.
1.297 +
1.298 +WARN_LOGFILE =
1.299 +
1.300 +#---------------------------------------------------------------------------
1.301 +# configuration options related to the input files
1.302 +#---------------------------------------------------------------------------
1.303 +
1.304 +# The INPUT tag can be used to specify the files and/or directories that contain
1.305 +# documented source files. You may enter file names like "myfile.cpp" or
1.306 +# directories like "/usr/src/myproject". Separate the files or directories
1.307 +# with spaces.
1.308 +
1.309 +INPUT = \security\certman\tpkixcert
1.310 +# If the value of the INPUT tag contains directories, you can use the
1.311 +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
1.312 +# and *.h) to filter out the source-files in the directories. If left
1.313 +# blank all files are included.
1.314 +
1.315 +FILE_PATTERNS =
1.316 +
1.317 +# The RECURSIVE tag can be used to turn specify whether or not subdirectories
1.318 +# should be searched for input files as well. Possible values are YES and NO.
1.319 +# If left blank NO is used.
1.320 +
1.321 +RECURSIVE = NO
1.322 +
1.323 +# The EXCLUDE tag can be used to specify files and/or directories that should
1.324 +# excluded from the INPUT source files. This way you can easily exclude a
1.325 +# subdirectory from a directory tree whose root is specified with the INPUT tag.
1.326 +
1.327 +EXCLUDE =
1.328 +
1.329 +# If the value of the INPUT tag contains directories, you can use the
1.330 +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1.331 +# certain files from those directories.
1.332 +
1.333 +EXCLUDE_PATTERNS =
1.334 +
1.335 +# The EXAMPLE_PATH tag can be used to specify one or more files or
1.336 +# directories that contain example code fragments that are included (see
1.337 +# the \include command).
1.338 +
1.339 +EXAMPLE_PATH =
1.340 +
1.341 +# If the value of the EXAMPLE_PATH tag contains directories, you can use the
1.342 +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
1.343 +# and *.h) to filter out the source-files in the directories. If left
1.344 +# blank all files are included.
1.345 +
1.346 +EXAMPLE_PATTERNS =
1.347 +
1.348 +# The IMAGE_PATH tag can be used to specify one or more files or
1.349 +# directories that contain image that are included in the documentation (see
1.350 +# the \image command).
1.351 +
1.352 +IMAGE_PATH =
1.353 +
1.354 +# The INPUT_FILTER tag can be used to specify a program that doxygen should
1.355 +# invoke to filter for each input file. Doxygen will invoke the filter program
1.356 +# by executing (via popen()) the command <filter> <input-file>, where <filter>
1.357 +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
1.358 +# input file. Doxygen will then use the output that the filter program writes
1.359 +# to standard output.
1.360 +
1.361 +INPUT_FILTER =
1.362 +
1.363 +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1.364 +# INPUT_FILTER) will be used to filter the input files when producing source
1.365 +# files to browse.
1.366 +
1.367 +FILTER_SOURCE_FILES = NO
1.368 +
1.369 +#---------------------------------------------------------------------------
1.370 +# configuration options related to the alphabetical class index
1.371 +#---------------------------------------------------------------------------
1.372 +
1.373 +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
1.374 +# of all compounds will be generated. Enable this if the project
1.375 +# contains a lot of classes, structs, unions or interfaces.
1.376 +
1.377 +ALPHABETICAL_INDEX = NO
1.378 +
1.379 +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
1.380 +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
1.381 +# in which this list will be split (can be a number in the range [1..20])
1.382 +
1.383 +COLS_IN_ALPHA_INDEX = 5
1.384 +
1.385 +# In case all classes in a project start with a common prefix, all
1.386 +# classes will be put under the same header in the alphabetical index.
1.387 +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
1.388 +# should be ignored while generating the index headers.
1.389 +
1.390 +IGNORE_PREFIX =
1.391 +
1.392 +#---------------------------------------------------------------------------
1.393 +# configuration options related to the HTML output
1.394 +#---------------------------------------------------------------------------
1.395 +
1.396 +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
1.397 +# generate HTML output.
1.398 +
1.399 +GENERATE_HTML = YES
1.400 +
1.401 +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
1.402 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.403 +# put in front of it. If left blank `html' will be used as the default path.
1.404 +
1.405 +HTML_OUTPUT =
1.406 +
1.407 +# The HTML_HEADER tag can be used to specify a personal HTML header for
1.408 +# each generated HTML page. If it is left blank doxygen will generate a
1.409 +# standard header.
1.410 +
1.411 +HTML_HEADER =
1.412 +
1.413 +# The HTML_FOOTER tag can be used to specify a personal HTML footer for
1.414 +# each generated HTML page. If it is left blank doxygen will generate a
1.415 +# standard footer.
1.416 +
1.417 +HTML_FOOTER =
1.418 +
1.419 +# The HTML_STYLESHEET tag can be used to specify a user defined cascading
1.420 +# style sheet that is used by each HTML page. It can be used to
1.421 +# fine-tune the look of the HTML output. If the tag is left blank doxygen
1.422 +# will generate a default style sheet
1.423 +
1.424 +HTML_STYLESHEET =
1.425 +
1.426 +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
1.427 +# files or namespaces will be aligned in HTML using tables. If set to
1.428 +# NO a bullet list will be used.
1.429 +
1.430 +HTML_ALIGN_MEMBERS = YES
1.431 +
1.432 +# If the GENERATE_HTMLHELP tag is set to YES, additional index files
1.433 +# will be generated that can be used as input for tools like the
1.434 +# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
1.435 +# of the generated HTML documentation.
1.436 +
1.437 +GENERATE_HTMLHELP = NO
1.438 +
1.439 +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1.440 +# controls if a separate .chi index file is generated (YES) or that
1.441 +# it should be included in the master .chm file (NO).
1.442 +
1.443 +GENERATE_CHI = NO
1.444 +
1.445 +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1.446 +# controls whether a binary table of contents is generated (YES) or a
1.447 +# normal table of contents (NO) in the .chm file.
1.448 +
1.449 +BINARY_TOC = NO
1.450 +
1.451 +# The TOC_EXPAND flag can be set to YES to add extra items for group members
1.452 +# to the contents of the Html help documentation and to the tree view.
1.453 +
1.454 +TOC_EXPAND = NO
1.455 +
1.456 +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1.457 +# top of each HTML page. The value NO (the default) enables the index and
1.458 +# the value YES disables it.
1.459 +
1.460 +DISABLE_INDEX = NO
1.461 +
1.462 +# This tag can be used to set the number of enum values (range [1..20])
1.463 +# that doxygen will group on one line in the generated HTML documentation.
1.464 +
1.465 +ENUM_VALUES_PER_LINE = 4
1.466 +
1.467 +# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
1.468 +# generated containing a tree-like index structure (just like the one that
1.469 +# is generated for HTML Help). For this to work a browser that supports
1.470 +# JavaScript and frames is required (for instance Netscape 4.0+
1.471 +# or Internet explorer 4.0+).
1.472 +
1.473 +GENERATE_TREEVIEW = NO
1.474 +
1.475 +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1.476 +# used to set the initial width (in pixels) of the frame in which the tree
1.477 +# is shown.
1.478 +
1.479 +TREEVIEW_WIDTH = 250
1.480 +
1.481 +#---------------------------------------------------------------------------
1.482 +# configuration options related to the LaTeX output
1.483 +#---------------------------------------------------------------------------
1.484 +
1.485 +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1.486 +# generate Latex output.
1.487 +
1.488 +GENERATE_LATEX = YES
1.489 +
1.490 +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1.491 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.492 +# put in front of it. If left blank `latex' will be used as the default path.
1.493 +
1.494 +LATEX_OUTPUT =
1.495 +
1.496 +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1.497 +# LaTeX documents. This may be useful for small projects and may help to
1.498 +# save some trees in general.
1.499 +
1.500 +COMPACT_LATEX = NO
1.501 +
1.502 +# The PAPER_TYPE tag can be used to set the paper type that is used
1.503 +# by the printer. Possible values are: a4, a4wide, letter, legal and
1.504 +# executive. If left blank a4wide will be used.
1.505 +
1.506 +PAPER_TYPE = a4wide
1.507 +
1.508 +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1.509 +# packages that should be included in the LaTeX output.
1.510 +
1.511 +EXTRA_PACKAGES =
1.512 +
1.513 +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1.514 +# the generated latex document. The header should contain everything until
1.515 +# the first chapter. If it is left blank doxygen will generate a
1.516 +# standard header. Notice: only use this tag if you know what you are doing!
1.517 +
1.518 +LATEX_HEADER =
1.519 +
1.520 +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1.521 +# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1.522 +# contain links (just like the HTML output) instead of page references
1.523 +# This makes the output suitable for online browsing using a pdf viewer.
1.524 +
1.525 +PDF_HYPERLINKS = NO
1.526 +
1.527 +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1.528 +# plain latex in the generated Makefile. Set this option to YES to get a
1.529 +# higher quality PDF documentation.
1.530 +
1.531 +USE_PDFLATEX = NO
1.532 +
1.533 +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1.534 +# command to the generated LaTeX files. This will instruct LaTeX to keep
1.535 +# running if errors occur, instead of asking the user for help.
1.536 +# This option is also used when generating formulas in HTML.
1.537 +
1.538 +LATEX_BATCHMODE = NO
1.539 +
1.540 +#---------------------------------------------------------------------------
1.541 +# configuration options related to the RTF output
1.542 +#---------------------------------------------------------------------------
1.543 +
1.544 +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1.545 +# The RTF output is optimised for Word 97 and may not look very pretty with
1.546 +# other RTF readers or editors.
1.547 +
1.548 +GENERATE_RTF = NO
1.549 +
1.550 +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1.551 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.552 +# put in front of it. If left blank `rtf' will be used as the default path.
1.553 +
1.554 +RTF_OUTPUT =
1.555 +
1.556 +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1.557 +# RTF documents. This may be useful for small projects and may help to
1.558 +# save some trees in general.
1.559 +
1.560 +COMPACT_RTF = NO
1.561 +
1.562 +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1.563 +# will contain hyperlink fields. The RTF file will
1.564 +# contain links (just like the HTML output) instead of page references.
1.565 +# This makes the output suitable for online browsing using WORD or other
1.566 +# programs which support those fields.
1.567 +# Note: wordpad (write) and others do not support links.
1.568 +
1.569 +RTF_HYPERLINKS = NO
1.570 +
1.571 +# Load stylesheet definitions from file. Syntax is similar to doxygen's
1.572 +# config file, i.e. a series of assigments. You only have to provide
1.573 +# replacements, missing definitions are set to their default value.
1.574 +
1.575 +RTF_STYLESHEET_FILE =
1.576 +
1.577 +# Set optional variables used in the generation of an rtf document.
1.578 +# Syntax is similar to doxygen's config file.
1.579 +
1.580 +RTF_EXTENSIONS_FILE =
1.581 +
1.582 +#---------------------------------------------------------------------------
1.583 +# configuration options related to the man page output
1.584 +#---------------------------------------------------------------------------
1.585 +
1.586 +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1.587 +# generate man pages
1.588 +
1.589 +GENERATE_MAN = NO
1.590 +
1.591 +# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1.592 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.593 +# put in front of it. If left blank `man' will be used as the default path.
1.594 +
1.595 +MAN_OUTPUT =
1.596 +
1.597 +# The MAN_EXTENSION tag determines the extension that is added to
1.598 +# the generated man pages (default is the subroutine's section .3)
1.599 +
1.600 +MAN_EXTENSION =
1.601 +
1.602 +# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1.603 +# then it will generate one additional man file for each entity
1.604 +# documented in the real man page(s). These additional files
1.605 +# only source the real man page, but without them the man command
1.606 +# would be unable to find the correct page. The default is NO.
1.607 +
1.608 +MAN_LINKS = NO
1.609 +
1.610 +#---------------------------------------------------------------------------
1.611 +# Configuration options related to the preprocessor
1.612 +#---------------------------------------------------------------------------
1.613 +
1.614 +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1.615 +# evaluate all C-preprocessor directives found in the sources and include
1.616 +# files.
1.617 +
1.618 +ENABLE_PREPROCESSING = YES
1.619 +
1.620 +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1.621 +# names in the source code. If set to NO (the default) only conditional
1.622 +# compilation will be performed. Macro expansion can be done in a controlled
1.623 +# way by setting EXPAND_ONLY_PREDEF to YES.
1.624 +
1.625 +MACRO_EXPANSION = NO
1.626 +
1.627 +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1.628 +# then the macro expansion is limited to the macros specified with the
1.629 +# PREDEFINED and EXPAND_AS_PREDEFINED tags.
1.630 +
1.631 +EXPAND_ONLY_PREDEF = NO
1.632 +
1.633 +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1.634 +# in the INCLUDE_PATH (see below) will be search if a #include is found.
1.635 +
1.636 +SEARCH_INCLUDES = YES
1.637 +
1.638 +# The INCLUDE_PATH tag can be used to specify one or more directories that
1.639 +# contain include files that are not input files but should be processed by
1.640 +# the preprocessor.
1.641 +
1.642 +INCLUDE_PATH =
1.643 +
1.644 +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1.645 +# patterns (like *.h and *.hpp) to filter out the header-files in the
1.646 +# directories. If left blank, the patterns specified with FILE_PATTERNS will
1.647 +# be used.
1.648 +
1.649 +INCLUDE_FILE_PATTERNS =
1.650 +
1.651 +# The PREDEFINED tag can be used to specify one or more macro names that
1.652 +# are defined before the preprocessor is started (similar to the -D option of
1.653 +# gcc). The argument of the tag is a list of macros of the form: name
1.654 +# or name=definition (no spaces). If the definition and the = are
1.655 +# omitted =1 is assumed.
1.656 +
1.657 +PREDEFINED =
1.658 +
1.659 +# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
1.660 +# this tag can be used to specify a list of macro names that should be expanded.
1.661 +# The macro definition that is found in the sources will be used.
1.662 +# Use the PREDEFINED tag if you want to use a different macro definition.
1.663 +
1.664 +EXPAND_AS_DEFINED =
1.665 +
1.666 +#---------------------------------------------------------------------------
1.667 +# Configuration::addtions related to external references
1.668 +#---------------------------------------------------------------------------
1.669 +
1.670 +# The TAGFILES tag can be used to specify one or more tagfiles.
1.671 +
1.672 +TAGFILES =
1.673 +
1.674 +# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1.675 +# a tag file that is based on the input files it reads.
1.676 +
1.677 +GENERATE_TAGFILE =
1.678 +
1.679 +# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1.680 +# in the class index. If set to NO only the inherited external classes
1.681 +# will be listed.
1.682 +
1.683 +ALLEXTERNALS = NO
1.684 +
1.685 +# The PERL_PATH should be the absolute path and name of the perl script
1.686 +# interpreter (i.e. the result of `which perl').
1.687 +
1.688 +PERL_PATH =
1.689 +
1.690 +#---------------------------------------------------------------------------
1.691 +# Configuration options related to the dot tool
1.692 +#---------------------------------------------------------------------------
1.693 +
1.694 +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1.695 +# available from the path. This tool is part of Graphviz, a graph visualization
1.696 +# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1.697 +# have no effect if this option is set to NO (the default)
1.698 +
1.699 +HAVE_DOT = NO
1.700 +
1.701 +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1.702 +# will generate a graph for each documented class showing the direct and
1.703 +# indirect inheritance relations. Setting this tag to YES will force the
1.704 +# the CLASS_DIAGRAMS tag to NO.
1.705 +
1.706 +CLASS_GRAPH = YES
1.707 +
1.708 +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1.709 +# will generate a graph for each documented class showing the direct and
1.710 +# indirect implementation dependencies (inheritance, containment, and
1.711 +# class references variables) of the class with other documented classes.
1.712 +
1.713 +COLLABORATION_GRAPH = YES
1.714 +
1.715 +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1.716 +# tags are set to YES then doxygen will generate a graph for each documented
1.717 +# file showing the direct and indirect include dependencies of the file with
1.718 +# other documented files.
1.719 +
1.720 +INCLUDE_GRAPH = YES
1.721 +
1.722 +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1.723 +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1.724 +# documented header file showing the documented files that directly or
1.725 +# indirectly include this file.
1.726 +
1.727 +INCLUDED_BY_GRAPH = YES
1.728 +
1.729 +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1.730 +# will graphical hierarchy of all classes instead of a textual one.
1.731 +
1.732 +GRAPHICAL_HIERARCHY = YES
1.733 +
1.734 +# The tag DOT_PATH can be used to specify the path where the dot tool can be
1.735 +# found. If left blank, it is assumed the dot tool can be found on the path.
1.736 +
1.737 +DOT_PATH =
1.738 +
1.739 +# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1.740 +# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1.741 +# this value, doxygen will try to truncate the graph, so that it fits within
1.742 +# the specified constraint. Beware that most browsers cannot cope with very
1.743 +# large images.
1.744 +
1.745 +MAX_DOT_GRAPH_WIDTH = 1024
1.746 +
1.747 +# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1.748 +# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1.749 +# this value, doxygen will try to truncate the graph, so that it fits within
1.750 +# the specified constraint. Beware that most browsers cannot cope with very
1.751 +# large images.
1.752 +
1.753 +MAX_DOT_GRAPH_HEIGHT = 1024
1.754 +
1.755 +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1.756 +# generate a legend page explaining the meaning of the various boxes and
1.757 +# arrows in the dot generated graphs.
1.758 +
1.759 +GENERATE_LEGEND = YES
1.760 +
1.761 +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1.762 +# remove the intermedate dot files that are used to generate
1.763 +# the various graphs.
1.764 +
1.765 +DOT_CLEANUP = YES
1.766 +
1.767 +#---------------------------------------------------------------------------
1.768 +# Configuration::addtions related to the search engine
1.769 +#---------------------------------------------------------------------------
1.770 +
1.771 +# The SEARCHENGINE tag specifies whether or not a search engine should be
1.772 +# used. If set to NO the values of all tags below this one will be ignored.
1.773 +
1.774 +SEARCHENGINE = NO
1.775 +
1.776 +# The CGI_NAME tag should be the name of the CGI script that
1.777 +# starts the search engine (doxysearch) with the correct parameters.
1.778 +# A script with this name will be generated by doxygen.
1.779 +
1.780 +CGI_NAME =
1.781 +
1.782 +# The CGI_URL tag should be the absolute URL to the directory where the
1.783 +# cgi binaries are located. See the documentation of your http daemon for
1.784 +# details.
1.785 +
1.786 +CGI_URL =
1.787 +
1.788 +# The DOC_URL tag should be the absolute URL to the directory where the
1.789 +# documentation is located. If left blank the absolute path to the
1.790 +# documentation, with file:// prepended to it, will be used.
1.791 +
1.792 +DOC_URL =
1.793 +
1.794 +# The DOC_ABSPATH tag should be the absolute path to the directory where the
1.795 +# documentation is located. If left blank the directory on the local machine
1.796 +# will be used.
1.797 +
1.798 +DOC_ABSPATH =
1.799 +
1.800 +# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
1.801 +# is installed.
1.802 +
1.803 +BIN_ABSPATH =
1.804 +
1.805 +# The EXT_DOC_PATHS tag can be used to specify one or more paths to
1.806 +# documentation generated for other projects. This allows doxysearch to search
1.807 +# the documentation for these projects as well.
1.808 +
1.809 +EXT_DOC_PATHS =