~ubuntu-branches/ubuntu/saucy/rivet/saucy-proposed

# Doxyfile 1.8.1.2

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

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

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

# The PROJECT_NAME tag is a single word (or sequence of words) that should

# identify the project. Note that if you do not use Doxywizard you need

# to put quotes around the project name if it contains spaces.

# Using the PROJECT_BRIEF tag one can provide an optional one line description

# for a project that appears at the top of each page and should give viewer

# a quick idea about the purpose of the project. Keep the description short.

 

PROJECT_BRIEF          =

 

# With the PROJECT_LOGO tag one can specify an logo or icon that is

# included in the documentation. The maximum height of the logo should not

# exceed 55 pixels and the maximum width should not exceed 200 pixels.

# Doxygen will copy the logo to the output directory.

 

PROJECT_LOGO           =

 

# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,

# (but less readable) file names. This can be useful if your file system

# This tag can be used to specify a number of word-keyword mappings (TCL only).

# A mapping has the form "name=value". For example adding

# "class=itcl::class" will allow you to use the command class in the

# itcl::class meaning.

 

TCL_SUBST              =

 

# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all

# comments according to the Markdown format, which allows for more readable

# documentation. See http://daringfireball.net/projects/markdown/ for details.

# The output of markdown processing is further processed by doxygen, so you

# can mix doxygen, HTML, and XML commands with Markdown formatting.

# Disable only in case of backward compatibilities issues.

 

MARKDOWN_SUPPORT       = YES

 

# func(std::string) {}). This also makes the inheritance and collaboration

# will make doxygen replace the get and set methods by a property in the

# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and

# unions are shown inside the group in which they are included (e.g. using

# @ingroup) instead of on a separate page (for HTML and Man pages) or

# section (for LaTeX and RTF).

 

INLINE_GROUPED_CLASSES = NO

 

# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and

# unions with only public data fields will be shown inline in the documentation

# of the scope in which they are defined (i.e. file, namespace, or group

# documentation), provided this scope is documented. If set to NO (the default),

# structs, classes, and unions are shown on a separate page (for HTML and Man

# pages) or section (for LaTeX and RTF).

 

INLINE_SIMPLE_STRUCTS  = NO

 

# causing a significant performance penalty.

# a logarithmic scale so increasing the size by one will roughly double the

# corresponding to a cache size of 2^16 = 65536 symbols.

# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be

# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given

# their name and scope. Since this can be an expensive process and often the

# same symbol appear multiple times in the code, doxygen keeps a cache of

# pre-resolved symbols. If the cache is too small doxygen will become slower.

# If the cache is too large, memory is wasted. The cache size is given by this

# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,

# corresponding to a cache size of 2^16 = 65536 symbols.

 

LOOKUP_CACHE_SIZE      = 0

 

# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation.

 

EXTRACT_PACKAGE        = NO

 

# anonymous namespaces are hidden.

# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to

# do proper type resolution of all parameters of a function it will reject a

# match between the prototype and the implementation of a member function even

# if there is only one candidate or it is obvious which candidate to choose

# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen

# will still accept a match between prototype and implementation in such cases.

 

STRICT_PROTO_MATCHING  = NO

 

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

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

# output files in an output format independent way. To create the layout file

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

# containing the references data. This must be a list of .bib files. The

# .bib extension is automatically appended if omitted. Using this command

# requires the bibtex tool to be installed. See also

# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style

# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this

# feature you need bibtex and perl available in the search path.

 

CITE_BIB_FILES         =

 

# The WARN_NO_PARAMDOC option can be enabled to get warnings for

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

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

# *.f90 *.f *.for *.vhd *.vhdl

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

# Note that relative paths are relative to the directory from which doxygen is

# run.

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

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

# info on how filters are used. If FILTER_PATTERNS is empty or if

# non of the patterns match the file name, INPUT_FILTER is applied.

# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file

# pattern. A pattern will override the setting for FILTER_PATTERN (if any)

# and it is also possible to disable source filtering for a specific pattern

# using *.ext= (so without naming a filter). This option only has effect when

# FILTER_SOURCE_FILES is enabled.

 

FILTER_SOURCE_PATTERNS =

 

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

# standard header. Note that when using a custom header you are responsible

#  for the proper inclusion of any scripts and style sheets that doxygen

# needs, which is dependent on the configuration options used.

# It is advised to generate a default header using "doxygen -w html

# header.html footer.html stylesheet.css YourConfigFile" and then modify

# that header. Note that the header is subject to change so you typically

# have to redo this when upgrading to a newer version of doxygen or when

# changing the value of configuration settings such as GENERATE_TREEVIEW!

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

# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or

# other source files which should be copied to the HTML output directory. Note

# that these files will be copied to the base HTML output directory. Use the

# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these

# files. In the HTML_STYLESHEET file, use the file name only. Also note that

# the files will be copied as-is; there are no commands or markers available.

 

HTML_EXTRA_FILES       =

 

# Doxygen will adjust the colors in the style sheet and background images

# page has loaded.

# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of

# entries shown in the various tree structured indices initially; the user

# can expand and collapse entries dynamically later on. Doxygen will expand

# the tree to such a level that at most the specified number of entries are

# visible (unless a fully collapsed tree already exceeds this amount).

# So setting the number of entries 1 will produce a full collapsed tree by

# default. 0 is a special value representing an infinite number of entries

# and will result in a full expanded tree by default.

 

HTML_INDEX_NUM_ENTRIES = 100

 

# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)

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

# the value YES disables it. Since the tabs have the same information as the

# navigation tree you can set this option to NO if you already set

# GENERATE_TREEVIEW to YES.

# Since the tree basically has the same information as the tab index you

# could consider to set DISABLE_INDEX to NO when enabling this option.

# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values

# (range [0,1..20]) that doxygen will group on one line in the generated HTML

# documentation. Note that a value of 0 will completely suppress the enum

# values from appearing in the overview section.

ENUM_VALUES_PER_LINE   = 4

# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax

# (see http://www.mathjax.org) which uses client side Javascript for the

# rendering instead of using prerendered bitmaps. Use this if you do not

# have LaTeX installed or if you want to formulas look prettier in the HTML

# output. When enabled you may also need to install MathJax separately and

# configure the path to it using the MATHJAX_RELPATH option.

 

USE_MATHJAX            = NO

 

# When MathJax is enabled you need to specify the location relative to the

# HTML output directory using the MATHJAX_RELPATH option. The destination

# directory should contain the MathJax.js script. For instance, if the mathjax

# directory is located at the same level as the HTML output directory, then

# MATHJAX_RELPATH should be ../mathjax. The default value points to

# the MathJax Content Delivery Network so you can quickly see the result without

# installing MathJax.

# However, it is strongly recommended to install a local

# copy of MathJax from http://www.mathjax.org before deployment.

 

MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest

 

# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension

# names that should be enabled during MathJax rendering.

 

MATHJAX_EXTENSIONS     =

 

# full text search. The disadvantages are that it is more difficult to setup

# by the printer. Possible values are: a4, letter, legal and

# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for

# the generated latex document. The footer should contain everything after

# the last chapter. If it is left blank doxygen will generate a

# standard footer. Notice: only use this tag if you know what you are doing!

 

LATEX_FOOTER           =

 

# The LATEX_BIB_STYLE tag can be used to specify the style to use for the

# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See

# http://en.wikipedia.org/wiki/BibTeX for more info.

 

LATEX_BIB_STYLE        = plain

 

# Load style sheet definitions from file. Syntax is similar to doxygen's

# pointed to by INCLUDE_PATH will be searched when a #include is found.

# Use the PREDEFINED tag if you want to use a different macro definition that

# overrules the definition found in the source code.

# doxygen's preprocessor will remove all references to function-like macros

# that are alone on a line, have an all uppercase name, and do not end with a

# semicolon, because these will confuse the parser if not removed.

# The TAGFILES option can be used to specify one or more tagfiles. For each

# tag file the location of the external documentation should be added. The

# format of a tag file without this location is as follows:

# where "loc1" and "loc2" can be relative or absolute paths

# or URLs. Note that each tag file must have a unique name (where the name does

# NOT include the path). If a tag file is not located in the directory in which

# doxygen is run, you must also specify the path to the tagfile here.

# this option also works with HAVE_DOT disabled, but it is recommended to

# install and use dot, since it yields more powerful graphs.

# By default doxygen will use the Helvetica font for all dot files that

# doxygen generates. When you want a differently looking font you can specify

# the font name using DOT_FONTNAME. You need to make sure dot is able to find

# the font, which can be done by putting it in a standard location or by setting

# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the

# directory containing the font.

# By default doxygen will tell dot to use the Helvetica font.

# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to

# set the path where dot can find it.

# CLASS_DIAGRAMS tag to NO.

# If the UML_LOOK tag is enabled, the fields and methods are shown inside

# the class node. If there are many fields or methods and many nodes the

# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS

# threshold limits the number of items for each type to make the size more

# managable. Set this to 0 for no limit. Note that the threshold may be

# exceeded by 50% before the limit is enforced.

 

UML_LIMIT_NUM_FIELDS   = 10

 

# will generate a graphical hierarchy of all classes instead of a textual one.

# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES

# generated by dot. Possible values are svg, png, jpg, or gif.

# If left blank png will be used. If you choose svg you need to set

# HTML_FILE_EXTENSION to xhtml in order to make the SVG files

# visible in IE 9+ (other browsers do not have this requirement).

# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to

# enable generation of interactive SVG images that allow zooming and panning.

# Note that this requires a modern browser other than Internet Explorer.

# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you

# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files

# visible. Older versions of IE do not have SVG support.

 

INTERACTIVE_SVG        = NO

 

# The MSCFILE_DIRS tag can be used to specify one or more directories that

# contain msc files that are included in the documentation (see the

# \mscfile command).

 

MSCFILE_DIRS           =