1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/config/doxygen.cfg.in Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,1364 @@
1.4 +/* This Source Code Form is subject to the terms of the Mozilla Public
1.5 + * License, v. 2.0. If a copy of the MPL was not distributed with this
1.6 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1.7 +
1.8 +# Doxyfile 1.5.5
1.9 +
1.10 +# This file describes the settings to be used by the documentation system
1.11 +# doxygen (www.doxygen.org) for a project
1.12 +#
1.13 +# All text after a hash (#) is considered a comment and will be ignored
1.14 +# The format is:
1.15 +# TAG = value [value, ...]
1.16 +# For lists items can also be appended using:
1.17 +# TAG += value [value, ...]
1.18 +# Values that contain spaces should be placed between quotes (" ")
1.19 +
1.20 +#---------------------------------------------------------------------------
1.21 +# Project related configuration options
1.22 +#---------------------------------------------------------------------------
1.23 +
1.24 +# This tag specifies the encoding used for all characters in the config file
1.25 +# that follow. The default is UTF-8 which is also the encoding used for all
1.26 +# text before the first occurrence of this tag. Doxygen uses libiconv (or the
1.27 +# iconv built into libc) for the transcoding. See
1.28 +# http://www.gnu.org/software/libiconv for the list of possible encodings.
1.29 +
1.30 +DOXYFILE_ENCODING = UTF-8
1.31 +
1.32 +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
1.33 +# by quotes) that should identify the project.
1.34 +
1.35 +PROJECT_NAME = "Mozilla"
1.36 +
1.37 +# The PROJECT_NUMBER tag can be used to enter a project or revision number.
1.38 +# This could be handy for archiving the generated documentation or
1.39 +# if some version control system is used.
1.40 +
1.41 +PROJECT_NUMBER =
1.42 +
1.43 +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
1.44 +# base path where the generated documentation will be put.
1.45 +# If a relative path is entered, it will be relative to the location
1.46 +# where doxygen was started. If left blank the current directory will be used.
1.47 +
1.48 +OUTPUT_DIRECTORY = @MOZ_DOC_OUTPUT_DIR@
1.49 +
1.50 +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
1.51 +# 4096 sub-directories (in 2 levels) under the output directory of each output
1.52 +# format and will distribute the generated files over these directories.
1.53 +# Enabling this option can be useful when feeding doxygen a huge amount of
1.54 +# source files, where putting all generated files in the same directory would
1.55 +# otherwise cause performance problems for the file system.
1.56 +
1.57 +CREATE_SUBDIRS = NO
1.58 +
1.59 +# The OUTPUT_LANGUAGE tag is used to specify the language in which all
1.60 +# documentation generated by doxygen is written. Doxygen will use this
1.61 +# information to generate all constant output in the proper language.
1.62 +# The default language is English, other supported languages are:
1.63 +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
1.64 +# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
1.65 +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
1.66 +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
1.67 +# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
1.68 +# and Ukrainian.
1.69 +
1.70 +OUTPUT_LANGUAGE = English
1.71 +
1.72 +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
1.73 +# include brief member descriptions after the members that are listed in
1.74 +# the file and class documentation (similar to JavaDoc).
1.75 +# Set to NO to disable this.
1.76 +
1.77 +BRIEF_MEMBER_DESC = YES
1.78 +
1.79 +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
1.80 +# the brief description of a member or function before the detailed description.
1.81 +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
1.82 +# brief descriptions will be completely suppressed.
1.83 +
1.84 +REPEAT_BRIEF = YES
1.85 +
1.86 +# This tag implements a quasi-intelligent brief description abbreviator
1.87 +# that is used to form the text in various listings. Each string
1.88 +# in this list, if found as the leading text of the brief description, will be
1.89 +# stripped from the text and the result after processing the whole list, is
1.90 +# used as the annotated text. Otherwise, the brief description is used as-is.
1.91 +# If left blank, the following values are used ("$name" is automatically
1.92 +# replaced with the name of the entity): "The $name class" "The $name widget"
1.93 +# "The $name file" "is" "provides" "specifies" "contains"
1.94 +# "represents" "a" "an" "the"
1.95 +
1.96 +ABBREVIATE_BRIEF =
1.97 +
1.98 +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
1.99 +# Doxygen will generate a detailed section even if there is only a brief
1.100 +# description.
1.101 +
1.102 +ALWAYS_DETAILED_SEC = NO
1.103 +
1.104 +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
1.105 +# inherited members of a class in the documentation of that class as if those
1.106 +# members were ordinary class members. Constructors, destructors and assignment
1.107 +# operators of the base classes will not be shown.
1.108 +
1.109 +INLINE_INHERITED_MEMB = NO
1.110 +
1.111 +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
1.112 +# path before files name in the file list and in the header files. If set
1.113 +# to NO the shortest path that makes the file name unique will be used.
1.114 +
1.115 +FULL_PATH_NAMES = NO
1.116 +
1.117 +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
1.118 +# can be used to strip a user-defined part of the path. Stripping is
1.119 +# only done if one of the specified strings matches the left-hand part of
1.120 +# the path. The tag can be used to show relative paths in the file list.
1.121 +# If left blank the directory from which doxygen is run is used as the
1.122 +# path to strip.
1.123 +
1.124 +STRIP_FROM_PATH =
1.125 +
1.126 +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
1.127 +# the path mentioned in the documentation of a class, which tells
1.128 +# the reader which header file to include in order to use a class.
1.129 +# If left blank only the name of the header file containing the class
1.130 +# definition is used. Otherwise one should specify the include paths that
1.131 +# are normally passed to the compiler using the -I flag.
1.132 +
1.133 +STRIP_FROM_INC_PATH =
1.134 +
1.135 +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
1.136 +# (but less readable) file names. This can be useful is your file systems
1.137 +# doesn't support long names like on DOS, Mac, or CD-ROM.
1.138 +
1.139 +SHORT_NAMES = NO
1.140 +
1.141 +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
1.142 +# will interpret the first line (until the first dot) of a JavaDoc-style
1.143 +# comment as the brief description. If set to NO, the JavaDoc
1.144 +# comments will behave just like regular Qt-style comments
1.145 +# (thus requiring an explicit @brief command for a brief description.)
1.146 +
1.147 +JAVADOC_AUTOBRIEF = YES
1.148 +
1.149 +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
1.150 +# interpret the first line (until the first dot) of a Qt-style
1.151 +# comment as the brief description. If set to NO, the comments
1.152 +# will behave just like regular Qt-style comments (thus requiring
1.153 +# an explicit \brief command for a brief description.)
1.154 +
1.155 +QT_AUTOBRIEF = NO
1.156 +
1.157 +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
1.158 +# treat a multi-line C++ special comment block (i.e. a block of //! or ///
1.159 +# comments) as a brief description. This used to be the default behaviour.
1.160 +# The new default is to treat a multi-line C++ comment block as a detailed
1.161 +# description. Set this tag to YES if you prefer the old behaviour instead.
1.162 +
1.163 +MULTILINE_CPP_IS_BRIEF = NO
1.164 +
1.165 +# If the DETAILS_AT_TOP tag is set to YES then Doxygen
1.166 +# will output the detailed description near the top, like JavaDoc.
1.167 +# If set to NO, the detailed description appears after the member
1.168 +# documentation.
1.169 +
1.170 +DETAILS_AT_TOP = NO
1.171 +
1.172 +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
1.173 +# member inherits the documentation from any documented member that it
1.174 +# re-implements.
1.175 +
1.176 +INHERIT_DOCS = YES
1.177 +
1.178 +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
1.179 +# a new page for each member. If set to NO, the documentation of a member will
1.180 +# be part of the file/class/namespace that contains it.
1.181 +
1.182 +SEPARATE_MEMBER_PAGES = NO
1.183 +
1.184 +# The TAB_SIZE tag can be used to set the number of spaces in a tab.
1.185 +# Doxygen uses this value to replace tabs by spaces in code fragments.
1.186 +
1.187 +TAB_SIZE = 4
1.188 +
1.189 +# This tag can be used to specify a number of aliases that acts
1.190 +# as commands in the documentation. An alias has the form "name=value".
1.191 +# For example adding "sideeffect=\par Side Effects:\n" will allow you to
1.192 +# put the command \sideeffect (or @sideeffect) in the documentation, which
1.193 +# will result in a user-defined paragraph with heading "Side Effects:".
1.194 +# You can put \n's in the value part of an alias to insert newlines.
1.195 +
1.196 +ALIASES = "status=\par Status:\n"
1.197 +
1.198 +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
1.199 +# sources only. Doxygen will then generate output that is more tailored for C.
1.200 +# For instance, some of the names that are used will be different. The list
1.201 +# of all members will be omitted, etc.
1.202 +
1.203 +OPTIMIZE_OUTPUT_FOR_C = NO
1.204 +
1.205 +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
1.206 +# sources only. Doxygen will then generate output that is more tailored for
1.207 +# Java. For instance, namespaces will be presented as packages, qualified
1.208 +# scopes will look different, etc.
1.209 +
1.210 +OPTIMIZE_OUTPUT_JAVA = NO
1.211 +
1.212 +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
1.213 +# sources only. Doxygen will then generate output that is more tailored for
1.214 +# Fortran.
1.215 +
1.216 +OPTIMIZE_FOR_FORTRAN = NO
1.217 +
1.218 +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
1.219 +# sources. Doxygen will then generate output that is tailored for
1.220 +# VHDL.
1.221 +
1.222 +OPTIMIZE_OUTPUT_VHDL = NO
1.223 +
1.224 +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
1.225 +# to include (a tag file for) the STL sources as input, then you should
1.226 +# set this tag to YES in order to let doxygen match functions declarations and
1.227 +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
1.228 +# func(std::string) {}). This also make the inheritance and collaboration
1.229 +# diagrams that involve STL classes more complete and accurate.
1.230 +
1.231 +BUILTIN_STL_SUPPORT = NO
1.232 +
1.233 +# If you use Microsoft's C++/CLI language, you should set this option to YES to
1.234 +# enable parsing support.
1.235 +
1.236 +CPP_CLI_SUPPORT = NO
1.237 +
1.238 +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
1.239 +# Doxygen will parse them like normal C++ but will assume all classes use public
1.240 +# instead of private inheritance when no explicit protection keyword is present.
1.241 +
1.242 +SIP_SUPPORT = NO
1.243 +
1.244 +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
1.245 +# tag is set to YES, then doxygen will reuse the documentation of the first
1.246 +# member in the group (if any) for the other members of the group. By default
1.247 +# all members of a group must be documented explicitly.
1.248 +
1.249 +DISTRIBUTE_GROUP_DOC = YES
1.250 +
1.251 +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
1.252 +# the same type (for instance a group of public functions) to be put as a
1.253 +# subgroup of that type (e.g. under the Public Functions section). Set it to
1.254 +# NO to prevent subgrouping. Alternatively, this can be done per class using
1.255 +# the \nosubgrouping command.
1.256 +
1.257 +SUBGROUPING = YES
1.258 +
1.259 +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
1.260 +# is documented as struct, union, or enum with the name of the typedef. So
1.261 +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
1.262 +# with name TypeT. When disabled the typedef will appear as a member of a file,
1.263 +# namespace, or class. And the struct will be named TypeS. This can typically
1.264 +# be useful for C code in case the coding convention dictates that all compound
1.265 +# types are typedef'ed and only the typedef is referenced, never the tag name.
1.266 +
1.267 +TYPEDEF_HIDES_STRUCT = NO
1.268 +
1.269 +#---------------------------------------------------------------------------
1.270 +# Build related configuration options
1.271 +#---------------------------------------------------------------------------
1.272 +
1.273 +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
1.274 +# documentation are documented, even if no documentation was available.
1.275 +# Private class members and static file members will be hidden unless
1.276 +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
1.277 +
1.278 +EXTRACT_ALL = YES
1.279 +
1.280 +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
1.281 +# will be included in the documentation.
1.282 +
1.283 +EXTRACT_PRIVATE = NO
1.284 +
1.285 +# If the EXTRACT_STATIC tag is set to YES all static members of a file
1.286 +# will be included in the documentation.
1.287 +
1.288 +EXTRACT_STATIC = NO
1.289 +
1.290 +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
1.291 +# defined locally in source files will be included in the documentation.
1.292 +# If set to NO only classes defined in header files are included.
1.293 +
1.294 +EXTRACT_LOCAL_CLASSES = YES
1.295 +
1.296 +# This flag is only useful for Objective-C code. When set to YES local
1.297 +# methods, which are defined in the implementation section but not in
1.298 +# the interface are included in the documentation.
1.299 +# If set to NO (the default) only methods in the interface are included.
1.300 +
1.301 +EXTRACT_LOCAL_METHODS = NO
1.302 +
1.303 +# If this flag is set to YES, the members of anonymous namespaces will be
1.304 +# extracted and appear in the documentation as a namespace called
1.305 +# 'anonymous_namespace{file}', where file will be replaced with the base
1.306 +# name of the file that contains the anonymous namespace. By default
1.307 +# anonymous namespace are hidden.
1.308 +
1.309 +EXTRACT_ANON_NSPACES = NO
1.310 +
1.311 +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
1.312 +# undocumented members of documented classes, files or namespaces.
1.313 +# If set to NO (the default) these members will be included in the
1.314 +# various overviews, but no documentation section is generated.
1.315 +# This option has no effect if EXTRACT_ALL is enabled.
1.316 +
1.317 +HIDE_UNDOC_MEMBERS = NO
1.318 +
1.319 +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
1.320 +# undocumented classes that are normally visible in the class hierarchy.
1.321 +# If set to NO (the default) these classes will be included in the various
1.322 +# overviews. This option has no effect if EXTRACT_ALL is enabled.
1.323 +
1.324 +HIDE_UNDOC_CLASSES = NO
1.325 +
1.326 +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
1.327 +# friend (class|struct|union) declarations.
1.328 +# If set to NO (the default) these declarations will be included in the
1.329 +# documentation.
1.330 +
1.331 +HIDE_FRIEND_COMPOUNDS = NO
1.332 +
1.333 +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
1.334 +# documentation blocks found inside the body of a function.
1.335 +# If set to NO (the default) these blocks will be appended to the
1.336 +# function's detailed documentation block.
1.337 +
1.338 +HIDE_IN_BODY_DOCS = NO
1.339 +
1.340 +# The INTERNAL_DOCS tag determines if documentation
1.341 +# that is typed after a \internal command is included. If the tag is set
1.342 +# to NO (the default) then the documentation will be excluded.
1.343 +# Set it to YES to include the internal documentation.
1.344 +
1.345 +INTERNAL_DOCS = NO
1.346 +
1.347 +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
1.348 +# file names in lower-case letters. If set to YES upper-case letters are also
1.349 +# allowed. This is useful if you have classes or files whose names only differ
1.350 +# in case and if your file system supports case sensitive file names. Windows
1.351 +# and Mac users are advised to set this option to NO.
1.352 +
1.353 +CASE_SENSE_NAMES = YES
1.354 +
1.355 +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
1.356 +# will show members with their full class and namespace scopes in the
1.357 +# documentation. If set to YES the scope will be hidden.
1.358 +
1.359 +HIDE_SCOPE_NAMES = NO
1.360 +
1.361 +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
1.362 +# will put a list of the files that are included by a file in the documentation
1.363 +# of that file.
1.364 +
1.365 +SHOW_INCLUDE_FILES = YES
1.366 +
1.367 +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
1.368 +# is inserted in the documentation for inline members.
1.369 +
1.370 +INLINE_INFO = YES
1.371 +
1.372 +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
1.373 +# will sort the (detailed) documentation of file and class members
1.374 +# alphabetically by member name. If set to NO the members will appear in
1.375 +# declaration order.
1.376 +
1.377 +SORT_MEMBER_DOCS = YES
1.378 +
1.379 +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
1.380 +# brief documentation of file, namespace and class members alphabetically
1.381 +# by member name. If set to NO (the default) the members will appear in
1.382 +# declaration order.
1.383 +
1.384 +SORT_BRIEF_DOCS = NO
1.385 +
1.386 +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
1.387 +# hierarchy of group names into alphabetical order. If set to NO (the default)
1.388 +# the group names will appear in their defined order.
1.389 +
1.390 +SORT_GROUP_NAMES = NO
1.391 +
1.392 +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
1.393 +# sorted by fully-qualified names, including namespaces. If set to
1.394 +# NO (the default), the class list will be sorted only by class name,
1.395 +# not including the namespace part.
1.396 +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
1.397 +# Note: This option applies only to the class list, not to the
1.398 +# alphabetical list.
1.399 +
1.400 +SORT_BY_SCOPE_NAME = NO
1.401 +
1.402 +# The GENERATE_TODOLIST tag can be used to enable (YES) or
1.403 +# disable (NO) the todo list. This list is created by putting \todo
1.404 +# commands in the documentation.
1.405 +
1.406 +GENERATE_TODOLIST = YES
1.407 +
1.408 +# The GENERATE_TESTLIST tag can be used to enable (YES) or
1.409 +# disable (NO) the test list. This list is created by putting \test
1.410 +# commands in the documentation.
1.411 +
1.412 +GENERATE_TESTLIST = YES
1.413 +
1.414 +# The GENERATE_BUGLIST tag can be used to enable (YES) or
1.415 +# disable (NO) the bug list. This list is created by putting \bug
1.416 +# commands in the documentation.
1.417 +
1.418 +GENERATE_BUGLIST = NO
1.419 +
1.420 +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
1.421 +# disable (NO) the deprecated list. This list is created by putting
1.422 +# \deprecated commands in the documentation.
1.423 +
1.424 +GENERATE_DEPRECATEDLIST= YES
1.425 +
1.426 +# The ENABLED_SECTIONS tag can be used to enable conditional
1.427 +# documentation sections, marked by \if sectionname ... \endif.
1.428 +
1.429 +ENABLED_SECTIONS =
1.430 +
1.431 +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
1.432 +# the initial value of a variable or define consists of for it to appear in
1.433 +# the documentation. If the initializer consists of more lines than specified
1.434 +# here it will be hidden. Use a value of 0 to hide initializers completely.
1.435 +# The appearance of the initializer of individual variables and defines in the
1.436 +# documentation can be controlled using \showinitializer or \hideinitializer
1.437 +# command in the documentation regardless of this setting.
1.438 +
1.439 +MAX_INITIALIZER_LINES = 30
1.440 +
1.441 +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
1.442 +# at the bottom of the documentation of classes and structs. If set to YES the
1.443 +# list will mention the files that were used to generate the documentation.
1.444 +
1.445 +SHOW_USED_FILES = YES
1.446 +
1.447 +# If the sources in your project are distributed over multiple directories
1.448 +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
1.449 +# in the documentation. The default is NO.
1.450 +
1.451 +SHOW_DIRECTORIES = NO
1.452 +
1.453 +# The FILE_VERSION_FILTER tag can be used to specify a program or script that
1.454 +# doxygen should invoke to get the current version for each file (typically from
1.455 +# the version control system). Doxygen will invoke the program by executing (via
1.456 +# popen()) the command <command> <input-file>, where <command> is the value of
1.457 +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
1.458 +# provided by doxygen. Whatever the program writes to standard output
1.459 +# is used as the file version. See the manual for examples.
1.460 +
1.461 +FILE_VERSION_FILTER =
1.462 +
1.463 +#---------------------------------------------------------------------------
1.464 +# configuration options related to warning and progress messages
1.465 +#---------------------------------------------------------------------------
1.466 +
1.467 +# The QUIET tag can be used to turn on/off the messages that are generated
1.468 +# by doxygen. Possible values are YES and NO. If left blank NO is used.
1.469 +
1.470 +QUIET = NO
1.471 +
1.472 +# The WARNINGS tag can be used to turn on/off the warning messages that are
1.473 +# generated by doxygen. Possible values are YES and NO. If left blank
1.474 +# NO is used.
1.475 +
1.476 +WARNINGS = YES
1.477 +
1.478 +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
1.479 +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
1.480 +# automatically be disabled.
1.481 +
1.482 +WARN_IF_UNDOCUMENTED = NO
1.483 +
1.484 +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
1.485 +# potential errors in the documentation, such as not documenting some
1.486 +# parameters in a documented function, or documenting parameters that
1.487 +# don't exist or using markup commands wrongly.
1.488 +
1.489 +WARN_IF_DOC_ERROR = YES
1.490 +
1.491 +# This WARN_NO_PARAMDOC option can be abled to get warnings for
1.492 +# functions that are documented, but have no documentation for their parameters
1.493 +# or return value. If set to NO (the default) doxygen will only warn about
1.494 +# wrong or incomplete parameter documentation, but not about the absence of
1.495 +# documentation.
1.496 +
1.497 +WARN_NO_PARAMDOC = NO
1.498 +
1.499 +# The WARN_FORMAT tag determines the format of the warning messages that
1.500 +# doxygen can produce. The string should contain the $file, $line, and $text
1.501 +# tags, which will be replaced by the file and line number from which the
1.502 +# warning originated and the warning text. Optionally the format may contain
1.503 +# $version, which will be replaced by the version of the file (if it could
1.504 +# be obtained via FILE_VERSION_FILTER)
1.505 +
1.506 +WARN_FORMAT =
1.507 +
1.508 +# The WARN_LOGFILE tag can be used to specify a file to which warning
1.509 +# and error messages should be written. If left blank the output is written
1.510 +# to stderr.
1.511 +
1.512 +WARN_LOGFILE =
1.513 +
1.514 +#---------------------------------------------------------------------------
1.515 +# configuration options related to the input files
1.516 +#---------------------------------------------------------------------------
1.517 +
1.518 +# The INPUT tag can be used to specify the files and/or directories that contain
1.519 +# documented source files. You may enter file names like "myfile.cpp" or
1.520 +# directories like "/usr/src/myproject". Separate the files or directories
1.521 +# with spaces.
1.522 +
1.523 +INPUT = @MOZ_DOC_INPUT_DIRS@
1.524 +
1.525 +# This tag can be used to specify the character encoding of the source files
1.526 +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
1.527 +# also the default input encoding. Doxygen uses libiconv (or the iconv built
1.528 +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
1.529 +# the list of possible encodings.
1.530 +
1.531 +INPUT_ENCODING = UTF-8
1.532 +
1.533 +# If the value of the INPUT tag contains directories, you can use the
1.534 +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
1.535 +# and *.h) to filter out the source-files in the directories. If left
1.536 +# blank the following patterns are tested:
1.537 +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
1.538 +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
1.539 +
1.540 +FILE_PATTERNS = *.idl \
1.541 + *.cpp \
1.542 + *.h
1.543 +
1.544 +# The RECURSIVE tag can be used to turn specify whether or not subdirectories
1.545 +# should be searched for input files as well. Possible values are YES and NO.
1.546 +# If left blank NO is used.
1.547 +
1.548 +RECURSIVE = YES
1.549 +
1.550 +# The EXCLUDE tag can be used to specify files and/or directories that should
1.551 +# excluded from the INPUT source files. This way you can easily exclude a
1.552 +# subdirectory from a directory tree whose root is specified with the INPUT tag.
1.553 +
1.554 +EXCLUDE =
1.555 +
1.556 +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
1.557 +# directories that are symbolic links (a Unix filesystem feature) are excluded
1.558 +# from the input.
1.559 +
1.560 +EXCLUDE_SYMLINKS = NO
1.561 +
1.562 +# If the value of the INPUT tag contains directories, you can use the
1.563 +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1.564 +# certain files from those directories. Note that the wildcards are matched
1.565 +# against the file with absolute path, so to exclude all test directories
1.566 +# for example use the pattern */test/*
1.567 +
1.568 +EXCLUDE_PATTERNS = nsI*.h mozI*.h imgI*.h
1.569 +
1.570 +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1.571 +# (namespaces, classes, functions, etc.) that should be excluded from the
1.572 +# output. The symbol name can be a fully qualified name, a word, or if the
1.573 +# wildcard * is used, a substring. Examples: ANamespace, AClass,
1.574 +# AClass::ANamespace, ANamespace::*Test
1.575 +
1.576 +EXCLUDE_SYMBOLS = nsCOMPtr_base
1.577 +
1.578 +# The EXAMPLE_PATH tag can be used to specify one or more files or
1.579 +# directories that contain example code fragments that are included (see
1.580 +# the \include command).
1.581 +
1.582 +EXAMPLE_PATH =
1.583 +
1.584 +# If the value of the EXAMPLE_PATH tag contains directories, you can use the
1.585 +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
1.586 +# and *.h) to filter out the source-files in the directories. If left
1.587 +# blank all files are included.
1.588 +
1.589 +EXAMPLE_PATTERNS =
1.590 +
1.591 +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1.592 +# searched for input files to be used with the \include or \dontinclude
1.593 +# commands irrespective of the value of the RECURSIVE tag.
1.594 +# Possible values are YES and NO. If left blank NO is used.
1.595 +
1.596 +EXAMPLE_RECURSIVE = NO
1.597 +
1.598 +# The IMAGE_PATH tag can be used to specify one or more files or
1.599 +# directories that contain image that are included in the documentation (see
1.600 +# the \image command).
1.601 +
1.602 +IMAGE_PATH =
1.603 +
1.604 +# The INPUT_FILTER tag can be used to specify a program that doxygen should
1.605 +# invoke to filter for each input file. Doxygen will invoke the filter program
1.606 +# by executing (via popen()) the command <filter> <input-file>, where <filter>
1.607 +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
1.608 +# input file. Doxygen will then use the output that the filter program writes
1.609 +# to standard output. If FILTER_PATTERNS is specified, this tag will be
1.610 +# ignored.
1.611 +
1.612 +INPUT_FILTER =
1.613 +
1.614 +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1.615 +# basis. Doxygen will compare the file name with each pattern and apply the
1.616 +# filter if there is a match. The filters are a list of the form:
1.617 +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
1.618 +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
1.619 +# is applied to all files.
1.620 +
1.621 +FILTER_PATTERNS =
1.622 +
1.623 +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1.624 +# INPUT_FILTER) will be used to filter the input files when producing source
1.625 +# files to browse (i.e. when SOURCE_BROWSER is set to YES).
1.626 +
1.627 +FILTER_SOURCE_FILES = NO
1.628 +
1.629 +#---------------------------------------------------------------------------
1.630 +# configuration options related to source browsing
1.631 +#---------------------------------------------------------------------------
1.632 +
1.633 +# If the SOURCE_BROWSER tag is set to YES then a list of source files will
1.634 +# be generated. Documented entities will be cross-referenced with these sources.
1.635 +# Note: To get rid of all source code in the generated output, make sure also
1.636 +# VERBATIM_HEADERS is set to NO.
1.637 +
1.638 +SOURCE_BROWSER = NO
1.639 +
1.640 +# Setting the INLINE_SOURCES tag to YES will include the body
1.641 +# of functions and classes directly in the documentation.
1.642 +
1.643 +INLINE_SOURCES = NO
1.644 +
1.645 +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
1.646 +# doxygen to hide any special comment blocks from generated source code
1.647 +# fragments. Normal C and C++ comments will always remain visible.
1.648 +
1.649 +STRIP_CODE_COMMENTS = YES
1.650 +
1.651 +# If the REFERENCED_BY_RELATION tag is set to YES (the default)
1.652 +# then for each documented function all documented
1.653 +# functions referencing it will be listed.
1.654 +
1.655 +REFERENCED_BY_RELATION = NO
1.656 +
1.657 +# If the REFERENCES_RELATION tag is set to YES (the default)
1.658 +# then for each documented function all documented entities
1.659 +# called/used by that function will be listed.
1.660 +
1.661 +REFERENCES_RELATION = NO
1.662 +
1.663 +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
1.664 +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
1.665 +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
1.666 +# link to the source code. Otherwise they will link to the documentstion.
1.667 +
1.668 +REFERENCES_LINK_SOURCE = NO
1.669 +
1.670 +# If the USE_HTAGS tag is set to YES then the references to source code
1.671 +# will point to the HTML generated by the htags(1) tool instead of doxygen
1.672 +# built-in source browser. The htags tool is part of GNU's global source
1.673 +# tagging system (see http://www.gnu.org/software/global/global.html). You
1.674 +# will need version 4.8.6 or higher.
1.675 +
1.676 +USE_HTAGS = NO
1.677 +
1.678 +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
1.679 +# will generate a verbatim copy of the header file for each class for
1.680 +# which an include is specified. Set to NO to disable this.
1.681 +
1.682 +VERBATIM_HEADERS = NO
1.683 +
1.684 +#---------------------------------------------------------------------------
1.685 +# configuration options related to the alphabetical class index
1.686 +#---------------------------------------------------------------------------
1.687 +
1.688 +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
1.689 +# of all compounds will be generated. Enable this if the project
1.690 +# contains a lot of classes, structs, unions or interfaces.
1.691 +
1.692 +ALPHABETICAL_INDEX = YES
1.693 +
1.694 +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
1.695 +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
1.696 +# in which this list will be split (can be a number in the range [1..20])
1.697 +
1.698 +COLS_IN_ALPHA_INDEX = 5
1.699 +
1.700 +# In case all classes in a project start with a common prefix, all
1.701 +# classes will be put under the same header in the alphabetical index.
1.702 +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
1.703 +# should be ignored while generating the index headers.
1.704 +
1.705 +IGNORE_PREFIX = nsI ns \
1.706 + mozI moz \
1.707 + imgI img
1.708 +
1.709 +#---------------------------------------------------------------------------
1.710 +# configuration options related to the HTML output
1.711 +#---------------------------------------------------------------------------
1.712 +
1.713 +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
1.714 +# generate HTML output.
1.715 +
1.716 +GENERATE_HTML = YES
1.717 +
1.718 +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
1.719 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.720 +# put in front of it. If left blank `html' will be used as the default path.
1.721 +
1.722 +HTML_OUTPUT =
1.723 +
1.724 +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
1.725 +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
1.726 +# doxygen will generate files with .html extension.
1.727 +
1.728 +HTML_FILE_EXTENSION = .html
1.729 +
1.730 +# The HTML_HEADER tag can be used to specify a personal HTML header for
1.731 +# each generated HTML page. If it is left blank doxygen will generate a
1.732 +# standard header.
1.733 +
1.734 +HTML_HEADER =
1.735 +
1.736 +# The HTML_FOOTER tag can be used to specify a personal HTML footer for
1.737 +# each generated HTML page. If it is left blank doxygen will generate a
1.738 +# standard footer.
1.739 +
1.740 +HTML_FOOTER =
1.741 +
1.742 +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
1.743 +# style sheet that is used by each HTML page. It can be used to
1.744 +# fine-tune the look of the HTML output. If the tag is left blank doxygen
1.745 +# will generate a default style sheet. Note that doxygen will try to copy
1.746 +# the style sheet file to the HTML output directory, so don't put your own
1.747 +# stylesheet in the HTML output directory as well, or it will be erased!
1.748 +
1.749 +HTML_STYLESHEET =
1.750 +
1.751 +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
1.752 +# files or namespaces will be aligned in HTML using tables. If set to
1.753 +# NO a bullet list will be used.
1.754 +
1.755 +HTML_ALIGN_MEMBERS = YES
1.756 +
1.757 +# If the GENERATE_HTMLHELP tag is set to YES, additional index files
1.758 +# will be generated that can be used as input for tools like the
1.759 +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1.760 +# of the generated HTML documentation.
1.761 +
1.762 +GENERATE_HTMLHELP = NO
1.763 +
1.764 +# If the GENERATE_DOCSET tag is set to YES, additional index files
1.765 +# will be generated that can be used as input for Apple's Xcode 3
1.766 +# integrated development environment, introduced with OSX 10.5 (Leopard).
1.767 +# To create a documentation set, doxygen will generate a Makefile in the
1.768 +# HTML output directory. Running make will produce the docset in that
1.769 +# directory and running "make install" will install the docset in
1.770 +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1.771 +# it at startup.
1.772 +
1.773 +GENERATE_DOCSET = NO
1.774 +
1.775 +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1.776 +# feed. A documentation feed provides an umbrella under which multiple
1.777 +# documentation sets from a single provider (such as a company or product suite)
1.778 +# can be grouped.
1.779 +
1.780 +DOCSET_FEEDNAME = "Doxygen generated docs"
1.781 +
1.782 +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1.783 +# should uniquely identify the documentation set bundle. This should be a
1.784 +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1.785 +# will append .docset to the name.
1.786 +
1.787 +DOCSET_BUNDLE_ID = org.doxygen.Project
1.788 +
1.789 +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1.790 +# documentation will contain sections that can be hidden and shown after the
1.791 +# page has loaded. For this to work a browser that supports
1.792 +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
1.793 +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
1.794 +
1.795 +HTML_DYNAMIC_SECTIONS = NO
1.796 +
1.797 +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1.798 +# be used to specify the file name of the resulting .chm file. You
1.799 +# can add a path in front of the file if the result should not be
1.800 +# written to the html output directory.
1.801 +
1.802 +CHM_FILE =
1.803 +
1.804 +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1.805 +# be used to specify the location (absolute path including file name) of
1.806 +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1.807 +# the HTML help compiler on the generated index.hhp.
1.808 +
1.809 +HHC_LOCATION =
1.810 +
1.811 +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1.812 +# controls if a separate .chi index file is generated (YES) or that
1.813 +# it should be included in the master .chm file (NO).
1.814 +
1.815 +GENERATE_CHI = NO
1.816 +
1.817 +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1.818 +# controls whether a binary table of contents is generated (YES) or a
1.819 +# normal table of contents (NO) in the .chm file.
1.820 +
1.821 +BINARY_TOC = NO
1.822 +
1.823 +# The TOC_EXPAND flag can be set to YES to add extra items for group members
1.824 +# to the contents of the HTML help documentation and to the tree view.
1.825 +
1.826 +TOC_EXPAND = NO
1.827 +
1.828 +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1.829 +# top of each HTML page. The value NO (the default) enables the index and
1.830 +# the value YES disables it.
1.831 +
1.832 +DISABLE_INDEX = NO
1.833 +
1.834 +# This tag can be used to set the number of enum values (range [1..20])
1.835 +# that doxygen will group on one line in the generated HTML documentation.
1.836 +
1.837 +ENUM_VALUES_PER_LINE = 4
1.838 +
1.839 +# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
1.840 +# generated containing a tree-like index structure (just like the one that
1.841 +# is generated for HTML Help). For this to work a browser that supports
1.842 +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
1.843 +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
1.844 +# probably better off using the HTML help feature.
1.845 +
1.846 +GENERATE_TREEVIEW = NO
1.847 +
1.848 +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1.849 +# used to set the initial width (in pixels) of the frame in which the tree
1.850 +# is shown.
1.851 +
1.852 +TREEVIEW_WIDTH = 250
1.853 +
1.854 +#---------------------------------------------------------------------------
1.855 +# configuration options related to the LaTeX output
1.856 +#---------------------------------------------------------------------------
1.857 +
1.858 +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1.859 +# generate Latex output.
1.860 +
1.861 +GENERATE_LATEX = NO
1.862 +
1.863 +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1.864 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.865 +# put in front of it. If left blank `latex' will be used as the default path.
1.866 +
1.867 +LATEX_OUTPUT =
1.868 +
1.869 +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1.870 +# invoked. If left blank `latex' will be used as the default command name.
1.871 +
1.872 +LATEX_CMD_NAME = latex
1.873 +
1.874 +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1.875 +# generate index for LaTeX. If left blank `makeindex' will be used as the
1.876 +# default command name.
1.877 +
1.878 +MAKEINDEX_CMD_NAME = makeindex
1.879 +
1.880 +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1.881 +# LaTeX documents. This may be useful for small projects and may help to
1.882 +# save some trees in general.
1.883 +
1.884 +COMPACT_LATEX = NO
1.885 +
1.886 +# The PAPER_TYPE tag can be used to set the paper type that is used
1.887 +# by the printer. Possible values are: a4, a4wide, letter, legal and
1.888 +# executive. If left blank a4wide will be used.
1.889 +
1.890 +PAPER_TYPE = a4wide
1.891 +
1.892 +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1.893 +# packages that should be included in the LaTeX output.
1.894 +
1.895 +EXTRA_PACKAGES =
1.896 +
1.897 +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1.898 +# the generated latex document. The header should contain everything until
1.899 +# the first chapter. If it is left blank doxygen will generate a
1.900 +# standard header. Notice: only use this tag if you know what you are doing!
1.901 +
1.902 +LATEX_HEADER =
1.903 +
1.904 +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1.905 +# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1.906 +# contain links (just like the HTML output) instead of page references
1.907 +# This makes the output suitable for online browsing using a pdf viewer.
1.908 +
1.909 +PDF_HYPERLINKS = NO
1.910 +
1.911 +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1.912 +# plain latex in the generated Makefile. Set this option to YES to get a
1.913 +# higher quality PDF documentation.
1.914 +
1.915 +USE_PDFLATEX = NO
1.916 +
1.917 +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1.918 +# command to the generated LaTeX files. This will instruct LaTeX to keep
1.919 +# running if errors occur, instead of asking the user for help.
1.920 +# This option is also used when generating formulas in HTML.
1.921 +
1.922 +LATEX_BATCHMODE = NO
1.923 +
1.924 +# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1.925 +# include the index chapters (such as File Index, Compound Index, etc.)
1.926 +# in the output.
1.927 +
1.928 +LATEX_HIDE_INDICES = NO
1.929 +
1.930 +#---------------------------------------------------------------------------
1.931 +# configuration options related to the RTF output
1.932 +#---------------------------------------------------------------------------
1.933 +
1.934 +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1.935 +# The RTF output is optimized for Word 97 and may not look very pretty with
1.936 +# other RTF readers or editors.
1.937 +
1.938 +GENERATE_RTF = NO
1.939 +
1.940 +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1.941 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.942 +# put in front of it. If left blank `rtf' will be used as the default path.
1.943 +
1.944 +RTF_OUTPUT =
1.945 +
1.946 +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1.947 +# RTF documents. This may be useful for small projects and may help to
1.948 +# save some trees in general.
1.949 +
1.950 +COMPACT_RTF = NO
1.951 +
1.952 +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1.953 +# will contain hyperlink fields. The RTF file will
1.954 +# contain links (just like the HTML output) instead of page references.
1.955 +# This makes the output suitable for online browsing using WORD or other
1.956 +# programs which support those fields.
1.957 +# Note: wordpad (write) and others do not support links.
1.958 +
1.959 +RTF_HYPERLINKS = NO
1.960 +
1.961 +# Load stylesheet definitions from file. Syntax is similar to doxygen's
1.962 +# config file, i.e. a series of assignments. You only have to provide
1.963 +# replacements, missing definitions are set to their default value.
1.964 +
1.965 +RTF_STYLESHEET_FILE =
1.966 +
1.967 +# Set optional variables used in the generation of an rtf document.
1.968 +# Syntax is similar to doxygen's config file.
1.969 +
1.970 +RTF_EXTENSIONS_FILE =
1.971 +
1.972 +#---------------------------------------------------------------------------
1.973 +# configuration options related to the man page output
1.974 +#---------------------------------------------------------------------------
1.975 +
1.976 +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1.977 +# generate man pages
1.978 +
1.979 +GENERATE_MAN = NO
1.980 +
1.981 +# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1.982 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.983 +# put in front of it. If left blank `man' will be used as the default path.
1.984 +
1.985 +MAN_OUTPUT =
1.986 +
1.987 +# The MAN_EXTENSION tag determines the extension that is added to
1.988 +# the generated man pages (default is the subroutine's section .3)
1.989 +
1.990 +MAN_EXTENSION =
1.991 +
1.992 +# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1.993 +# then it will generate one additional man file for each entity
1.994 +# documented in the real man page(s). These additional files
1.995 +# only source the real man page, but without them the man command
1.996 +# would be unable to find the correct page. The default is NO.
1.997 +
1.998 +MAN_LINKS = NO
1.999 +
1.1000 +#---------------------------------------------------------------------------
1.1001 +# configuration options related to the XML output
1.1002 +#---------------------------------------------------------------------------
1.1003 +
1.1004 +# If the GENERATE_XML tag is set to YES Doxygen will
1.1005 +# generate an XML file that captures the structure of
1.1006 +# the code including all documentation.
1.1007 +
1.1008 +GENERATE_XML = NO
1.1009 +
1.1010 +# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1.1011 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.1012 +# put in front of it. If left blank `xml' will be used as the default path.
1.1013 +
1.1014 +XML_OUTPUT = xml
1.1015 +
1.1016 +# The XML_SCHEMA tag can be used to specify an XML schema,
1.1017 +# which can be used by a validating XML parser to check the
1.1018 +# syntax of the XML files.
1.1019 +
1.1020 +XML_SCHEMA =
1.1021 +
1.1022 +# The XML_DTD tag can be used to specify an XML DTD,
1.1023 +# which can be used by a validating XML parser to check the
1.1024 +# syntax of the XML files.
1.1025 +
1.1026 +XML_DTD =
1.1027 +
1.1028 +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1.1029 +# dump the program listings (including syntax highlighting
1.1030 +# and cross-referencing information) to the XML output. Note that
1.1031 +# enabling this will significantly increase the size of the XML output.
1.1032 +
1.1033 +XML_PROGRAMLISTING = YES
1.1034 +
1.1035 +#---------------------------------------------------------------------------
1.1036 +# configuration options for the AutoGen Definitions output
1.1037 +#---------------------------------------------------------------------------
1.1038 +
1.1039 +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1.1040 +# generate an AutoGen Definitions (see autogen.sf.net) file
1.1041 +# that captures the structure of the code including all
1.1042 +# documentation. Note that this feature is still experimental
1.1043 +# and incomplete at the moment.
1.1044 +
1.1045 +GENERATE_AUTOGEN_DEF = NO
1.1046 +
1.1047 +#---------------------------------------------------------------------------
1.1048 +# configuration options related to the Perl module output
1.1049 +#---------------------------------------------------------------------------
1.1050 +
1.1051 +# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1.1052 +# generate a Perl module file that captures the structure of
1.1053 +# the code including all documentation. Note that this
1.1054 +# feature is still experimental and incomplete at the
1.1055 +# moment.
1.1056 +
1.1057 +GENERATE_PERLMOD = NO
1.1058 +
1.1059 +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1.1060 +# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1.1061 +# to generate PDF and DVI output from the Perl module output.
1.1062 +
1.1063 +PERLMOD_LATEX = NO
1.1064 +
1.1065 +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1.1066 +# nicely formatted so it can be parsed by a human reader. This is useful
1.1067 +# if you want to understand what is going on. On the other hand, if this
1.1068 +# tag is set to NO the size of the Perl module output will be much smaller
1.1069 +# and Perl will parse it just the same.
1.1070 +
1.1071 +PERLMOD_PRETTY = YES
1.1072 +
1.1073 +# The names of the make variables in the generated doxyrules.make file
1.1074 +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1.1075 +# This is useful so different doxyrules.make files included by the same
1.1076 +# Makefile don't overwrite each other's variables.
1.1077 +
1.1078 +PERLMOD_MAKEVAR_PREFIX =
1.1079 +
1.1080 +#---------------------------------------------------------------------------
1.1081 +# Configuration options related to the preprocessor
1.1082 +#---------------------------------------------------------------------------
1.1083 +
1.1084 +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1.1085 +# evaluate all C-preprocessor directives found in the sources and include
1.1086 +# files.
1.1087 +
1.1088 +ENABLE_PREPROCESSING = YES
1.1089 +
1.1090 +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1.1091 +# names in the source code. If set to NO (the default) only conditional
1.1092 +# compilation will be performed. Macro expansion can be done in a controlled
1.1093 +# way by setting EXPAND_ONLY_PREDEF to YES.
1.1094 +
1.1095 +MACRO_EXPANSION = YES
1.1096 +
1.1097 +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1.1098 +# then the macro expansion is limited to the macros specified with the
1.1099 +# PREDEFINED and EXPAND_AS_DEFINED tags.
1.1100 +
1.1101 +EXPAND_ONLY_PREDEF = NO
1.1102 +
1.1103 +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1.1104 +# in the INCLUDE_PATH (see below) will be search if a #include is found.
1.1105 +
1.1106 +SEARCH_INCLUDES = YES
1.1107 +
1.1108 +# The INCLUDE_PATH tag can be used to specify one or more directories that
1.1109 +# contain include files that are not input files but should be processed by
1.1110 +# the preprocessor.
1.1111 +
1.1112 +INCLUDE_PATH = @MOZ_DOC_INCLUDE_DIRS@
1.1113 +
1.1114 +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1.1115 +# patterns (like *.h and *.hpp) to filter out the header-files in the
1.1116 +# directories. If left blank, the patterns specified with FILE_PATTERNS will
1.1117 +# be used.
1.1118 +
1.1119 +INCLUDE_FILE_PATTERNS = *.h
1.1120 +
1.1121 +# The PREDEFINED tag can be used to specify one or more macro names that
1.1122 +# are defined before the preprocessor is started (similar to the -D option of
1.1123 +# gcc). The argument of the tag is a list of macros of the form: name
1.1124 +# or name=definition (no spaces). If the definition and the = are
1.1125 +# omitted =1 is assumed. To prevent a macro definition from being
1.1126 +# undefined via #undef or recursively expanded use the := operator
1.1127 +# instead of the = operator.
1.1128 +
1.1129 +PREDEFINED =
1.1130 +
1.1131 +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1.1132 +# this tag can be used to specify a list of macro names that should be expanded.
1.1133 +# The macro definition that is found in the sources will be used.
1.1134 +# Use the PREDEFINED tag if you want to use a different macro definition.
1.1135 +
1.1136 +EXPAND_AS_DEFINED =
1.1137 +
1.1138 +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1.1139 +# doxygen's preprocessor will remove all function-like macros that are alone
1.1140 +# on a line, have an all uppercase name, and do not end with a semicolon. Such
1.1141 +# function macros are typically used for boiler-plate code, and will confuse
1.1142 +# the parser if not removed.
1.1143 +
1.1144 +SKIP_FUNCTION_MACROS = YES
1.1145 +
1.1146 +#---------------------------------------------------------------------------
1.1147 +# Configuration::additions related to external references
1.1148 +#---------------------------------------------------------------------------
1.1149 +
1.1150 +# The TAGFILES option can be used to specify one or more tagfiles.
1.1151 +# Optionally an initial location of the external documentation
1.1152 +# can be added for each tagfile. The format of a tag file without
1.1153 +# this location is as follows:
1.1154 +# TAGFILES = file1 file2 ...
1.1155 +# Adding location for the tag files is done as follows:
1.1156 +# TAGFILES = file1=loc1 "file2 = loc2" ...
1.1157 +# where "loc1" and "loc2" can be relative or absolute paths or
1.1158 +# URLs. If a location is present for each tag, the installdox tool
1.1159 +# does not have to be run to correct the links.
1.1160 +# Note that each tag file must have a unique name
1.1161 +# (where the name does NOT include the path)
1.1162 +# If a tag file is not located in the directory in which doxygen
1.1163 +# is run, you must also specify the path to the tagfile here.
1.1164 +
1.1165 +TAGFILES =
1.1166 +
1.1167 +# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1.1168 +# a tag file that is based on the input files it reads.
1.1169 +
1.1170 +GENERATE_TAGFILE =
1.1171 +
1.1172 +# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1.1173 +# in the class index. If set to NO only the inherited external classes
1.1174 +# will be listed.
1.1175 +
1.1176 +ALLEXTERNALS = NO
1.1177 +
1.1178 +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1.1179 +# in the modules index. If set to NO, only the current project's groups will
1.1180 +# be listed.
1.1181 +
1.1182 +EXTERNAL_GROUPS = YES
1.1183 +
1.1184 +# The PERL_PATH should be the absolute path and name of the perl script
1.1185 +# interpreter (i.e. the result of `which perl').
1.1186 +
1.1187 +PERL_PATH =
1.1188 +
1.1189 +#---------------------------------------------------------------------------
1.1190 +# Configuration options related to the dot tool
1.1191 +#---------------------------------------------------------------------------
1.1192 +
1.1193 +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1.1194 +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1.1195 +# or super classes. Setting the tag to NO turns the diagrams off. Note that
1.1196 +# this option is superseded by the HAVE_DOT option below. This is only a
1.1197 +# fallback. It is recommended to install and use dot, since it yields more
1.1198 +# powerful graphs.
1.1199 +
1.1200 +CLASS_DIAGRAMS = YES
1.1201 +
1.1202 +# You can define message sequence charts within doxygen comments using the \msc
1.1203 +# command. Doxygen will then run the mscgen tool (see
1.1204 +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1.1205 +# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1.1206 +# the mscgen tool resides. If left empty the tool is assumed to be found in the
1.1207 +# default search path.
1.1208 +
1.1209 +MSCGEN_PATH =
1.1210 +
1.1211 +# If set to YES, the inheritance and collaboration graphs will hide
1.1212 +# inheritance and usage relations if the target is undocumented
1.1213 +# or is not a class.
1.1214 +
1.1215 +HIDE_UNDOC_RELATIONS = YES
1.1216 +
1.1217 +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1.1218 +# available from the path. This tool is part of Graphviz, a graph visualization
1.1219 +# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1.1220 +# have no effect if this option is set to NO (the default)
1.1221 +
1.1222 +HAVE_DOT = YES
1.1223 +
1.1224 +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1.1225 +# will generate a graph for each documented class showing the direct and
1.1226 +# indirect inheritance relations. Setting this tag to YES will force the
1.1227 +# the CLASS_DIAGRAMS tag to NO.
1.1228 +
1.1229 +CLASS_GRAPH = YES
1.1230 +
1.1231 +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1.1232 +# will generate a graph for each documented class showing the direct and
1.1233 +# indirect implementation dependencies (inheritance, containment, and
1.1234 +# class references variables) of the class with other documented classes.
1.1235 +
1.1236 +COLLABORATION_GRAPH = YES
1.1237 +
1.1238 +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1.1239 +# will generate a graph for groups, showing the direct groups dependencies
1.1240 +
1.1241 +GROUP_GRAPHS = YES
1.1242 +
1.1243 +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1.1244 +# collaboration diagrams in a style similar to the OMG's Unified Modeling
1.1245 +# Language.
1.1246 +
1.1247 +UML_LOOK = NO
1.1248 +
1.1249 +# If set to YES, the inheritance and collaboration graphs will show the
1.1250 +# relations between templates and their instances.
1.1251 +
1.1252 +TEMPLATE_RELATIONS = NO
1.1253 +
1.1254 +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1.1255 +# tags are set to YES then doxygen will generate a graph for each documented
1.1256 +# file showing the direct and indirect include dependencies of the file with
1.1257 +# other documented files.
1.1258 +
1.1259 +INCLUDE_GRAPH = YES
1.1260 +
1.1261 +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1.1262 +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1.1263 +# documented header file showing the documented files that directly or
1.1264 +# indirectly include this file.
1.1265 +
1.1266 +INCLUDED_BY_GRAPH = YES
1.1267 +
1.1268 +# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1.1269 +# doxygen will generate a call dependency graph for every global function
1.1270 +# or class method. Note that enabling this option will significantly increase
1.1271 +# the time of a run. So in most cases it will be better to enable call graphs
1.1272 +# for selected functions only using the \callgraph command.
1.1273 +
1.1274 +CALL_GRAPH = NO
1.1275 +
1.1276 +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1.1277 +# doxygen will generate a caller dependency graph for every global function
1.1278 +# or class method. Note that enabling this option will significantly increase
1.1279 +# the time of a run. So in most cases it will be better to enable caller
1.1280 +# graphs for selected functions only using the \callergraph command.
1.1281 +
1.1282 +CALLER_GRAPH = NO
1.1283 +
1.1284 +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1.1285 +# will graphical hierarchy of all classes instead of a textual one.
1.1286 +
1.1287 +GRAPHICAL_HIERARCHY = YES
1.1288 +
1.1289 +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1.1290 +# then doxygen will show the dependencies a directory has on other directories
1.1291 +# in a graphical way. The dependency relations are determined by the #include
1.1292 +# relations between the files in the directories.
1.1293 +
1.1294 +DIRECTORY_GRAPH = YES
1.1295 +
1.1296 +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1.1297 +# generated by dot. Possible values are png, jpg, or gif
1.1298 +# If left blank png will be used.
1.1299 +
1.1300 +DOT_IMAGE_FORMAT = png
1.1301 +
1.1302 +# The tag DOT_PATH can be used to specify the path where the dot tool can be
1.1303 +# found. If left blank, it is assumed the dot tool can be found in the path.
1.1304 +
1.1305 +DOT_PATH =
1.1306 +
1.1307 +# The DOTFILE_DIRS tag can be used to specify one or more directories that
1.1308 +# contain dot files that are included in the documentation (see the
1.1309 +# \dotfile command).
1.1310 +
1.1311 +DOTFILE_DIRS =
1.1312 +
1.1313 +# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1.1314 +# nodes that will be shown in the graph. If the number of nodes in a graph
1.1315 +# becomes larger than this value, doxygen will truncate the graph, which is
1.1316 +# visualized by representing a node as a red box. Note that doxygen if the
1.1317 +# number of direct children of the root node in a graph is already larger than
1.1318 +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1.1319 +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1.1320 +
1.1321 +DOT_GRAPH_MAX_NODES = 50
1.1322 +
1.1323 +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1.1324 +# graphs generated by dot. A depth value of 3 means that only nodes reachable
1.1325 +# from the root by following a path via at most 3 edges will be shown. Nodes
1.1326 +# that lay further from the root node will be omitted. Note that setting this
1.1327 +# option to 1 or 2 may greatly reduce the computation time needed for large
1.1328 +# code bases. Also note that the size of a graph can be further restricted by
1.1329 +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1.1330 +
1.1331 +MAX_DOT_GRAPH_DEPTH = 3
1.1332 +
1.1333 +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1.1334 +# background. This is enabled by default, which results in a transparent
1.1335 +# background. Warning: Depending on the platform used, enabling this option
1.1336 +# may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1.1337 +# become hard to read).
1.1338 +
1.1339 +DOT_TRANSPARENT = YES
1.1340 +
1.1341 +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1.1342 +# files in one run (i.e. multiple -o and -T options on the command line). This
1.1343 +# makes dot run faster, but since only newer versions of dot (>1.8.10)
1.1344 +# support this, this feature is disabled by default.
1.1345 +
1.1346 +DOT_MULTI_TARGETS = NO
1.1347 +
1.1348 +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1.1349 +# generate a legend page explaining the meaning of the various boxes and
1.1350 +# arrows in the dot generated graphs.
1.1351 +
1.1352 +GENERATE_LEGEND = YES
1.1353 +
1.1354 +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1.1355 +# remove the intermediate dot files that are used to generate
1.1356 +# the various graphs.
1.1357 +
1.1358 +DOT_CLEANUP = YES
1.1359 +
1.1360 +#---------------------------------------------------------------------------
1.1361 +# Configuration::additions related to the search engine
1.1362 +#---------------------------------------------------------------------------
1.1363 +
1.1364 +# The SEARCHENGINE tag specifies whether or not a search engine should be
1.1365 +# used. If set to NO the values of all tags below this one will be ignored.
1.1366 +
1.1367 +SEARCHENGINE = NO
