~vbursian/research-assistant/trunk

 

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

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

# Project related configuration options

#---------------------------------------------------------------------------

 

# The default value is: UTF-8.

 

DOXYFILE_ENCODING      = UTF-8

 

PROJECT_BRIEF          = "Research Assistant: source code documentation"

 

 

PROJECT_LOGO           = RaEye_71x43.png

 

 

OUTPUT_DIRECTORY       =

 

# 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

 

CREATE_SUBDIRS         = NO

 

# 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.

 

OUTPUT_LANGUAGE        = English

 

# descriptions after the members that are listed in the file and class

# documentation (similar to Javadoc). Set to NO to disable this.

# The default value is: YES.

 

BRIEF_MEMBER_DESC      = YES

 

# 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

 

INLINE_INHERITED_MEMB  = NO

 

# 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

# The default value is: YES.

 

JAVADOC_AUTOBRIEF      = NO

 

# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first

# line (until the first dot) of a Qt-style comment as the brief description. If

# set to NO, the Qt-style will behave just like regular Qt-style comments (thus

 

INHERIT_DOCS           = YES

 

# The default value is: NO.

 

SEPARATE_MEMBER_PAGES  = NO

# 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

 

ALIASES                = "sotovarischam=@xrefitem sotovarischamkey \"Коментарий для со-разработчика\" \"Коментарии для сотоварищей по разработке\"" \

                         "macro=@xrefitem macrodefs \"Macro\" \"Macro list\"" \

 

OPTIMIZE_OUTPUT_VHDL   = NO

 

# Doxygen selects the parser to use depending on the extension of the files it

# parses. With this tag you can assign which parser to use for a given

# extension. Doxygen has a built-in mapping, but you can override or extend it

# using this tag. The format is ext=language, where ext is a file extension, and

#

#

# Note that for custom extensions you also need to set FILE_PATTERNS otherwise

# the files are not read by doxygen.

 

# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments

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

# 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

 

# When enabled doxygen tries to link words that correspond to documented

# classes, or namespaces to their corresponding documentation. Such a link can

# The default value is: YES.

 

AUTOLINK_SUPPORT       = YES

CPP_CLI_SUPPORT        = NO

 

# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:

# will parse them like normal C++ but will assume all classes use public instead

# of private inheritance when no explicit protection keyword is present.

# The default value is: NO.

IDL_PROPERTY_SUPPORT   = YES

 

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

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

# all members of a group must be documented explicitly.

# The default value is: NO.

 

DISTRIBUTE_GROUP_DOC   = NO

 

# Set the SUBGROUPING tag to YES 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

# Build related configuration options

#---------------------------------------------------------------------------

 

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

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

# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.

 

EXTRACT_ALL            = YES

 

# be included in the documentation.

# The default value is: NO.

 

EXTRACT_PRIVATE        = YES

 

# scope will be included in the documentation.

# The default value is: NO.

 

EXTRACT_PACKAGE        = NO

 

# included in the documentation.

# The default value is: NO.

 

EXTRACT_STATIC         = YES

 

# only classes defined in header files are included. Does not have any effect

# for Java sources.

# The default value is: YES.

 

EXTRACT_LOCAL_CLASSES  = YES

 

# which are defined in the implementation section but not in the interface are

# included.

# The default value is: NO.

 

 

# 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

# The default value is: NO.

 

HIDE_UNDOC_CLASSES     = NO

 

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

# The default value is: NO.

 

HIDE_FRIEND_COMPOUNDS  = NO

 

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

# blocks will be appended to the function's detailed documentation block.

# The default value is: NO.

 

INTERNAL_DOCS          = NO

 

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

# 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

# The default value is: system dependent.

 

CASE_SENSE_NAMES       = YES

 

# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with

# scope will be hidden.

# The default value is: NO.

 

HIDE_SCOPE_NAMES       = NO

 

# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of

# the files that are included by a file in the documentation of that file.

# The default value is: YES.

 

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

# (detailed) documentation of file and class members alphabetically by member

# The default value is: YES.

 

SORT_MEMBER_DOCS       = YES

 

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

# descriptions of file, namespace and class members alphabetically by member

# this will also influence the order of the classes in the class list.

# The default value is: NO.

 

 

STRICT_PROTO_MATCHING  = NO

 

# The default value is: YES.

 

GENERATE_TODOLIST      = YES

 

# The default value is: YES.

 

GENERATE_TESTLIST      = YES

 

# list. This list is created by putting \bug commands in the documentation.

# The default value is: YES.

 

GENERATE_BUGLIST       = YES

 

# the deprecated list. This list is created by putting \deprecated commands in

# the documentation.

# The default value is: YES.

MAX_INITIALIZER_LINES  = 30

 

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

# The default value is: YES.

 

SHOW_USED_FILES        = YES

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

# the reference definitions. This must be a list of .bib files. The .bib

# extension is automatically appended if omitted. This requires the bibtex tool

# 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

 

CITE_BIB_FILES         =

 

QUIET                  = YES

 

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

# this implies that the warnings are on.

#

# Tip: Turn warnings on while writing the documentation.

 

WARNINGS               = NO

 

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

# will automatically be disabled.

# The default value is: YES.

 

# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that

# are documented, but have no documentation for their parameters or return

# The default value is: NO.

 

WARN_NO_PARAMDOC       = NO

 

# 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

# The INPUT tag is 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

# Note: If this tag is empty the current directory is searched.

 

INPUT                  = ../

# This tag can be used to specify the character encoding of the source files

# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

# libiconv (or the iconv built into libc) for the transcoding. See the libiconv

# possible encodings.

# The default value is: UTF-8.

 

 

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

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

 

FILE_PATTERNS          = *.h \

                         *.cpp \

                         *.dox \

                         HistoryLog.txt

# run.

 

EXCLUDE                = ../RATests/ \

                         ../what-not/

 

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

# 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

# irrespective of the value of the RECURSIVE tag.

# The default value is: NO.

 

 

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

# that contain images that are to be included in the documentation (see the

# Note that the filter must not add or remove lines; it is applied before the

# code is scanned, but not when the output code is generated. If lines are added

# or removed, the anchors will not be placed correctly.

 

INPUT_FILTER           =

 

# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how

# filters are used. If the FILTER_PATTERNS tag is empty or if none of the

# patterns match the file name, INPUT_FILTER is applied.

 

FILTER_PATTERNS        =

 

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

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

# The default value is: NO.

 

STRIP_CODE_COMMENTS    = YES

 

# If the REFERENCED_BY_RELATION tag is set to YES then for each documented

# The default value is: NO.

 

REFERENCED_BY_RELATION = NO

REFERENCES_RELATION    = NO

 

# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set

# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will

# link to the documentation.

# The default value is: YES.

# If the USE_HTAGS tag is set to YES then the references to source code will

# point to the HTML generated by the htags(1) tool instead of doxygen built-in

# source browser. The htags tool is part of GNU's global source tagging system

# 4.8.6 or higher.

#

# To use it do the following:

# - Install the latest version of global

# - Make sure the INPUT points to the root of the source tree

# - Run doxygen as normal

#

 

VERBATIM_HEADERS       = NO

 

#---------------------------------------------------------------------------

# Configuration options related to the alphabetical class index

#---------------------------------------------------------------------------

# Configuration options related to the HTML output

#---------------------------------------------------------------------------

 

# The default value is: YES.

 

GENERATE_HTML          = YES

 

HTML_STYLESHEET        =

 

# created by doxygen. Using this option one can overrule certain style aspects.

# This is preferred over using HTML_STYLESHEET since it does not replace the

# This tag requires that the tag GENERATE_HTML is set to YES.

 

HTML_EXTRA_STYLESHEET  =

HTML_EXTRA_FILES       =

 

# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen

# this color. Hue is specified as an angle on a colorwheel, see

# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300

# purple, and 360 is red again.

# Minimum value: 0, maximum value: 359, default value: 220.

 

# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML

# page will contain the date and time when the page was generated. Setting this

# This tag requires that the tag GENERATE_HTML is set to YES.

 

HTML_TIMESTAMP         = YES

 

# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML

# documentation will contain sections that can be hidden and shown after the

# page has loaded.

 

# If the GENERATE_DOCSET tag is set to YES, additional index files will be

# generated that can be used as input for Apple's Xcode 3 integrated development

# Makefile in the HTML output directory. Running make will produce the docset in

# that directory and running make install will install the docset in

# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at

# The default value is: NO.

# This tag requires that the tag GENERATE_HTML is set to YES.

 

# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three

# additional HTML index files: index.hhp, index.hhc, and index.hhk. The

# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop

# Windows.

#

# The HTML Help Workshop contains a compiler that can convert all HTML output

CHM_FILE               =

 

# The HHC_LOCATION tag can be used to specify the location (absolute path

# doxygen will try to run the HTML help compiler on the generated index.hhp.

# The file has to be specified with full path.

# This tag requires that the tag GENERATE_HTMLHELP is set to YES.

 

HHC_LOCATION           =

 

# The default value is: NO.

# This tag requires that the tag GENERATE_HTMLHELP is set to YES.

 

GENERATE_CHI           = NO

 

# and project file content.

# This tag requires that the tag GENERATE_HTMLHELP is set to YES.

 

CHM_INDEX_ENCODING     =

 

# The default value is: NO.

# This tag requires that the tag GENERATE_HTMLHELP is set to YES.

 

 

# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help

# Project output. For more information please see Qt Help Project / Namespace

# The default value is: org.doxygen.Project.

# This tag requires that the tag GENERATE_QHP is set to YES.

 

 

# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt

# Help Project output. For more information please see Qt Help Project / Virtual

# folders).

# The default value is: doc.

# This tag requires that the tag GENERATE_QHP is set to YES.

 

# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom

# filter to add. For more information please see Qt Help Project / Custom

# filters).

# This tag requires that the tag GENERATE_QHP is set to YES.

 

 

# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the

# custom filter to add. For more information please see Qt Help Project / Custom

# filters).

# This tag requires that the tag GENERATE_QHP is set to YES.

 

 

# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this

# project's filter section matches. Qt Help Project / Filter Attributes (see:

# This tag requires that the tag GENERATE_QHP is set to YES.

 

QHP_SECT_FILTER_ATTRS  =

# 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

# (i.e. any modern browser). Windows users are probably better off using the

# further fine-tune the look of the index. As an example, the default style

# sheet generated by doxygen has an example that shows how to put an image at

# the root of the tree instead of the PROJECT_NAME. Since the tree basically has

 

TREEVIEW_WIDTH         = 250

 

# external symbols imported via tag files in a separate window.

# The default value is: NO.

# This tag requires that the tag GENERATE_HTML is set to YES.

 

FORMULA_FONTSIZE       = 10

 

# generated for formulas are transparent PNGs. Transparent PNGs are not

# supported properly for IE 6.0, but are supported on all modern browsers.

#

 

FORMULA_TRANSPARENT    = YES

 

# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see

# 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.

# 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

# This tag requires that the tag USE_MATHJAX is set to YES.

 

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

SEARCHENGINE           = NO

 

# When the SERVER_BASED_SEARCH tag is enabled the search engine will be

# The default value is: NO.

# This tag requires that the tag SEARCHENGINE is set to YES.

 

# external search engine pointed to by the SEARCHENGINE_URL option to obtain the

# search results.

#

# (doxysearch.cgi) which are based on the open source search engine library

#

# See the section "External Indexing and Searching" for details.

# The default value is: NO.

# The SEARCHENGINE_URL should point to a search engine hosted by a web server

# which will return the search results when EXTERNAL_SEARCH is enabled.

#

# (doxysearch.cgi) which are based on the open source search engine library

# Searching" for details.

# This tag requires that the tag SEARCHENGINE is set to YES.

 

# Configuration options related to the LaTeX output

#---------------------------------------------------------------------------

 

# The default value is: YES.

 

GENERATE_LATEX         = NO

# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be

# invoked.

#

# This tag requires that the tag GENERATE_LATEX is set to YES.

 

LATEX_CMD_NAME         = latex

 

# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate

# index for LaTeX.

# The default file is: makeindex.

# This tag requires that the tag GENERATE_LATEX is set to YES.

 

MAKEINDEX_CMD_NAME     = makeindex

 

# documents. This may be useful for small projects and may help to save some

# trees in general.

# The default value is: NO.

PAPER_TYPE             = a4wide

 

# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names

# If left blank no extra packages will be included.

# This tag requires that the tag GENERATE_LATEX is set to YES.

 

#

# Note: Only use a user-defined header if you know what you are doing! The

# following commands have a special meaning inside the header: $title,

# This tag requires that the tag GENERATE_LATEX is set to YES.

 

LATEX_HEADER           =

 

# 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

#

# Note: Only use a user-defined footer if you know what you are doing!

# This tag requires that the tag GENERATE_LATEX is set to YES.

 

LATEX_FOOTER           =

 

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

# other source files which should be copied to the LATEX_OUTPUT output

# directory. Note that the files will be copied as-is; there are no commands or

 

PDF_HYPERLINKS         = YES

 

# higher quality PDF documentation.

# The default value is: YES.

# This tag requires that the tag GENERATE_LATEX is set to YES.

 

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

# bibliography, e.g. plainnat, or ieeetr. See

# The default value is: plain.

# This tag requires that the tag GENERATE_LATEX is set to YES.

 

LATEX_BIB_STYLE        = plain

 

#---------------------------------------------------------------------------

# Configuration options related to the RTF output

#---------------------------------------------------------------------------

 

# RTF output is optimized for Word 97 and may not look too pretty with other RTF

# readers/editors.

# The default value is: NO.

 

RTF_OUTPUT             = rtf

 

# documents. This may be useful for small projects and may help to save some

# trees in general.

# The default value is: NO.

 

RTF_HYPERLINKS         = NO

 

#

# See also section "Doxygen usage" for information on how to generate the

# default style sheet that doxygen normally uses.

RTF_STYLESHEET_FILE    =

 

# Set optional variables used in the generation of an RTF document. Syntax is

# This tag requires that the tag GENERATE_RTF is set to YES.

 

RTF_EXTENSIONS_FILE    =

 

#---------------------------------------------------------------------------

# Configuration options related to the man page output

#---------------------------------------------------------------------------

 

# classes and files.

# The default value is: NO.

 

 

MAN_EXTENSION          = .3

 

# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it

# will generate one additional man file for each entity documented in the real

# man page(s). These additional files only source the real man page, but without

# Configuration options related to the XML output

#---------------------------------------------------------------------------

 

# captures the structure of the code including all documentation.

# The default value is: NO.

 

 

XML_OUTPUT             = xml

 

# listings (including syntax highlighting and cross-referencing information) to

# the XML output. Note that enabling this will significantly increase the size

# of the XML output.

 

XML_PROGRAMLISTING     = YES

 

#---------------------------------------------------------------------------

# Configuration options related to the DOCBOOK output

#---------------------------------------------------------------------------

 

# that can be used to generate PDF.

# The default value is: NO.

 

 

DOCBOOK_OUTPUT         = docbook

 

#---------------------------------------------------------------------------

# Configuration options for the AutoGen Definitions output

#---------------------------------------------------------------------------

 

# The default value is: NO.

 

GENERATE_AUTOGEN_DEF   = NO

# Configuration options related to the Perl module output

#---------------------------------------------------------------------------

 

# file that captures the structure of the code including all documentation.

#

# Note that this feature is still experimental and incomplete at the moment.

 

GENERATE_PERLMOD       = NO

 

# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI

# output from the Perl module output.

# The default value is: NO.

 

PERLMOD_LATEX          = NO

 

# formatted so it can be parsed by a human reader. This is useful if you want to

# size of the Perl module output will be much smaller and Perl will parse it

# just the same.

# The default value is: YES.

# Configuration options related to the preprocessor

#---------------------------------------------------------------------------

 

# C-preprocessor directives found in the sources and include files.

# The default value is: YES.

 

ENABLE_PREPROCESSING   = YES

 

# performed. Macro expansion can be done in a controlled way by setting

# EXPAND_ONLY_PREDEF to YES.

# The default value is: NO.

 

EXPAND_ONLY_PREDEF     = NO

 

# INCLUDE_PATH will be searched if a #include is found.

# The default value is: YES.

# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

EXPAND_AS_DEFINED      =

 

# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will

# removed.

# The default value is: YES.

# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

# where loc1 and loc2 can be relative or absolute paths or URLs. See the

# section "Linking to external documentation" for more information about the use

# of tag files.

# 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.

 

 

GENERATE_TAGFILE       =

 

# The default value is: NO.

 

ALLEXTERNALS           = NO

 

# listed.

# The default value is: YES.

 

EXTERNAL_GROUPS        = YES

 

# the related pages index. If set to NO, only the current project's pages will

# be listed.

# The default value is: YES.

 

EXTERNAL_PAGES         = YES

 

#---------------------------------------------------------------------------

# Configuration options related to the dot tool

#---------------------------------------------------------------------------

 

# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to

# NO turns the diagrams off. Note that this option also works with HAVE_DOT

# disabled, but it is recommended to install and use dot, since it yields more

 

CLASS_DIAGRAMS         = NO

 

# You can include diagrams made with dia in doxygen documentation. Doxygen will

# then run dia to produce the diagram and insert it in the documentation. The

# DIA_PATH tag allows you to specify the directory where the dia binary resides.

 

DIA_PATH               =

 

# and usage relations if the target is undocumented or is not a class.

# The default value is: YES.

 

# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent

# Bell Labs. The other options in this section have no effect if this option is

# set to NO

 

HAVE_DOT               = YES

 

 

DOT_NUM_THREADS        = 0

 

# generates 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