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