aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2017-10-16 18:46:03 +0200
committerHarald Welte <laforge@gnumonks.org>2017-10-17 07:53:02 +0200
commit37b61655130b200bb26bc75633a515f3bfdc3208 (patch)
treea47b9e2105d836abe72b62f6b389c9cb16d5af6c
parenta338983d3bfd8d8475921df84b746d27f857d2e7 (diff)
[doc] Properly define gsm0800 group and move all related files into it
-rw-r--r--include/osmocom/gsm/gsm0808.h6
-rw-r--r--include/osmocom/gsm/gsm0808_utils.h6
-rw-r--r--src/gsm/gsm0808.c5
-rw-r--r--src/gsm/gsm0808_utils.c2
4 files changed, 14 insertions, 5 deletions
diff --git a/include/osmocom/gsm/gsm0808.h b/include/osmocom/gsm/gsm0808.h
index 4369cabe..3deee70d 100644
--- a/include/osmocom/gsm/gsm0808.h
+++ b/include/osmocom/gsm/gsm0808.h
@@ -1,4 +1,6 @@
-/*! \file gsm0808.h */
+/*! \defgroup gsm0808 GSM 08.08 / 3GPP TS 48.008 A Interface
+ * @{
+ * \file gsm0808.h */
/*
* (C) 2009,2010 by Holger Hans Peter Freyther <zecke@selfish.org>
* (C) 2009,2010 by On-Waves
@@ -75,3 +77,5 @@ const struct tlv_definition *gsm0808_att_tlvdef(void);
const char *gsm0808_bssmap_name(uint8_t msg_type);
const char *gsm0808_bssap_name(uint8_t msg_type);
+
+/*! @} */
diff --git a/include/osmocom/gsm/gsm0808_utils.h b/include/osmocom/gsm/gsm0808_utils.h
index 17a03f55..db156668 100644
--- a/include/osmocom/gsm/gsm0808_utils.h
+++ b/include/osmocom/gsm/gsm0808_utils.h
@@ -1,4 +1,6 @@
-/*! \file gsm0808_utils.h */
+/*! \addtogroup gsm0808
+ * @{
+ * \file gsm0808_utils.h */
/*
* (C) 2016 by Sysmocom s.f.m.c. GmbH
* All Rights Reserved
@@ -53,3 +55,5 @@ int gsm0808_dec_cell_id_list(struct gsm0808_cell_id_list *cil,
int gsm0808_chan_type_to_speech_codec(uint8_t perm_spch);
int gsm0808_speech_codec_from_chan_type(struct gsm0808_speech_codec *sc,
uint8_t perm_spch);
+
+/*! @} */
diff --git a/src/gsm/gsm0808.c b/src/gsm/gsm0808.c
index a8a5e45a..ee5eda4d 100644
--- a/src/gsm/gsm0808.c
+++ b/src/gsm/gsm0808.c
@@ -1,4 +1,3 @@
-/*! \file gsm0808.c */
/*
* (C) 2009,2010 by Holger Hans Peter Freyther <zecke@selfish.org>
* (C) 2009,2010 by On-Waves
@@ -28,7 +27,9 @@
/*! \addtogroup gsm0808
* @{
- * Helper functions regarding the TS 08.08 / 48.008 A interface
+ * \file gsm0808.c
+ * Helper functions regarding the TS 08.08 / 48.008 A interface, primarily
+ * message generation/encoding.
*/
#define BSSMAP_MSG_SIZE 512
diff --git a/src/gsm/gsm0808_utils.c b/src/gsm/gsm0808_utils.c
index e2cd91b4..798a122b 100644
--- a/src/gsm/gsm0808_utils.c
+++ b/src/gsm/gsm0808_utils.c
@@ -1,4 +1,3 @@
-/*! \file gsm0808_utils.c */
/*
* (C) 2016 by Sysmocom s.f.m.c. GmbH
* All Rights Reserved
@@ -44,6 +43,7 @@
/*! \addtogroup gsm0808
* @{
+ * \file gsm0808_utils.c
*/
/*! Encode TS 08.08 AoIP transport address IE