2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Doxyfile 1.6.1
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# This file describes the settings to be used by the documentation system
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# doxygen (www.doxygen.org) for a project
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# All text after a hash (#) is considered a comment and will be ignored
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The format is:
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# TAG = value [value, ...]
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# For lists items can also be appended using:
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# TAG += value [value, ...]
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Values that contain spaces should be placed between quotes (" ")
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Project related configuration options
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# This tag specifies the encoding used for all characters in the config file
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# that follow. The default is UTF-8 which is also the encoding used for all
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# text before the first occurrence of this tag. Doxygen uses libiconv (or the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# iconv built into libc) for the transcoding. See
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# http://www.gnu.org/software/libiconv for the list of possible encodings.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseDOXYFILE_ENCODING = UTF-8
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# by quotes) that should identify the project.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BosePROJECT_NAME = sss_nss_idmap
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The PROJECT_NUMBER tag can be used to enter a project or revision number.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# This could be handy for archiving the generated documentation or
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# if some version control system is used.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BosePROJECT_NUMBER = @PACKAGE_VERSION@
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# base path where the generated documentation will be put.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If a relative path is entered, it will be relative to the location
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# where doxygen was started. If left blank the current directory will be used.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseOUTPUT_DIRECTORY = nss_idmap_doc
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# 4096 sub-directories (in 2 levels) under the output directory of each output
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# format and will distribute the generated files over these directories.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Enabling this option can be useful when feeding doxygen a huge amount of
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# source files, where putting all generated files in the same directory would
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# otherwise cause performance problems for the file system.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseCREATE_SUBDIRS = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The OUTPUT_LANGUAGE tag is used to specify the language in which all
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# documentation generated by doxygen is written. Doxygen will use this
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# information to generate all constant output in the proper language.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The default language is English, other supported languages are:
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseOUTPUT_LANGUAGE = English
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# include brief member descriptions after the members that are listed in
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the file and class documentation (similar to JavaDoc).
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Set to NO to disable this.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseBRIEF_MEMBER_DESC = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the brief description of a member or function before the detailed description.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# brief descriptions will be completely suppressed.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseREPEAT_BRIEF = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# This tag implements a quasi-intelligent brief description abbreviator
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# that is used to form the text in various listings. Each string
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# in this list, if found as the leading text of the brief description, will be
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# stripped from the text and the result after processing the whole list, is
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# used as the annotated text. Otherwise, the brief description is used as-is.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If left blank, the following values are used ("$name" is automatically
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# replaced with the name of the entity): "The $name class" "The $name widget"
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# "The $name file" "is" "provides" "specifies" "contains"
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# "represents" "a" "an" "the"
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseABBREVIATE_BRIEF = "The $name class" \
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose "The $name widget" \
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose "The $name file" \
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose represents \
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Doxygen will generate a detailed section even if there is only a brief
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# description.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseALWAYS_DETAILED_SEC = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# inherited members of a class in the documentation of that class as if those
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# members were ordinary class members. Constructors, destructors and assignment
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# operators of the base classes will not be shown.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseINLINE_INHERITED_MEMB = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# path before files name in the file list and in the header files. If set
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# to NO the shortest path that makes the file name unique will be used.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseFULL_PATH_NAMES = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# can be used to strip a user-defined part of the path. Stripping is
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# only done if one of the specified strings matches the left-hand part of
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the path. The tag can be used to show relative paths in the file list.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If left blank the directory from which doxygen is run is used as the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# path to strip.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSTRIP_FROM_PATH =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the path mentioned in the documentation of a class, which tells
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the reader which header file to include in order to use a class.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If left blank only the name of the header file containing the class
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# definition is used. Otherwise one should specify the include paths that
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# are normally passed to the compiler using the -I flag.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSTRIP_FROM_INC_PATH =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# (but less readable) file names. This can be useful is your file systems
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# doesn't support long names like on DOS, Mac, or CD-ROM.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSHORT_NAMES = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will interpret the first line (until the first dot) of a JavaDoc-style
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# comment as the brief description. If set to NO, the JavaDoc
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# comments will behave just like regular Qt-style comments
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# (thus requiring an explicit @brief command for a brief description.)
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseJAVADOC_AUTOBRIEF = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# interpret the first line (until the first dot) of a Qt-style
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# comment as the brief description. If set to NO, the comments
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will behave just like regular Qt-style comments (thus requiring
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# an explicit \brief command for a brief description.)
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseQT_AUTOBRIEF = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# treat a multi-line C++ special comment block (i.e. a block of //! or ///
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# comments) as a brief description. This used to be the default behaviour.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The new default is to treat a multi-line C++ comment block as a detailed
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# description. Set this tag to YES if you prefer the old behaviour instead.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseMULTILINE_CPP_IS_BRIEF = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# member inherits the documentation from any documented member that it
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# re-implements.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseINHERIT_DOCS = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# a new page for each member. If set to NO, the documentation of a member will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# be part of the file/class/namespace that contains it.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSEPARATE_MEMBER_PAGES = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The TAB_SIZE tag can be used to set the number of spaces in a tab.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Doxygen uses this value to replace tabs by spaces in code fragments.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# This tag can be used to specify a number of aliases that acts
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# as commands in the documentation. An alias has the form "name=value".
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# For example adding "sideeffect=\par Side Effects:\n" will allow you to
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# put the command \sideeffect (or @sideeffect) in the documentation, which
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will result in a user-defined paragraph with heading "Side Effects:".
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# You can put \n's in the value part of an alias to insert newlines.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# sources only. Doxygen will then generate output that is more tailored for C.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# For instance, some of the names that are used will be different. The list
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# of all members will be omitted, etc.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseOPTIMIZE_OUTPUT_FOR_C = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# sources only. Doxygen will then generate output that is more tailored for
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Java. For instance, namespaces will be presented as packages, qualified
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# scopes will look different, etc.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseOPTIMIZE_OUTPUT_JAVA = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# sources only. Doxygen will then generate output that is more tailored for
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseOPTIMIZE_FOR_FORTRAN = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# sources. Doxygen will then generate output that is tailored for
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseOPTIMIZE_OUTPUT_VHDL = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Doxygen selects the parser to use depending on the extension of the files it parses.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# With this tag you can assign which parser to use for a given extension.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Doxygen has a built-in mapping, but you can override or extend it using this tag.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The format is ext=language, where ext is a file extension, and language is one of
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# 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.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseEXTENSION_MAPPING =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# to include (a tag file for) the STL sources as input, then you should
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# set this tag to YES in order to let doxygen match functions declarations and
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# func(std::string) {}). This also make the inheritance and collaboration
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# diagrams that involve STL classes more complete and accurate.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseBUILTIN_STL_SUPPORT = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If you use Microsoft's C++/CLI language, you should set this option to YES to
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# enable parsing support.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseCPP_CLI_SUPPORT = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Doxygen will parse them like normal C++ but will assume all classes use public
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# instead of private inheritance when no explicit protection keyword is present.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSIP_SUPPORT = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# For Microsoft's IDL there are propget and propput attributes to indicate getter
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# and setter methods for a property. Setting this option to YES (the default)
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will make doxygen to replace the get and set methods by a property in the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# documentation. This will only work if the methods are indeed getting or
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# setting a simple type. If this is not the case, or you want to show the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# methods anyway, you should set this option to NO.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseIDL_PROPERTY_SUPPORT = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# tag is set to YES, then doxygen will reuse the documentation of the first
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# member in the group (if any) for the other members of the group. By default
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# all members of a group must be documented explicitly.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseDISTRIBUTE_GROUP_DOC = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the same type (for instance a group of public functions) to be put as a
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# subgroup of that type (e.g. under the Public Functions section). Set it to
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# NO to prevent subgrouping. Alternatively, this can be done per class using
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the \nosubgrouping command.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSUBGROUPING = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# is documented as struct, union, or enum with the name of the typedef. So
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# with name TypeT. When disabled the typedef will appear as a member of a file,
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# namespace, or class. And the struct will be named TypeS. This can typically
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# be useful for C code in case the coding convention dictates that all compound
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# types are typedef'ed and only the typedef is referenced, never the tag name.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseTYPEDEF_HIDES_STRUCT = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# determine which symbols to keep in memory and which to flush to disk.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# When the cache is full, less often used symbols will be written to disk.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# For small to medium size projects (<1000 input files) the default value is
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# probably good enough. For larger projects a too small cache size can cause
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# doxygen to be busy swapping symbols to and from disk most of the time
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# causing a significant performance penality.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the system has enough physical memory increasing the cache will improve the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# performance by keeping more symbols in memory. Note that the value works on
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# a logarithmic scale so increasing the size by one will rougly double the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# memory usage. The cache size is given by this formula:
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# corresponding to a cache size of 2^16 = 65536 symbols
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSYMBOL_CACHE_SIZE = 0
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Build related configuration options
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# documentation are documented, even if no documentation was available.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Private class members and static file members will be hidden unless
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseEXTRACT_ALL = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will be included in the documentation.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseEXTRACT_PRIVATE = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the EXTRACT_STATIC tag is set to YES all static members of a file
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will be included in the documentation.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseEXTRACT_STATIC = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# defined locally in source files will be included in the documentation.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If set to NO only classes defined in header files are included.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseEXTRACT_LOCAL_CLASSES = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# This flag is only useful for Objective-C code. When set to YES local
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# methods, which are defined in the implementation section but not in
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the interface are included in the documentation.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If set to NO (the default) only methods in the interface are included.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseEXTRACT_LOCAL_METHODS = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If this flag is set to YES, the members of anonymous namespaces will be
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# extracted and appear in the documentation as a namespace called
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# 'anonymous_namespace{file}', where file will be replaced with the base
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# name of the file that contains the anonymous namespace. By default
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# anonymous namespace are hidden.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseEXTRACT_ANON_NSPACES = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# undocumented members of documented classes, files or namespaces.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If set to NO (the default) these members will be included in the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# various overviews, but no documentation section is generated.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# This option has no effect if EXTRACT_ALL is enabled.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseHIDE_UNDOC_MEMBERS = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# undocumented classes that are normally visible in the class hierarchy.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If set to NO (the default) these classes will be included in the various
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# overviews. This option has no effect if EXTRACT_ALL is enabled.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseHIDE_UNDOC_CLASSES = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# friend (class|struct|union) declarations.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If set to NO (the default) these declarations will be included in the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# documentation.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseHIDE_FRIEND_COMPOUNDS = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# documentation blocks found inside the body of a function.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If set to NO (the default) these blocks will be appended to the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# function's detailed documentation block.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseHIDE_IN_BODY_DOCS = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The INTERNAL_DOCS tag determines if documentation
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# that is typed after a \internal command is included. If the tag is set
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# to NO (the default) then the documentation will be excluded.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Set it to YES to include the internal documentation.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseINTERNAL_DOCS = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# file names in lower-case letters. If set to YES upper-case letters are also
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# allowed. This is useful if you have classes or files whose names only differ
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# in case and if your file system supports case sensitive file names. Windows
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# and Mac users are advised to set this option to NO.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseCASE_SENSE_NAMES = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will show members with their full class and namespace scopes in the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# documentation. If set to YES the scope will be hidden.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseHIDE_SCOPE_NAMES = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will put a list of the files that are included by a file in the documentation
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# of that file.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSHOW_INCLUDE_FILES = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# is inserted in the documentation for inline members.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseINLINE_INFO = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will sort the (detailed) documentation of file and class members
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# alphabetically by member name. If set to NO the members will appear in
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# declaration order.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSORT_MEMBER_DOCS = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# brief documentation of file, namespace and class members alphabetically
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# by member name. If set to NO (the default) the members will appear in
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# declaration order.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSORT_BRIEF_DOCS = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# 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.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSORT_MEMBERS_CTORS_1ST = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# hierarchy of group names into alphabetical order. If set to NO (the default)
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the group names will appear in their defined order.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSORT_GROUP_NAMES = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# sorted by fully-qualified names, including namespaces. If set to
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# NO (the default), the class list will be sorted only by class name,
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# not including the namespace part.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Note: This option applies only to the class list, not to the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# alphabetical list.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSORT_BY_SCOPE_NAME = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The GENERATE_TODOLIST tag can be used to enable (YES) or
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# disable (NO) the todo list. This list is created by putting \todo
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# commands in the documentation.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseGENERATE_TODOLIST = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The GENERATE_TESTLIST tag can be used to enable (YES) or
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# disable (NO) the test list. This list is created by putting \test
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# commands in the documentation.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseGENERATE_TESTLIST = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The GENERATE_BUGLIST tag can be used to enable (YES) or
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# disable (NO) the bug list. This list is created by putting \bug
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# commands in the documentation.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseGENERATE_BUGLIST = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# disable (NO) the deprecated list. This list is created by putting
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# \deprecated commands in the documentation.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseGENERATE_DEPRECATEDLIST= YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The ENABLED_SECTIONS tag can be used to enable conditional
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# documentation sections, marked by \if sectionname ... \endif.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseENABLED_SECTIONS =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the initial value of a variable or define consists of for it to appear in
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the documentation. If the initializer consists of more lines than specified
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# here it will be hidden. Use a value of 0 to hide initializers completely.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The appearance of the initializer of individual variables and defines in the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# documentation can be controlled using \showinitializer or \hideinitializer
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# command in the documentation regardless of this setting.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseMAX_INITIALIZER_LINES = 30
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# at the bottom of the documentation of classes and structs. If set to YES the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# list will mention the files that were used to generate the documentation.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSHOW_USED_FILES = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the sources in your project are distributed over multiple directories
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# in the documentation. The default is NO.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSHOW_DIRECTORIES = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# This will remove the Files entry from the Quick Index and from the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Folder Tree View (if specified). The default is YES.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSHOW_FILES = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Namespaces page.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# This will remove the Namespaces entry from the Quick Index
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# and from the Folder Tree View (if specified). The default is YES.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSHOW_NAMESPACES = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The FILE_VERSION_FILTER tag can be used to specify a program or script that
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# doxygen should invoke to get the current version for each file (typically from
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the version control system). Doxygen will invoke the program by executing (via
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# popen()) the command <command> <input-file>, where <command> is the value of
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# provided by doxygen. Whatever the program writes to standard output
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# is used as the file version. See the manual for examples.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseFILE_VERSION_FILTER =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# doxygen. The layout file controls the global structure of the generated output files
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# in an output format independent way. The create the layout file that represents
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# file name after the option, if omitted DoxygenLayout.xml will be used as the name
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# of the layout file.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseLAYOUT_FILE =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# configuration options related to warning and progress messages
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The QUIET tag can be used to turn on/off the messages that are generated
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# by doxygen. Possible values are YES and NO. If left blank NO is used.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The WARNINGS tag can be used to turn on/off the warning messages that are
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# generated by doxygen. Possible values are YES and NO. If left blank
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# NO is used.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseWARNINGS = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# automatically be disabled.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseWARN_IF_UNDOCUMENTED = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# potential errors in the documentation, such as not documenting some
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# parameters in a documented function, or documenting parameters that
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# don't exist or using markup commands wrongly.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseWARN_IF_DOC_ERROR = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# This WARN_NO_PARAMDOC option can be abled to get warnings for
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# functions that are documented, but have no documentation for their parameters
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# or return value. If set to NO (the default) doxygen will only warn about
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# wrong or incomplete parameter documentation, but not about the absence of
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# documentation.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseWARN_NO_PARAMDOC = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The WARN_FORMAT tag determines the format of the warning messages that
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# doxygen can produce. The string should contain the $file, $line, and $text
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# tags, which will be replaced by the file and line number from which the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# warning originated and the warning text. Optionally the format may contain
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# $version, which will be replaced by the version of the file (if it could
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# be obtained via FILE_VERSION_FILTER)
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseWARN_FORMAT = "$file:$line: $text"
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The WARN_LOGFILE tag can be used to specify a file to which warning
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# and error messages should be written. If left blank the output is written
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseWARN_LOGFILE =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# configuration options related to the input files
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The INPUT tag can be used to specify the files and/or directories that contain
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# documented source files. You may enter file names like "myfile.cpp" or
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# directories like "/usr/src/myproject". Separate the files or directories
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# with spaces.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseINPUT = @abs_top_srcdir@/src/sss_client/idmap/sss_nss_idmap.h
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# This tag can be used to specify the character encoding of the source files
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# also the default input encoding. Doxygen uses libiconv (or the iconv built
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the list of possible encodings.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseINPUT_ENCODING = UTF-8
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the value of the INPUT tag contains directories, you can use the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# and *.h) to filter out the source-files in the directories. If left
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# blank the following patterns are tested:
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseFILE_PATTERNS = *.cpp \
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The RECURSIVE tag can be used to turn specify whether or not subdirectories
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# should be searched for input files as well. Possible values are YES and NO.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If left blank NO is used.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseRECURSIVE = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The EXCLUDE tag can be used to specify files and/or directories that should
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# excluded from the INPUT source files. This way you can easily exclude a
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# subdirectory from a directory tree whose root is specified with the INPUT tag.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
a02a5ed51178b2cbede0396d66aed716b8898096René Genz# directories that are symbolic links (a UNIX filesystem feature) are excluded
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# from the input.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseEXCLUDE_SYMLINKS = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the value of the INPUT tag contains directories, you can use the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# certain files from those directories. Note that the wildcards are matched
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# against the file with absolute path, so to exclude all test directories
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# for example use the pattern */test/*
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseEXCLUDE_PATTERNS = */.git/* \
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# (namespaces, classes, functions, etc.) that should be excluded from the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# output. The symbol name can be a fully qualified name, a word, or if the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# wildcard * is used, a substring. Examples: ANamespace, AClass,
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# AClass::ANamespace, ANamespace::*Test
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseEXCLUDE_SYMBOLS =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The EXAMPLE_PATH tag can be used to specify one or more files or
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# directories that contain example code fragments that are included (see
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the \include command).
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseEXAMPLE_PATH =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the value of the EXAMPLE_PATH tag contains directories, you can use the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# and *.h) to filter out the source-files in the directories. If left
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# blank all files are included.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseEXAMPLE_PATTERNS =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# searched for input files to be used with the \include or \dontinclude
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# commands irrespective of the value of the RECURSIVE tag.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Possible values are YES and NO. If left blank NO is used.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseEXAMPLE_RECURSIVE = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The IMAGE_PATH tag can be used to specify one or more files or
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# directories that contain image that are included in the documentation (see
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the \image command).
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The INPUT_FILTER tag can be used to specify a program that doxygen should
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# invoke to filter for each input file. Doxygen will invoke the filter program
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# by executing (via popen()) the command <filter> <input-file>, where <filter>
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# input file. Doxygen will then use the output that the filter program writes
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# to standard output.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If FILTER_PATTERNS is specified, this tag will be
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseINPUT_FILTER =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Doxygen will compare the file name with each pattern and apply the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# filter if there is a match.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The filters are a list of the form:
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# is applied to all files.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseFILTER_PATTERNS =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# INPUT_FILTER) will be used to filter the input files when producing source
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# files to browse (i.e. when SOURCE_BROWSER is set to YES).
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseFILTER_SOURCE_FILES = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# configuration options related to source browsing
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the SOURCE_BROWSER tag is set to YES then a list of source files will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# be generated. Documented entities will be cross-referenced with these sources.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Note: To get rid of all source code in the generated output, make sure also
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# VERBATIM_HEADERS is set to NO.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSOURCE_BROWSER = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Setting the INLINE_SOURCES tag to YES will include the body
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# of functions and classes directly in the documentation.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseINLINE_SOURCES = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# doxygen to hide any special comment blocks from generated source code
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# fragments. Normal C and C++ comments will always remain visible.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSTRIP_CODE_COMMENTS = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the REFERENCED_BY_RELATION tag is set to YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# then for each documented function all documented
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# functions referencing it will be listed.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseREFERENCED_BY_RELATION = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the REFERENCES_RELATION tag is set to YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# then for each documented function all documented entities
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# called/used by that function will be listed.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseREFERENCES_RELATION = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# link to the source code.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Otherwise they will link to the documentation.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseREFERENCES_LINK_SOURCE = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the USE_HTAGS tag is set to YES then the references to source code
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will point to the HTML generated by the htags(1) tool instead of doxygen
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# built-in source browser. The htags tool is part of GNU's global source
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# tagging system (see http://www.gnu.org/software/global/global.html). You
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will need version 4.8.6 or higher.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseUSE_HTAGS = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will generate a verbatim copy of the header file for each class for
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# which an include is specified. Set to NO to disable this.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseVERBATIM_HEADERS = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# configuration options related to the alphabetical class index
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# of all compounds will be generated. Enable this if the project
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# contains a lot of classes, structs, unions or interfaces.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseALPHABETICAL_INDEX = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# in which this list will be split (can be a number in the range [1..20])
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseCOLS_IN_ALPHA_INDEX = 5
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# In case all classes in a project start with a common prefix, all
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# classes will be put under the same header in the alphabetical index.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# should be ignored while generating the index headers.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseIGNORE_PREFIX =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# configuration options related to the HTML output
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# generate HTML output.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseGENERATE_HTML = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# HTML page will contain the date and time when the page was generated. Setting
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# this to NO can help when comparing the output of multiple runs.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseHTML_TIMESTAMP = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If a relative path is entered the value of OUTPUT_DIRECTORY will be
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# put in front of it. If left blank `html' will be used as the default path.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseHTML_OUTPUT = html
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# doxygen will generate files with .html extension.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseHTML_FILE_EXTENSION = .html
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The HTML_HEADER tag can be used to specify a personal HTML header for
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# each generated HTML page. If it is left blank doxygen will generate a
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# standard header.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseHTML_HEADER =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The HTML_FOOTER tag can be used to specify a personal HTML footer for
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# each generated HTML page. If it is left blank doxygen will generate a
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# standard footer.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseHTML_FOOTER =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# style sheet that is used by each HTML page. It can be used to
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# fine-tune the look of the HTML output. If the tag is left blank doxygen
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will generate a default style sheet. Note that doxygen will try to copy
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the style sheet file to the HTML output directory, so don't put your own
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# stylesheet in the HTML output directory as well, or it will be erased!
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseHTML_STYLESHEET =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# files or namespaces will be aligned in HTML using tables. If set to
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# NO a bullet list will be used.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseHTML_ALIGN_MEMBERS = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# documentation will contain sections that can be hidden and shown after the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# page has loaded. For this to work a browser that supports
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseHTML_DYNAMIC_SECTIONS = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the GENERATE_DOCSET tag is set to YES, additional index files
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will be generated that can be used as input for Apple's Xcode 3
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# integrated development environment, introduced with OSX 10.5 (Leopard).
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# To create a documentation set, doxygen will generate a Makefile in the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# HTML output directory. Running make will produce the docset in that
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# directory and running "make install" will install the docset in
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# it at startup.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseGENERATE_DOCSET = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# feed. A documentation feed provides an umbrella under which multiple
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# documentation sets from a single provider (such as a company or product suite)
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# can be grouped.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseDOCSET_FEEDNAME = "Doxygen generated docs"
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# should uniquely identify the documentation set bundle. This should be a
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will append .docset to the name.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseDOCSET_BUNDLE_ID = org.doxygen.Project
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the GENERATE_HTMLHELP tag is set to YES, additional index files
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will be generated that can be used as input for tools like the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# of the generated HTML documentation.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseGENERATE_HTMLHELP = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# be used to specify the file name of the resulting .chm file. You
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# can add a path in front of the file if the result should not be
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# written to the html output directory.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# be used to specify the location (absolute path including file name) of
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the HTML help compiler on the generated index.hhp.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseHHC_LOCATION =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# controls if a separate .chi index file is generated (YES) or that
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# it should be included in the master .chm file (NO).
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseGENERATE_CHI = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# is used to encode HtmlHelp index (hhk), content (hhc) and project file
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseCHM_INDEX_ENCODING =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# controls whether a binary table of contents is generated (YES) or a
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# normal table of contents (NO) in the .chm file.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseBINARY_TOC = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The TOC_EXPAND flag can be set to YES to add extra items for group members
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# to the contents of the HTML help documentation and to the tree view.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseTOC_EXPAND = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# are set, an additional index file will be generated that can be used as input for
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# HTML documentation.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseGENERATE_QHP = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# be used to specify the file name of the resulting .qch file.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The path specified is relative to the HTML output folder.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The QHP_NAMESPACE tag specifies the namespace to use when generating
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Qt Help Project output. For more information please see
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# http://doc.trolltech.com/qthelpproject.html#namespace
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseQHP_NAMESPACE =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Qt Help Project output. For more information please see
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# http://doc.trolltech.com/qthelpproject.html#virtual-folders
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseQHP_VIRTUAL_FOLDER = doc
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# For more information please see
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# http://doc.trolltech.com/qthelpproject.html#custom-filters
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseQHP_CUST_FILTER_NAME =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseQHP_CUST_FILTER_ATTRS =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# filter section matches.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseQHP_SECT_FILTER_ATTRS =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# be used to specify the location of Qt's qhelpgenerator.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If non-empty doxygen will try to run qhelpgenerator on the generated
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseQHG_LOCATION =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# top of each HTML page. The value NO (the default) enables the index and
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the value YES disables it.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseDISABLE_INDEX = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# This tag can be used to set the number of enum values (range [1..20])
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# that doxygen will group on one line in the generated HTML documentation.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseENUM_VALUES_PER_LINE = 4
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# structure should be generated to display hierarchical information.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the tag value is set to YES, a side panel will be generated
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# containing a tree-like index structure (just like the one that
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# is generated for HTML Help). For this to work a browser that supports
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Windows users are probably better off using the HTML help feature.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseGENERATE_TREEVIEW = NONE
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# and Class Hierarchy pages using a tree view instead of an ordered list.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseUSE_INLINE_TREES = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# used to set the initial width (in pixels) of the frame in which the tree
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseTREEVIEW_WIDTH = 250
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Use this tag to change the font size of Latex formulas included
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# as images in the HTML documentation. The default is 10. Note that
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# when you change the font size after a successful doxygen run you need
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# to manually remove any form_*.png images from the HTML output directory
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# to force them to be regenerated.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseFORMULA_FONTSIZE = 10
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# there is already a search function so this one should typically
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# be disabled.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSEARCHENGINE = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# configuration options related to the LaTeX output
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# generate Latex output.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseGENERATE_LATEX = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If a relative path is entered the value of OUTPUT_DIRECTORY will be
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# put in front of it. If left blank `latex' will be used as the default path.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseLATEX_OUTPUT = latex
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# invoked. If left blank `latex' will be used as the default command name.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseLATEX_CMD_NAME = latex
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# generate index for LaTeX. If left blank `makeindex' will be used as the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# default command name.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseMAKEINDEX_CMD_NAME = makeindex
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# LaTeX documents. This may be useful for small projects and may help to
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# save some trees in general.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseCOMPACT_LATEX = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The PAPER_TYPE tag can be used to set the paper type that is used
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# by the printer. Possible values are: a4, a4wide, letter, legal and
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# executive. If left blank a4wide will be used.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BosePAPER_TYPE = a4wide
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# packages that should be included in the LaTeX output.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseEXTRA_PACKAGES =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the generated latex document. The header should contain everything until
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the first chapter. If it is left blank doxygen will generate a
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# standard header. Notice: only use this tag if you know what you are doing!
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseLATEX_HEADER =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# is prepared for conversion to pdf (using ps2pdf). The pdf file will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# contain links (just like the HTML output) instead of page references
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# This makes the output suitable for online browsing using a pdf viewer.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BosePDF_HYPERLINKS = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# plain latex in the generated Makefile. Set this option to YES to get a
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# higher quality PDF documentation.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseUSE_PDFLATEX = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# command to the generated LaTeX files. This will instruct LaTeX to keep
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# running if errors occur, instead of asking the user for help.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# This option is also used when generating formulas in HTML.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseLATEX_BATCHMODE = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If LATEX_HIDE_INDICES is set to YES then doxygen will not
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# include the index chapters (such as File Index, Compound Index, etc.)
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# in the output.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseLATEX_HIDE_INDICES = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseLATEX_SOURCE_CODE = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# configuration options related to the RTF output
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The RTF output is optimized for Word 97 and may not look very pretty with
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# other RTF readers or editors.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseGENERATE_RTF = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If a relative path is entered the value of OUTPUT_DIRECTORY will be
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# put in front of it. If left blank `rtf' will be used as the default path.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseRTF_OUTPUT = rtf
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# RTF documents. This may be useful for small projects and may help to
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# save some trees in general.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseCOMPACT_RTF = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will contain hyperlink fields. The RTF file will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# contain links (just like the HTML output) instead of page references.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# This makes the output suitable for online browsing using WORD or other
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# programs which support those fields.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Note: wordpad (write) and others do not support links.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseRTF_HYPERLINKS = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Load stylesheet definitions from file. Syntax is similar to doxygen's
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# config file, i.e. a series of assignments. You only have to provide
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# replacements, missing definitions are set to their default value.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseRTF_STYLESHEET_FILE =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Set optional variables used in the generation of an rtf document.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Syntax is similar to doxygen's config file.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseRTF_EXTENSIONS_FILE =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# configuration options related to the man page output
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# generate man pages
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseGENERATE_MAN = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The MAN_OUTPUT tag is used to specify where the man pages will be put.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If a relative path is entered the value of OUTPUT_DIRECTORY will be
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# put in front of it. If left blank `man' will be used as the default path.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseMAN_OUTPUT = man
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The MAN_EXTENSION tag determines the extension that is added to
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the generated man pages (default is the subroutine's section .3)
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseMAN_EXTENSION = .3
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# then it will generate one additional man file for each entity
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# documented in the real man page(s). These additional files
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# only source the real man page, but without them the man command
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# would be unable to find the correct page. The default is NO.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseMAN_LINKS = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# configuration options related to the XML output
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the GENERATE_XML tag is set to YES Doxygen will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# generate an XML file that captures the structure of
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the code including all documentation.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseGENERATE_XML = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The XML_OUTPUT tag is used to specify where the XML pages will be put.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If a relative path is entered the value of OUTPUT_DIRECTORY will be
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# put in front of it. If left blank `xml' will be used as the default path.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseXML_OUTPUT = xml
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The XML_SCHEMA tag can be used to specify an XML schema,
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# which can be used by a validating XML parser to check the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# syntax of the XML files.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The XML_DTD tag can be used to specify an XML DTD,
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# which can be used by a validating XML parser to check the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# syntax of the XML files.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# dump the program listings (including syntax highlighting
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# and cross-referencing information) to the XML output. Note that
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# enabling this will significantly increase the size of the XML output.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseXML_PROGRAMLISTING = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# configuration options for the AutoGen Definitions output
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# generate an AutoGen Definitions (see autogen.sf.net) file
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# that captures the structure of the code including all
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# documentation. Note that this feature is still experimental
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# and incomplete at the moment.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseGENERATE_AUTOGEN_DEF = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# configuration options related to the Perl module output
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the GENERATE_PERLMOD tag is set to YES Doxygen will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# generate a Perl module file that captures the structure of
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the code including all documentation. Note that this
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# feature is still experimental and incomplete at the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseGENERATE_PERLMOD = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the necessary Makefile rules, Perl scripts and LaTeX code to be able
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# to generate PDF and DVI output from the Perl module output.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BosePERLMOD_LATEX = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# nicely formatted so it can be parsed by a human reader.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# This is useful
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# if you want to understand what is going on.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# On the other hand, if this
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# tag is set to NO the size of the Perl module output will be much smaller
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# and Perl will parse it just the same.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BosePERLMOD_PRETTY = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The names of the make variables in the generated doxyrules.make file
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# This is useful so different doxyrules.make files included by the same
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Makefile don't overwrite each other's variables.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BosePERLMOD_MAKEVAR_PREFIX =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Configuration options related to the preprocessor
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# evaluate all C-preprocessor directives found in the sources and include
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseENABLE_PREPROCESSING = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# names in the source code. If set to NO (the default) only conditional
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# compilation will be performed. Macro expansion can be done in a controlled
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# way by setting EXPAND_ONLY_PREDEF to YES.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseMACRO_EXPANSION = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# then the macro expansion is limited to the macros specified with the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# PREDEFINED and EXPAND_AS_DEFINED tags.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseEXPAND_ONLY_PREDEF = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# in the INCLUDE_PATH (see below) will be search if a #include is found.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSEARCH_INCLUDES = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The INCLUDE_PATH tag can be used to specify one or more directories that
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# contain include files that are not input files but should be processed by
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the preprocessor.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseINCLUDE_PATH =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# patterns (like *.h and *.hpp) to filter out the header-files in the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# directories. If left blank, the patterns specified with FILE_PATTERNS will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseINCLUDE_FILE_PATTERNS =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The PREDEFINED tag can be used to specify one or more macro names that
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# are defined before the preprocessor is started (similar to the -D option of
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# gcc). The argument of the tag is a list of macros of the form: name
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# or name=definition (no spaces). If the definition and the = are
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# omitted =1 is assumed. To prevent a macro definition from being
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# undefined via #undef or recursively expanded use the := operator
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# instead of the = operator.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BosePREDEFINED = DOXYGEN
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# this tag can be used to specify a list of macro names that should be expanded.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The macro definition that is found in the sources will be used.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Use the PREDEFINED tag if you want to use a different macro definition.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseEXPAND_AS_DEFINED =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# doxygen's preprocessor will remove all function-like macros that are alone
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# on a line, have an all uppercase name, and do not end with a semicolon. Such
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# function macros are typically used for boiler-plate code, and will confuse
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the parser if not removed.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseSKIP_FUNCTION_MACROS = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Configuration::additions related to external references
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The TAGFILES option can be used to specify one or more tagfiles.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Optionally an initial location of the external documentation
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# can be added for each tagfile. The format of a tag file without
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# this location is as follows:
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# TAGFILES = file1 file2 ...
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Adding location for the tag files is done as follows:
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# TAGFILES = file1=loc1 "file2 = loc2" ...
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# where "loc1" and "loc2" can be relative or absolute paths or
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# URLs. If a location is present for each tag, the installdox tool
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# does not have to be run to correct the links.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Note that each tag file must have a unique name
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# (where the name does NOT include the path)
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If a tag file is not located in the directory in which doxygen
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# is run, you must also specify the path to the tagfile here.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# When a file name is specified after GENERATE_TAGFILE, doxygen will create
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# a tag file that is based on the input files it reads.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseGENERATE_TAGFILE =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the ALLEXTERNALS tag is set to YES all external classes will be listed
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# in the class index. If set to NO only the inherited external classes
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will be listed.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseALLEXTERNALS = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# in the modules index. If set to NO, only the current project's groups will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseEXTERNAL_GROUPS = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The PERL_PATH should be the absolute path and name of the perl script
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# interpreter (i.e. the result of `which perl').
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Configuration options related to the dot tool
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose#---------------------------------------------------------------------------
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# or super classes. Setting the tag to NO turns the diagrams off. Note that
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# this option is superseded by the HAVE_DOT option below. This is only a
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# fallback. It is recommended to install and use dot, since it yields more
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# powerful graphs.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseCLASS_DIAGRAMS = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# You can define message sequence charts within doxygen comments using the \msc
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# command. Doxygen will then run the mscgen tool (see
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the mscgen tool resides. If left empty the tool is assumed to be found in the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# default search path.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseMSCGEN_PATH =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If set to YES, the inheritance and collaboration graphs will hide
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# inheritance and usage relations if the target is undocumented
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# or is not a class.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseHIDE_UNDOC_RELATIONS = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# available from the path. This tool is part of Graphviz, a graph visualization
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# toolkit from AT&T and Lucent Bell Labs. The other options in this section
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# have no effect if this option is set to NO (the default)
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseHAVE_DOT = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# By default doxygen will write a font called FreeSans.ttf to the output
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# directory and reference it in all dot files that doxygen generates. This
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# font does not include all possible unicode characters however, so when you need
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# these (or just want a differently looking font) you can specify the font name
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# which can be done by putting it in a standard location or by setting the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# containing the font.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseDOT_FONTNAME = FreeSans
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The default size is 10pt.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseDOT_FONTSIZE = 10
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# By default doxygen will tell dot to use the output directory to look for the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# FreeSans.ttf font (which doxygen will put there itself). If you specify a
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# different font using DOT_FONTNAME you can set the path where dot
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# can find it using this tag.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseDOT_FONTPATH =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will generate a graph for each documented class showing the direct and
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# indirect inheritance relations. Setting this tag to YES will force the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the CLASS_DIAGRAMS tag to NO.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseCLASS_GRAPH = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will generate a graph for each documented class showing the direct and
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# indirect implementation dependencies (inheritance, containment, and
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# class references variables) of the class with other documented classes.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseCOLLABORATION_GRAPH = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will generate a graph for groups, showing the direct groups dependencies
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseGROUP_GRAPHS = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# collaboration diagrams in a style similar to the OMG's Unified Modeling
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseUML_LOOK = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If set to YES, the inheritance and collaboration graphs will show the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# relations between templates and their instances.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseTEMPLATE_RELATIONS = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# tags are set to YES then doxygen will generate a graph for each documented
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# file showing the direct and indirect include dependencies of the file with
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# other documented files.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseINCLUDE_GRAPH = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# documented header file showing the documented files that directly or
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# indirectly include this file.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseINCLUDED_BY_GRAPH = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the CALL_GRAPH and HAVE_DOT options are set to YES then
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# doxygen will generate a call dependency graph for every global function
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# or class method. Note that enabling this option will significantly increase
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the time of a run. So in most cases it will be better to enable call graphs
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# for selected functions only using the \callgraph command.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseCALL_GRAPH = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# doxygen will generate a caller dependency graph for every global function
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# or class method. Note that enabling this option will significantly increase
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the time of a run. So in most cases it will be better to enable caller
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# graphs for selected functions only using the \callergraph command.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseCALLER_GRAPH = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# will graphical hierarchy of all classes instead of a textual one.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseGRAPHICAL_HIERARCHY = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# then doxygen will show the dependencies a directory has on other directories
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# in a graphical way. The dependency relations are determined by the #include
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# relations between the files in the directories.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseDIRECTORY_GRAPH = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# generated by dot. Possible values are png, jpg, or gif
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If left blank png will be used.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseDOT_IMAGE_FORMAT = png
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The tag DOT_PATH can be used to specify the path where the dot tool can be
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# found. If left blank, it is assumed the dot tool can be found in the path.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The DOTFILE_DIRS tag can be used to specify one or more directories that
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# contain dot files that are included in the documentation (see the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# \dotfile command).
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseDOTFILE_DIRS =
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# nodes that will be shown in the graph. If the number of nodes in a graph
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# becomes larger than this value, doxygen will truncate the graph, which is
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# visualized by representing a node as a red box. Note that doxygen if the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# number of direct children of the root node in a graph is already larger than
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseDOT_GRAPH_MAX_NODES = 50
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# graphs generated by dot. A depth value of 3 means that only nodes reachable
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# from the root by following a path via at most 3 edges will be shown. Nodes
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# that lay further from the root node will be omitted. Note that setting this
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# option to 1 or 2 may greatly reduce the computation time needed for large
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# code bases. Also note that the size of a graph can be further restricted by
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseMAX_DOT_GRAPH_DEPTH = 0
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# background. This is disabled by default, because dot on Windows does not
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# seem to support this out of the box. Warning: Depending on the platform used,
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# enabling this option may lead to badly anti-aliased labels on the edges of
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# a graph (i.e. they become hard to read).
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseDOT_TRANSPARENT = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# files in one run (i.e. multiple -o and -T options on the command line). This
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# makes dot run faster, but since only newer versions of dot (>1.8.10)
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# support this, this feature is disabled by default.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseDOT_MULTI_TARGETS = NO
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# generate a legend page explaining the meaning of the various boxes and
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# arrows in the dot generated graphs.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseGENERATE_LEGEND = YES
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# remove the intermediate dot files that are used to generate
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit Bose# the various graphs.
2a9af1f71887f02935e2fb6ad5023afba5b6d43eSumit BoseDOT_CLEANUP = YES