Ichthyostega
bd48b17f70
Hereby I introduce a ''Development Status'' page, where the current phase of the release cycle can be marked and similar status information is published. This page also includes the Changelog (from the file NEWS). Since updates must be checked into Git and then pushed to our website, such status marks are documented in the history. Some notes regarding the phases of the Release cycle were also added to the Release checklist. + some additional links resources and documentation tweaks
285 lines
9.3 KiB
Text
285 lines
9.3 KiB
Text
# Doxyfile 1.8.13
|
|
|
|
# Variation of the Lumiera Doxygen configuration for PDF output
|
|
#
|
|
# This setup was created several years again as draft,
|
|
# but never scrutinised or tested in practice.
|
|
# Feel free to tweak, adapt and improve it.
|
|
#
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Project related configuration options
|
|
#---------------------------------------------------------------------------
|
|
DOXYFILE_ENCODING = UTF-8
|
|
PROJECT_NAME = Lumiera
|
|
PROJECT_NUMBER = 0.pre.05~dev
|
|
PROJECT_BRIEF = "»edit your freedom«"
|
|
PROJECT_LOGO = draw/rendered/LumiLogo-small.png
|
|
OUTPUT_DIRECTORY =
|
|
CREATE_SUBDIRS = YES
|
|
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 = YES
|
|
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 = NO
|
|
EXTRACT_PRIVATE = NO
|
|
EXTRACT_PACKAGE = NO
|
|
EXTRACT_STATIC = YES
|
|
EXTRACT_LOCAL_CLASSES = YES
|
|
EXTRACT_LOCAL_METHODS = NO
|
|
EXTRACT_ANON_NSPACES = NO
|
|
RESOLVE_UNNAMED_PARAMS = YES
|
|
HIDE_UNDOC_MEMBERS = YES
|
|
HIDE_UNDOC_CLASSES = YES
|
|
HIDE_FRIEND_COMPOUNDS = NO
|
|
HIDE_IN_BODY_DOCS = YES
|
|
INTERNAL_DOCS = NO
|
|
CASE_SENSE_NAMES = YES
|
|
HIDE_SCOPE_NAMES = NO
|
|
SHOW_HEADERFILE = NO
|
|
SHOW_INCLUDE_FILES = NO
|
|
SHOW_GROUPED_MEMB_INC = NO
|
|
FORCE_LOCAL_INCLUDES = YES
|
|
INLINE_INFO = YES
|
|
SORT_MEMBER_DOCS = YES
|
|
SORT_BRIEF_DOCS = YES
|
|
SORT_MEMBERS_CTORS_1ST = YES
|
|
SORT_GROUP_NAMES = NO
|
|
SORT_BY_SCOPE_NAME = NO
|
|
STRICT_PROTO_MATCHING = NO
|
|
GENERATE_TODOLIST = NO
|
|
GENERATE_TESTLIST = YES
|
|
GENERATE_BUGLIST = NO
|
|
GENERATE_DEPRECATEDLIST= NO
|
|
ENABLED_SECTIONS =
|
|
MAX_INITIALIZER_LINES = 50
|
|
SHOW_USED_FILES = NO
|
|
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-pdf.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 = NO
|
|
INLINE_SOURCES = NO
|
|
STRIP_CODE_COMMENTS = YES
|
|
REFERENCED_BY_RELATION = YES
|
|
REFERENCES_RELATION = YES
|
|
REFERENCES_LINK_SOURCE = YES
|
|
SOURCE_TOOLTIPS = NO
|
|
USE_HTAGS = NO
|
|
VERBATIM_HEADERS = NO
|
|
CLANG_ASSISTED_PARSING = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# 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 = NO
|
|
HTML_OUTPUT = html_browse
|
|
HTML_FILE_EXTENSION = .html
|
|
HTML_HEADER =
|
|
HTML_FOOTER =
|
|
HTML_STYLESHEET =
|
|
HTML_EXTRA_STYLESHEET =
|
|
HTML_EXTRA_FILES =
|
|
HTML_COLORSTYLE = LIGHT
|
|
HTML_DYNAMIC_MENUS = YES
|
|
HTML_DYNAMIC_SECTIONS = NO
|
|
HTML_CODE_FOLDING = NO
|
|
HTML_PROJECT_COOKIE = DoxyLumiBrow
|
|
HTML_INDEX_NUM_ENTRIES = 500
|
|
GENERATE_DOCSET = NO
|
|
GENERATE_HTMLHELP = NO
|
|
GENERATE_ECLIPSEHELP = NO
|
|
TOC_EXPAND = NO
|
|
DISABLE_INDEX = NO
|
|
GENERATE_TREEVIEW = YES
|
|
TREEVIEW_WIDTH = 250
|
|
ENUM_VALUES_PER_LINE = 4
|
|
EXT_LINKS_IN_WINDOW = NO
|
|
HTML_FORMULA_FORMAT = svg
|
|
FORMULA_FONTSIZE = 9
|
|
USE_MATHJAX = NO
|
|
SEARCHENGINE = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the LaTeX output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_LATEX = YES
|
|
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 =
|
|
ALLEXTERNALS = NO
|
|
EXTERNAL_GROUPS = NO
|
|
EXTERNAL_PAGES = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the dot tool
|
|
#---------------------------------------------------------------------------
|
|
HAVE_DOT = YES
|
|
DOT_NUM_THREADS = 0 # use all cores
|
|
CLASS_GRAPH = NO
|
|
COLLABORATION_GRAPH = NO
|
|
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 = NO
|
|
CALLER_GRAPH = NO
|
|
DIRECTORY_GRAPH = NO
|
|
GRAPHICAL_HIERARCHY = NO
|
|
DOT_IMAGE_FORMAT = png
|
|
INTERACTIVE_SVG = NO
|
|
DOT_GRAPH_MAX_NODES = 50
|
|
MAX_DOT_GRAPH_DEPTH = 10
|
|
DOT_MULTI_TARGETS = NO
|
|
GENERATE_LEGEND = NO
|
|
DOT_CLEANUP = YES
|