From c663678b26aed636e13b56ab8a220791e268f244 Mon Sep 17 00:00:00 2001
From: Harald Welte <laforge@gnumonks.org>
Date: Mon, 12 Jun 2017 14:59:37 +0200
Subject: 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
---
 src/coding/gsm0503_parity.c | 40 ++++++++++++++++++++++------------------
 1 file changed, 22 insertions(+), 18 deletions(-)

(limited to 'src/coding/gsm0503_parity.c')

diff --git a/src/coding/gsm0503_parity.c b/src/coding/gsm0503_parity.c
index 99198ba8..171feb46 100644
--- a/src/coding/gsm0503_parity.c
+++ b/src/coding/gsm0503_parity.c
@@ -24,8 +24,18 @@
 #include <osmocom/core/crcgen.h>
 #include <osmocom/coding/gsm0503_parity.h>
 
-/*
- * GSM (SACCH) parity (FIRE code)
+/*! \addtogroup parity
+ *  @{
+ *
+ *  \brief GSM TS 05.03 parity
+ *
+ *  This module contains parity/crc code definitions for the various
+ *  parity/crc schemes as defined in 3GPP TS 05.03 / 45.003
+ */
+
+/*! \file gsm0503_parity.c */
+
+/*! \brief GSM (SACCH) parity (FIRE code)
  *
  * g(x) = (x^23 + 1)(x^17 + x^3 + 1)
  *      = x^40 + x^26 + x^23 + x^17 + x^3 + a1
@@ -37,8 +47,7 @@ const struct osmo_crc64gen_code gsm0503_fire_crc40 = {
 	.remainder = 0xffffffffffULL,
 };
 
-/*
- * GSM PDTCH CS-2, CS-3, CS-4 parity
+/*! \brief GSM PDTCH CS-2, CS-3, CS-4 parity
  *
  * g(x) = x^16 + x^12 + x^5 + 1
  */
@@ -49,8 +58,7 @@ const struct osmo_crc16gen_code gsm0503_cs234_crc16 = {
 	.remainder = 0xffff,
 };
 
-/*
- * EDGE MCS header parity
+/*! \brief EDGE MCS header parity
  *
  */
 const struct osmo_crc8gen_code gsm0503_mcs_crc8_hdr = {
@@ -60,8 +68,7 @@ const struct osmo_crc8gen_code gsm0503_mcs_crc8_hdr = {
 	.remainder = 0xff,
 };
 
-/*
- * EDGE MCS data parity
+/*! \brief EDGE MCS data parity
  *
  */
 const struct osmo_crc16gen_code gsm0503_mcs_crc12 = {
@@ -71,8 +78,7 @@ const struct osmo_crc16gen_code gsm0503_mcs_crc12 = {
 	.remainder = 0x0fff,
 };
 
-/*
- * GSM RACH parity
+/*! \brief GSM RACH parity
  *
  * g(x) = x^6 + x^5 + x^3 + x^2 + x^1 + 1
  */
@@ -83,8 +89,7 @@ const struct osmo_crc8gen_code gsm0503_rach_crc6 = {
 	.remainder = 0x3f,
 };
 
-/*
- * GSM SCH parity
+/*! \brief GSM SCH parity
  *
  * g(x) = x^10 + x^8 + x^6 + x^5 + x^4 + x^2 + 1
  */
@@ -95,8 +100,7 @@ const struct osmo_crc16gen_code gsm0503_sch_crc10 = {
 	.remainder = 0x3ff,
 };
 
-/*
- * GSM TCH FR/HR/EFR parity
+/*! \brief GSM TCH FR/HR/EFR parity
  *
  * g(x) = x^3 + x + 1
  */
@@ -107,8 +111,7 @@ const struct osmo_crc8gen_code gsm0503_tch_fr_crc3 = {
 	.remainder = 0x7,
 };
 
-/*
- * GSM TCH EFR parity
+/*! \brief GSM TCH EFR parity
  *
  * g(x) = x^8 + x^4 + x^3 + x^2 + 1
  */
@@ -119,8 +122,7 @@ const struct osmo_crc8gen_code gsm0503_tch_efr_crc8 = {
 	.remainder = 0x00,
 };
 
-/*
- * GSM AMR parity
+/*! \brief GSM AMR parity
  *
  * g(x) = x^6 + x^5 + x^3 + x^2 + x^1 + 1
  */
@@ -130,3 +132,5 @@ const struct osmo_crc8gen_code gsm0503_amr_crc6 = {
 	.init = 0x00,
 	.remainder = 0x3f,
 };
+
+/*! @} */
-- 
cgit v1.2.3