diff options
author | Neels Hofmeyr <neels@hofmeyr.de> | 2019-02-01 05:25:36 +0100 |
---|---|---|
committer | Neels Hofmeyr <nhofmeyr@sysmocom.de> | 2019-02-04 16:43:57 +0000 |
commit | 2fe50ac9511469a587426b80501b2b5da770e3a0 (patch) | |
tree | ee38028794ac52cd0a7a2100bcb564a3d8941869 /Doxyfile.coding.in | |
parent | c1aa178c8bc71129d13b7b47cfce4449bcec0c2c (diff) |
doxygen: enable cross referencing everywhere
doxygen \ref cross-references to groups or files from other libraries only work
when the .map file was present when the HTML was generated, and when that .map
file was listed in TAGFILES in the Doxyfile.
- Makefile.am: introduce a two-pass build for doxygen API docs.
- First build pass makes sure the .tag files are present.
- Second build pass picks up all the references, hence generates hyperlinks
properly.
- Add all libraries to TAGFILES of all other libraries, so we can from now on
freely criss-cross reference from everywhere to everywhere.
- Add all libraries' tag files as dependencies for all others.
Example: in upcoming tdef.h, I would like to cross reference to tdef_vty.h, and
vice versa, even though they are in libosmocore and libosmovty, respectively.
This is now possible.
We may still need to fix some problems with naming collisions, see for example
stats.h, which exists twice with identical doxygen handle (different source
dirs seems to not suffice for doxygen).
Change-Id: Ib03d0b70d536c8f1386def666c89106a840f7363
Diffstat (limited to 'Doxyfile.coding.in')
-rw-r--r-- | Doxyfile.coding.in | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Doxyfile.coding.in b/Doxyfile.coding.in index 43c4f822..d0e99425 100644 --- a/Doxyfile.coding.in +++ b/Doxyfile.coding.in @@ -1485,7 +1485,7 @@ SKIP_FUNCTION_MACROS = YES # If a tag file is not located in the directory in which doxygen # is run, you must also specify the path to the tagfile here. -TAGFILES = doc/libosmocore.tag=../../core/html +TAGFILES = doc/libosmocore.tag=../../core/html doc/libosmogsm.tag=../../gsm/html doc/libosmovty.tag=../../vty/html doc/libosmocodec.tag=../../codec/html doc/libosmoctrl.tag=../../ctrl/html doc/libosmogb.tag=../../gb/html # When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. |