summaryrefslogtreecommitdiffstats
path: root/Doxyfile.core.in
Commit message (Collapse)AuthorAgeFilesLines
* Set HTML_TIMESTAMP to NO to make build reproducibleRuben Undheim2019-07-171-1/+1
| | | | Change-Id: I56cce5cda0621f5e9f1c28aaad4646e9e267d17d
* doxygen: enable cross referencing everywhereNeels Hofmeyr2019-02-041-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | 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
* [doc] Ensure stats.h is parsed properly for DoxygenHarald Welte2017-10-171-1/+1
| | | | | | | | | stats.h uses a rather crude '#ifdef unix' hack, which means that Doxygen will not scan the body of the file. This patch ensures 'unix' is defined to parse the stats.h body and thus have all relevant information in it is parsed. Change-Id: I65384e5cc01f2ad7783cf6b71ab78b4422902aa1
* 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: enable tagfile generation and usage for cross-project referencesSylvain Munaut2016-04-241-1/+1
| | | | 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.
* doc: Fix typo in Doxyfile.core.in causing sources to be ignoredSylvain Munaut2013-02-081-1/+1
| | | | Signed-off-by: Sylvain Munaut <tnt@246tNt.com>
* 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>
* consistent Doxyfile namingHarald Welte2011-08-201-0/+1716
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-28 04:18:21 +0000