LUMIERA.clone/doc/devel
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
..
draw DOC: a drawing to explain the 3D structure of the Track controls in the UI 2019-04-05 23:46:38 +02:00
images Documentation: integrate the time quantisation concept pages 2012-10-10 05:18:46 +02:00
meeting_summary Switch to HTTPS: also adjust protocol for the ASCIIDOC generated links 2018-10-26 17:47:18 +02:00
rfc Global-Layer-Renaming: fix remaining textual usages and IDs in the code 2018-12-10 00:09:56 +01:00
rfc_dropped DOC: mark this RfC as dropped -- it was never implemented this way 2014-09-08 02:46:46 +02:00
rfc_final DOC: decide to pull through with the layer renaming 2018-11-15 19:40:12 +01:00
rfc_parked apply the new RFC structure to existing RFC's 2012-08-30 20:50:08 +02:00
rfc_pending DOC: decide to pull through with the layer renaming 2018-11-15 19:40:12 +01:00
template DOC: update meeting and IRC transcript overview pages 2013-09-16 04:03:42 +02:00
transcript DOC: some further round-up and polishsing 2013-10-28 06:14:42 +01:00
uml CmdAccess: rename the front-end to CmdContext to clarify the purpose 2017-04-17 20:00:07 +02:00
.gitignore Project: update and clean-up Doxygen configuration 2021-01-24 19:35:45 +01:00
design_process.txt create a submenu entry showing all RfC 2012-10-07 08:06:30 +02:00
DIR_INFO DOC: some further round-up and polishsing 2013-10-28 06:14:42 +01:00
Doxyfile Project: update and clean-up Doxygen configuration 2021-01-24 19:35:45 +01:00
Doxyfile.browse Project: update and clean-up Doxygen configuration 2021-01-24 19:35:45 +01:00
Doxyfile.pdf Project: update and clean-up Doxygen configuration 2021-01-24 19:35:45 +01:00
DoxygenLayout.xml DOC: reorganise the Doxygen configuration and structure 2013-10-25 06:34:38 +02:00
report.txt Switch to HTTPS: also adjust protocol for the ASCIIDOC generated links 2018-10-26 17:47:18 +02:00