Commit Graph

5 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
Harald Welte c663678b26 Add doxygen documentation to libosmocoding
This adds the minimum amount of API documentation that we should have on
all our code, particularly new code merged into a library.

Change-Id: I526804f64313867913574e50e5b9e9205ad3aa74
2017-06-12 15:35:23 +02:00
Vadim Yanitskiy 3262f820b5 libosmocoding: migrate transcoding routines from OsmoBTS
There are some projects, such as GR-GSM and OsmocomBB, which would
benefit from using one shared implementation of GSM 05.03 code. So,
this commit introduces a new sub-library called libosmocoding, which
(for now) provides GSM, GPRS and EDGE transcoding routines, migrated
from OsmoBTS.

The original GSM 05.03 code from OsmoBTS was relicensed under
GPLv2-or-later with permission of copyright holders (Andreas Eversberg,
Alexander Chemeris and Tom Tsou).

The following data types are currently supported:

 - xCCH
 - PDTCH (CS 1-4 and MCS 1-9)
 - TCH/FR
 - TCH/HR
 - TCH/AFS
 - RCH/AHS
 - RACH
 - SCH

Change-Id: I0c3256b87686d878e4e716d12393cad5924fdfa1
2017-03-07 01:06:38 +07:00