|
|
@@ -1,4 +1,4 @@ |
|
|
|
# Doxyfile 1.4.6 |
|
|
|
# Doxyfile 1.5.3-20071008 |
|
|
|
|
|
|
|
# This file describes the settings to be used by the documentation system |
|
|
|
# doxygen (www.doxygen.org) for a project |
|
|
@@ -14,6 +14,14 @@ |
|
|
|
# Project related configuration options |
|
|
|
#--------------------------------------------------------------------------- |
|
|
|
|
|
|
|
# This tag specifies the encoding used for all characters in the config file that |
|
|
|
# follow. The default is UTF-8 which is also the encoding used for all text before |
|
|
|
# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into |
|
|
|
# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of |
|
|
|
# possible encodings. |
|
|
|
|
|
|
|
DOXYFILE_ENCODING = UTF-8 |
|
|
|
|
|
|
|
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
|
|
|
# by quotes) that should identify the project. |
|
|
|
|
|
|
@@ -45,24 +53,14 @@ CREATE_SUBDIRS = NO |
|
|
|
# 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. |
|
|
|
# Afrikaans, Arabic, 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, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, |
|
|
|
# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. |
|
|
|
|
|
|
|
OUTPUT_LANGUAGE = English |
|
|
|
|
|
|
|
# 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). |
|
|
@@ -135,11 +133,19 @@ SHORT_NAMES = NO |
|
|
|
# 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. |
|
|
|
# comments will behave just like regular Qt-style comments |
|
|
|
# (thus requiring an explicit @brief command for a brief description.) |
|
|
|
|
|
|
|
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 comments |
|
|
|
# will behave just like regular Qt-style comments (thus requiring |
|
|
|
# an explicit \brief command for a brief description.) |
|
|
|
|
|
|
|
QT_AUTOBRIEF = NO |
|
|
|
|
|
|
|
# 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. |
|
|
@@ -204,6 +210,17 @@ OPTIMIZE_OUTPUT_JAVA = NO |
|
|
|
|
|
|
|
BUILTIN_STL_SUPPORT = NO |
|
|
|
|
|
|
|
# If you use Microsoft's C++/CLI language, you should set this option to YES to |
|
|
|
# enable parsing support. |
|
|
|
|
|
|
|
CPP_CLI_SUPPORT = NO |
|
|
|
|
|
|
|
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. |
|
|
|
# Doxygen will parse them like normal C++ but will assume all classes use public |
|
|
|
# instead of private inheritance when no explicit protection keyword is present. |
|
|
|
|
|
|
|
SIP_SUPPORT = NO |
|
|
|
|
|
|
|
# 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 |
|
|
@@ -253,6 +270,13 @@ EXTRACT_LOCAL_CLASSES = NO |
|
|
|
|
|
|
|
EXTRACT_LOCAL_METHODS = NO |
|
|
|
|
|
|
|
# If this flag is set to YES, the members of anonymous namespaces will be extracted |
|
|
|
# and appear in the documentation as a namespace called 'anonymous_namespace{file}', |
|
|
|
# where file will be replaced with the base name of the file that contains the anonymous |
|
|
|
# namespace. By default anonymous namespace are hidden. |
|
|
|
|
|
|
|
EXTRACT_ANON_NSPACES = NO |
|
|
|
|
|
|
|
# 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 |
|
|
@@ -442,7 +466,7 @@ WARN_NO_PARAMDOC = NO |
|
|
|
# $version, which will be replaced by the version of the file (if it could |
|
|
|
# be obtained via FILE_VERSION_FILTER) |
|
|
|
|
|
|
|
WARN_FORMAT = "$file:$line: $text" |
|
|
|
WARN_FORMAT = "$file:$line: $text " |
|
|
|
|
|
|
|
# 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 |
|
|
@@ -464,6 +488,13 @@ INPUT = @top_srcdir@ \ |
|
|
|
@top_srcdir@/cucul \ |
|
|
|
@top_srcdir@/caca |
|
|
|
|
|
|
|
# This tag can be used to specify the character encoding of the source files that |
|
|
|
# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default |
|
|
|
# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. |
|
|
|
# See http://www.gnu.org/software/libiconv for the list of possible encodings. |
|
|
|
|
|
|
|
INPUT_ENCODING = UTF-8 |
|
|
|
|
|
|
|
# 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 |
|
|
@@ -471,8 +502,14 @@ INPUT = @top_srcdir@ \ |
|
|
|
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx |
|
|
|
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py |
|
|
|
|
|
|
|
FILE_PATTERNS = *.dox *.c cucul.h caca.h \ |
|
|
|
NEWS AUTHORS THANKS TODO |
|
|
|
FILE_PATTERNS = *.dox \ |
|
|
|
*.c \ |
|
|
|
cucul.h \ |
|
|
|
caca.h \ |
|
|
|
NEWS \ |
|
|
|
AUTHORS \ |
|
|
|
THANKS \ |
|
|
|
TODO |
|
|
|
|
|
|
|
# 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. |
|
|
@@ -501,6 +538,13 @@ EXCLUDE_SYMLINKS = NO |
|
|
|
EXCLUDE_PATTERNS = *_internal.h \ |
|
|
|
driver_*.c |
|
|
|
|
|
|
|
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
|
|
|
# (namespaces, classes, functions, etc.) that should be excluded from the output. |
|
|
|
# The symbol name can be a fully qualified name, a word, or if the wildcard * is used, |
|
|
|
# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test |
|
|
|
|
|
|
|
EXCLUDE_SYMBOLS = |
|
|
|
|
|
|
|
# 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). |
|
|
@@ -559,7 +603,9 @@ FILTER_SOURCE_FILES = NO |
|
|
|
# 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. |
|
|
|
# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH |
|
|
|
# then you must also enable this option. If you don't then doxygen will produce |
|
|
|
# a warning and turn it on anyway |
|
|
|
|
|
|
|
SOURCE_BROWSER = NO |
|
|
|
|
|
|
@@ -586,6 +632,13 @@ REFERENCED_BY_RELATION = YES |
|
|
|
|
|
|
|
REFERENCES_RELATION = YES |
|
|
|
|
|
|
|
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) |
|
|
|
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from |
|
|
|
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will |
|
|
|
# link to the source code. Otherwise they will link to the documentstion. |
|
|
|
|
|
|
|
REFERENCES_LINK_SOURCE = 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 |
|
|
@@ -663,7 +716,7 @@ HTML_FOOTER = @srcdir@/footer.html |
|
|
|
# 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! |
|
|
|
|
|
|
|
HTML_STYLESHEET = |
|
|
|
HTML_STYLESHEET = /dev/null |
|
|
|
|
|
|
|
# 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 |
|
|
@@ -678,6 +731,14 @@ HTML_ALIGN_MEMBERS = YES |
|
|
|
|
|
|
|
GENERATE_HTMLHELP = NO |
|
|
|
|
|
|
|
# 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. For this to work a browser that supports |
|
|
|
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox |
|
|
|
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). |
|
|
|
|
|
|
|
HTML_DYNAMIC_SECTIONS = NO |
|
|
|
|
|
|
|
# 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 |
|
|
@@ -1083,6 +1144,14 @@ PERL_PATH = /usr/bin/perl |
|
|
|
|
|
|
|
CLASS_DIAGRAMS = YES |
|
|
|
|
|
|
|
# You can define message sequence charts within doxygen comments using the \msc |
|
|
|
# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to |
|
|
|
# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to |
|
|
|
# specify the directory where the mscgen tool resides. If left empty the tool is assumed to |
|
|
|
# be found in the default search path. |
|
|
|
|
|
|
|
MSCGEN_PATH = |
|
|
|
|
|
|
|
# If set to YES, the inheritance and collaboration graphs will hide |
|
|
|
# inheritance and usage relations if the target is undocumented |
|
|
|
# or is not a class. |
|
|
@@ -1140,7 +1209,7 @@ INCLUDE_GRAPH = YES |
|
|
|
|
|
|
|
INCLUDED_BY_GRAPH = YES |
|
|
|
|
|
|
|
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will |
|
|
|
# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will |
|
|
|
# generate a call dependency graph for every global function or class method. |
|
|
|
# Note that enabling this option will significantly increase the time of a run. |
|
|
|
# So in most cases it will be better to enable call graphs for selected |
|
|
@@ -1148,6 +1217,14 @@ INCLUDED_BY_GRAPH = YES |
|
|
|
|
|
|
|
CALL_GRAPH = NO |
|
|
|
|
|
|
|
# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will |
|
|
|
# generate a caller dependency graph for every global function or class method. |
|
|
|
# Note that enabling this option will significantly increase the time of a run. |
|
|
|
# So in most cases it will be better to enable caller graphs for selected |
|
|
|
# functions only using the \callergraph command. |
|
|
|
|
|
|
|
CALLER_GRAPH = NO |
|
|
|
|
|
|
|
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
|
|
|
# will graphical hierarchy of all classes instead of a textual one. |
|
|
|
|
|
|
@@ -1177,31 +1254,23 @@ DOT_PATH = |
|
|
|
|
|
|
|
DOTFILE_DIRS = . |
|
|
|
|
|
|
|
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width |
|
|
|
# (in pixels) of the graphs generated by dot. If a graph becomes larger than |
|
|
|
# this value, doxygen will try to truncate the graph, so that it fits within |
|
|
|
# the specified constraint. Beware that most browsers cannot cope with very |
|
|
|
# large images. |
|
|
|
|
|
|
|
MAX_DOT_GRAPH_WIDTH = 1024 |
|
|
|
|
|
|
|
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height |
|
|
|
# (in pixels) of the graphs generated by dot. If a graph becomes larger than |
|
|
|
# this value, doxygen will try to truncate the graph, so that it fits within |
|
|
|
# the specified constraint. Beware that most browsers cannot cope with very |
|
|
|
# large images. |
|
|
|
# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of |
|
|
|
# nodes that will be shown in the graph. If the number of nodes in a graph |
|
|
|
# becomes larger than this value, doxygen will truncate the graph, which is |
|
|
|
# visualized by representing a node as a red box. Note that doxygen if the number |
|
|
|
# of direct children of the root node in a graph is already larger than |
|
|
|
# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note |
|
|
|
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. |
|
|
|
|
|
|
|
MAX_DOT_GRAPH_HEIGHT = 1024 |
|
|
|
DOT_GRAPH_MAX_NODES = 50 |
|
|
|
|
|
|
|
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the |
|
|
|
# graphs generated by dot. A depth value of 3 means that only nodes reachable |
|
|
|
# from the root by following a path via at most 3 edges will be shown. Nodes |
|
|
|
# that lay further from the root node will be omitted. Note that setting this |
|
|
|
# option to 1 or 2 may greatly reduce the computation time needed for large |
|
|
|
# code bases. Also note that a graph may be further truncated if the graph's |
|
|
|
# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH |
|
|
|
# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), |
|
|
|
# the graph is not depth-constrained. |
|
|
|
# code bases. Also note that the size of a graph can be further restricted by |
|
|
|
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. |
|
|
|
|
|
|
|
MAX_DOT_GRAPH_DEPTH = 0 |
|
|
|
|
|
|
|