Commit Graph

8 Commits

Author SHA1 Message Date
Neels Hofmeyr 95efc6993f doxygen: config: one enum val per line
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
2017-06-23 00:18:24 +00:00
Neels Hofmeyr 87e4550585 doxygen: enable AUTOBRIEF, drop \brief
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
2017-06-23 00:18:22 +00:00
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
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