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