12dc49f36SDustin Sallings# Doxyfile 1.6.3
22dc49f36SDustin Sallings
32dc49f36SDustin Sallings# This file describes the settings to be used by the documentation system
42dc49f36SDustin Sallings# doxygen (www.doxygen.org) for a project
52dc49f36SDustin Sallings#
62dc49f36SDustin Sallings# All text after a hash (#) is considered a comment and will be ignored
72dc49f36SDustin Sallings# The format is:
82dc49f36SDustin Sallings#       TAG = value [value, ...]
92dc49f36SDustin Sallings# For lists items can also be appended using:
102dc49f36SDustin Sallings#       TAG += value [value, ...]
112dc49f36SDustin Sallings# Values that contain spaces should be placed between quotes (" ")
122dc49f36SDustin Sallings
132dc49f36SDustin Sallings#---------------------------------------------------------------------------
142dc49f36SDustin Sallings# Project related configuration options
152dc49f36SDustin Sallings#---------------------------------------------------------------------------
162dc49f36SDustin Sallings
172dc49f36SDustin Sallings# This tag specifies the encoding used for all characters in the config file
182dc49f36SDustin Sallings# that follow. The default is UTF-8 which is also the encoding used for all
192dc49f36SDustin Sallings# text before the first occurrence of this tag. Doxygen uses libiconv (or the
202dc49f36SDustin Sallings# iconv built into libc) for the transcoding. See
212dc49f36SDustin Sallings# http://www.gnu.org/software/libiconv for the list of possible encodings.
222dc49f36SDustin Sallings
232dc49f36SDustin SallingsDOXYFILE_ENCODING      = UTF-8
242dc49f36SDustin Sallings
252dc49f36SDustin Sallings# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
262dc49f36SDustin Sallings# by quotes) that should identify the project.
272dc49f36SDustin Sallings
282dc49f36SDustin SallingsPROJECT_NAME           = "membase core engine"
292dc49f36SDustin Sallings
302dc49f36SDustin Sallings# The PROJECT_NUMBER tag can be used to enter a project or revision number.
312dc49f36SDustin Sallings# This could be handy for archiving the generated documentation or
322dc49f36SDustin Sallings# if some version control system is used.
332dc49f36SDustin Sallings
342dc49f36SDustin SallingsPROJECT_NUMBER         =
352dc49f36SDustin Sallings
362dc49f36SDustin Sallings# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
372dc49f36SDustin Sallings# base path where the generated documentation will be put.
382dc49f36SDustin Sallings# If a relative path is entered, it will be relative to the location
392dc49f36SDustin Sallings# where doxygen was started. If left blank the current directory will be used.
402dc49f36SDustin Sallings
412dc49f36SDustin SallingsOUTPUT_DIRECTORY       = docs/doxy
422dc49f36SDustin Sallings
432dc49f36SDustin Sallings# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
442dc49f36SDustin Sallings# 4096 sub-directories (in 2 levels) under the output directory of each output
452dc49f36SDustin Sallings# format and will distribute the generated files over these directories.
462dc49f36SDustin Sallings# Enabling this option can be useful when feeding doxygen a huge amount of
472dc49f36SDustin Sallings# source files, where putting all generated files in the same directory would
482dc49f36SDustin Sallings# otherwise cause performance problems for the file system.
492dc49f36SDustin Sallings
502dc49f36SDustin SallingsCREATE_SUBDIRS         = NO
512dc49f36SDustin Sallings
522dc49f36SDustin Sallings# The OUTPUT_LANGUAGE tag is used to specify the language in which all
532dc49f36SDustin Sallings# documentation generated by doxygen is written. Doxygen will use this
542dc49f36SDustin Sallings# information to generate all constant output in the proper language.
552dc49f36SDustin Sallings# The default language is English, other supported languages are:
562dc49f36SDustin Sallings# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
572dc49f36SDustin Sallings# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
582dc49f36SDustin Sallings# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
592dc49f36SDustin Sallings# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
602dc49f36SDustin Sallings# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
612dc49f36SDustin Sallings# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
622dc49f36SDustin Sallings
632dc49f36SDustin SallingsOUTPUT_LANGUAGE        = English
642dc49f36SDustin Sallings
652dc49f36SDustin Sallings# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
662dc49f36SDustin Sallings# include brief member descriptions after the members that are listed in
672dc49f36SDustin Sallings# the file and class documentation (similar to JavaDoc).
682dc49f36SDustin Sallings# Set to NO to disable this.
692dc49f36SDustin Sallings
702dc49f36SDustin SallingsBRIEF_MEMBER_DESC      = YES
712dc49f36SDustin Sallings
722dc49f36SDustin Sallings# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
732dc49f36SDustin Sallings# the brief description of a member or function before the detailed description.
742dc49f36SDustin Sallings# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
752dc49f36SDustin Sallings# brief descriptions will be completely suppressed.
762dc49f36SDustin Sallings
772dc49f36SDustin SallingsREPEAT_BRIEF           = YES
782dc49f36SDustin Sallings
792dc49f36SDustin Sallings# This tag implements a quasi-intelligent brief description abbreviator
802dc49f36SDustin Sallings# that is used to form the text in various listings. Each string
812dc49f36SDustin Sallings# in this list, if found as the leading text of the brief description, will be
822dc49f36SDustin Sallings# stripped from the text and the result after processing the whole list, is
832dc49f36SDustin Sallings# used as the annotated text. Otherwise, the brief description is used as-is.
842dc49f36SDustin Sallings# If left blank, the following values are used ("$name" is automatically
852dc49f36SDustin Sallings# replaced with the name of the entity): "The $name class" "The $name widget"
862dc49f36SDustin Sallings# "The $name file" "is" "provides" "specifies" "contains"
872dc49f36SDustin Sallings# "represents" "a" "an" "the"
882dc49f36SDustin Sallings
892dc49f36SDustin SallingsABBREVIATE_BRIEF       =
902dc49f36SDustin Sallings
912dc49f36SDustin Sallings# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
922dc49f36SDustin Sallings# Doxygen will generate a detailed section even if there is only a brief
932dc49f36SDustin Sallings# description.
942dc49f36SDustin Sallings
952dc49f36SDustin SallingsALWAYS_DETAILED_SEC    = YES
962dc49f36SDustin Sallings
972dc49f36SDustin Sallings# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
982dc49f36SDustin Sallings# inherited members of a class in the documentation of that class as if those
992dc49f36SDustin Sallings# members were ordinary class members. Constructors, destructors and assignment
1002dc49f36SDustin Sallings# operators of the base classes will not be shown.
1012dc49f36SDustin Sallings
1022dc49f36SDustin SallingsINLINE_INHERITED_MEMB  = NO
1032dc49f36SDustin Sallings
1042dc49f36SDustin Sallings# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
1052dc49f36SDustin Sallings# path before files name in the file list and in the header files. If set
1062dc49f36SDustin Sallings# to NO the shortest path that makes the file name unique will be used.
1072dc49f36SDustin Sallings
1082dc49f36SDustin SallingsFULL_PATH_NAMES        = YES
1092dc49f36SDustin Sallings
1102dc49f36SDustin Sallings# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
1112dc49f36SDustin Sallings# can be used to strip a user-defined part of the path. Stripping is
1122dc49f36SDustin Sallings# only done if one of the specified strings matches the left-hand part of
1132dc49f36SDustin Sallings# the path. The tag can be used to show relative paths in the file list.
1142dc49f36SDustin Sallings# If left blank the directory from which doxygen is run is used as the
1152dc49f36SDustin Sallings# path to strip.
1162dc49f36SDustin Sallings
1172dc49f36SDustin SallingsSTRIP_FROM_PATH        =
1182dc49f36SDustin Sallings
1192dc49f36SDustin Sallings# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
1202dc49f36SDustin Sallings# the path mentioned in the documentation of a class, which tells
1212dc49f36SDustin Sallings# the reader which header file to include in order to use a class.
1222dc49f36SDustin Sallings# If left blank only the name of the header file containing the class
1232dc49f36SDustin Sallings# definition is used. Otherwise one should specify the include paths that
1242dc49f36SDustin Sallings# are normally passed to the compiler using the -I flag.
1252dc49f36SDustin Sallings
1262dc49f36SDustin SallingsSTRIP_FROM_INC_PATH    =
1272dc49f36SDustin Sallings
1282dc49f36SDustin Sallings# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
1292dc49f36SDustin Sallings# (but less readable) file names. This can be useful is your file systems
1302dc49f36SDustin Sallings# doesn't support long names like on DOS, Mac, or CD-ROM.
1312dc49f36SDustin Sallings
1322dc49f36SDustin SallingsSHORT_NAMES            = NO
1332dc49f36SDustin Sallings
1342dc49f36SDustin Sallings# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
1352dc49f36SDustin Sallings# will interpret the first line (until the first dot) of a JavaDoc-style
1362dc49f36SDustin Sallings# comment as the brief description. If set to NO, the JavaDoc
1372dc49f36SDustin Sallings# comments will behave just like regular Qt-style comments
1382dc49f36SDustin Sallings# (thus requiring an explicit @brief command for a brief description.)
1392dc49f36SDustin Sallings
1402dc49f36SDustin SallingsJAVADOC_AUTOBRIEF      = YES
1412dc49f36SDustin Sallings
1422dc49f36SDustin Sallings# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
1432dc49f36SDustin Sallings# interpret the first line (until the first dot) of a Qt-style
1442dc49f36SDustin Sallings# comment as the brief description. If set to NO, the comments
1452dc49f36SDustin Sallings# will behave just like regular Qt-style comments (thus requiring
1462dc49f36SDustin Sallings# an explicit \brief command for a brief description.)
1472dc49f36SDustin Sallings
1482dc49f36SDustin SallingsQT_AUTOBRIEF           = NO
1492dc49f36SDustin Sallings
1502dc49f36SDustin Sallings# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
1512dc49f36SDustin Sallings# treat a multi-line C++ special comment block (i.e. a block of //! or ///
1522dc49f36SDustin Sallings# comments) as a brief description. This used to be the default behaviour.
1532dc49f36SDustin Sallings# The new default is to treat a multi-line C++ comment block as a detailed
1542dc49f36SDustin Sallings# description. Set this tag to YES if you prefer the old behaviour instead.
1552dc49f36SDustin Sallings
1562dc49f36SDustin SallingsMULTILINE_CPP_IS_BRIEF = NO
1572dc49f36SDustin Sallings
1582dc49f36SDustin Sallings# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
1592dc49f36SDustin Sallings# member inherits the documentation from any documented member that it
1602dc49f36SDustin Sallings# re-implements.
1612dc49f36SDustin Sallings
1622dc49f36SDustin SallingsINHERIT_DOCS           = YES
1632dc49f36SDustin Sallings
1642dc49f36SDustin Sallings# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
1652dc49f36SDustin Sallings# a new page for each member. If set to NO, the documentation of a member will
1662dc49f36SDustin Sallings# be part of the file/class/namespace that contains it.
1672dc49f36SDustin Sallings
1682dc49f36SDustin SallingsSEPARATE_MEMBER_PAGES  = NO
1692dc49f36SDustin Sallings
1702dc49f36SDustin Sallings# The TAB_SIZE tag can be used to set the number of spaces in a tab.
1712dc49f36SDustin Sallings# Doxygen uses this value to replace tabs by spaces in code fragments.
1722dc49f36SDustin Sallings
1732dc49f36SDustin SallingsTAB_SIZE               = 8
1742dc49f36SDustin Sallings
1752dc49f36SDustin Sallings# This tag can be used to specify a number of aliases that acts
1762dc49f36SDustin Sallings# as commands in the documentation. An alias has the form "name=value".
1772dc49f36SDustin Sallings# For example adding "sideeffect=\par Side Effects:\n" will allow you to
1782dc49f36SDustin Sallings# put the command \sideeffect (or @sideeffect) in the documentation, which
1792dc49f36SDustin Sallings# will result in a user-defined paragraph with heading "Side Effects:".
1802dc49f36SDustin Sallings# You can put \n's in the value part of an alias to insert newlines.
1812dc49f36SDustin Sallings
1822dc49f36SDustin SallingsALIASES                =
1832dc49f36SDustin Sallings
1842dc49f36SDustin Sallings# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
1852dc49f36SDustin Sallings# sources only. Doxygen will then generate output that is more tailored for C.
1862dc49f36SDustin Sallings# For instance, some of the names that are used will be different. The list
1872dc49f36SDustin Sallings# of all members will be omitted, etc.
1882dc49f36SDustin Sallings
1892dc49f36SDustin SallingsOPTIMIZE_OUTPUT_FOR_C  = NO
1902dc49f36SDustin Sallings
1912dc49f36SDustin Sallings# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
1922dc49f36SDustin Sallings# sources only. Doxygen will then generate output that is more tailored for
1932dc49f36SDustin Sallings# Java. For instance, namespaces will be presented as packages, qualified
1942dc49f36SDustin Sallings# scopes will look different, etc.
1952dc49f36SDustin Sallings
1962dc49f36SDustin SallingsOPTIMIZE_OUTPUT_JAVA   = NO
1972dc49f36SDustin Sallings
1982dc49f36SDustin Sallings# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
1992dc49f36SDustin Sallings# sources only. Doxygen will then generate output that is more tailored for
2002dc49f36SDustin Sallings# Fortran.
2012dc49f36SDustin Sallings
2022dc49f36SDustin SallingsOPTIMIZE_FOR_FORTRAN   = NO
2032dc49f36SDustin Sallings
2042dc49f36SDustin Sallings# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
2052dc49f36SDustin Sallings# sources. Doxygen will then generate output that is tailored for
2062dc49f36SDustin Sallings# VHDL.
2072dc49f36SDustin Sallings
2082dc49f36SDustin SallingsOPTIMIZE_OUTPUT_VHDL   = NO
2092dc49f36SDustin Sallings
2102dc49f36SDustin Sallings# Doxygen selects the parser to use depending on the extension of the files it parses.
2112dc49f36SDustin Sallings# With this tag you can assign which parser to use for a given extension.
2122dc49f36SDustin Sallings# Doxygen has a built-in mapping, but you can override or extend it using this tag.
2132dc49f36SDustin Sallings# The format is ext=language, where ext is a file extension, and language is one of
2142dc49f36SDustin Sallings# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
2152dc49f36SDustin Sallings# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
2162dc49f36SDustin Sallings# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
2172dc49f36SDustin Sallings# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
2182dc49f36SDustin Sallings
2192dc49f36SDustin SallingsEXTENSION_MAPPING      =
2202dc49f36SDustin Sallings
2212dc49f36SDustin Sallings# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
2222dc49f36SDustin Sallings# to include (a tag file for) the STL sources as input, then you should
2232dc49f36SDustin Sallings# set this tag to YES in order to let doxygen match functions declarations and
2242dc49f36SDustin Sallings# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
2252dc49f36SDustin Sallings# func(std::string) {}). This also make the inheritance and collaboration
2262dc49f36SDustin Sallings# diagrams that involve STL classes more complete and accurate.
2272dc49f36SDustin Sallings
2282dc49f36SDustin SallingsBUILTIN_STL_SUPPORT    = NO
2292dc49f36SDustin Sallings
2302dc49f36SDustin Sallings# If you use Microsoft's C++/CLI language, you should set this option to YES to
2312dc49f36SDustin Sallings# enable parsing support.
2322dc49f36SDustin Sallings
2332dc49f36SDustin SallingsCPP_CLI_SUPPORT        = NO
2342dc49f36SDustin Sallings
2352dc49f36SDustin Sallings# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
2362dc49f36SDustin Sallings# Doxygen will parse them like normal C++ but will assume all classes use public
2372dc49f36SDustin Sallings# instead of private inheritance when no explicit protection keyword is present.
2382dc49f36SDustin Sallings
2392dc49f36SDustin SallingsSIP_SUPPORT            = NO
2402dc49f36SDustin Sallings
2412dc49f36SDustin Sallings# For Microsoft's IDL there are propget and propput attributes to indicate getter
2422dc49f36SDustin Sallings# and setter methods for a property. Setting this option to YES (the default)
2432dc49f36SDustin Sallings# will make doxygen to replace the get and set methods by a property in the
2442dc49f36SDustin Sallings# documentation. This will only work if the methods are indeed getting or
2452dc49f36SDustin Sallings# setting a simple type. If this is not the case, or you want to show the
2462dc49f36SDustin Sallings# methods anyway, you should set this option to NO.
2472dc49f36SDustin Sallings
2482dc49f36SDustin SallingsIDL_PROPERTY_SUPPORT   = YES
2492dc49f36SDustin Sallings
2502dc49f36SDustin Sallings# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
2512dc49f36SDustin Sallings# tag is set to YES, then doxygen will reuse the documentation of the first
2522dc49f36SDustin Sallings# member in the group (if any) for the other members of the group. By default
2532dc49f36SDustin Sallings# all members of a group must be documented explicitly.
2542dc49f36SDustin Sallings
2552dc49f36SDustin SallingsDISTRIBUTE_GROUP_DOC   = NO
2562dc49f36SDustin Sallings
2572dc49f36SDustin Sallings# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
2582dc49f36SDustin Sallings# the same type (for instance a group of public functions) to be put as a
2592dc49f36SDustin Sallings# subgroup of that type (e.g. under the Public Functions section). Set it to
2602dc49f36SDustin Sallings# NO to prevent subgrouping. Alternatively, this can be done per class using
2612dc49f36SDustin Sallings# the \nosubgrouping command.
2622dc49f36SDustin Sallings
2632dc49f36SDustin SallingsSUBGROUPING            = YES
2642dc49f36SDustin Sallings
2652dc49f36SDustin Sallings# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
2662dc49f36SDustin Sallings# is documented as struct, union, or enum with the name of the typedef. So
2672dc49f36SDustin Sallings# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
2682dc49f36SDustin Sallings# with name TypeT. When disabled the typedef will appear as a member of a file,
2692dc49f36SDustin Sallings# namespace, or class. And the struct will be named TypeS. This can typically
2702dc49f36SDustin Sallings# be useful for C code in case the coding convention dictates that all compound
2712dc49f36SDustin Sallings# types are typedef'ed and only the typedef is referenced, never the tag name.
2722dc49f36SDustin Sallings
2732dc49f36SDustin SallingsTYPEDEF_HIDES_STRUCT   = NO
2742dc49f36SDustin Sallings
2752dc49f36SDustin Sallings# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
2762dc49f36SDustin Sallings# determine which symbols to keep in memory and which to flush to disk.
2772dc49f36SDustin Sallings# When the cache is full, less often used symbols will be written to disk.
2782dc49f36SDustin Sallings# For small to medium size projects (<1000 input files) the default value is
2792dc49f36SDustin Sallings# probably good enough. For larger projects a too small cache size can cause
2802dc49f36SDustin Sallings# doxygen to be busy swapping symbols to and from disk most of the time
2812dc49f36SDustin Sallings# causing a significant performance penality.
2822dc49f36SDustin Sallings# If the system has enough physical memory increasing the cache will improve the
2832dc49f36SDustin Sallings# performance by keeping more symbols in memory. Note that the value works on
2842dc49f36SDustin Sallings# a logarithmic scale so increasing the size by one will rougly double the
2852dc49f36SDustin Sallings# memory usage. The cache size is given by this formula:
2862dc49f36SDustin Sallings# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
2872dc49f36SDustin Sallings# corresponding to a cache size of 2^16 = 65536 symbols
2882dc49f36SDustin Sallings
2892dc49f36SDustin SallingsSYMBOL_CACHE_SIZE      = 0
2902dc49f36SDustin Sallings
2912dc49f36SDustin Sallings#---------------------------------------------------------------------------
2922dc49f36SDustin Sallings# Build related configuration options
2932dc49f36SDustin Sallings#---------------------------------------------------------------------------
2942dc49f36SDustin Sallings
2952dc49f36SDustin Sallings# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
2962dc49f36SDustin Sallings# documentation are documented, even if no documentation was available.
2972dc49f36SDustin Sallings# Private class members and static file members will be hidden unless
2982dc49f36SDustin Sallings# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
2992dc49f36SDustin Sallings
3002dc49f36SDustin SallingsEXTRACT_ALL            = YES
3012dc49f36SDustin Sallings
3022dc49f36SDustin Sallings# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
3032dc49f36SDustin Sallings# will be included in the documentation.
3042dc49f36SDustin Sallings
3052dc49f36SDustin SallingsEXTRACT_PRIVATE        = NO
3062dc49f36SDustin Sallings
3072dc49f36SDustin Sallings# If the EXTRACT_STATIC tag is set to YES all static members of a file
3082dc49f36SDustin Sallings# will be included in the documentation.
3092dc49f36SDustin Sallings
3102dc49f36SDustin SallingsEXTRACT_STATIC         = YES
3112dc49f36SDustin Sallings
3122dc49f36SDustin Sallings# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
3132dc49f36SDustin Sallings# defined locally in source files will be included in the documentation.
3142dc49f36SDustin Sallings# If set to NO only classes defined in header files are included.
3152dc49f36SDustin Sallings
3162dc49f36SDustin SallingsEXTRACT_LOCAL_CLASSES  = YES
3172dc49f36SDustin Sallings
3182dc49f36SDustin Sallings# This flag is only useful for Objective-C code. When set to YES local
3192dc49f36SDustin Sallings# methods, which are defined in the implementation section but not in
3202dc49f36SDustin Sallings# the interface are included in the documentation.
3212dc49f36SDustin Sallings# If set to NO (the default) only methods in the interface are included.
3222dc49f36SDustin Sallings
3232dc49f36SDustin SallingsEXTRACT_LOCAL_METHODS  = NO
3242dc49f36SDustin Sallings
3252dc49f36SDustin Sallings# If this flag is set to YES, the members of anonymous namespaces will be
3262dc49f36SDustin Sallings# extracted and appear in the documentation as a namespace called
3272dc49f36SDustin Sallings# 'anonymous_namespace{file}', where file will be replaced with the base
3282dc49f36SDustin Sallings# name of the file that contains the anonymous namespace. By default
3292dc49f36SDustin Sallings# anonymous namespace are hidden.
3302dc49f36SDustin Sallings
3312dc49f36SDustin SallingsEXTRACT_ANON_NSPACES   = NO
3322dc49f36SDustin Sallings
3332dc49f36SDustin Sallings# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
3342dc49f36SDustin Sallings# undocumented members of documented classes, files or namespaces.
3352dc49f36SDustin Sallings# If set to NO (the default) these members will be included in the
3362dc49f36SDustin Sallings# various overviews, but no documentation section is generated.
3372dc49f36SDustin Sallings# This option has no effect if EXTRACT_ALL is enabled.
3382dc49f36SDustin Sallings
3392dc49f36SDustin SallingsHIDE_UNDOC_MEMBERS     = NO
3402dc49f36SDustin Sallings
3412dc49f36SDustin Sallings# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
3422dc49f36SDustin Sallings# undocumented classes that are normally visible in the class hierarchy.
3432dc49f36SDustin Sallings# If set to NO (the default) these classes will be included in the various
3442dc49f36SDustin Sallings# overviews. This option has no effect if EXTRACT_ALL is enabled.
3452dc49f36SDustin Sallings
3462dc49f36SDustin SallingsHIDE_UNDOC_CLASSES     = NO
3472dc49f36SDustin Sallings
3482dc49f36SDustin Sallings# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
3492dc49f36SDustin Sallings# friend (class|struct|union) declarations.
3502dc49f36SDustin Sallings# If set to NO (the default) these declarations will be included in the
3512dc49f36SDustin Sallings# documentation.
3522dc49f36SDustin Sallings
3532dc49f36SDustin SallingsHIDE_FRIEND_COMPOUNDS  = NO
3542dc49f36SDustin Sallings
3552dc49f36SDustin Sallings# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
3562dc49f36SDustin Sallings# documentation blocks found inside the body of a function.
3572dc49f36SDustin Sallings# If set to NO (the default) these blocks will be appended to the
3582dc49f36SDustin Sallings# function's detailed documentation block.
3592dc49f36SDustin Sallings
3602dc49f36SDustin SallingsHIDE_IN_BODY_DOCS      = NO
3612dc49f36SDustin Sallings
3622dc49f36SDustin Sallings# The INTERNAL_DOCS tag determines if documentation
3632dc49f36SDustin Sallings# that is typed after a \internal command is included. If the tag is set
3642dc49f36SDustin Sallings# to NO (the default) then the documentation will be excluded.
3652dc49f36SDustin Sallings# Set it to YES to include the internal documentation.
3662dc49f36SDustin Sallings
3672dc49f36SDustin SallingsINTERNAL_DOCS          = NO
3682dc49f36SDustin Sallings
3692dc49f36SDustin Sallings# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
3702dc49f36SDustin Sallings# file names in lower-case letters. If set to YES upper-case letters are also
3712dc49f36SDustin Sallings# allowed. This is useful if you have classes or files whose names only differ
3722dc49f36SDustin Sallings# in case and if your file system supports case sensitive file names. Windows
3732dc49f36SDustin Sallings# and Mac users are advised to set this option to NO.
3742dc49f36SDustin Sallings
3752dc49f36SDustin SallingsCASE_SENSE_NAMES       = NO
3762dc49f36SDustin Sallings
3772dc49f36SDustin Sallings# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
3782dc49f36SDustin Sallings# will show members with their full class and namespace scopes in the
3792dc49f36SDustin Sallings# documentation. If set to YES the scope will be hidden.
3802dc49f36SDustin Sallings
3812dc49f36SDustin SallingsHIDE_SCOPE_NAMES       = NO
3822dc49f36SDustin Sallings
3832dc49f36SDustin Sallings# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
3842dc49f36SDustin Sallings# will put a list of the files that are included by a file in the documentation
3852dc49f36SDustin Sallings# of that file.
3862dc49f36SDustin Sallings
3872dc49f36SDustin SallingsSHOW_INCLUDE_FILES     = YES
3882dc49f36SDustin Sallings
3892dc49f36SDustin Sallings# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
3902dc49f36SDustin Sallings# will list include files with double quotes in the documentation
3912dc49f36SDustin Sallings# rather than with sharp brackets.
3922dc49f36SDustin Sallings
3932dc49f36SDustin SallingsFORCE_LOCAL_INCLUDES   = NO
3942dc49f36SDustin Sallings
3952dc49f36SDustin Sallings# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
3962dc49f36SDustin Sallings# is inserted in the documentation for inline members.
3972dc49f36SDustin Sallings
3982dc49f36SDustin SallingsINLINE_INFO            = YES
3992dc49f36SDustin Sallings
4002dc49f36SDustin Sallings# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
4012dc49f36SDustin Sallings# will sort the (detailed) documentation of file and class members
4022dc49f36SDustin Sallings# alphabetically by member name. If set to NO the members will appear in
4032dc49f36SDustin Sallings# declaration order.
4042dc49f36SDustin Sallings
4052dc49f36SDustin SallingsSORT_MEMBER_DOCS       = YES
4062dc49f36SDustin Sallings
4072dc49f36SDustin Sallings# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
4082dc49f36SDustin Sallings# brief documentation of file, namespace and class members alphabetically
4092dc49f36SDustin Sallings# by member name. If set to NO (the default) the members will appear in
4102dc49f36SDustin Sallings# declaration order.
4112dc49f36SDustin Sallings
4122dc49f36SDustin SallingsSORT_BRIEF_DOCS        = NO
4132dc49f36SDustin Sallings
4142dc49f36SDustin Sallings# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
4152dc49f36SDustin Sallings
4162dc49f36SDustin SallingsSORT_MEMBERS_CTORS_1ST = NO
4172dc49f36SDustin Sallings
4182dc49f36SDustin Sallings# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
4192dc49f36SDustin Sallings# hierarchy of group names into alphabetical order. If set to NO (the default)
4202dc49f36SDustin Sallings# the group names will appear in their defined order.
4212dc49f36SDustin Sallings
4222dc49f36SDustin SallingsSORT_GROUP_NAMES       = NO
4232dc49f36SDustin Sallings
4242dc49f36SDustin Sallings# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
4252dc49f36SDustin Sallings# sorted by fully-qualified names, including namespaces. If set to
4262dc49f36SDustin Sallings# NO (the default), the class list will be sorted only by class name,
4272dc49f36SDustin Sallings# not including the namespace part.
4282dc49f36SDustin Sallings# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
4292dc49f36SDustin Sallings# Note: This option applies only to the class list, not to the
4302dc49f36SDustin Sallings# alphabetical list.
4312dc49f36SDustin Sallings
4322dc49f36SDustin SallingsSORT_BY_SCOPE_NAME     = NO
4332dc49f36SDustin Sallings
4342dc49f36SDustin Sallings# The GENERATE_TODOLIST tag can be used to enable (YES) or
4352dc49f36SDustin Sallings# disable (NO) the todo list. This list is created by putting \todo
4362dc49f36SDustin Sallings# commands in the documentation.
4372dc49f36SDustin Sallings
4382dc49f36SDustin SallingsGENERATE_TODOLIST      = YES
4392dc49f36SDustin Sallings
4402dc49f36SDustin Sallings# The GENERATE_TESTLIST tag can be used to enable (YES) or
4412dc49f36SDustin Sallings# disable (NO) the test list. This list is created by putting \test
4422dc49f36SDustin Sallings# commands in the documentation.
4432dc49f36SDustin Sallings
4442dc49f36SDustin SallingsGENERATE_TESTLIST      = YES
4452dc49f36SDustin Sallings
4462dc49f36SDustin Sallings# The GENERATE_BUGLIST tag can be used to enable (YES) or
4472dc49f36SDustin Sallings# disable (NO) the bug list. This list is created by putting \bug
4482dc49f36SDustin Sallings# commands in the documentation.
4492dc49f36SDustin Sallings
4502dc49f36SDustin SallingsGENERATE_BUGLIST       = YES
4512dc49f36SDustin Sallings
4522dc49f36SDustin Sallings# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
4532dc49f36SDustin Sallings# disable (NO) the deprecated list. This list is created by putting
4542dc49f36SDustin Sallings# \deprecated commands in the documentation.
4552dc49f36SDustin Sallings
4562dc49f36SDustin SallingsGENERATE_DEPRECATEDLIST= YES
4572dc49f36SDustin Sallings
4582dc49f36SDustin Sallings# The ENABLED_SECTIONS tag can be used to enable conditional
4592dc49f36SDustin Sallings# documentation sections, marked by \if sectionname ... \endif.
4602dc49f36SDustin Sallings
4612dc49f36SDustin SallingsENABLED_SECTIONS       =
4622dc49f36SDustin Sallings
4632dc49f36SDustin Sallings# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
4642dc49f36SDustin Sallings# the initial value of a variable or define consists of for it to appear in
4652dc49f36SDustin Sallings# the documentation. If the initializer consists of more lines than specified
4662dc49f36SDustin Sallings# here it will be hidden. Use a value of 0 to hide initializers completely.
4672dc49f36SDustin Sallings# The appearance of the initializer of individual variables and defines in the
4682dc49f36SDustin Sallings# documentation can be controlled using \showinitializer or \hideinitializer
4692dc49f36SDustin Sallings# command in the documentation regardless of this setting.
4702dc49f36SDustin Sallings
4712dc49f36SDustin SallingsMAX_INITIALIZER_LINES  = 30
4722dc49f36SDustin Sallings
4732dc49f36SDustin Sallings# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
4742dc49f36SDustin Sallings# at the bottom of the documentation of classes and structs. If set to YES the
4752dc49f36SDustin Sallings# list will mention the files that were used to generate the documentation.
4762dc49f36SDustin Sallings
4772dc49f36SDustin SallingsSHOW_USED_FILES        = YES
4782dc49f36SDustin Sallings
4792dc49f36SDustin Sallings# If the sources in your project are distributed over multiple directories
4802dc49f36SDustin Sallings# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
4812dc49f36SDustin Sallings# in the documentation. The default is NO.
4822dc49f36SDustin Sallings
4832dc49f36SDustin SallingsSHOW_DIRECTORIES       = NO
4842dc49f36SDustin Sallings
4852dc49f36SDustin Sallings# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
4862dc49f36SDustin Sallings# This will remove the Files entry from the Quick Index and from the
4872dc49f36SDustin Sallings# Folder Tree View (if specified). The default is YES.
4882dc49f36SDustin Sallings
4892dc49f36SDustin SallingsSHOW_FILES             = YES
4902dc49f36SDustin Sallings
4912dc49f36SDustin Sallings# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
4922dc49f36SDustin Sallings# Namespaces page.
4932dc49f36SDustin Sallings# This will remove the Namespaces entry from the Quick Index
4942dc49f36SDustin Sallings# and from the Folder Tree View (if specified). The default is YES.
4952dc49f36SDustin Sallings
4962dc49f36SDustin SallingsSHOW_NAMESPACES        = YES
4972dc49f36SDustin Sallings
4982dc49f36SDustin Sallings# The FILE_VERSION_FILTER tag can be used to specify a program or script that
4992dc49f36SDustin Sallings# doxygen should invoke to get the current version for each file (typically from
5002dc49f36SDustin Sallings# the version control system). Doxygen will invoke the program by executing (via
5012dc49f36SDustin Sallings# popen()) the command <command> <input-file>, where <command> is the value of
5022dc49f36SDustin Sallings# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
5032dc49f36SDustin Sallings# provided by doxygen. Whatever the program writes to standard output
5042dc49f36SDustin Sallings# is used as the file version. See the manual for examples.
5052dc49f36SDustin Sallings
5062dc49f36SDustin SallingsFILE_VERSION_FILTER    =
5072dc49f36SDustin Sallings
5082dc49f36SDustin Sallings# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
5092dc49f36SDustin Sallings# doxygen. The layout file controls the global structure of the generated output files
5102dc49f36SDustin Sallings# in an output format independent way. The create the layout file that represents
5112dc49f36SDustin Sallings# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
5122dc49f36SDustin Sallings# file name after the option, if omitted DoxygenLayout.xml will be used as the name
5132dc49f36SDustin Sallings# of the layout file.
5142dc49f36SDustin Sallings
5152dc49f36SDustin SallingsLAYOUT_FILE            =
5162dc49f36SDustin Sallings
5172dc49f36SDustin Sallings#---------------------------------------------------------------------------
5182dc49f36SDustin Sallings# configuration options related to warning and progress messages
5192dc49f36SDustin Sallings#---------------------------------------------------------------------------
5202dc49f36SDustin Sallings
5212dc49f36SDustin Sallings# The QUIET tag can be used to turn on/off the messages that are generated
5222dc49f36SDustin Sallings# by doxygen. Possible values are YES and NO. If left blank NO is used.
5232dc49f36SDustin Sallings
5242dc49f36SDustin SallingsQUIET                  = NO
5252dc49f36SDustin Sallings
5262dc49f36SDustin Sallings# The WARNINGS tag can be used to turn on/off the warning messages that are
5272dc49f36SDustin Sallings# generated by doxygen. Possible values are YES and NO. If left blank
5282dc49f36SDustin Sallings# NO is used.
5292dc49f36SDustin Sallings
5302dc49f36SDustin SallingsWARNINGS               = YES
5312dc49f36SDustin Sallings
5322dc49f36SDustin Sallings# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
5332dc49f36SDustin Sallings# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
5342dc49f36SDustin Sallings# automatically be disabled.
5352dc49f36SDustin Sallings
5362dc49f36SDustin SallingsWARN_IF_UNDOCUMENTED   = YES
5372dc49f36SDustin Sallings
5382dc49f36SDustin Sallings# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
5392dc49f36SDustin Sallings# potential errors in the documentation, such as not documenting some
5402dc49f36SDustin Sallings# parameters in a documented function, or documenting parameters that
5412dc49f36SDustin Sallings# don't exist or using markup commands wrongly.
5422dc49f36SDustin Sallings
5432dc49f36SDustin SallingsWARN_IF_DOC_ERROR      = YES
5442dc49f36SDustin Sallings
5452dc49f36SDustin Sallings# This WARN_NO_PARAMDOC option can be abled to get warnings for
5462dc49f36SDustin Sallings# functions that are documented, but have no documentation for their parameters
5472dc49f36SDustin Sallings# or return value. If set to NO (the default) doxygen will only warn about
5482dc49f36SDustin Sallings# wrong or incomplete parameter documentation, but not about the absence of
5492dc49f36SDustin Sallings# documentation.
5502dc49f36SDustin Sallings
5512dc49f36SDustin SallingsWARN_NO_PARAMDOC       = NO
5522dc49f36SDustin Sallings
5532dc49f36SDustin Sallings# The WARN_FORMAT tag determines the format of the warning messages that
5542dc49f36SDustin Sallings# doxygen can produce. The string should contain the $file, $line, and $text
5552dc49f36SDustin Sallings# tags, which will be replaced by the file and line number from which the
5562dc49f36SDustin Sallings# warning originated and the warning text. Optionally the format may contain
5572dc49f36SDustin Sallings# $version, which will be replaced by the version of the file (if it could
5582dc49f36SDustin Sallings# be obtained via FILE_VERSION_FILTER)
5592dc49f36SDustin Sallings
5602dc49f36SDustin SallingsWARN_FORMAT            = "$file:$line: $text"
5612dc49f36SDustin Sallings
5622dc49f36SDustin Sallings# The WARN_LOGFILE tag can be used to specify a file to which warning
5632dc49f36SDustin Sallings# and error messages should be written. If left blank the output is written
5642dc49f36SDustin Sallings# to stderr.
5652dc49f36SDustin Sallings
5662dc49f36SDustin SallingsWARN_LOGFILE           =
5672dc49f36SDustin Sallings
5682dc49f36SDustin Sallings#---------------------------------------------------------------------------
5692dc49f36SDustin Sallings# configuration options related to the input files
5702dc49f36SDustin Sallings#---------------------------------------------------------------------------
5712dc49f36SDustin Sallings
5722dc49f36SDustin Sallings# The INPUT tag can be used to specify the files and/or directories that contain
5732dc49f36SDustin Sallings# documented source files. You may enter file names like "myfile.cpp" or
5742dc49f36SDustin Sallings# directories like "/usr/src/myproject". Separate the files or directories
5752dc49f36SDustin Sallings# with spaces.
5762dc49f36SDustin Sallings
57773dac325SabhinavdangetiINPUT                  = src/ src/atomic src/blackhole-kvstore src/couch-kvstore src/iomanager
5782dc49f36SDustin Sallings
5792dc49f36SDustin Sallings# This tag can be used to specify the character encoding of the source files
5802dc49f36SDustin Sallings# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
5812dc49f36SDustin Sallings# also the default input encoding. Doxygen uses libiconv (or the iconv built
5822dc49f36SDustin Sallings# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
5832dc49f36SDustin Sallings# the list of possible encodings.
5842dc49f36SDustin Sallings
5852dc49f36SDustin SallingsINPUT_ENCODING         = UTF-8
5862dc49f36SDustin Sallings
5872dc49f36SDustin Sallings# If the value of the INPUT tag contains directories, you can use the
5882dc49f36SDustin Sallings# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
5892dc49f36SDustin Sallings# and *.h) to filter out the source-files in the directories. If left
5902dc49f36SDustin Sallings# blank the following patterns are tested:
5912dc49f36SDustin Sallings# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
5922dc49f36SDustin Sallings# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
5932dc49f36SDustin Sallings
5942dc49f36SDustin SallingsFILE_PATTERNS          =
5952dc49f36SDustin Sallings
5962dc49f36SDustin Sallings# The RECURSIVE tag can be used to turn specify whether or not subdirectories
5972dc49f36SDustin Sallings# should be searched for input files as well. Possible values are YES and NO.
5982dc49f36SDustin Sallings# If left blank NO is used.
5992dc49f36SDustin Sallings
6002dc49f36SDustin SallingsRECURSIVE              = NO
6012dc49f36SDustin Sallings
6022dc49f36SDustin Sallings# The EXCLUDE tag can be used to specify files and/or directories that should
6032dc49f36SDustin Sallings# excluded from the INPUT source files. This way you can easily exclude a
6042dc49f36SDustin Sallings# subdirectory from a directory tree whose root is specified with the INPUT tag.
6052dc49f36SDustin Sallings
6062dc49f36SDustin SallingsEXCLUDE                =
6072dc49f36SDustin Sallings
6082dc49f36SDustin Sallings# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
6092dc49f36SDustin Sallings# directories that are symbolic links (a Unix filesystem feature) are excluded
6102dc49f36SDustin Sallings# from the input.
6112dc49f36SDustin Sallings
6122dc49f36SDustin SallingsEXCLUDE_SYMLINKS       = NO
6132dc49f36SDustin Sallings
6142dc49f36SDustin Sallings# If the value of the INPUT tag contains directories, you can use the
6152dc49f36SDustin Sallings# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
6162dc49f36SDustin Sallings# certain files from those directories. Note that the wildcards are matched
6172dc49f36SDustin Sallings# against the file with absolute path, so to exclude all test directories
6182dc49f36SDustin Sallings# for example use the pattern */test/*
6192dc49f36SDustin Sallings
620373c914bSDustin SallingsEXCLUDE_PATTERNS       = *suite* t/* *test* sizes.cc
6212dc49f36SDustin Sallings
6222dc49f36SDustin Sallings# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
6232dc49f36SDustin Sallings# (namespaces, classes, functions, etc.) that should be excluded from the
6242dc49f36SDustin Sallings# output. The symbol name can be a fully qualified name, a word, or if the
6252dc49f36SDustin Sallings# wildcard * is used, a substring. Examples: ANamespace, AClass,
6262dc49f36SDustin Sallings# AClass::ANamespace, ANamespace::*Test
6272dc49f36SDustin Sallings
6282dc49f36SDustin SallingsEXCLUDE_SYMBOLS        =
6292dc49f36SDustin Sallings
6302dc49f36SDustin Sallings# The EXAMPLE_PATH tag can be used to specify one or more files or
6312dc49f36SDustin Sallings# directories that contain example code fragments that are included (see
6322dc49f36SDustin Sallings# the \include command).
6332dc49f36SDustin Sallings
6342dc49f36SDustin SallingsEXAMPLE_PATH           =
6352dc49f36SDustin Sallings
6362dc49f36SDustin Sallings# If the value of the EXAMPLE_PATH tag contains directories, you can use the
6372dc49f36SDustin Sallings# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
6382dc49f36SDustin Sallings# and *.h) to filter out the source-files in the directories. If left
6392dc49f36SDustin Sallings# blank all files are included.
6402dc49f36SDustin Sallings
6412dc49f36SDustin SallingsEXAMPLE_PATTERNS       =
6422dc49f36SDustin Sallings
6432dc49f36SDustin Sallings# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
6442dc49f36SDustin Sallings# searched for input files to be used with the \include or \dontinclude
6452dc49f36SDustin Sallings# commands irrespective of the value of the RECURSIVE tag.
6462dc49f36SDustin Sallings# Possible values are YES and NO. If left blank NO is used.
6472dc49f36SDustin Sallings
6482dc49f36SDustin SallingsEXAMPLE_RECURSIVE      = NO
6492dc49f36SDustin Sallings
6502dc49f36SDustin Sallings# The IMAGE_PATH tag can be used to specify one or more files or
6512dc49f36SDustin Sallings# directories that contain image that are included in the documentation (see
6522dc49f36SDustin Sallings# the \image command).
6532dc49f36SDustin Sallings
6542dc49f36SDustin SallingsIMAGE_PATH             =
6552dc49f36SDustin Sallings
6562dc49f36SDustin Sallings# The INPUT_FILTER tag can be used to specify a program that doxygen should
6572dc49f36SDustin Sallings# invoke to filter for each input file. Doxygen will invoke the filter program
6582dc49f36SDustin Sallings# by executing (via popen()) the command <filter> <input-file>, where <filter>
6592dc49f36SDustin Sallings# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
6602dc49f36SDustin Sallings# input file. Doxygen will then use the output that the filter program writes
6612dc49f36SDustin Sallings# to standard output.
6622dc49f36SDustin Sallings# If FILTER_PATTERNS is specified, this tag will be
6632dc49f36SDustin Sallings# ignored.
6642dc49f36SDustin Sallings
6652dc49f36SDustin SallingsINPUT_FILTER           =
6662dc49f36SDustin Sallings
6672dc49f36SDustin Sallings# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
6682dc49f36SDustin Sallings# basis.
6692dc49f36SDustin Sallings# Doxygen will compare the file name with each pattern and apply the
6702dc49f36SDustin Sallings# filter if there is a match.
6712dc49f36SDustin Sallings# The filters are a list of the form:
6722dc49f36SDustin Sallings# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
6732dc49f36SDustin Sallings# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
6742dc49f36SDustin Sallings# is applied to all files.
6752dc49f36SDustin Sallings
6762dc49f36SDustin SallingsFILTER_PATTERNS        =
6772dc49f36SDustin Sallings
6782dc49f36SDustin Sallings# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
6792dc49f36SDustin Sallings# INPUT_FILTER) will be used to filter the input files when producing source
6802dc49f36SDustin Sallings# files to browse (i.e. when SOURCE_BROWSER is set to YES).
6812dc49f36SDustin Sallings
6822dc49f36SDustin SallingsFILTER_SOURCE_FILES    = NO
6832dc49f36SDustin Sallings
6842dc49f36SDustin Sallings#---------------------------------------------------------------------------
6852dc49f36SDustin Sallings# configuration options related to source browsing
6862dc49f36SDustin Sallings#---------------------------------------------------------------------------
6872dc49f36SDustin Sallings
6882dc49f36SDustin Sallings# If the SOURCE_BROWSER tag is set to YES then a list of source files will
6892dc49f36SDustin Sallings# be generated. Documented entities will be cross-referenced with these sources.
6902dc49f36SDustin Sallings# Note: To get rid of all source code in the generated output, make sure also
6912dc49f36SDustin Sallings# VERBATIM_HEADERS is set to NO.
6922dc49f36SDustin Sallings
6932dc49f36SDustin SallingsSOURCE_BROWSER         = NO
6942dc49f36SDustin Sallings
6952dc49f36SDustin Sallings# Setting the INLINE_SOURCES tag to YES will include the body
6962dc49f36SDustin Sallings# of functions and classes directly in the documentation.
6972dc49f36SDustin Sallings
6982dc49f36SDustin SallingsINLINE_SOURCES         = NO
6992dc49f36SDustin Sallings
7002dc49f36SDustin Sallings# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
7012dc49f36SDustin Sallings# doxygen to hide any special comment blocks from generated source code
7022dc49f36SDustin Sallings# fragments. Normal C and C++ comments will always remain visible.
7032dc49f36SDustin Sallings
7042dc49f36SDustin SallingsSTRIP_CODE_COMMENTS    = YES
7052dc49f36SDustin Sallings
7062dc49f36SDustin Sallings# If the REFERENCED_BY_RELATION tag is set to YES
7072dc49f36SDustin Sallings# then for each documented function all documented
7082dc49f36SDustin Sallings# functions referencing it will be listed.
7092dc49f36SDustin Sallings
7102dc49f36SDustin SallingsREFERENCED_BY_RELATION = YES
7112dc49f36SDustin Sallings
7122dc49f36SDustin Sallings# If the REFERENCES_RELATION tag is set to YES
7132dc49f36SDustin Sallings# then for each documented function all documented entities
7142dc49f36SDustin Sallings# called/used by that function will be listed.
7152dc49f36SDustin Sallings
7162dc49f36SDustin SallingsREFERENCES_RELATION    = YES
7172dc49f36SDustin Sallings
7182dc49f36SDustin Sallings# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
7192dc49f36SDustin Sallings# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
7202dc49f36SDustin Sallings# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
7212dc49f36SDustin Sallings# link to the source code.
7222dc49f36SDustin Sallings# Otherwise they will link to the documentation.
7232dc49f36SDustin Sallings
7242dc49f36SDustin SallingsREFERENCES_LINK_SOURCE = YES
7252dc49f36SDustin Sallings
7262dc49f36SDustin Sallings# If the USE_HTAGS tag is set to YES then the references to source code
7272dc49f36SDustin Sallings# will point to the HTML generated by the htags(1) tool instead of doxygen
7282dc49f36SDustin Sallings# built-in source browser. The htags tool is part of GNU's global source
7292dc49f36SDustin Sallings# tagging system (see http://www.gnu.org/software/global/global.html). You
7302dc49f36SDustin Sallings# will need version 4.8.6 or higher.
7312dc49f36SDustin Sallings
7322dc49f36SDustin SallingsUSE_HTAGS              = NO
7332dc49f36SDustin Sallings
7342dc49f36SDustin Sallings# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
7352dc49f36SDustin Sallings# will generate a verbatim copy of the header file for each class for
7362dc49f36SDustin Sallings# which an include is specified. Set to NO to disable this.
7372dc49f36SDustin Sallings
7382dc49f36SDustin SallingsVERBATIM_HEADERS       = YES
7392dc49f36SDustin Sallings
7402dc49f36SDustin Sallings#---------------------------------------------------------------------------
7412dc49f36SDustin Sallings# configuration options related to the alphabetical class index
7422dc49f36SDustin Sallings#---------------------------------------------------------------------------
7432dc49f36SDustin Sallings
7442dc49f36SDustin Sallings# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
7452dc49f36SDustin Sallings# of all compounds will be generated. Enable this if the project
7462dc49f36SDustin Sallings# contains a lot of classes, structs, unions or interfaces.
7472dc49f36SDustin Sallings
7482dc49f36SDustin SallingsALPHABETICAL_INDEX     = NO
7492dc49f36SDustin Sallings
7502dc49f36SDustin Sallings# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
7512dc49f36SDustin Sallings# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
7522dc49f36SDustin Sallings# in which this list will be split (can be a number in the range [1..20])
7532dc49f36SDustin Sallings
7542dc49f36SDustin SallingsCOLS_IN_ALPHA_INDEX    = 5
7552dc49f36SDustin Sallings
7562dc49f36SDustin Sallings# In case all classes in a project start with a common prefix, all
7572dc49f36SDustin Sallings# classes will be put under the same header in the alphabetical index.
7582dc49f36SDustin Sallings# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
7592dc49f36SDustin Sallings# should be ignored while generating the index headers.
7602dc49f36SDustin Sallings
7612dc49f36SDustin SallingsIGNORE_PREFIX          =
7622dc49f36SDustin Sallings
7632dc49f36SDustin Sallings#---------------------------------------------------------------------------
7642dc49f36SDustin Sallings# configuration options related to the HTML output
7652dc49f36SDustin Sallings#---------------------------------------------------------------------------
7662dc49f36SDustin Sallings
7672dc49f36SDustin Sallings# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
7682dc49f36SDustin Sallings# generate HTML output.
7692dc49f36SDustin Sallings
7702dc49f36SDustin SallingsGENERATE_HTML          = YES
7712dc49f36SDustin Sallings
7722dc49f36SDustin Sallings# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
7732dc49f36SDustin Sallings# If a relative path is entered the value of OUTPUT_DIRECTORY will be
7742dc49f36SDustin Sallings# put in front of it. If left blank `html' will be used as the default path.
7752dc49f36SDustin Sallings
7762dc49f36SDustin SallingsHTML_OUTPUT            = .
7772dc49f36SDustin Sallings
7782dc49f36SDustin Sallings# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
7792dc49f36SDustin Sallings# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
7802dc49f36SDustin Sallings# doxygen will generate files with .html extension.
7812dc49f36SDustin Sallings
7822dc49f36SDustin SallingsHTML_FILE_EXTENSION    = .html
7832dc49f36SDustin Sallings
7842dc49f36SDustin Sallings# The HTML_HEADER tag can be used to specify a personal HTML header for
7852dc49f36SDustin Sallings# each generated HTML page. If it is left blank doxygen will generate a
7862dc49f36SDustin Sallings# standard header.
7872dc49f36SDustin Sallings
7882dc49f36SDustin SallingsHTML_HEADER            =
7892dc49f36SDustin Sallings
7902dc49f36SDustin Sallings# The HTML_FOOTER tag can be used to specify a personal HTML footer for
7912dc49f36SDustin Sallings# each generated HTML page. If it is left blank doxygen will generate a
7922dc49f36SDustin Sallings# standard footer.
7932dc49f36SDustin Sallings
7942dc49f36SDustin SallingsHTML_FOOTER            =
7952dc49f36SDustin Sallings
7962dc49f36SDustin Sallings# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
7972dc49f36SDustin Sallings# style sheet that is used by each HTML page. It can be used to
7982dc49f36SDustin Sallings# fine-tune the look of the HTML output. If the tag is left blank doxygen
7992dc49f36SDustin Sallings# will generate a default style sheet. Note that doxygen will try to copy
8002dc49f36SDustin Sallings# the style sheet file to the HTML output directory, so don't put your own
8012dc49f36SDustin Sallings# stylesheet in the HTML output directory as well, or it will be erased!
8022dc49f36SDustin Sallings
8032dc49f36SDustin SallingsHTML_STYLESHEET        =
8042dc49f36SDustin Sallings
8052dc49f36SDustin Sallings# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
8062dc49f36SDustin Sallings# page will contain the date and time when the page was generated. Setting
8072dc49f36SDustin Sallings# this to NO can help when comparing the output of multiple runs.
8082dc49f36SDustin Sallings
8092dc49f36SDustin SallingsHTML_TIMESTAMP         = YES
8102dc49f36SDustin Sallings
8112dc49f36SDustin Sallings# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
8122dc49f36SDustin Sallings# files or namespaces will be aligned in HTML using tables. If set to
8132dc49f36SDustin Sallings# NO a bullet list will be used.
8142dc49f36SDustin Sallings
8152dc49f36SDustin SallingsHTML_ALIGN_MEMBERS     = YES
8162dc49f36SDustin Sallings
8172dc49f36SDustin Sallings# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
8182dc49f36SDustin Sallings# documentation will contain sections that can be hidden and shown after the
8192dc49f36SDustin Sallings# page has loaded. For this to work a browser that supports
8202dc49f36SDustin Sallings# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
8212dc49f36SDustin Sallings# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
8222dc49f36SDustin Sallings
8232dc49f36SDustin SallingsHTML_DYNAMIC_SECTIONS  = NO
8242dc49f36SDustin Sallings
8252dc49f36SDustin Sallings# If the GENERATE_DOCSET tag is set to YES, additional index files
8262dc49f36SDustin Sallings# will be generated that can be used as input for Apple's Xcode 3
8272dc49f36SDustin Sallings# integrated development environment, introduced with OSX 10.5 (Leopard).
8282dc49f36SDustin Sallings# To create a documentation set, doxygen will generate a Makefile in the
8292dc49f36SDustin Sallings# HTML output directory. Running make will produce the docset in that
8302dc49f36SDustin Sallings# directory and running "make install" will install the docset in
8312dc49f36SDustin Sallings# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
8322dc49f36SDustin Sallings# it at startup.
8332dc49f36SDustin Sallings# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
8342dc49f36SDustin Sallings
8352dc49f36SDustin SallingsGENERATE_DOCSET        = NO
8362dc49f36SDustin Sallings
8372dc49f36SDustin Sallings# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
8382dc49f36SDustin Sallings# feed. A documentation feed provides an umbrella under which multiple
8392dc49f36SDustin Sallings# documentation sets from a single provider (such as a company or product suite)
8402dc49f36SDustin Sallings# can be grouped.
8412dc49f36SDustin Sallings
8422dc49f36SDustin SallingsDOCSET_FEEDNAME        = "Doxygen generated docs"
8432dc49f36SDustin Sallings
8442dc49f36SDustin Sallings# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
8452dc49f36SDustin Sallings# should uniquely identify the documentation set bundle. This should be a
8462dc49f36SDustin Sallings# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
8472dc49f36SDustin Sallings# will append .docset to the name.
8482dc49f36SDustin Sallings
8492dc49f36SDustin SallingsDOCSET_BUNDLE_ID       = org.doxygen.Project
8502dc49f36SDustin Sallings
8512dc49f36SDustin Sallings# If the GENERATE_HTMLHELP tag is set to YES, additional index files
8522dc49f36SDustin Sallings# will be generated that can be used as input for tools like the
8532dc49f36SDustin Sallings# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
8542dc49f36SDustin Sallings# of the generated HTML documentation.
8552dc49f36SDustin Sallings
8562dc49f36SDustin SallingsGENERATE_HTMLHELP      = NO
8572dc49f36SDustin Sallings
8582dc49f36SDustin Sallings# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
8592dc49f36SDustin Sallings# be used to specify the file name of the resulting .chm file. You
8602dc49f36SDustin Sallings# can add a path in front of the file if the result should not be
8612dc49f36SDustin Sallings# written to the html output directory.
8622dc49f36SDustin Sallings
8632dc49f36SDustin SallingsCHM_FILE               =
8642dc49f36SDustin Sallings
8652dc49f36SDustin Sallings# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
8662dc49f36SDustin Sallings# be used to specify the location (absolute path including file name) of
8672dc49f36SDustin Sallings# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
8682dc49f36SDustin Sallings# the HTML help compiler on the generated index.hhp.
8692dc49f36SDustin Sallings
8702dc49f36SDustin SallingsHHC_LOCATION           =
8712dc49f36SDustin Sallings
8722dc49f36SDustin Sallings# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
8732dc49f36SDustin Sallings# controls if a separate .chi index file is generated (YES) or that
8742dc49f36SDustin Sallings# it should be included in the master .chm file (NO).
8752dc49f36SDustin Sallings
8762dc49f36SDustin SallingsGENERATE_CHI           = NO
8772dc49f36SDustin Sallings
8782dc49f36SDustin Sallings# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
8792dc49f36SDustin Sallings# is used to encode HtmlHelp index (hhk), content (hhc) and project file
8802dc49f36SDustin Sallings# content.
8812dc49f36SDustin Sallings
8822dc49f36SDustin SallingsCHM_INDEX_ENCODING     =
8832dc49f36SDustin Sallings
8842dc49f36SDustin Sallings# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
8852dc49f36SDustin Sallings# controls whether a binary table of contents is generated (YES) or a
8862dc49f36SDustin Sallings# normal table of contents (NO) in the .chm file.
8872dc49f36SDustin Sallings
8882dc49f36SDustin SallingsBINARY_TOC             = NO
8892dc49f36SDustin Sallings
8902dc49f36SDustin Sallings# The TOC_EXPAND flag can be set to YES to add extra items for group members
8912dc49f36SDustin Sallings# to the contents of the HTML help documentation and to the tree view.
8922dc49f36SDustin Sallings
8932dc49f36SDustin SallingsTOC_EXPAND             = NO
8942dc49f36SDustin Sallings
8952dc49f36SDustin Sallings# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
8962dc49f36SDustin Sallings# are set, an additional index file will be generated that can be used as input for
8972dc49f36SDustin Sallings# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
8982dc49f36SDustin Sallings# HTML documentation.
8992dc49f36SDustin Sallings
9002dc49f36SDustin SallingsGENERATE_QHP           = NO
9012dc49f36SDustin Sallings
9022dc49f36SDustin Sallings# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
9032dc49f36SDustin Sallings# be used to specify the file name of the resulting .qch file.
9042dc49f36SDustin Sallings# The path specified is relative to the HTML output folder.
9052dc49f36SDustin Sallings
9062dc49f36SDustin SallingsQCH_FILE               =
9072dc49f36SDustin Sallings
9082dc49f36SDustin Sallings# The QHP_NAMESPACE tag specifies the namespace to use when generating
9092dc49f36SDustin Sallings# Qt Help Project output. For more information please see
9102dc49f36SDustin Sallings# http://doc.trolltech.com/qthelpproject.html#namespace
9112dc49f36SDustin Sallings
9122dc49f36SDustin SallingsQHP_NAMESPACE          = org.doxygen.Project
9132dc49f36SDustin Sallings
9142dc49f36SDustin Sallings# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
9152dc49f36SDustin Sallings# Qt Help Project output. For more information please see
9162dc49f36SDustin Sallings# http://doc.trolltech.com/qthelpproject.html#virtual-folders
9172dc49f36SDustin Sallings
9182dc49f36SDustin SallingsQHP_VIRTUAL_FOLDER     = doc
9192dc49f36SDustin Sallings
9202dc49f36SDustin Sallings# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
9212dc49f36S