ichthyo/LUMIERA.clone
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
LUMIERA.clone/doc/devel/Doxyfile.browse

288 lines
9.4 KiB
Text
Raw Normal View History

Project: update and clean-up Doxygen configuration ...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
2021-01-23 16:45:04 +01:00
# Doxyfile 1.8.13
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
Project: update and clean-up Doxygen configuration ...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
2021-01-23 16:45:04 +01:00
# 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.
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
#
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = Lumiera
Dev: bump version to 0.pre.05~dev __Explanation__: in line with the Git-flow scheme, the version number embedded in-tree will now indicate the ''expected next release version,'' yet marked with a suffix `~dev` (which sorts ''before'' this version number)
2025-07-21 03:42:55 +02:00
PROJECT_NUMBER = 0.pre.05~dev
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
PROJECT_BRIEF = "»edit your freedom«"
Project: update and clean-up Doxygen configuration ...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
2021-01-23 16:45:04 +01:00
PROJECT_LOGO = draw/rendered/LumiLogo-small.png
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
OUTPUT_DIRECTORY =
small tweaks to the doxygen config
2013-09-12 22:30:01 +02:00
CREATE_SUBDIRS = NO
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
ALLOW_UNICODE_NAMES = NO
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
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/
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
STRIP_FROM_INC_PATH = ../../src/
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = YES
QT_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
PYTHON_DOCSTRING = NO
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 4
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
ALIASES =
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
OPTIMIZE_OUTPUT_FOR_C = NO
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
OPTIMIZE_OUTPUT_JAVA = NO
EXTENSION_MAPPING =
MARKDOWN_SUPPORT = YES
MARKDOWN_ID_STYLE = GITHUB
TOC_INCLUDE_HEADINGS = 2
AUTOLINK_SUPPORT = YES
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
BUILTIN_STL_SUPPORT = YES
CPP_CLI_SUPPORT = NO
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
IDL_PROPERTY_SUPPORT = NO
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
DISTRIBUTE_GROUP_DOC = NO
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
GROUP_NESTED_COMPOUNDS = NO
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
SUBGROUPING = YES
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
INLINE_GROUPED_CLASSES = NO
INLINE_SIMPLE_STRUCTS = YES
TYPEDEF_HIDES_STRUCT = YES
LOOKUP_CACHE_SIZE = 2
NUM_PROC_THREADS = 0
TIMESTAMP = DATE
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL = YES
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
EXTRACT_PRIVATE = NO
EXTRACT_PACKAGE = NO
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = NO
EXTRACT_ANON_NSPACES = NO
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
RESOLVE_UNNAMED_PARAMS = YES
HIDE_UNDOC_MEMBERS = YES
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
HIDE_UNDOC_CLASSES = NO
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
INTERNAL_DOCS = NO
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
CASE_SENSE_NAMES = YES
HIDE_SCOPE_NAMES = NO
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
SHOW_HEADERFILE = YES
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
SHOW_INCLUDE_FILES = YES
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
SHOW_GROUPED_MEMB_INC = NO
FORCE_LOCAL_INCLUDES = YES
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
INLINE_INFO = YES
SORT_MEMBER_DOCS = NO
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
SORT_BRIEF_DOCS = NO
SORT_MEMBERS_CTORS_1ST = YES
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
SORT_GROUP_NAMES = NO
SORT_BY_SCOPE_NAME = NO
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
STRICT_PROTO_MATCHING = NO
Project: update and clean-up Doxygen configuration ...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
2021-01-23 16:45:04 +01:00
GENERATE_TODOLIST = NO
GENERATE_TESTLIST = NO
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
GENERATE_BUGLIST = NO
Project: update and clean-up Doxygen configuration ...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
2021-01-23 16:45:04 +01:00
GENERATE_DEPRECATEDLIST= NO
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 50
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
SHOW_USED_FILES = YES
SHOW_FILES = YES
SHOW_NAMESPACES = YES
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
FILE_VERSION_FILTER =
LAYOUT_FILE =
CITE_BIB_FILES =
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
#---------------------------------------------------------------------------
Project: update and clean-up Doxygen configuration ...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
2021-01-23 16:45:04 +01:00
# Configuration options related to warning and progress messages
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
#---------------------------------------------------------------------------
QUIET = NO
WARNINGS = YES
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
WARN_IF_UNDOCUMENTED = NO
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
WARN_IF_DOC_ERROR = YES
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
WARN_NO_PARAMDOC = NO
WARN_AS_ERROR = NO
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
WARN_FORMAT = "$file:$line: $text"
Project: update and clean-up Doxygen configuration ...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
2021-01-23 16:45:04 +01:00
WARN_LOGFILE = doxygen-warnings-browse.txt
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
#---------------------------------------------------------------------------
Project: update and clean-up Doxygen configuration ...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
2021-01-23 16:45:04 +01:00
# Configuration options related to the input files
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
#---------------------------------------------------------------------------
INPUT_ENCODING = UTF-8
Project: update and clean-up Doxygen configuration ...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
2021-01-23 16:45:04 +01:00
INPUT = ../../src/ \
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
../../tests \
../../admin/scons
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
FILE_PATTERNS = *.c \
*.cc \
*.cpp \
*.h \
*.hh \
*.hpp \
*.inc \
*.dox \
Project: update and clean-up Doxygen configuration ...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
2021-01-23 16:45:04 +01:00
*.py
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
RECURSIVE = YES
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
EXCLUDE =
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
EXCLUDE_SYMLINKS = YES
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
EXAMPLE_PATH =
EXAMPLE_PATTERNS =
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
EXAMPLE_RECURSIVE = NO
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
IMAGE_PATH =
INPUT_FILTER =
FILTER_PATTERNS =
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
FILTER_SOURCE_FILES = NO
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
FILTER_SOURCE_PATTERNS =
USE_MDFILE_AS_MAINPAGE =
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
#---------------------------------------------------------------------------
Project: update and clean-up Doxygen configuration ...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
2021-01-23 16:45:04 +01:00
# Configuration options related to source browsing
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
#---------------------------------------------------------------------------
SOURCE_BROWSER = YES
INLINE_SOURCES = YES
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
REFERENCES_LINK_SOURCE = YES
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
SOURCE_TOOLTIPS = YES
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
USE_HTAGS = NO
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
VERBATIM_HEADERS = NO
CLANG_ASSISTED_PARSING = NO
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
#---------------------------------------------------------------------------
Project: update and clean-up Doxygen configuration ...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
2021-01-23 16:45:04 +01:00
# Configuration options related to the alphabetical class index
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = YES
IGNORE_PREFIX = lumiera:: \
lumiera_ \
lumi_ \
LUMIERA_
#---------------------------------------------------------------------------
Project: update and clean-up Doxygen configuration ...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
2021-01-23 16:45:04 +01:00
# Configuration options related to the HTML output
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = html_browse
HTML_FILE_EXTENSION = .html
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
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
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
GENERATE_DOCSET = NO
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
GENERATE_HTMLHELP = NO
GENERATE_ECLIPSEHELP = NO
TOC_EXPAND = NO
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
DISABLE_INDEX = NO
GENERATE_TREEVIEW = YES
TREEVIEW_WIDTH = 250
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
ENUM_VALUES_PER_LINE = 4
EXT_LINKS_IN_WINDOW = NO
HTML_FORMULA_FORMAT = svg
FORMULA_FONTSIZE = 9
USE_MATHJAX = NO
Project: update and clean-up Doxygen configuration ...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
2021-01-23 16:45:04 +01:00
SEARCHENGINE = NO
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
#---------------------------------------------------------------------------
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
# Configuration options related to the LaTeX output
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
#---------------------------------------------------------------------------
GENERATE_LATEX = NO
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
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
#---------------------------------------------------------------------------
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
GENERATE_RTF = NO
GENERATE_MAN = NO
GENERATE_XML = NO
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
GENERATE_DOCBOOK = NO
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
GENERATE_AUTOGEN_DEF = NO
GENERATE_PERLMOD = NO
#---------------------------------------------------------------------------
Project: update and clean-up Doxygen configuration ...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
2021-01-23 16:45:04 +01:00
# Configuration options related to the preprocessor
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = NO
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED = __cplusplus DEBUG EBUG_ALPHA
EXPAND_AS_DEFINED =
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
Project: update and clean-up Doxygen configuration ...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
2021-01-23 16:45:04 +01:00
# Configuration options related to external references
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
#---------------------------------------------------------------------------
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
TAGFILES =
GENERATE_TAGFILE =
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
Project: update and clean-up Doxygen configuration ...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
2021-01-23 16:45:04 +01:00
EXTERNAL_PAGES = NO
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
#---------------------------------------------------------------------------
Project: update and clean-up Doxygen configuration ...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
2021-01-23 16:45:04 +01:00
# Configuration options related to the dot tool
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
#---------------------------------------------------------------------------
HAVE_DOT = YES
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
DOT_NUM_THREADS = 0 # use all cores
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
CLASS_GRAPH = NO
COLLABORATION_GRAPH = NO
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
GROUP_GRAPHS = YES
HIDE_UNDOC_RELATIONS = YES
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
UML_LOOK = YES
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
UML_LIMIT_NUM_FIELDS = 12
TEMPLATE_RELATIONS = YES
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
INCLUDE_GRAPH = NO
INCLUDED_BY_GRAPH = NO
CALL_GRAPH = NO
CALLER_GRAPH = NO
DIRECTORY_GRAPH = NO
Status: Release published -- now again in Development Phase 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
2025-12-09 23:11:46 +01:00
GRAPHICAL_HIERARCHY = NO
DOT_IMAGE_FORMAT = svg
INTERACTIVE_SVG = NO
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
DOT_GRAPH_MAX_NODES = 50
Project: update and clean-up Doxygen configuration ...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
2021-01-23 16:45:04 +01:00
MAX_DOT_GRAPH_DEPTH = 10
New Doxyfile.browse for detailed code browsing This generates a detailed documentation in html_browse/ * all things get extracted (undocumented, TODO, BUG etc...) * produces a warnings_browse.txt to show undocumented things * no graphs to keep it reasonable small
2008-11-14 18:20:41 +01:00
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = NO
DOT_CLEANUP = YES
Reference in a new issue Copy permalink