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
Clear out the EXCLUDE tag to not exclude anything.
Tried to add API doc to gsm/protocol/gsm_08_08.h and after a long time found
out why they are not appearing in the API doc.
The original reason to exclude these files was that we were not going to
copy-paste descriptions from the 3GPP specs. Nevertheless, for an API doc
reader it is helpful if all data structures are listed and linked.
Change-Id: Ib569a46f00866bdaa4017f803d85f625ae011316
In the generated API doc, do not print multiple enum values on the same line,
because this makes the lists pretty much unreadable.
Change-Id: I63d6f42567f532851e19eb8a6c842e418ce666af
Especially for short descriptions, it is annoying to have to type \brief for
every single API doc.
Drop all \brief and enable the AUTOBRIEF feature of doxygen, which always takes
the first sentence of an API doc as the brief description.
Change-Id: I11a8a821b065a128108641a2a63fb5a2b1916e87
Currently, files that omit the \file directive and all functions, enums,
structs lacking a doxygen style comment are completely missing from the doxygen
API docs.
Set EXTRACT_ALL = YES so that all files and code items are at least listed in
the doxygen API.
Change-Id: I39f558ec0a33a61a1fcec0554f53c8e7668733de
include/osmocom/gsm/protocol is also implicitly included in its parent dir
because of the recursive rule. Naming it again makes doxygen use it twice. It
doesn't seem to be harmful, but not needed either.
Change-Id: I5dc22ca65740a88540dacc61c0742fede172de9c
We don't document the header files that define structs/enums/types
that are taken 1:1 from the relevant GSM specifications. So let's avoid
having doxygen generate tons of warnings for related undocumented
members.
Change-Id: I231f78972a015902e4085aa80fcbc04009ae9f13
When building out-of-srcdir, paths such as "src/gsm" will not find any
source files. Since the Doxyfiles are preprocessed, we can prepend
@srcdir@ to fix that.
Signed-off-by: Alex Badea <vamposdecampos@gmail.com>
Neels Hofmeyr
Harald Welte
Neels Hofmeyr
Sylvain Munaut