LUMIERA.clone/doc
Ichthyostega acb674a9d2 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-24 19:35:45 +01:00
..
design Global-Layer-Renaming: fix remaining textual usages and IDs in the code 2018-12-10 00:09:56 +01:00
devel Project: update and clean-up Doxygen configuration 2021-01-24 19:35:45 +01:00
technical MERGE: upgrade to Debian/Buster and to C++17 2020-02-22 02:16:25 +01:00
user C++17: some related clean-up 2020-02-21 23:55:09 +01:00
.gitignore infrastructure to test the documentation standalone 2018-11-01 04:38:17 +01:00
DIR_INFO spelling fixes 2011-02-06 02:12:55 +01:00
index.txt Global-Layer-Renaming: fix remaining textual usages and IDs in the code 2018-12-10 00:09:56 +01:00
SConscript DOC: reorganise the Doxygen configuration and structure 2013-10-25 06:34:38 +02:00