Ichthyostega
6822a9e2fb
- upgrade the configuration to a current version - provide a frontpage with cross-links to other documentation - define a set of modules; relevant classes and files can be added to these, to create a exploration path for new readers - fix a lot of errors in documentation comments - use a custom configuration for the documentation pages - tweak the navigation, the sections and further arrangements
246 lines
8.5 KiB
Text
246 lines
8.5 KiB
Text
# Doxyfile 1.8.1.2
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Project related configuration options
|
|
#---------------------------------------------------------------------------
|
|
DOXYFILE_ENCODING = UTF-8
|
|
PROJECT_NAME = Lumiera
|
|
PROJECT_NUMBER = 0.1+pre
|
|
PROJECT_BRIEF =
|
|
PROJECT_LOGO = draw/rendered/LumiLogo-small.png
|
|
OUTPUT_DIRECTORY =
|
|
CREATE_SUBDIRS = NO
|
|
OUTPUT_LANGUAGE = English
|
|
BRIEF_MEMBER_DESC = YES
|
|
REPEAT_BRIEF = YES
|
|
ABBREVIATE_BRIEF = "The $name class" \
|
|
"The $name widget" \
|
|
"The $name file" \
|
|
is \
|
|
provides \
|
|
specifies \
|
|
contains \
|
|
represents \
|
|
a \
|
|
an \
|
|
the
|
|
ALWAYS_DETAILED_SEC = YES
|
|
INLINE_INHERITED_MEMB = NO
|
|
FULL_PATH_NAMES = NO
|
|
STRIP_FROM_PATH = ../../src/ \
|
|
../../tests/
|
|
STRIP_FROM_INC_PATH = ../../src/
|
|
SHORT_NAMES = NO
|
|
JAVADOC_AUTOBRIEF = YES
|
|
QT_AUTOBRIEF = NO
|
|
MULTILINE_CPP_IS_BRIEF = NO
|
|
INHERIT_DOCS = YES
|
|
SEPARATE_MEMBER_PAGES = NO
|
|
TAB_SIZE = 4
|
|
ALIASES =
|
|
EXTENSION_MAPPING =
|
|
MARKDOWN_SUPPORT = YES
|
|
BUILTIN_STL_SUPPORT = YES
|
|
DISTRIBUTE_GROUP_DOC = NO
|
|
SUBGROUPING = YES
|
|
INLINE_GROUPED_CLASSES = NO
|
|
INLINE_SIMPLE_STRUCTS = YES
|
|
TYPEDEF_HIDES_STRUCT = YES
|
|
#---------------------------------------------------------------------------
|
|
# Build related configuration options
|
|
#---------------------------------------------------------------------------
|
|
EXTRACT_ALL = NO
|
|
EXTRACT_PRIVATE = YES
|
|
EXTRACT_PACKAGE = NO
|
|
EXTRACT_STATIC = YES
|
|
EXTRACT_LOCAL_CLASSES = YES
|
|
EXTRACT_ANON_NSPACES = NO
|
|
HIDE_UNDOC_MEMBERS = NO
|
|
HIDE_UNDOC_CLASSES = NO
|
|
HIDE_FRIEND_COMPOUNDS = NO
|
|
HIDE_IN_BODY_DOCS = NO
|
|
INTERNAL_DOCS = YES
|
|
CASE_SENSE_NAMES = YES
|
|
HIDE_SCOPE_NAMES = YES
|
|
SHOW_INCLUDE_FILES = YES
|
|
FORCE_LOCAL_INCLUDES = YES
|
|
INLINE_INFO = YES
|
|
SORT_MEMBER_DOCS = NO
|
|
SORT_BRIEF_DOCS = YES
|
|
SORT_MEMBERS_CTORS_1ST = YES
|
|
SORT_GROUP_NAMES = NO
|
|
SORT_BY_SCOPE_NAME = NO
|
|
STRICT_PROTO_MATCHING = NO
|
|
GENERATE_TODOLIST = YES
|
|
GENERATE_TESTLIST = YES
|
|
GENERATE_BUGLIST = NO
|
|
GENERATE_DEPRECATEDLIST= NO
|
|
ENABLED_SECTIONS =
|
|
MAX_INITIALIZER_LINES = 0
|
|
SHOW_USED_FILES = YES
|
|
SHOW_FILES = YES
|
|
SHOW_NAMESPACES = YES
|
|
FILE_VERSION_FILTER =
|
|
LAYOUT_FILE =
|
|
#---------------------------------------------------------------------------
|
|
# configuration options related to warning and progress messages
|
|
#---------------------------------------------------------------------------
|
|
QUIET = NO
|
|
WARNINGS = YES
|
|
WARN_IF_UNDOCUMENTED = NO
|
|
WARN_IF_DOC_ERROR = YES
|
|
WARN_NO_PARAMDOC = NO
|
|
WARN_FORMAT = "$file:$line: $text"
|
|
WARN_LOGFILE = html/doxygen-warnings.txt
|
|
#---------------------------------------------------------------------------
|
|
# configuration options related to the input files
|
|
#---------------------------------------------------------------------------
|
|
INPUT_ENCODING = UTF-8
|
|
INPUT = ../../src/ \
|
|
../../tests \
|
|
../../admin/scons
|
|
FILE_PATTERNS = *.c \
|
|
*.cc \
|
|
*.cpp \
|
|
*.h \
|
|
*.hh \
|
|
*.hpp \
|
|
*.inc \
|
|
*.dox \
|
|
*.py
|
|
RECURSIVE = YES
|
|
EXCLUDE =
|
|
EXCLUDE_SYMLINKS = YES
|
|
EXCLUDE_PATTERNS =
|
|
EXCLUDE_SYMBOLS =
|
|
EXAMPLE_PATH =
|
|
EXAMPLE_PATTERNS =
|
|
EXAMPLE_RECURSIVE = NO
|
|
IMAGE_PATH =
|
|
INPUT_FILTER =
|
|
FILTER_PATTERNS =
|
|
FILTER_SOURCE_FILES = NO
|
|
FILTER_SOURCE_PATTERNS =
|
|
#---------------------------------------------------------------------------
|
|
# configuration options related to source browsing
|
|
#---------------------------------------------------------------------------
|
|
SOURCE_BROWSER = YES
|
|
INLINE_SOURCES = NO
|
|
STRIP_CODE_COMMENTS = YES
|
|
REFERENCED_BY_RELATION = YES
|
|
REFERENCES_RELATION = YES
|
|
REFERENCES_LINK_SOURCE = NO
|
|
USE_HTAGS = NO
|
|
VERBATIM_HEADERS = YES
|
|
#---------------------------------------------------------------------------
|
|
# configuration options related to the alphabetical class index
|
|
#---------------------------------------------------------------------------
|
|
ALPHABETICAL_INDEX = YES
|
|
COLS_IN_ALPHA_INDEX = 1
|
|
IGNORE_PREFIX = lumiera:: \
|
|
lumiera_ \
|
|
lumi_ \
|
|
LUMIERA_
|
|
#---------------------------------------------------------------------------
|
|
# configuration options related to the HTML output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_HTML = YES
|
|
HTML_OUTPUT = html
|
|
HTML_FILE_EXTENSION = .html
|
|
HTML_HEADER =
|
|
HTML_FOOTER =
|
|
HTML_STYLESHEET =
|
|
HTML_EXTRA_FILES =
|
|
HTML_COLORSTYLE_HUE = 344
|
|
HTML_COLORSTYLE_SAT = 68
|
|
HTML_COLORSTYLE_GAMMA = 80
|
|
HTML_TIMESTAMP = YES
|
|
HTML_DYNAMIC_SECTIONS = YES
|
|
HTML_INDEX_NUM_ENTRIES = 100
|
|
GENERATE_HTMLHELP = NO
|
|
GENERATE_ECLIPSEHELP = NO
|
|
TOC_EXPAND = YES
|
|
DISABLE_INDEX = NO
|
|
GENERATE_TREEVIEW = YES
|
|
TREEVIEW_WIDTH = 200
|
|
ENUM_VALUES_PER_LINE = 1
|
|
FORMULA_FONTSIZE = 9
|
|
FORMULA_TRANSPARENT = YES
|
|
SEARCHENGINE = YES
|
|
SERVER_BASED_SEARCH = NO
|
|
#---------------------------------------------------------------------------
|
|
# configuration options related to the LaTeX output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_LATEX = NO
|
|
LATEX_OUTPUT = latex
|
|
LATEX_CMD_NAME = latex
|
|
MAKEINDEX_CMD_NAME = makeindex
|
|
COMPACT_LATEX = YES
|
|
PAPER_TYPE = a4wide
|
|
EXTRA_PACKAGES =
|
|
LATEX_HEADER =
|
|
LATEX_FOOTER =
|
|
PDF_HYPERLINKS = YES
|
|
USE_PDFLATEX = YES
|
|
LATEX_BATCHMODE = YES
|
|
LATEX_HIDE_INDICES = NO
|
|
LATEX_SOURCE_CODE = NO
|
|
LATEX_BIB_STYLE = plain
|
|
#---------------------------------------------------------------------------
|
|
# configuration options related to other output formats
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_RTF = NO
|
|
GENERATE_MAN = NO
|
|
GENERATE_XML = NO
|
|
GENERATE_AUTOGEN_DEF = NO
|
|
GENERATE_PERLMOD = NO
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the preprocessor
|
|
#---------------------------------------------------------------------------
|
|
ENABLE_PREPROCESSING = YES
|
|
MACRO_EXPANSION = NO
|
|
EXPAND_ONLY_PREDEF = NO
|
|
SEARCH_INCLUDES = YES
|
|
INCLUDE_PATH =
|
|
INCLUDE_FILE_PATTERNS =
|
|
PREDEFINED =
|
|
EXPAND_AS_DEFINED =
|
|
SKIP_FUNCTION_MACROS = YES
|
|
#---------------------------------------------------------------------------
|
|
# Configuration::additions related to external references
|
|
#---------------------------------------------------------------------------
|
|
TAGFILES =
|
|
GENERATE_TAGFILE = lumiera.tag
|
|
ALLEXTERNALS = NO
|
|
EXTERNAL_GROUPS = YES
|
|
PERL_PATH = /usr/bin/perl
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the dot tool
|
|
#---------------------------------------------------------------------------
|
|
CLASS_DIAGRAMS = YES
|
|
MSCGEN_PATH =
|
|
HIDE_UNDOC_RELATIONS = YES
|
|
HAVE_DOT = YES
|
|
DOT_FONTNAME = FreeSans
|
|
DOT_FONTSIZE = 8
|
|
DOT_FONTPATH =
|
|
CLASS_GRAPH = YES
|
|
COLLABORATION_GRAPH = YES
|
|
GROUP_GRAPHS = YES
|
|
UML_LOOK = YES
|
|
UML_LIMIT_NUM_FIELDS = 8
|
|
TEMPLATE_RELATIONS = YES
|
|
INCLUDE_GRAPH = NO
|
|
INCLUDED_BY_GRAPH = NO
|
|
CALL_GRAPH = YES
|
|
CALLER_GRAPH = YES
|
|
GRAPHICAL_HIERARCHY = NO
|
|
DIRECTORY_GRAPH = YES
|
|
DOT_IMAGE_FORMAT = svg
|
|
INTERACTIVE_SVG = YES
|
|
DOT_GRAPH_MAX_NODES = 80
|
|
MAX_DOT_GRAPH_DEPTH = 1000
|
|
DOT_TRANSPARENT = YES
|
|
DOT_MULTI_TARGETS = YES
|
|
GENERATE_LEGEND = YES
|
|
DOT_CLEANUP = YES
|