michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public michael@0: * License, v. 2.0. If a copy of the MPL was not distributed with this michael@0: * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ michael@0: michael@0: # Doxyfile 1.5.5 michael@0: michael@0: # This file describes the settings to be used by the documentation system michael@0: # doxygen (www.doxygen.org) for a project michael@0: # michael@0: # All text after a hash (#) is considered a comment and will be ignored michael@0: # The format is: michael@0: # TAG = value [value, ...] michael@0: # For lists items can also be appended using: michael@0: # TAG += value [value, ...] michael@0: # Values that contain spaces should be placed between quotes (" ") michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # Project related configuration options michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # This tag specifies the encoding used for all characters in the config file michael@0: # that follow. The default is UTF-8 which is also the encoding used for all michael@0: # text before the first occurrence of this tag. Doxygen uses libiconv (or the michael@0: # iconv built into libc) for the transcoding. See michael@0: # http://www.gnu.org/software/libiconv for the list of possible encodings. michael@0: michael@0: DOXYFILE_ENCODING = UTF-8 michael@0: michael@0: # The PROJECT_NAME tag is a single word (or a sequence of words surrounded michael@0: # by quotes) that should identify the project. michael@0: michael@0: PROJECT_NAME = "Mozilla" michael@0: michael@0: # The PROJECT_NUMBER tag can be used to enter a project or revision number. michael@0: # This could be handy for archiving the generated documentation or michael@0: # if some version control system is used. michael@0: michael@0: PROJECT_NUMBER = michael@0: michael@0: # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) michael@0: # base path where the generated documentation will be put. michael@0: # If a relative path is entered, it will be relative to the location michael@0: # where doxygen was started. If left blank the current directory will be used. michael@0: michael@0: OUTPUT_DIRECTORY = @MOZ_DOC_OUTPUT_DIR@ michael@0: michael@0: # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create michael@0: # 4096 sub-directories (in 2 levels) under the output directory of each output michael@0: # format and will distribute the generated files over these directories. michael@0: # Enabling this option can be useful when feeding doxygen a huge amount of michael@0: # source files, where putting all generated files in the same directory would michael@0: # otherwise cause performance problems for the file system. michael@0: michael@0: CREATE_SUBDIRS = NO michael@0: michael@0: # The OUTPUT_LANGUAGE tag is used to specify the language in which all michael@0: # documentation generated by doxygen is written. Doxygen will use this michael@0: # information to generate all constant output in the proper language. michael@0: # The default language is English, other supported languages are: michael@0: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, michael@0: # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, michael@0: # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), michael@0: # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, michael@0: # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, michael@0: # and Ukrainian. michael@0: michael@0: OUTPUT_LANGUAGE = English michael@0: michael@0: # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will michael@0: # include brief member descriptions after the members that are listed in michael@0: # the file and class documentation (similar to JavaDoc). michael@0: # Set to NO to disable this. michael@0: michael@0: BRIEF_MEMBER_DESC = YES michael@0: michael@0: # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend michael@0: # the brief description of a member or function before the detailed description. michael@0: # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the michael@0: # brief descriptions will be completely suppressed. michael@0: michael@0: REPEAT_BRIEF = YES michael@0: michael@0: # This tag implements a quasi-intelligent brief description abbreviator michael@0: # that is used to form the text in various listings. Each string michael@0: # in this list, if found as the leading text of the brief description, will be michael@0: # stripped from the text and the result after processing the whole list, is michael@0: # used as the annotated text. Otherwise, the brief description is used as-is. michael@0: # If left blank, the following values are used ("$name" is automatically michael@0: # replaced with the name of the entity): "The $name class" "The $name widget" michael@0: # "The $name file" "is" "provides" "specifies" "contains" michael@0: # "represents" "a" "an" "the" michael@0: michael@0: ABBREVIATE_BRIEF = michael@0: michael@0: # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then michael@0: # Doxygen will generate a detailed section even if there is only a brief michael@0: # description. michael@0: michael@0: ALWAYS_DETAILED_SEC = NO michael@0: michael@0: # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all michael@0: # inherited members of a class in the documentation of that class as if those michael@0: # members were ordinary class members. Constructors, destructors and assignment michael@0: # operators of the base classes will not be shown. michael@0: michael@0: INLINE_INHERITED_MEMB = NO michael@0: michael@0: # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full michael@0: # path before files name in the file list and in the header files. If set michael@0: # to NO the shortest path that makes the file name unique will be used. michael@0: michael@0: FULL_PATH_NAMES = NO michael@0: michael@0: # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag michael@0: # can be used to strip a user-defined part of the path. Stripping is michael@0: # only done if one of the specified strings matches the left-hand part of michael@0: # the path. The tag can be used to show relative paths in the file list. michael@0: # If left blank the directory from which doxygen is run is used as the michael@0: # path to strip. michael@0: michael@0: STRIP_FROM_PATH = michael@0: michael@0: # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of michael@0: # the path mentioned in the documentation of a class, which tells michael@0: # the reader which header file to include in order to use a class. michael@0: # If left blank only the name of the header file containing the class michael@0: # definition is used. Otherwise one should specify the include paths that michael@0: # are normally passed to the compiler using the -I flag. michael@0: michael@0: STRIP_FROM_INC_PATH = michael@0: michael@0: # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter michael@0: # (but less readable) file names. This can be useful is your file systems michael@0: # doesn't support long names like on DOS, Mac, or CD-ROM. michael@0: michael@0: SHORT_NAMES = NO michael@0: michael@0: # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen michael@0: # will interpret the first line (until the first dot) of a JavaDoc-style michael@0: # comment as the brief description. If set to NO, the JavaDoc michael@0: # comments will behave just like regular Qt-style comments michael@0: # (thus requiring an explicit @brief command for a brief description.) michael@0: michael@0: JAVADOC_AUTOBRIEF = YES michael@0: michael@0: # If the QT_AUTOBRIEF tag is set to YES then Doxygen will michael@0: # interpret the first line (until the first dot) of a Qt-style michael@0: # comment as the brief description. If set to NO, the comments michael@0: # will behave just like regular Qt-style comments (thus requiring michael@0: # an explicit \brief command for a brief description.) michael@0: michael@0: QT_AUTOBRIEF = NO michael@0: michael@0: # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen michael@0: # treat a multi-line C++ special comment block (i.e. a block of //! or /// michael@0: # comments) as a brief description. This used to be the default behaviour. michael@0: # The new default is to treat a multi-line C++ comment block as a detailed michael@0: # description. Set this tag to YES if you prefer the old behaviour instead. michael@0: michael@0: MULTILINE_CPP_IS_BRIEF = NO michael@0: michael@0: # If the DETAILS_AT_TOP tag is set to YES then Doxygen michael@0: # will output the detailed description near the top, like JavaDoc. michael@0: # If set to NO, the detailed description appears after the member michael@0: # documentation. michael@0: michael@0: DETAILS_AT_TOP = NO michael@0: michael@0: # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented michael@0: # member inherits the documentation from any documented member that it michael@0: # re-implements. michael@0: michael@0: INHERIT_DOCS = YES michael@0: michael@0: # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce michael@0: # a new page for each member. If set to NO, the documentation of a member will michael@0: # be part of the file/class/namespace that contains it. michael@0: michael@0: SEPARATE_MEMBER_PAGES = NO michael@0: michael@0: # The TAB_SIZE tag can be used to set the number of spaces in a tab. michael@0: # Doxygen uses this value to replace tabs by spaces in code fragments. michael@0: michael@0: TAB_SIZE = 4 michael@0: michael@0: # This tag can be used to specify a number of aliases that acts michael@0: # as commands in the documentation. An alias has the form "name=value". michael@0: # For example adding "sideeffect=\par Side Effects:\n" will allow you to michael@0: # put the command \sideeffect (or @sideeffect) in the documentation, which michael@0: # will result in a user-defined paragraph with heading "Side Effects:". michael@0: # You can put \n's in the value part of an alias to insert newlines. michael@0: michael@0: ALIASES = "status=\par Status:\n" michael@0: michael@0: # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C michael@0: # sources only. Doxygen will then generate output that is more tailored for C. michael@0: # For instance, some of the names that are used will be different. The list michael@0: # of all members will be omitted, etc. michael@0: michael@0: OPTIMIZE_OUTPUT_FOR_C = NO michael@0: michael@0: # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java michael@0: # sources only. Doxygen will then generate output that is more tailored for michael@0: # Java. For instance, namespaces will be presented as packages, qualified michael@0: # scopes will look different, etc. michael@0: michael@0: OPTIMIZE_OUTPUT_JAVA = NO michael@0: michael@0: # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran michael@0: # sources only. Doxygen will then generate output that is more tailored for michael@0: # Fortran. michael@0: michael@0: OPTIMIZE_FOR_FORTRAN = NO michael@0: michael@0: # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL michael@0: # sources. Doxygen will then generate output that is tailored for michael@0: # VHDL. michael@0: michael@0: OPTIMIZE_OUTPUT_VHDL = NO michael@0: michael@0: # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want michael@0: # to include (a tag file for) the STL sources as input, then you should michael@0: # set this tag to YES in order to let doxygen match functions declarations and michael@0: # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. michael@0: # func(std::string) {}). This also make the inheritance and collaboration michael@0: # diagrams that involve STL classes more complete and accurate. michael@0: michael@0: BUILTIN_STL_SUPPORT = NO michael@0: michael@0: # If you use Microsoft's C++/CLI language, you should set this option to YES to michael@0: # enable parsing support. michael@0: michael@0: CPP_CLI_SUPPORT = NO michael@0: michael@0: # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. michael@0: # Doxygen will parse them like normal C++ but will assume all classes use public michael@0: # instead of private inheritance when no explicit protection keyword is present. michael@0: michael@0: SIP_SUPPORT = NO michael@0: michael@0: # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC michael@0: # tag is set to YES, then doxygen will reuse the documentation of the first michael@0: # member in the group (if any) for the other members of the group. By default michael@0: # all members of a group must be documented explicitly. michael@0: michael@0: DISTRIBUTE_GROUP_DOC = YES michael@0: michael@0: # Set the SUBGROUPING tag to YES (the default) to allow class member groups of michael@0: # the same type (for instance a group of public functions) to be put as a michael@0: # subgroup of that type (e.g. under the Public Functions section). Set it to michael@0: # NO to prevent subgrouping. Alternatively, this can be done per class using michael@0: # the \nosubgrouping command. michael@0: michael@0: SUBGROUPING = YES michael@0: michael@0: # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum michael@0: # is documented as struct, union, or enum with the name of the typedef. So michael@0: # typedef struct TypeS {} TypeT, will appear in the documentation as a struct michael@0: # with name TypeT. When disabled the typedef will appear as a member of a file, michael@0: # namespace, or class. And the struct will be named TypeS. This can typically michael@0: # be useful for C code in case the coding convention dictates that all compound michael@0: # types are typedef'ed and only the typedef is referenced, never the tag name. michael@0: michael@0: TYPEDEF_HIDES_STRUCT = NO michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # Build related configuration options michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in michael@0: # documentation are documented, even if no documentation was available. michael@0: # Private class members and static file members will be hidden unless michael@0: # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES michael@0: michael@0: EXTRACT_ALL = YES michael@0: michael@0: # If the EXTRACT_PRIVATE tag is set to YES all private members of a class michael@0: # will be included in the documentation. michael@0: michael@0: EXTRACT_PRIVATE = NO michael@0: michael@0: # If the EXTRACT_STATIC tag is set to YES all static members of a file michael@0: # will be included in the documentation. michael@0: michael@0: EXTRACT_STATIC = NO michael@0: michael@0: # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) michael@0: # defined locally in source files will be included in the documentation. michael@0: # If set to NO only classes defined in header files are included. michael@0: michael@0: EXTRACT_LOCAL_CLASSES = YES michael@0: michael@0: # This flag is only useful for Objective-C code. When set to YES local michael@0: # methods, which are defined in the implementation section but not in michael@0: # the interface are included in the documentation. michael@0: # If set to NO (the default) only methods in the interface are included. michael@0: michael@0: EXTRACT_LOCAL_METHODS = NO michael@0: michael@0: # If this flag is set to YES, the members of anonymous namespaces will be michael@0: # extracted and appear in the documentation as a namespace called michael@0: # 'anonymous_namespace{file}', where file will be replaced with the base michael@0: # name of the file that contains the anonymous namespace. By default michael@0: # anonymous namespace are hidden. michael@0: michael@0: EXTRACT_ANON_NSPACES = NO michael@0: michael@0: # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all michael@0: # undocumented members of documented classes, files or namespaces. michael@0: # If set to NO (the default) these members will be included in the michael@0: # various overviews, but no documentation section is generated. michael@0: # This option has no effect if EXTRACT_ALL is enabled. michael@0: michael@0: HIDE_UNDOC_MEMBERS = NO michael@0: michael@0: # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all michael@0: # undocumented classes that are normally visible in the class hierarchy. michael@0: # If set to NO (the default) these classes will be included in the various michael@0: # overviews. This option has no effect if EXTRACT_ALL is enabled. michael@0: michael@0: HIDE_UNDOC_CLASSES = NO michael@0: michael@0: # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all michael@0: # friend (class|struct|union) declarations. michael@0: # If set to NO (the default) these declarations will be included in the michael@0: # documentation. michael@0: michael@0: HIDE_FRIEND_COMPOUNDS = NO michael@0: michael@0: # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any michael@0: # documentation blocks found inside the body of a function. michael@0: # If set to NO (the default) these blocks will be appended to the michael@0: # function's detailed documentation block. michael@0: michael@0: HIDE_IN_BODY_DOCS = NO michael@0: michael@0: # The INTERNAL_DOCS tag determines if documentation michael@0: # that is typed after a \internal command is included. If the tag is set michael@0: # to NO (the default) then the documentation will be excluded. michael@0: # Set it to YES to include the internal documentation. michael@0: michael@0: INTERNAL_DOCS = NO michael@0: michael@0: # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate michael@0: # file names in lower-case letters. If set to YES upper-case letters are also michael@0: # allowed. This is useful if you have classes or files whose names only differ michael@0: # in case and if your file system supports case sensitive file names. Windows michael@0: # and Mac users are advised to set this option to NO. michael@0: michael@0: CASE_SENSE_NAMES = YES michael@0: michael@0: # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen michael@0: # will show members with their full class and namespace scopes in the michael@0: # documentation. If set to YES the scope will be hidden. michael@0: michael@0: HIDE_SCOPE_NAMES = NO michael@0: michael@0: # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen michael@0: # will put a list of the files that are included by a file in the documentation michael@0: # of that file. michael@0: michael@0: SHOW_INCLUDE_FILES = YES michael@0: michael@0: # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] michael@0: # is inserted in the documentation for inline members. michael@0: michael@0: INLINE_INFO = YES michael@0: michael@0: # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen michael@0: # will sort the (detailed) documentation of file and class members michael@0: # alphabetically by member name. If set to NO the members will appear in michael@0: # declaration order. michael@0: michael@0: SORT_MEMBER_DOCS = YES michael@0: michael@0: # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the michael@0: # brief documentation of file, namespace and class members alphabetically michael@0: # by member name. If set to NO (the default) the members will appear in michael@0: # declaration order. michael@0: michael@0: SORT_BRIEF_DOCS = NO michael@0: michael@0: # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the michael@0: # hierarchy of group names into alphabetical order. If set to NO (the default) michael@0: # the group names will appear in their defined order. michael@0: michael@0: SORT_GROUP_NAMES = NO michael@0: michael@0: # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be michael@0: # sorted by fully-qualified names, including namespaces. If set to michael@0: # NO (the default), the class list will be sorted only by class name, michael@0: # not including the namespace part. michael@0: # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. michael@0: # Note: This option applies only to the class list, not to the michael@0: # alphabetical list. michael@0: michael@0: SORT_BY_SCOPE_NAME = NO michael@0: michael@0: # The GENERATE_TODOLIST tag can be used to enable (YES) or michael@0: # disable (NO) the todo list. This list is created by putting \todo michael@0: # commands in the documentation. michael@0: michael@0: GENERATE_TODOLIST = YES michael@0: michael@0: # The GENERATE_TESTLIST tag can be used to enable (YES) or michael@0: # disable (NO) the test list. This list is created by putting \test michael@0: # commands in the documentation. michael@0: michael@0: GENERATE_TESTLIST = YES michael@0: michael@0: # The GENERATE_BUGLIST tag can be used to enable (YES) or michael@0: # disable (NO) the bug list. This list is created by putting \bug michael@0: # commands in the documentation. michael@0: michael@0: GENERATE_BUGLIST = NO michael@0: michael@0: # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or michael@0: # disable (NO) the deprecated list. This list is created by putting michael@0: # \deprecated commands in the documentation. michael@0: michael@0: GENERATE_DEPRECATEDLIST= YES michael@0: michael@0: # The ENABLED_SECTIONS tag can be used to enable conditional michael@0: # documentation sections, marked by \if sectionname ... \endif. michael@0: michael@0: ENABLED_SECTIONS = michael@0: michael@0: # The MAX_INITIALIZER_LINES tag determines the maximum number of lines michael@0: # the initial value of a variable or define consists of for it to appear in michael@0: # the documentation. If the initializer consists of more lines than specified michael@0: # here it will be hidden. Use a value of 0 to hide initializers completely. michael@0: # The appearance of the initializer of individual variables and defines in the michael@0: # documentation can be controlled using \showinitializer or \hideinitializer michael@0: # command in the documentation regardless of this setting. michael@0: michael@0: MAX_INITIALIZER_LINES = 30 michael@0: michael@0: # Set the SHOW_USED_FILES tag to NO to disable the list of files generated michael@0: # at the bottom of the documentation of classes and structs. If set to YES the michael@0: # list will mention the files that were used to generate the documentation. michael@0: michael@0: SHOW_USED_FILES = YES michael@0: michael@0: # If the sources in your project are distributed over multiple directories michael@0: # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy michael@0: # in the documentation. The default is NO. michael@0: michael@0: SHOW_DIRECTORIES = NO michael@0: michael@0: # The FILE_VERSION_FILTER tag can be used to specify a program or script that michael@0: # doxygen should invoke to get the current version for each file (typically from michael@0: # the version control system). Doxygen will invoke the program by executing (via michael@0: # popen()) the command , where is the value of michael@0: # the FILE_VERSION_FILTER tag, and is the name of an input file michael@0: # provided by doxygen. Whatever the program writes to standard output michael@0: # is used as the file version. See the manual for examples. michael@0: michael@0: FILE_VERSION_FILTER = michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # configuration options related to warning and progress messages michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # The QUIET tag can be used to turn on/off the messages that are generated michael@0: # by doxygen. Possible values are YES and NO. If left blank NO is used. michael@0: michael@0: QUIET = NO michael@0: michael@0: # The WARNINGS tag can be used to turn on/off the warning messages that are michael@0: # generated by doxygen. Possible values are YES and NO. If left blank michael@0: # NO is used. michael@0: michael@0: WARNINGS = YES michael@0: michael@0: # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings michael@0: # for undocumented members. If EXTRACT_ALL is set to YES then this flag will michael@0: # automatically be disabled. michael@0: michael@0: WARN_IF_UNDOCUMENTED = NO michael@0: michael@0: # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for michael@0: # potential errors in the documentation, such as not documenting some michael@0: # parameters in a documented function, or documenting parameters that michael@0: # don't exist or using markup commands wrongly. michael@0: michael@0: WARN_IF_DOC_ERROR = YES michael@0: michael@0: # This WARN_NO_PARAMDOC option can be abled to get warnings for michael@0: # functions that are documented, but have no documentation for their parameters michael@0: # or return value. If set to NO (the default) doxygen will only warn about michael@0: # wrong or incomplete parameter documentation, but not about the absence of michael@0: # documentation. michael@0: michael@0: WARN_NO_PARAMDOC = NO michael@0: michael@0: # The WARN_FORMAT tag determines the format of the warning messages that michael@0: # doxygen can produce. The string should contain the $file, $line, and $text michael@0: # tags, which will be replaced by the file and line number from which the michael@0: # warning originated and the warning text. Optionally the format may contain michael@0: # $version, which will be replaced by the version of the file (if it could michael@0: # be obtained via FILE_VERSION_FILTER) michael@0: michael@0: WARN_FORMAT = michael@0: michael@0: # The WARN_LOGFILE tag can be used to specify a file to which warning michael@0: # and error messages should be written. If left blank the output is written michael@0: # to stderr. michael@0: michael@0: WARN_LOGFILE = michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # configuration options related to the input files michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # The INPUT tag can be used to specify the files and/or directories that contain michael@0: # documented source files. You may enter file names like "myfile.cpp" or michael@0: # directories like "/usr/src/myproject". Separate the files or directories michael@0: # with spaces. michael@0: michael@0: INPUT = @MOZ_DOC_INPUT_DIRS@ michael@0: michael@0: # This tag can be used to specify the character encoding of the source files michael@0: # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is michael@0: # also the default input encoding. Doxygen uses libiconv (or the iconv built michael@0: # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for michael@0: # the list of possible encodings. michael@0: michael@0: INPUT_ENCODING = UTF-8 michael@0: michael@0: # If the value of the INPUT tag contains directories, you can use the michael@0: # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp michael@0: # and *.h) to filter out the source-files in the directories. If left michael@0: # blank the following patterns are tested: michael@0: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx michael@0: # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 michael@0: michael@0: FILE_PATTERNS = *.idl \ michael@0: *.cpp \ michael@0: *.h michael@0: michael@0: # The RECURSIVE tag can be used to turn specify whether or not subdirectories michael@0: # should be searched for input files as well. Possible values are YES and NO. michael@0: # If left blank NO is used. michael@0: michael@0: RECURSIVE = YES michael@0: michael@0: # The EXCLUDE tag can be used to specify files and/or directories that should michael@0: # excluded from the INPUT source files. This way you can easily exclude a michael@0: # subdirectory from a directory tree whose root is specified with the INPUT tag. michael@0: michael@0: EXCLUDE = michael@0: michael@0: # The EXCLUDE_SYMLINKS tag can be used select whether or not files or michael@0: # directories that are symbolic links (a Unix filesystem feature) are excluded michael@0: # from the input. michael@0: michael@0: EXCLUDE_SYMLINKS = NO michael@0: michael@0: # If the value of the INPUT tag contains directories, you can use the michael@0: # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude michael@0: # certain files from those directories. Note that the wildcards are matched michael@0: # against the file with absolute path, so to exclude all test directories michael@0: # for example use the pattern */test/* michael@0: michael@0: EXCLUDE_PATTERNS = nsI*.h mozI*.h imgI*.h michael@0: michael@0: # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names michael@0: # (namespaces, classes, functions, etc.) that should be excluded from the michael@0: # output. The symbol name can be a fully qualified name, a word, or if the michael@0: # wildcard * is used, a substring. Examples: ANamespace, AClass, michael@0: # AClass::ANamespace, ANamespace::*Test michael@0: michael@0: EXCLUDE_SYMBOLS = nsCOMPtr_base michael@0: michael@0: # The EXAMPLE_PATH tag can be used to specify one or more files or michael@0: # directories that contain example code fragments that are included (see michael@0: # the \include command). michael@0: michael@0: EXAMPLE_PATH = michael@0: michael@0: # If the value of the EXAMPLE_PATH tag contains directories, you can use the michael@0: # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp michael@0: # and *.h) to filter out the source-files in the directories. If left michael@0: # blank all files are included. michael@0: michael@0: EXAMPLE_PATTERNS = michael@0: michael@0: # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be michael@0: # searched for input files to be used with the \include or \dontinclude michael@0: # commands irrespective of the value of the RECURSIVE tag. michael@0: # Possible values are YES and NO. If left blank NO is used. michael@0: michael@0: EXAMPLE_RECURSIVE = NO michael@0: michael@0: # The IMAGE_PATH tag can be used to specify one or more files or michael@0: # directories that contain image that are included in the documentation (see michael@0: # the \image command). michael@0: michael@0: IMAGE_PATH = michael@0: michael@0: # The INPUT_FILTER tag can be used to specify a program that doxygen should michael@0: # invoke to filter for each input file. Doxygen will invoke the filter program michael@0: # by executing (via popen()) the command , where michael@0: # is the value of the INPUT_FILTER tag, and is the name of an michael@0: # input file. Doxygen will then use the output that the filter program writes michael@0: # to standard output. If FILTER_PATTERNS is specified, this tag will be michael@0: # ignored. michael@0: michael@0: INPUT_FILTER = michael@0: michael@0: # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern michael@0: # basis. Doxygen will compare the file name with each pattern and apply the michael@0: # filter if there is a match. The filters are a list of the form: michael@0: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further michael@0: # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER michael@0: # is applied to all files. michael@0: michael@0: FILTER_PATTERNS = michael@0: michael@0: # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using michael@0: # INPUT_FILTER) will be used to filter the input files when producing source michael@0: # files to browse (i.e. when SOURCE_BROWSER is set to YES). michael@0: michael@0: FILTER_SOURCE_FILES = NO michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # configuration options related to source browsing michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # If the SOURCE_BROWSER tag is set to YES then a list of source files will michael@0: # be generated. Documented entities will be cross-referenced with these sources. michael@0: # Note: To get rid of all source code in the generated output, make sure also michael@0: # VERBATIM_HEADERS is set to NO. michael@0: michael@0: SOURCE_BROWSER = NO michael@0: michael@0: # Setting the INLINE_SOURCES tag to YES will include the body michael@0: # of functions and classes directly in the documentation. michael@0: michael@0: INLINE_SOURCES = NO michael@0: michael@0: # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct michael@0: # doxygen to hide any special comment blocks from generated source code michael@0: # fragments. Normal C and C++ comments will always remain visible. michael@0: michael@0: STRIP_CODE_COMMENTS = YES michael@0: michael@0: # If the REFERENCED_BY_RELATION tag is set to YES (the default) michael@0: # then for each documented function all documented michael@0: # functions referencing it will be listed. michael@0: michael@0: REFERENCED_BY_RELATION = NO michael@0: michael@0: # If the REFERENCES_RELATION tag is set to YES (the default) michael@0: # then for each documented function all documented entities michael@0: # called/used by that function will be listed. michael@0: michael@0: REFERENCES_RELATION = NO michael@0: michael@0: # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) michael@0: # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from michael@0: # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will michael@0: # link to the source code. Otherwise they will link to the documentstion. michael@0: michael@0: REFERENCES_LINK_SOURCE = NO michael@0: michael@0: # If the USE_HTAGS tag is set to YES then the references to source code michael@0: # will point to the HTML generated by the htags(1) tool instead of doxygen michael@0: # built-in source browser. The htags tool is part of GNU's global source michael@0: # tagging system (see http://www.gnu.org/software/global/global.html). You michael@0: # will need version 4.8.6 or higher. michael@0: michael@0: USE_HTAGS = NO michael@0: michael@0: # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen michael@0: # will generate a verbatim copy of the header file for each class for michael@0: # which an include is specified. Set to NO to disable this. michael@0: michael@0: VERBATIM_HEADERS = NO michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # configuration options related to the alphabetical class index michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index michael@0: # of all compounds will be generated. Enable this if the project michael@0: # contains a lot of classes, structs, unions or interfaces. michael@0: michael@0: ALPHABETICAL_INDEX = YES michael@0: michael@0: # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then michael@0: # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns michael@0: # in which this list will be split (can be a number in the range [1..20]) michael@0: michael@0: COLS_IN_ALPHA_INDEX = 5 michael@0: michael@0: # In case all classes in a project start with a common prefix, all michael@0: # classes will be put under the same header in the alphabetical index. michael@0: # The IGNORE_PREFIX tag can be used to specify one or more prefixes that michael@0: # should be ignored while generating the index headers. michael@0: michael@0: IGNORE_PREFIX = nsI ns \ michael@0: mozI moz \ michael@0: imgI img michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # configuration options related to the HTML output michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # If the GENERATE_HTML tag is set to YES (the default) Doxygen will michael@0: # generate HTML output. michael@0: michael@0: GENERATE_HTML = YES michael@0: michael@0: # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. michael@0: # If a relative path is entered the value of OUTPUT_DIRECTORY will be michael@0: # put in front of it. If left blank `html' will be used as the default path. michael@0: michael@0: HTML_OUTPUT = michael@0: michael@0: # The HTML_FILE_EXTENSION tag can be used to specify the file extension for michael@0: # each generated HTML page (for example: .htm,.php,.asp). If it is left blank michael@0: # doxygen will generate files with .html extension. michael@0: michael@0: HTML_FILE_EXTENSION = .html michael@0: michael@0: # The HTML_HEADER tag can be used to specify a personal HTML header for michael@0: # each generated HTML page. If it is left blank doxygen will generate a michael@0: # standard header. michael@0: michael@0: HTML_HEADER = michael@0: michael@0: # The HTML_FOOTER tag can be used to specify a personal HTML footer for michael@0: # each generated HTML page. If it is left blank doxygen will generate a michael@0: # standard footer. michael@0: michael@0: HTML_FOOTER = michael@0: michael@0: # The HTML_STYLESHEET tag can be used to specify a user-defined cascading michael@0: # style sheet that is used by each HTML page. It can be used to michael@0: # fine-tune the look of the HTML output. If the tag is left blank doxygen michael@0: # will generate a default style sheet. Note that doxygen will try to copy michael@0: # the style sheet file to the HTML output directory, so don't put your own michael@0: # stylesheet in the HTML output directory as well, or it will be erased! michael@0: michael@0: HTML_STYLESHEET = michael@0: michael@0: # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, michael@0: # files or namespaces will be aligned in HTML using tables. If set to michael@0: # NO a bullet list will be used. michael@0: michael@0: HTML_ALIGN_MEMBERS = YES michael@0: michael@0: # If the GENERATE_HTMLHELP tag is set to YES, additional index files michael@0: # will be generated that can be used as input for tools like the michael@0: # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) michael@0: # of the generated HTML documentation. michael@0: michael@0: GENERATE_HTMLHELP = NO michael@0: michael@0: # If the GENERATE_DOCSET tag is set to YES, additional index files michael@0: # will be generated that can be used as input for Apple's Xcode 3 michael@0: # integrated development environment, introduced with OSX 10.5 (Leopard). michael@0: # To create a documentation set, doxygen will generate a Makefile in the michael@0: # HTML output directory. Running make will produce the docset in that michael@0: # directory and running "make install" will install the docset in michael@0: # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find michael@0: # it at startup. michael@0: michael@0: GENERATE_DOCSET = NO michael@0: michael@0: # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the michael@0: # feed. A documentation feed provides an umbrella under which multiple michael@0: # documentation sets from a single provider (such as a company or product suite) michael@0: # can be grouped. michael@0: michael@0: DOCSET_FEEDNAME = "Doxygen generated docs" michael@0: michael@0: # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that michael@0: # should uniquely identify the documentation set bundle. This should be a michael@0: # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen michael@0: # will append .docset to the name. michael@0: michael@0: DOCSET_BUNDLE_ID = org.doxygen.Project michael@0: michael@0: # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML michael@0: # documentation will contain sections that can be hidden and shown after the michael@0: # page has loaded. For this to work a browser that supports michael@0: # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox michael@0: # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). michael@0: michael@0: HTML_DYNAMIC_SECTIONS = NO michael@0: michael@0: # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can michael@0: # be used to specify the file name of the resulting .chm file. You michael@0: # can add a path in front of the file if the result should not be michael@0: # written to the html output directory. michael@0: michael@0: CHM_FILE = michael@0: michael@0: # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can michael@0: # be used to specify the location (absolute path including file name) of michael@0: # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run michael@0: # the HTML help compiler on the generated index.hhp. michael@0: michael@0: HHC_LOCATION = michael@0: michael@0: # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag michael@0: # controls if a separate .chi index file is generated (YES) or that michael@0: # it should be included in the master .chm file (NO). michael@0: michael@0: GENERATE_CHI = NO michael@0: michael@0: # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag michael@0: # controls whether a binary table of contents is generated (YES) or a michael@0: # normal table of contents (NO) in the .chm file. michael@0: michael@0: BINARY_TOC = NO michael@0: michael@0: # The TOC_EXPAND flag can be set to YES to add extra items for group members michael@0: # to the contents of the HTML help documentation and to the tree view. michael@0: michael@0: TOC_EXPAND = NO michael@0: michael@0: # The DISABLE_INDEX tag can be used to turn on/off the condensed index at michael@0: # top of each HTML page. The value NO (the default) enables the index and michael@0: # the value YES disables it. michael@0: michael@0: DISABLE_INDEX = NO michael@0: michael@0: # This tag can be used to set the number of enum values (range [1..20]) michael@0: # that doxygen will group on one line in the generated HTML documentation. michael@0: michael@0: ENUM_VALUES_PER_LINE = 4 michael@0: michael@0: # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be michael@0: # generated containing a tree-like index structure (just like the one that michael@0: # is generated for HTML Help). For this to work a browser that supports michael@0: # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, michael@0: # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are michael@0: # probably better off using the HTML help feature. michael@0: michael@0: GENERATE_TREEVIEW = NO michael@0: michael@0: # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be michael@0: # used to set the initial width (in pixels) of the frame in which the tree michael@0: # is shown. michael@0: michael@0: TREEVIEW_WIDTH = 250 michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # configuration options related to the LaTeX output michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will michael@0: # generate Latex output. michael@0: michael@0: GENERATE_LATEX = NO michael@0: michael@0: # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. michael@0: # If a relative path is entered the value of OUTPUT_DIRECTORY will be michael@0: # put in front of it. If left blank `latex' will be used as the default path. michael@0: michael@0: LATEX_OUTPUT = michael@0: michael@0: # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be michael@0: # invoked. If left blank `latex' will be used as the default command name. michael@0: michael@0: LATEX_CMD_NAME = latex michael@0: michael@0: # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to michael@0: # generate index for LaTeX. If left blank `makeindex' will be used as the michael@0: # default command name. michael@0: michael@0: MAKEINDEX_CMD_NAME = makeindex michael@0: michael@0: # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact michael@0: # LaTeX documents. This may be useful for small projects and may help to michael@0: # save some trees in general. michael@0: michael@0: COMPACT_LATEX = NO michael@0: michael@0: # The PAPER_TYPE tag can be used to set the paper type that is used michael@0: # by the printer. Possible values are: a4, a4wide, letter, legal and michael@0: # executive. If left blank a4wide will be used. michael@0: michael@0: PAPER_TYPE = a4wide michael@0: michael@0: # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX michael@0: # packages that should be included in the LaTeX output. michael@0: michael@0: EXTRA_PACKAGES = michael@0: michael@0: # The LATEX_HEADER tag can be used to specify a personal LaTeX header for michael@0: # the generated latex document. The header should contain everything until michael@0: # the first chapter. If it is left blank doxygen will generate a michael@0: # standard header. Notice: only use this tag if you know what you are doing! michael@0: michael@0: LATEX_HEADER = michael@0: michael@0: # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated michael@0: # is prepared for conversion to pdf (using ps2pdf). The pdf file will michael@0: # contain links (just like the HTML output) instead of page references michael@0: # This makes the output suitable for online browsing using a pdf viewer. michael@0: michael@0: PDF_HYPERLINKS = NO michael@0: michael@0: # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of michael@0: # plain latex in the generated Makefile. Set this option to YES to get a michael@0: # higher quality PDF documentation. michael@0: michael@0: USE_PDFLATEX = NO michael@0: michael@0: # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. michael@0: # command to the generated LaTeX files. This will instruct LaTeX to keep michael@0: # running if errors occur, instead of asking the user for help. michael@0: # This option is also used when generating formulas in HTML. michael@0: michael@0: LATEX_BATCHMODE = NO michael@0: michael@0: # If LATEX_HIDE_INDICES is set to YES then doxygen will not michael@0: # include the index chapters (such as File Index, Compound Index, etc.) michael@0: # in the output. michael@0: michael@0: LATEX_HIDE_INDICES = NO michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # configuration options related to the RTF output michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output michael@0: # The RTF output is optimized for Word 97 and may not look very pretty with michael@0: # other RTF readers or editors. michael@0: michael@0: GENERATE_RTF = NO michael@0: michael@0: # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. michael@0: # If a relative path is entered the value of OUTPUT_DIRECTORY will be michael@0: # put in front of it. If left blank `rtf' will be used as the default path. michael@0: michael@0: RTF_OUTPUT = michael@0: michael@0: # If the COMPACT_RTF tag is set to YES Doxygen generates more compact michael@0: # RTF documents. This may be useful for small projects and may help to michael@0: # save some trees in general. michael@0: michael@0: COMPACT_RTF = NO michael@0: michael@0: # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated michael@0: # will contain hyperlink fields. The RTF file will michael@0: # contain links (just like the HTML output) instead of page references. michael@0: # This makes the output suitable for online browsing using WORD or other michael@0: # programs which support those fields. michael@0: # Note: wordpad (write) and others do not support links. michael@0: michael@0: RTF_HYPERLINKS = NO michael@0: michael@0: # Load stylesheet definitions from file. Syntax is similar to doxygen's michael@0: # config file, i.e. a series of assignments. You only have to provide michael@0: # replacements, missing definitions are set to their default value. michael@0: michael@0: RTF_STYLESHEET_FILE = michael@0: michael@0: # Set optional variables used in the generation of an rtf document. michael@0: # Syntax is similar to doxygen's config file. michael@0: michael@0: RTF_EXTENSIONS_FILE = michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # configuration options related to the man page output michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # If the GENERATE_MAN tag is set to YES (the default) Doxygen will michael@0: # generate man pages michael@0: michael@0: GENERATE_MAN = NO michael@0: michael@0: # The MAN_OUTPUT tag is used to specify where the man pages will be put. michael@0: # If a relative path is entered the value of OUTPUT_DIRECTORY will be michael@0: # put in front of it. If left blank `man' will be used as the default path. michael@0: michael@0: MAN_OUTPUT = michael@0: michael@0: # The MAN_EXTENSION tag determines the extension that is added to michael@0: # the generated man pages (default is the subroutine's section .3) michael@0: michael@0: MAN_EXTENSION = michael@0: michael@0: # If the MAN_LINKS tag is set to YES and Doxygen generates man output, michael@0: # then it will generate one additional man file for each entity michael@0: # documented in the real man page(s). These additional files michael@0: # only source the real man page, but without them the man command michael@0: # would be unable to find the correct page. The default is NO. michael@0: michael@0: MAN_LINKS = NO michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # configuration options related to the XML output michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # If the GENERATE_XML tag is set to YES Doxygen will michael@0: # generate an XML file that captures the structure of michael@0: # the code including all documentation. michael@0: michael@0: GENERATE_XML = NO michael@0: michael@0: # The XML_OUTPUT tag is used to specify where the XML pages will be put. michael@0: # If a relative path is entered the value of OUTPUT_DIRECTORY will be michael@0: # put in front of it. If left blank `xml' will be used as the default path. michael@0: michael@0: XML_OUTPUT = xml michael@0: michael@0: # The XML_SCHEMA tag can be used to specify an XML schema, michael@0: # which can be used by a validating XML parser to check the michael@0: # syntax of the XML files. michael@0: michael@0: XML_SCHEMA = michael@0: michael@0: # The XML_DTD tag can be used to specify an XML DTD, michael@0: # which can be used by a validating XML parser to check the michael@0: # syntax of the XML files. michael@0: michael@0: XML_DTD = michael@0: michael@0: # If the XML_PROGRAMLISTING tag is set to YES Doxygen will michael@0: # dump the program listings (including syntax highlighting michael@0: # and cross-referencing information) to the XML output. Note that michael@0: # enabling this will significantly increase the size of the XML output. michael@0: michael@0: XML_PROGRAMLISTING = YES michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # configuration options for the AutoGen Definitions output michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will michael@0: # generate an AutoGen Definitions (see autogen.sf.net) file michael@0: # that captures the structure of the code including all michael@0: # documentation. Note that this feature is still experimental michael@0: # and incomplete at the moment. michael@0: michael@0: GENERATE_AUTOGEN_DEF = NO michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # configuration options related to the Perl module output michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # If the GENERATE_PERLMOD tag is set to YES Doxygen will michael@0: # generate a Perl module file that captures the structure of michael@0: # the code including all documentation. Note that this michael@0: # feature is still experimental and incomplete at the michael@0: # moment. michael@0: michael@0: GENERATE_PERLMOD = NO michael@0: michael@0: # If the PERLMOD_LATEX tag is set to YES Doxygen will generate michael@0: # the necessary Makefile rules, Perl scripts and LaTeX code to be able michael@0: # to generate PDF and DVI output from the Perl module output. michael@0: michael@0: PERLMOD_LATEX = NO michael@0: michael@0: # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be michael@0: # nicely formatted so it can be parsed by a human reader. This is useful michael@0: # if you want to understand what is going on. On the other hand, if this michael@0: # tag is set to NO the size of the Perl module output will be much smaller michael@0: # and Perl will parse it just the same. michael@0: michael@0: PERLMOD_PRETTY = YES michael@0: michael@0: # The names of the make variables in the generated doxyrules.make file michael@0: # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. michael@0: # This is useful so different doxyrules.make files included by the same michael@0: # Makefile don't overwrite each other's variables. michael@0: michael@0: PERLMOD_MAKEVAR_PREFIX = michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # Configuration options related to the preprocessor michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will michael@0: # evaluate all C-preprocessor directives found in the sources and include michael@0: # files. michael@0: michael@0: ENABLE_PREPROCESSING = YES michael@0: michael@0: # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro michael@0: # names in the source code. If set to NO (the default) only conditional michael@0: # compilation will be performed. Macro expansion can be done in a controlled michael@0: # way by setting EXPAND_ONLY_PREDEF to YES. michael@0: michael@0: MACRO_EXPANSION = YES michael@0: michael@0: # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES michael@0: # then the macro expansion is limited to the macros specified with the michael@0: # PREDEFINED and EXPAND_AS_DEFINED tags. michael@0: michael@0: EXPAND_ONLY_PREDEF = NO michael@0: michael@0: # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files michael@0: # in the INCLUDE_PATH (see below) will be search if a #include is found. michael@0: michael@0: SEARCH_INCLUDES = YES michael@0: michael@0: # The INCLUDE_PATH tag can be used to specify one or more directories that michael@0: # contain include files that are not input files but should be processed by michael@0: # the preprocessor. michael@0: michael@0: INCLUDE_PATH = @MOZ_DOC_INCLUDE_DIRS@ michael@0: michael@0: # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard michael@0: # patterns (like *.h and *.hpp) to filter out the header-files in the michael@0: # directories. If left blank, the patterns specified with FILE_PATTERNS will michael@0: # be used. michael@0: michael@0: INCLUDE_FILE_PATTERNS = *.h michael@0: michael@0: # The PREDEFINED tag can be used to specify one or more macro names that michael@0: # are defined before the preprocessor is started (similar to the -D option of michael@0: # gcc). The argument of the tag is a list of macros of the form: name michael@0: # or name=definition (no spaces). If the definition and the = are michael@0: # omitted =1 is assumed. To prevent a macro definition from being michael@0: # undefined via #undef or recursively expanded use the := operator michael@0: # instead of the = operator. michael@0: michael@0: PREDEFINED = michael@0: michael@0: # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then michael@0: # this tag can be used to specify a list of macro names that should be expanded. michael@0: # The macro definition that is found in the sources will be used. michael@0: # Use the PREDEFINED tag if you want to use a different macro definition. michael@0: michael@0: EXPAND_AS_DEFINED = michael@0: michael@0: # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then michael@0: # doxygen's preprocessor will remove all function-like macros that are alone michael@0: # on a line, have an all uppercase name, and do not end with a semicolon. Such michael@0: # function macros are typically used for boiler-plate code, and will confuse michael@0: # the parser if not removed. michael@0: michael@0: SKIP_FUNCTION_MACROS = YES michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # Configuration::additions related to external references michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # The TAGFILES option can be used to specify one or more tagfiles. michael@0: # Optionally an initial location of the external documentation michael@0: # can be added for each tagfile. The format of a tag file without michael@0: # this location is as follows: michael@0: # TAGFILES = file1 file2 ... michael@0: # Adding location for the tag files is done as follows: michael@0: # TAGFILES = file1=loc1 "file2 = loc2" ... michael@0: # where "loc1" and "loc2" can be relative or absolute paths or michael@0: # URLs. If a location is present for each tag, the installdox tool michael@0: # does not have to be run to correct the links. michael@0: # Note that each tag file must have a unique name michael@0: # (where the name does NOT include the path) michael@0: # If a tag file is not located in the directory in which doxygen michael@0: # is run, you must also specify the path to the tagfile here. michael@0: michael@0: TAGFILES = michael@0: michael@0: # When a file name is specified after GENERATE_TAGFILE, doxygen will create michael@0: # a tag file that is based on the input files it reads. michael@0: michael@0: GENERATE_TAGFILE = michael@0: michael@0: # If the ALLEXTERNALS tag is set to YES all external classes will be listed michael@0: # in the class index. If set to NO only the inherited external classes michael@0: # will be listed. michael@0: michael@0: ALLEXTERNALS = NO michael@0: michael@0: # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed michael@0: # in the modules index. If set to NO, only the current project's groups will michael@0: # be listed. michael@0: michael@0: EXTERNAL_GROUPS = YES michael@0: michael@0: # The PERL_PATH should be the absolute path and name of the perl script michael@0: # interpreter (i.e. the result of `which perl'). michael@0: michael@0: PERL_PATH = michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # Configuration options related to the dot tool michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will michael@0: # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base michael@0: # or super classes. Setting the tag to NO turns the diagrams off. Note that michael@0: # this option is superseded by the HAVE_DOT option below. This is only a michael@0: # fallback. It is recommended to install and use dot, since it yields more michael@0: # powerful graphs. michael@0: michael@0: CLASS_DIAGRAMS = YES michael@0: michael@0: # You can define message sequence charts within doxygen comments using the \msc michael@0: # command. Doxygen will then run the mscgen tool (see michael@0: # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the michael@0: # documentation. The MSCGEN_PATH tag allows you to specify the directory where michael@0: # the mscgen tool resides. If left empty the tool is assumed to be found in the michael@0: # default search path. michael@0: michael@0: MSCGEN_PATH = michael@0: michael@0: # If set to YES, the inheritance and collaboration graphs will hide michael@0: # inheritance and usage relations if the target is undocumented michael@0: # or is not a class. michael@0: michael@0: HIDE_UNDOC_RELATIONS = YES michael@0: michael@0: # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is michael@0: # available from the path. This tool is part of Graphviz, a graph visualization michael@0: # toolkit from AT&T and Lucent Bell Labs. The other options in this section michael@0: # have no effect if this option is set to NO (the default) michael@0: michael@0: HAVE_DOT = YES michael@0: michael@0: # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen michael@0: # will generate a graph for each documented class showing the direct and michael@0: # indirect inheritance relations. Setting this tag to YES will force the michael@0: # the CLASS_DIAGRAMS tag to NO. michael@0: michael@0: CLASS_GRAPH = YES michael@0: michael@0: # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen michael@0: # will generate a graph for each documented class showing the direct and michael@0: # indirect implementation dependencies (inheritance, containment, and michael@0: # class references variables) of the class with other documented classes. michael@0: michael@0: COLLABORATION_GRAPH = YES michael@0: michael@0: # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen michael@0: # will generate a graph for groups, showing the direct groups dependencies michael@0: michael@0: GROUP_GRAPHS = YES michael@0: michael@0: # If the UML_LOOK tag is set to YES doxygen will generate inheritance and michael@0: # collaboration diagrams in a style similar to the OMG's Unified Modeling michael@0: # Language. michael@0: michael@0: UML_LOOK = NO michael@0: michael@0: # If set to YES, the inheritance and collaboration graphs will show the michael@0: # relations between templates and their instances. michael@0: michael@0: TEMPLATE_RELATIONS = NO michael@0: michael@0: # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT michael@0: # tags are set to YES then doxygen will generate a graph for each documented michael@0: # file showing the direct and indirect include dependencies of the file with michael@0: # other documented files. michael@0: michael@0: INCLUDE_GRAPH = YES michael@0: michael@0: # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and michael@0: # HAVE_DOT tags are set to YES then doxygen will generate a graph for each michael@0: # documented header file showing the documented files that directly or michael@0: # indirectly include this file. michael@0: michael@0: INCLUDED_BY_GRAPH = YES michael@0: michael@0: # If the CALL_GRAPH and HAVE_DOT options are set to YES then michael@0: # doxygen will generate a call dependency graph for every global function michael@0: # or class method. Note that enabling this option will significantly increase michael@0: # the time of a run. So in most cases it will be better to enable call graphs michael@0: # for selected functions only using the \callgraph command. michael@0: michael@0: CALL_GRAPH = NO michael@0: michael@0: # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then michael@0: # doxygen will generate a caller dependency graph for every global function michael@0: # or class method. Note that enabling this option will significantly increase michael@0: # the time of a run. So in most cases it will be better to enable caller michael@0: # graphs for selected functions only using the \callergraph command. michael@0: michael@0: CALLER_GRAPH = NO michael@0: michael@0: # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen michael@0: # will graphical hierarchy of all classes instead of a textual one. michael@0: michael@0: GRAPHICAL_HIERARCHY = YES michael@0: michael@0: # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES michael@0: # then doxygen will show the dependencies a directory has on other directories michael@0: # in a graphical way. The dependency relations are determined by the #include michael@0: # relations between the files in the directories. michael@0: michael@0: DIRECTORY_GRAPH = YES michael@0: michael@0: # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images michael@0: # generated by dot. Possible values are png, jpg, or gif michael@0: # If left blank png will be used. michael@0: michael@0: DOT_IMAGE_FORMAT = png michael@0: michael@0: # The tag DOT_PATH can be used to specify the path where the dot tool can be michael@0: # found. If left blank, it is assumed the dot tool can be found in the path. michael@0: michael@0: DOT_PATH = michael@0: michael@0: # The DOTFILE_DIRS tag can be used to specify one or more directories that michael@0: # contain dot files that are included in the documentation (see the michael@0: # \dotfile command). michael@0: michael@0: DOTFILE_DIRS = michael@0: michael@0: # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of michael@0: # nodes that will be shown in the graph. If the number of nodes in a graph michael@0: # becomes larger than this value, doxygen will truncate the graph, which is michael@0: # visualized by representing a node as a red box. Note that doxygen if the michael@0: # number of direct children of the root node in a graph is already larger than michael@0: # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note michael@0: # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. michael@0: michael@0: DOT_GRAPH_MAX_NODES = 50 michael@0: michael@0: # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the michael@0: # graphs generated by dot. A depth value of 3 means that only nodes reachable michael@0: # from the root by following a path via at most 3 edges will be shown. Nodes michael@0: # that lay further from the root node will be omitted. Note that setting this michael@0: # option to 1 or 2 may greatly reduce the computation time needed for large michael@0: # code bases. Also note that the size of a graph can be further restricted by michael@0: # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. michael@0: michael@0: MAX_DOT_GRAPH_DEPTH = 3 michael@0: michael@0: # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent michael@0: # background. This is enabled by default, which results in a transparent michael@0: # background. Warning: Depending on the platform used, enabling this option michael@0: # may lead to badly anti-aliased labels on the edges of a graph (i.e. they michael@0: # become hard to read). michael@0: michael@0: DOT_TRANSPARENT = YES michael@0: michael@0: # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output michael@0: # files in one run (i.e. multiple -o and -T options on the command line). This michael@0: # makes dot run faster, but since only newer versions of dot (>1.8.10) michael@0: # support this, this feature is disabled by default. michael@0: michael@0: DOT_MULTI_TARGETS = NO michael@0: michael@0: # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will michael@0: # generate a legend page explaining the meaning of the various boxes and michael@0: # arrows in the dot generated graphs. michael@0: michael@0: GENERATE_LEGEND = YES michael@0: michael@0: # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will michael@0: # remove the intermediate dot files that are used to generate michael@0: # the various graphs. michael@0: michael@0: DOT_CLEANUP = YES michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # Configuration::additions related to the search engine michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # The SEARCHENGINE tag specifies whether or not a search engine should be michael@0: # used. If set to NO the values of all tags below this one will be ignored. michael@0: michael@0: SEARCHENGINE = NO