Ichthyostega
acb674a9d2
...in an attempt to clarify why numerous cross links are not generated. In the end, this attempt was not very successful, yet I could find some breadcrumbs... - file comments generally seem to have a problem with auto link generation; only fully qualified names seem to work reliably - cross links to entities within a namespace do not work, if the corresponding namespace is not documented in Doxygen - documentation for entities within anonymous namespaces must be explicitly enabled. Of course this makes only sense for detailed documentation (but we do generate detailed documentation here, including implementation notes) - and the notorious problem: each file needs a valid @file comment - the hierarchy of Markdown headings must be consistent within each documentation section. This entails also to individual documented entities. Basically, there must be a level-one heading (prefix "#"), otherwise all headings will just disappear... - sometimes the doc/devel/doxygen-warnings.txt gives further clues
234 lines
7.8 KiB
Text
234 lines
7.8 KiB
Text
# Doxyfile 1.8.13
|
|
|
|
# This variation of the Lumiera Doxygen configuration
|
|
# was created several years again, in an attempt to help
|
|
# with browsing the code base to get an overview
|
|
#
|
|
# This configuration was not updated further,
|
|
# and it is not clear if it is of any use.
|
|
# Feel free to test, adapt and improve it.
|
|
#
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Project related configuration options
|
|
#---------------------------------------------------------------------------
|
|
DOXYFILE_ENCODING = UTF-8
|
|
PROJECT_NAME = Lumiera
|
|
PROJECT_NUMBER = 0.pre.03
|
|
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 = YES
|
|
FULL_PATH_NAMES = YES
|
|
STRIP_FROM_PATH = ../../src/ \
|
|
../../tests/
|
|
STRIP_FROM_INC_PATH =
|
|
SHORT_NAMES = NO
|
|
JAVADOC_AUTOBRIEF = YES
|
|
QT_AUTOBRIEF = NO
|
|
MULTILINE_CPP_IS_BRIEF = NO
|
|
INHERIT_DOCS = YES
|
|
SEPARATE_MEMBER_PAGES = NO
|
|
TAB_SIZE = 4
|
|
OPTIMIZE_OUTPUT_FOR_C = NO
|
|
BUILTIN_STL_SUPPORT = YES
|
|
CPP_CLI_SUPPORT = NO
|
|
IDL_PROPERTY_SUPPORT = YES
|
|
DISTRIBUTE_GROUP_DOC = NO
|
|
SUBGROUPING = YES
|
|
TYPEDEF_HIDES_STRUCT = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Build related configuration options
|
|
#---------------------------------------------------------------------------
|
|
EXTRACT_ALL = YES
|
|
EXTRACT_PRIVATE = YES
|
|
EXTRACT_STATIC = YES
|
|
EXTRACT_LOCAL_CLASSES = YES
|
|
EXTRACT_LOCAL_METHODS = NO
|
|
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 = NO
|
|
SHOW_INCLUDE_FILES = YES
|
|
INLINE_INFO = YES
|
|
SORT_MEMBER_DOCS = NO
|
|
SORT_BRIEF_DOCS = YES
|
|
SORT_GROUP_NAMES = NO
|
|
SORT_BY_SCOPE_NAME = NO
|
|
GENERATE_TODOLIST = NO
|
|
GENERATE_TESTLIST = NO
|
|
GENERATE_BUGLIST = YES
|
|
GENERATE_DEPRECATEDLIST= NO
|
|
MAX_INITIALIZER_LINES = 10
|
|
SHOW_USED_FILES = YES
|
|
SHOW_DIRECTORIES = NO
|
|
SHOW_FILES = YES
|
|
SHOW_NAMESPACES = YES
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to warning and progress messages
|
|
#---------------------------------------------------------------------------
|
|
QUIET = NO
|
|
WARNINGS = YES
|
|
WARN_IF_UNDOCUMENTED = YES
|
|
WARN_IF_DOC_ERROR = YES
|
|
WARN_NO_PARAMDOC = YES
|
|
WARN_FORMAT = "$file:$line: $text"
|
|
WARN_LOGFILE = doxygen-warnings-browse.txt
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the input files
|
|
#---------------------------------------------------------------------------
|
|
INPUT_ENCODING = UTF-8
|
|
INPUT = ../../src/ \
|
|
FILE_PATTERNS = *.c \
|
|
*.cc \
|
|
*.cxx \
|
|
*.cpp \
|
|
*.ii \
|
|
*.ixx \
|
|
*.ipp \
|
|
*.i++ \
|
|
*.inl \
|
|
*.h \
|
|
*.hh \
|
|
*.hxx \
|
|
*.hpp \
|
|
*.h++ \
|
|
*.inc \
|
|
*.dox \
|
|
*.C \
|
|
*.CC \
|
|
*.C++ \
|
|
*.H \
|
|
*.HH \
|
|
*.H++ \
|
|
*.PY \
|
|
*.py
|
|
RECURSIVE = YES
|
|
EXCLUDE_SYMLINKS = YES
|
|
EXAMPLE_RECURSIVE = NO
|
|
FILTER_SOURCE_FILES = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to source browsing
|
|
#---------------------------------------------------------------------------
|
|
SOURCE_BROWSER = YES
|
|
INLINE_SOURCES = YES
|
|
STRIP_CODE_COMMENTS = YES
|
|
REFERENCED_BY_RELATION = YES
|
|
REFERENCES_RELATION = YES
|
|
REFERENCES_LINK_SOURCE = YES
|
|
USE_HTAGS = NO
|
|
VERBATIM_HEADERS = YES
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the alphabetical class index
|
|
#---------------------------------------------------------------------------
|
|
ALPHABETICAL_INDEX = YES
|
|
COLS_IN_ALPHA_INDEX = 5
|
|
IGNORE_PREFIX = lumiera:: \
|
|
lumiera_ \
|
|
lumi_ \
|
|
LUMIERA_
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the HTML output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_HTML = YES
|
|
HTML_OUTPUT = html_browse
|
|
HTML_FILE_EXTENSION = .html
|
|
HTML_HEADER =
|
|
HTML_FOOTER =
|
|
HTML_STYLESHEET =
|
|
HTML_ALIGN_MEMBERS = YES
|
|
GENERATE_HTMLHELP = NO
|
|
GENERATE_DOCSET = NO
|
|
DISABLE_INDEX = NO
|
|
ENUM_VALUES_PER_LINE = 4
|
|
GENERATE_TREEVIEW = YES
|
|
TREEVIEW_WIDTH = 250
|
|
FORMULA_FONTSIZE = 10
|
|
SEARCHENGINE = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options for other output formats
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_LATEX = NO
|
|
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 options related to external references
|
|
#---------------------------------------------------------------------------
|
|
TAGFILES =
|
|
GENERATE_TAGFILE =
|
|
ALLEXTERNALS = NO
|
|
EXTERNAL_GROUPS = YES
|
|
EXTERNAL_PAGES = NO
|
|
PERL_PATH = /usr/bin/perl
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the dot tool
|
|
#---------------------------------------------------------------------------
|
|
CLASS_DIAGRAMS = NO
|
|
HIDE_UNDOC_RELATIONS = YES
|
|
HAVE_DOT = YES
|
|
DOT_FONTNAME = FreeSans
|
|
DOT_FONTPATH =
|
|
CLASS_GRAPH = NO
|
|
COLLABORATION_GRAPH = NO
|
|
GROUP_GRAPHS = NO
|
|
UML_LOOK = YES
|
|
TEMPLATE_RELATIONS = NO
|
|
INCLUDE_GRAPH = NO
|
|
INCLUDED_BY_GRAPH = NO
|
|
CALL_GRAPH = NO
|
|
CALLER_GRAPH = NO
|
|
GRAPHICAL_HIERARCHY = NO
|
|
DIRECTORY_GRAPH = NO
|
|
DOT_IMAGE_FORMAT = png
|
|
DOT_PATH =
|
|
DOTFILE_DIRS =
|
|
DOT_GRAPH_MAX_NODES = 50
|
|
MAX_DOT_GRAPH_DEPTH = 10
|
|
DOT_TRANSPARENT = NO
|
|
DOT_MULTI_TARGETS = NO
|
|
GENERATE_LEGEND = NO
|
|
DOT_CLEANUP = YES
|