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