Commit Graph

8 Commits

Author SHA1 Message Date
Neels Hofmeyr 51816479bc doxygen: include all undocumented items in the API doc
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
2017-06-23 00:18:21 +00:00
Neels Hofmeyr 6a494f1ada doxygen: drop INPUT gsm/protocol, already part of gsm/
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
2017-06-23 00:18:21 +00:00
Harald Welte 486ac55f69 Doxygen: exclude osmocom/core/gsm/protocol/*
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
2017-03-15 09:13:38 +00:00
Sylvain Munaut 610ef99e6d Doxygen: enable tagfile generation and usage for cross-project references
Signed-off-by: Sylvain Munaut <tnt@246tNt.com>
2016-04-24 19:48:05 +02:00
Sylvain Munaut c7c582a95f Doxygen: Enable client-based search engine
Signed-off-by: Sylvain Munaut <tnt@246tNt.com>
2016-04-24 19:48:05 +02:00
Katerina Barone-Adesi c28c6a02d2 misc: Doxygen tweaks: fixed some typos and minor errors
Doxygen generates quite a lot of warnings on libosmocore. Some of them
are obvious typos - this patch aims to fix such low-hanging fruit.
2013-02-15 13:27:59 +01:00
Alex Badea 9043fe57e8 doxyfiles: refer paths to @srcdir@
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>
2013-01-06 00:42:26 +01:00
Harald Welte 49e1056cca Auto-generate the version information of Doxygen documentation 2011-08-17 19:22:12 +02:00