RhodeCode

# Doxyfile 1.4.2

# This file describes the settings to be used by the documentation system

# doxygen (www.doxygen.org) for a project

#

# All text after a hash (#) is considered a comment and will be ignored

# The format is:

#       TAG = value [value, ...]

# For lists items can also be appended using:

#       TAG += value [value, ...]

# Values that contain spaces should be placed between quotes (" ")

# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 

# by quotes) that should identify the project.

# The PROJECT_NUMBER tag can be used to enter a project or revision number. 

# This could be handy for archiving the generated documentation or 

# if some version control system is used.

# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 

# base path where the generated documentation will be put. 

# If a relative path is entered, it will be relative to the location 

# where doxygen was started. If left blank the current directory will be used.

# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 

# 4096 sub-directories (in 2 levels) under the output directory of each output 

# format and will distribute the generated files over these directories. 

# Enabling this option can be useful when feeding doxygen a huge amount of 

# source files, where putting all generated files in the same directory would 

# otherwise cause performance problems for the file system.

# The OUTPUT_LANGUAGE tag is used to specify the language in which all 

# documentation generated by doxygen is written. Doxygen will use this 

# information to generate all constant output in the proper language. 

# The default language is English, other supported languages are: 

# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, 

# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, 

# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, 

# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 

# Swedish, and Ukrainian.

# This tag can be used to specify the encoding used in the generated output. 

# The encoding is not always determined by the language that is chosen, 

# but also whether or not the output is meant for Windows or non-Windows users. 

# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 

# forces the Windows encoding (this is the default for the Windows binary), 

# whereas setting the tag to NO uses a Unix-style encoding (the default for 

# all platforms other than Windows).

USE_WINDOWS_ENCODING   = NO

# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 

# include brief member descriptions after the members that are listed in 

# the file and class documentation (similar to JavaDoc). 

# Set to NO to disable this.

# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 

# the brief description of a member or function before the detailed description. 

# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 

# brief descriptions will be completely suppressed.

# This tag implements a quasi-intelligent brief description abbreviator 

# that is used to form the text in various listings. Each string 

# in this list, if found as the leading text of the brief description, will be 

# stripped from the text and the result after processing the whole list, is 

# used as the annotated text. Otherwise, the brief description is used as-is. 

# If left blank, the following values are used ("$name" is automatically 

# replaced with the name of the entity): "The $name class" "The $name widget" 

# "The $name file" "is" "provides" "specifies" "contains" 

# "represents" "a" "an" "the"

# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 

# Doxygen will generate a detailed section even if there is only a brief 

# description.

# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 

# inherited members of a class in the documentation of that class as if those 

# members were ordinary class members. Constructors, destructors and assignment 

# operators of the base classes will not be shown.

# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 

# path before files name in the file list and in the header files. If set 

# to NO the shortest path that makes the file name unique will be used.

# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 

# can be used to strip a user-defined part of the path. Stripping is 

# only done if one of the specified strings matches the left-hand part of 

# the path. The tag can be used to show relative paths in the file list. 

# If left blank the directory from which doxygen is run is used as the 

# path to strip.

# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 

# the path mentioned in the documentation of a class, which tells 

# the reader which header file to include in order to use a class. 

# If left blank only the name of the header file containing the class 

# definition is used. Otherwise one should specify the include paths that 

# are normally passed to the compiler using the -I flag.

# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 

# (but less readable) file names. This can be useful is your file systems 

# doesn't support long names like on DOS, Mac, or CD-ROM.

# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 

# will interpret the first line (until the first dot) of a JavaDoc-style 

# comment as the brief description. If set to NO, the JavaDoc 

# comments will behave just like the Qt-style comments (thus requiring an 

# explicit @brief command for a brief description.

# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 

# treat a multi-line C++ special comment block (i.e. a block of //! or /// 

# comments) as a brief description. This used to be the default behaviour. 

# The new default is to treat a multi-line C++ comment block as a detailed 

# description. Set this tag to YES if you prefer the old behaviour instead.

# If the DETAILS_AT_TOP tag is set to YES then Doxygen 

# will output the detailed description near the top, like JavaDoc.

# If set to NO, the detailed description appears after the member 

# documentation.

# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 

# member inherits the documentation from any documented member that it 

# re-implements.

# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 

# tag is set to YES, then doxygen will reuse the documentation of the first 

# member in the group (if any) for the other members of the group. By default 

# all members of a group must be documented explicitly.

# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 

# a new page for each member. If set to NO, the documentation of a member will 

# be part of the file/class/namespace that contains it.

SEPARATE_MEMBER_PAGES  = NO

# The TAB_SIZE tag can be used to set the number of spaces in a tab. 

# Doxygen uses this value to replace tabs by spaces in code fragments.

TAB_SIZE               = 8

# This tag can be used to specify a number of aliases that acts 

# as commands in the documentation. An alias has the form "name=value". 

# For example adding "sideeffect=\par Side Effects:\n" will allow you to 

# put the command \sideeffect (or @sideeffect) in the documentation, which 

# will result in a user-defined paragraph with heading "Side Effects:". 

# You can put \n's in the value part of an alias to insert newlines.

ALIASES                = 

# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 

# sources only. Doxygen will then generate output that is more tailored for C. 

# For instance, some of the names that are used will be different. The list 

# of all members will be omitted, etc.

OPTIMIZE_OUTPUT_FOR_C  = NO

# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 

# only. Doxygen will then generate output that is more tailored for Java. 

# For instance, namespaces will be presented as packages, qualified scopes 

# will look different, etc.

OPTIMIZE_OUTPUT_JAVA   = NO

# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 

# the same type (for instance a group of public functions) to be put as a 

# subgroup of that type (e.g. under the Public Functions section). Set it to 

# NO to prevent subgrouping. Alternatively, this can be done per class using 

# the \nosubgrouping command.

# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 

# documentation are documented, even if no documentation was available. 

# Private class members and static file members will be hidden unless 

# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 

# will be included in the documentation.

# If the EXTRACT_STATIC tag is set to YES all static members of a file 

# will be included in the documentation.

# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 

# defined locally in source files will be included in the documentation. 

# If set to NO only classes defined in header files are included.

# This flag is only useful for Objective-C code. When set to YES local 

# methods, which are defined in the implementation section but not in 

# the interface are included in the documentation. 

# If set to NO (the default) only methods in the interface are included.

# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 

# undocumented members of documented classes, files or namespaces. 

# If set to NO (the default) these members will be included in the 

# various overviews, but no documentation section is generated. 

# This option has no effect if EXTRACT_ALL is enabled.

# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 

# undocumented classes that are normally visible in the class hierarchy. 

# If set to NO (the default) these classes will be included in the various 

# overviews. This option has no effect if EXTRACT_ALL is enabled.

# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 

# friend (class|struct|union) declarations. 

# If set to NO (the default) these declarations will be included in the 

# documentation.

# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 

# documentation blocks found inside the body of a function. 

# If set to NO (the default) these blocks will be appended to the 

# function's detailed documentation block.

# The INTERNAL_DOCS tag determines if documentation 

# that is typed after a \internal command is included. If the tag is set 

# to NO (the default) then the documentation will be excluded. 

# Set it to YES to include the internal documentation.

INTERNAL_DOCS          = @DOXYGEN_INTERNAL_DOCS@

# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 

# file names in lower-case letters. If set to YES upper-case letters are also 

# allowed. This is useful if you have classes or files whose names only differ 

# in case and if your file system supports case sensitive file names. Windows 

# and Mac users are advised to set this option to NO.

# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 

# will show members with their full class and namespace scopes in the 

# documentation. If set to YES the scope will be hidden.

# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 

# will put a list of the files that are included by a file in the documentation 

# of that file.

# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 

# is inserted in the documentation for inline members.

# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 

# will sort the (detailed) documentation of file and class members 

# alphabetically by member name. If set to NO the members will appear in 

# declaration order.

# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 

# brief documentation of file, namespace and class members alphabetically 

# by member name. If set to NO (the default) the members will appear in 

# declaration order.

# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 

# sorted by fully-qualified names, including namespaces. If set to 

# NO (the default), the class list will be sorted only by class name, 

# not including the namespace part. 

# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.

# Note: This option applies only to the class list, not to the 

# alphabetical list.

# The GENERATE_TODOLIST tag can be used to enable (YES) or 

# disable (NO) the todo list. This list is created by putting \todo 

# commands in the documentation.

# The GENERATE_TESTLIST tag can be used to enable (YES) or 

# disable (NO) the test list. This list is created by putting \test 

# commands in the documentation.

# The GENERATE_BUGLIST tag can be used to enable (YES) or 

# disable (NO) the bug list. This list is created by putting \bug 

# commands in the documentation.

# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 

# disable (NO) the deprecated list. This list is created by putting 

# \deprecated commands in the documentation.

# The ENABLED_SECTIONS tag can be used to enable conditional 

# documentation sections, marked by \if sectionname ... \endif.

# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 

# the initial value of a variable or define consists of for it to appear in 

# the documentation. If the initializer consists of more lines than specified 

# here it will be hidden. Use a value of 0 to hide initializers completely. 

# The appearance of the initializer of individual variables and defines in the 

# documentation can be controlled using \showinitializer or \hideinitializer 

# command in the documentation regardless of this setting.

# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 

# at the bottom of the documentation of classes and structs. If set to YES the 

# list will mention the files that were used to generate the documentation.

# If the sources in your project are distributed over multiple directories 

# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 

# in the documentation.

# The FILE_VERSION_FILTER tag can be used to specify a program or script that 

# doxygen should invoke to get the current version for each file (typically from the 

# version control system). Doxygen will invoke the program by executing (via 

# popen()) the command <command> <input-file>, where <command> is the value of 

# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 

# provided by doxygen. Whatever the progam writes to standard output 

# is used as the file version. See the manual for examples.

# The QUIET tag can be used to turn on/off the messages that are generated 

# by doxygen. Possible values are YES and NO. If left blank NO is used.

# The WARNINGS tag can be used to turn on/off the warning messages that are 

# generated by doxygen. Possible values are YES and NO. If left blank 

# NO is used.

# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 

# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 

# automatically be disabled.

# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 

# potential errors in the documentation, such as not documenting some 

# parameters in a documented function, or documenting parameters that 

# don't exist or using markup commands wrongly.

# This WARN_NO_PARAMDOC option can be abled to get warnings for 

# functions that are documented, but have no documentation for their parameters 

# or return value. If set to NO (the default) doxygen will only warn about 

# wrong or incomplete parameter documentation, but not about the absence of 

# documentation.

# The WARN_FORMAT tag determines the format of the warning messages that 

# doxygen can produce. The string should contain the $file, $line, and $text 

# tags, which will be replaced by the file and line number from which the 

# warning originated and the warning text. Optionally the format may contain 

# $version, which will be replaced by the version of the file (if it could 

# be obtained via FILE_VERSION_FILTER)

# The WARN_LOGFILE tag can be used to specify a file to which warning 

# and error messages should be written. If left blank the output is written 

# to stderr.

# The INPUT tag can be used to specify the files and/or directories that contain 

# documented source files. You may enter file names like "myfile.cpp" or 

# directories like "/usr/src/myproject". Separate the files or directories 

# with spaces.

# If the value of the INPUT tag contains directories, you can use the 

# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 

# and *.h) to filter out the source-files in the directories. If left 

# blank the following patterns are tested: 

# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 

# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm

FILE_PATTERNS          = *.h *.cc *.dox

# The RECURSIVE tag can be used to turn specify whether or not subdirectories 

# should be searched for input files as well. Possible values are YES and NO. 

# If left blank NO is used.

# The EXCLUDE tag can be used to specify files and/or directories that should 

# excluded from the INPUT source files. This way you can easily exclude a 

# subdirectory from a directory tree whose root is specified with the INPUT tag.

# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 

# directories that are symbolic links (a Unix filesystem feature) are excluded 

# from the input.

# If the value of the INPUT tag contains directories, you can use the 

# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 

# certain files from those directories.

# The EXAMPLE_PATH tag can be used to specify one or more files or 

# directories that contain example code fragments that are included (see 

# the \include command).

# If the value of the EXAMPLE_PATH tag contains directories, you can use the 

# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 

# and *.h) to filter out the source-files in the directories. If left 

# blank all files are included.

# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 

# searched for input files to be used with the \include or \dontinclude 

# commands irrespective of the value of the RECURSIVE tag. 

# Possible values are YES and NO. If left blank NO is used.

# The IMAGE_PATH tag can be used to specify one or more files or 

# directories that contain image that are included in the documentation (see 

# the \image command).

IMAGE_PATH             = @abs_top_srcdir@/doc/images

# The INPUT_FILTER tag can be used to specify a program that doxygen should 

# invoke to filter for each input file. Doxygen will invoke the filter program 

# by executing (via popen()) the command <filter> <input-file>, where <filter> 

# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 

# input file. Doxygen will then use the output that the filter program writes 

# to standard output.  If FILTER_PATTERNS is specified, this tag will be 

# ignored.

# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 

# basis.  Doxygen will compare the file name with each pattern and apply the 

# filter if there is a match.  The filters are a list of the form: 

# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 

# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 

# is applied to all files.

# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 

# INPUT_FILTER) will be used to filter the input files when producing source 

# files to browse (i.e. when SOURCE_BROWSER is set to YES).

# If the SOURCE_BROWSER tag is set to YES then a list of source files will 

# be generated. Documented entities will be cross-referenced with these sources. 

# Note: To get rid of all source code in the generated output, make sure also 

# VERBATIM_HEADERS is set to NO.

# Setting the INLINE_SOURCES tag to YES will include the body 

# of functions and classes directly in the documentation.

# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 

# doxygen to hide any special comment blocks from generated source code 

# fragments. Normal C and C++ comments will always remain visible.

# If the REFERENCED_BY_RELATION tag is set to YES (the default) 

# then for each documented function all documented 

# functions referencing it will be listed.

# If the REFERENCES_RELATION tag is set to YES (the default) 

# then for each documented function all documented entities 

# called/used by that function will be listed.

# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 

# will generate a verbatim copy of the header file for each class for 

# which an include is specified. Set to NO to disable this.

# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 

# of all compounds will be generated. Enable this if the project 

# contains a lot of classes, structs, unions or interfaces.

# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 

# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 

# in which this list will be split (can be a number in the range [1..20])

# In case all classes in a project start with a common prefix, all 

# classes will be put under the same header in the alphabetical index. 

# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 

# should be ignored while generating the index headers.

# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 

# generate HTML output.

# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 

# If a relative path is entered the value of OUTPUT_DIRECTORY will be 

# put in front of it. If left blank `html' will be used as the default path.

# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 

# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 

# doxygen will generate files with .html extension.

# The HTML_HEADER tag can be used to specify a personal HTML header for 

# each generated HTML page. If it is left blank doxygen will generate a 

# standard header.

# The HTML_FOOTER tag can be used to specify a personal HTML footer for 

# each generated HTML page. If it is left blank doxygen will generate a 

# standard footer.

# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 

# style sheet that is used by each HTML page. It can be used to 

# fine-tune the look of the HTML output. If the tag is left blank doxygen 

# will generate a default style sheet. Note that doxygen will try to copy 

# the style sheet file to the HTML output directory, so don't put your own 

# stylesheet in the HTML output directory as well, or it will be erased!

# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 

# files or namespaces will be aligned in HTML using tables. If set to 

# NO a bullet list will be used.

# If the GENERATE_HTMLHELP tag is set to YES, additional index files 

# will be generated that can be used as input for tools like the 

# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 

# of the generated HTML documentation.

# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 

# be used to specify the file name of the resulting .chm file. You 

# can add a path in front of the file if the result should not be 

# written to the html output directory.

# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 

# be used to specify the location (absolute path including file name) of 

# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 

# the HTML help compiler on the generated index.hhp.

# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 

# controls if a separate .chi index file is generated (YES) or that 

# it should be included in the master .chm file (NO).

# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 

# controls whether a binary table of contents is generated (YES) or a 

# normal table of contents (NO) in the .chm file.

# The TOC_EXPAND flag can be set to YES to add extra items for group members 

# to the contents of the HTML help documentation and to the tree view.

# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 

# top of each HTML page. The value NO (the default) enables the index and 

# the value YES disables it.

# This tag can be used to set the number of enum values (range [1..20]) 

# that doxygen will group on one line in the generated HTML documentation.

# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be

# generated containing a tree-like index structure (just like the one that 

# is generated for HTML Help). For this to work a browser that supports 

# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 

# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 

# probably better off using the HTML help feature.