Ichthyostega
555af315b3
- remove obsolete configuration settings - walk through all settings according to the documentation https://www.doxygen.nl/manual/config.html - now try to use the new feature to rely on Clang for C++ parsing - walk through the doxygen-warnings.txt and fix some obvious misspellings and structural problems in the documentation comments. With Debian-Trixie, we are now using Doxygen 1.9.8 — which produces massively better results in various fine points. However, there are still problems with automatic cross links, especially from implementation to the corresponding test classes.
285 lines
9.3 KiB
Text
285 lines
9.3 KiB
Text
# Doxyfile 1.8.13
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Project related configuration options
|
|
#---------------------------------------------------------------------------
|
|
DOXYFILE_ENCODING = UTF-8
|
|
PROJECT_NAME = Lumiera
|
|
PROJECT_NUMBER = 0.pre.03
|
|
PROJECT_BRIEF = "»edit your freedom«"
|
|
PROJECT_LOGO = draw/rendered/LumiLogo-small.png
|
|
OUTPUT_DIRECTORY =
|
|
CREATE_SUBDIRS = NO
|
|
ALLOW_UNICODE_NAMES = 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 = NO
|
|
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
|
|
PYTHON_DOCSTRING = NO
|
|
INHERIT_DOCS = YES
|
|
SEPARATE_MEMBER_PAGES = NO
|
|
TAB_SIZE = 4
|
|
ALIASES =
|
|
OPTIMIZE_OUTPUT_FOR_C = NO
|
|
OPTIMIZE_OUTPUT_JAVA = NO
|
|
EXTENSION_MAPPING =
|
|
MARKDOWN_SUPPORT = YES
|
|
MARKDOWN_ID_STYLE = GITHUB
|
|
TOC_INCLUDE_HEADINGS = 2
|
|
AUTOLINK_SUPPORT = YES
|
|
BUILTIN_STL_SUPPORT = YES
|
|
CPP_CLI_SUPPORT = NO
|
|
IDL_PROPERTY_SUPPORT = NO
|
|
DISTRIBUTE_GROUP_DOC = NO
|
|
GROUP_NESTED_COMPOUNDS = NO
|
|
SUBGROUPING = YES
|
|
INLINE_GROUPED_CLASSES = NO
|
|
INLINE_SIMPLE_STRUCTS = YES
|
|
TYPEDEF_HIDES_STRUCT = YES
|
|
LOOKUP_CACHE_SIZE = 2
|
|
NUM_PROC_THREADS = 0
|
|
TIMESTAMP = DATE
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Build related configuration options
|
|
#---------------------------------------------------------------------------
|
|
EXTRACT_ALL = YES
|
|
EXTRACT_PRIVATE = YES
|
|
EXTRACT_PACKAGE = YES
|
|
EXTRACT_STATIC = YES
|
|
EXTRACT_LOCAL_CLASSES = YES
|
|
EXTRACT_LOCAL_METHODS = YES
|
|
EXTRACT_ANON_NSPACES = YES
|
|
RESOLVE_UNNAMED_PARAMS = YES
|
|
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_HEADERFILE = YES
|
|
SHOW_INCLUDE_FILES = YES
|
|
SHOW_GROUPED_MEMB_INC = NO
|
|
FORCE_LOCAL_INCLUDES = YES
|
|
INLINE_INFO = YES
|
|
SORT_MEMBER_DOCS = NO
|
|
SORT_BRIEF_DOCS = NO
|
|
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= YES
|
|
ENABLED_SECTIONS =
|
|
MAX_INITIALIZER_LINES = 50
|
|
SHOW_USED_FILES = YES
|
|
SHOW_FILES = YES
|
|
SHOW_NAMESPACES = YES
|
|
FILE_VERSION_FILTER =
|
|
LAYOUT_FILE =
|
|
CITE_BIB_FILES =
|
|
|
|
#---------------------------------------------------------------------------
|
|
# 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_AS_ERROR = NO
|
|
WARN_FORMAT = "$file:$line: $text"
|
|
WARN_LOGFILE = 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 =
|
|
USE_MDFILE_AS_MAINPAGE =
|
|
|
|
#---------------------------------------------------------------------------
|
|
# 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
|
|
SOURCE_TOOLTIPS = YES
|
|
USE_HTAGS = NO
|
|
VERBATIM_HEADERS = NO
|
|
CLANG_ASSISTED_PARSING = YES
|
|
CLANG_OPTIONS = -DDEBUG -DEBUG_ALPHA
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the alphabetical class index
|
|
#---------------------------------------------------------------------------
|
|
ALPHABETICAL_INDEX = YES
|
|
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_STYLESHEET =
|
|
HTML_EXTRA_FILES =
|
|
HTML_COLORSTYLE = LIGHT
|
|
HTML_COLORSTYLE_HUE = 344
|
|
HTML_COLORSTYLE_SAT = 68
|
|
HTML_COLORSTYLE_GAMMA = 80
|
|
HTML_DYNAMIC_MENUS = YES
|
|
HTML_DYNAMIC_SECTIONS = YES
|
|
HTML_CODE_FOLDING = YES
|
|
HTML_PROJECT_COOKIE = DoxyLumi
|
|
HTML_INDEX_NUM_ENTRIES = 100
|
|
GENERATE_DOCSET = NO
|
|
GENERATE_HTMLHELP = NO
|
|
GENERATE_ECLIPSEHELP = NO
|
|
TOC_EXPAND = YES
|
|
DISABLE_INDEX = NO
|
|
GENERATE_TREEVIEW = YES
|
|
TREEVIEW_WIDTH = 200
|
|
ENUM_VALUES_PER_LINE = 1
|
|
EXT_LINKS_IN_WINDOW = NO
|
|
HTML_FORMULA_FORMAT = svg
|
|
FORMULA_FONTSIZE = 9
|
|
USE_MATHJAX = NO
|
|
SEARCHENGINE = YES
|
|
SERVER_BASED_SEARCH = NO
|
|
EXTERNAL_SEARCH = NO
|
|
SEARCHENGINE_URL =
|
|
|
|
#---------------------------------------------------------------------------
|
|
# 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 =
|
|
LATEX_EXTRA_STYLESHEET =
|
|
LATEX_EXTRA_FILES =
|
|
PDF_HYPERLINKS = YES
|
|
USE_PDFLATEX = YES
|
|
LATEX_BATCHMODE = YES
|
|
LATEX_HIDE_INDICES = NO
|
|
LATEX_BIB_STYLE = plain
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the RTF output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_RTF = NO
|
|
GENERATE_MAN = NO
|
|
GENERATE_XML = NO
|
|
GENERATE_DOCBOOK = 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 = __cplusplus DEBUG EBUG_ALPHA
|
|
EXPAND_AS_DEFINED =
|
|
SKIP_FUNCTION_MACROS = YES
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to external references
|
|
#---------------------------------------------------------------------------
|
|
TAGFILES =
|
|
GENERATE_TAGFILE = lumiera.tag
|
|
ALLEXTERNALS = NO
|
|
EXTERNAL_GROUPS = YES
|
|
EXTERNAL_PAGES = YES
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the dot tool
|
|
#---------------------------------------------------------------------------
|
|
HAVE_DOT = YES
|
|
DOT_NUM_THREADS = 0 # use all cores
|
|
CLASS_GRAPH = YES
|
|
COLLABORATION_GRAPH = YES
|
|
GROUP_GRAPHS = YES
|
|
HIDE_UNDOC_RELATIONS = YES
|
|
UML_LOOK = YES
|
|
UML_LIMIT_NUM_FIELDS = 12
|
|
TEMPLATE_RELATIONS = YES
|
|
INCLUDE_GRAPH = NO
|
|
INCLUDED_BY_GRAPH = NO
|
|
CALL_GRAPH = YES
|
|
CALLER_GRAPH = YES
|
|
DIRECTORY_GRAPH = YES
|
|
GRAPHICAL_HIERARCHY = NO
|
|
DOT_IMAGE_FORMAT = svg
|
|
INTERACTIVE_SVG = YES
|
|
DOT_GRAPH_MAX_NODES = 80
|
|
MAX_DOT_GRAPH_DEPTH = 20
|
|
DOT_MULTI_TARGETS = YES
|
|
GENERATE_LEGEND = YES
|
|
DOT_CLEANUP = YES
|