[PATCH] libosmocore[master]: [doc] Properly define gsm0800 group and move all related fil...

Harald Welte gerrit-no-reply at lists.osmocom.org
Tue Oct 17 05:53:14 UTC 2017


Hello Jenkins Builder,

I'd like you to reexamine a change.  Please visit

    https://gerrit.osmocom.org/4303

to look at the new patch set (#2).

[doc] Properly define gsm0800 group and move all related files into it

Change-Id: I91920c69c86d6a1932172becacb76faff2d3eb1e
---
M include/osmocom/gsm/gsm0808.h
M include/osmocom/gsm/gsm0808_utils.h
M src/gsm/gsm0808.c
M src/gsm/gsm0808_utils.c
4 files changed, 14 insertions(+), 5 deletions(-)


  git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/03/4303/2

diff --git a/include/osmocom/gsm/gsm0808.h b/include/osmocom/gsm/gsm0808.h
index 4369cab..3deee70 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 at selfish.org>
  * (C) 2009,2010 by On-Waves
@@ -75,3 +77,5 @@
 
 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 17a03f5..db15666 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_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 a8a5e45..ee5eda4 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 at 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 e2cd91b..798a122 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

-- 
To view, visit https://gerrit.osmocom.org/4303
To unsubscribe, visit https://gerrit.osmocom.org/settings

Gerrit-MessageType: newpatchset
Gerrit-Change-Id: I91920c69c86d6a1932172becacb76faff2d3eb1e
Gerrit-PatchSet: 2
Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-Owner: Harald Welte <laforge at gnumonks.org>
Gerrit-Reviewer: Harald Welte <laforge at gnumonks.org>
Gerrit-Reviewer: Jenkins Builder


More information about the gerrit-log mailing list