summaryrefslogtreecommitdiffstats
path: root/Doxyfile.gsm.in
Commit message (Collapse)AuthorAgeFilesLines
* doxygen: gsm: do not exclude include/gsm/protocol/*Neels Hofmeyr2017-06-251-1/+1
| | | | | | | | | | | | | 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
* doxygen: config: one enum val per lineNeels Hofmeyr2017-06-231-1/+1
| | | | | | | 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
* doxygen: enable AUTOBRIEF, drop \briefNeels Hofmeyr2017-06-231-3/+3
| | | | | | | | | | 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
* doxygen: include all undocumented items in the API docNeels Hofmeyr2017-06-231-1/+1
| | | | | | | | | | | 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
* doxygen: drop INPUT gsm/protocol, already part of gsm/Neels Hofmeyr2017-06-231-1/+1
| | | | | | | | 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
* Doxygen: exclude osmocom/core/gsm/protocol/*Harald Welte2017-03-151-1/+1
| | | | | | | | | 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
* Doxygen: enable tagfile generation and usage for cross-project referencesSylvain Munaut2016-04-241-2/+2
| | | | Signed-off-by: Sylvain Munaut <tnt@246tNt.com>
* Doxygen: Enable client-based search engineSylvain Munaut2016-04-241-1/+1
| | | | Signed-off-by: Sylvain Munaut <tnt@246tNt.com>
* misc: Doxygen tweaks: fixed some typos and minor errorsKaterina Barone-Adesi2013-02-151-2/+2
| | | | | Doxygen generates quite a lot of warnings on libosmocore. Some of them are obvious typos - this patch aims to fix such low-hanging fruit.
* doxyfiles: refer paths to @srcdir@Alex Badea2013-01-061-1/+1
| | | | | | | | 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>
* Auto-generate the version information of Doxygen documentationHarald Welte2011-08-171-0/+1716
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-16 21:08:15 +0000