[MERGED] libosmocore[master]: [doc] make sure all SMS related code is part of the 'sms' group

This is merely a historical archive of years 2008-2021, before the migration to mailman3.

A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/gerrit-log@lists.osmocom.org/.

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


Harald Welte has submitted this change and it was merged.

Change subject: [doc] make sure all SMS related code is part of the 'sms' group
......................................................................


[doc] make sure all SMS related code is part of the 'sms' group

Change-Id: I24c56ccb56d5b39cfb887808f91b715da54c0f8b
---
M include/osmocom/gsm/gsm0341.h
M include/osmocom/gsm/gsm0411_smc.h
M include/osmocom/gsm/gsm0411_smr.h
M include/osmocom/gsm/gsm0411_utils.h
M src/gsm/gsm0341.c
M src/gsm/gsm0411_smc.c
M src/gsm/gsm0411_smr.c
M src/gsm/gsm0411_utils.c
8 files changed, 27 insertions(+), 11 deletions(-)

Approvals:
  Harald Welte: Looks good to me, approved
  Jenkins Builder: Verified



diff --git a/include/osmocom/gsm/gsm0341.h b/include/osmocom/gsm/gsm0341.h
index 2fc83e4..834dbf9 100644
--- a/include/osmocom/gsm/gsm0341.h
+++ b/include/osmocom/gsm/gsm0341.h
@@ -1,4 +1,6 @@
-/*! \file gsm0341.h */
+/*! \defgroup sms Short Message Service (SMS)
+ *  @{
+ * \file gsm0341.h */
 
 #pragma once
 
@@ -9,3 +11,5 @@
 		  uint8_t update, uint16_t msg_id, uint8_t dcs,
 		  uint8_t page_total, uint8_t page_cur,
 		  uint8_t *data, uint8_t len);
+
+/*! @} */
diff --git a/include/osmocom/gsm/gsm0411_smc.h b/include/osmocom/gsm/gsm0411_smc.h
index 0cd1f94..7dfaa15 100644
--- a/include/osmocom/gsm/gsm0411_smc.h
+++ b/include/osmocom/gsm/gsm0411_smc.h
@@ -1,4 +1,6 @@
-/*! \file gsm0411_smc.h */
+/*! \addtogroup sms
+ *  @{
+ *  \file gsm0411_smc.h */
 
 #pragma once
 
@@ -61,3 +63,5 @@
 /* message from lower layer */
 int gsm411_smc_recv(struct gsm411_smc_inst *inst, int msg_type,
 	struct msgb *msg, int cp_msg_type);
+
+/*! @} */
diff --git a/include/osmocom/gsm/gsm0411_smr.h b/include/osmocom/gsm/gsm0411_smr.h
index 19f9c5d..28f43de 100644
--- a/include/osmocom/gsm/gsm0411_smr.h
+++ b/include/osmocom/gsm/gsm0411_smr.h
@@ -1,4 +1,6 @@
-/*! \file gsm0411_smr.h */
+/*! \addtogroup sms
+ *  @{
+ * \file gsm0411_smr.h */
 
 #pragma once
 
@@ -42,3 +44,5 @@
 /* message from lower layer */
 int gsm411_smr_recv(struct gsm411_smr_inst *inst, int msg_type,
 	struct msgb *msg);
+
+/*! @} */
diff --git a/include/osmocom/gsm/gsm0411_utils.h b/include/osmocom/gsm/gsm0411_utils.h
index 1c51111..2cd87b8 100644
--- a/include/osmocom/gsm/gsm0411_utils.h
+++ b/include/osmocom/gsm/gsm0411_utils.h
@@ -1,4 +1,6 @@
-/*! \file gsm0411_utils.h */
+/*! \addtogroup sms
+ *  @{
+ * \file gsm0411_utils.h */
 
 #pragma once
 
@@ -35,3 +37,5 @@
 /* Prefix msg with a 04.08/04.11 CP header */
 int gsm411_push_cp_header(struct msgb *msg, uint8_t proto, uint8_t trans,
 			     uint8_t msg_type);
+
+/*! @} */
diff --git a/src/gsm/gsm0341.c b/src/gsm/gsm0341.c
index 05a0b4a..485023f 100644
--- a/src/gsm/gsm0341.c
+++ b/src/gsm/gsm0341.c
@@ -1,4 +1,3 @@
-/*! \file gsm0341.c */
 /*
  * (C) 2014 by Harald Welte <laforge at gnumonks.org>
  * All Rights Reserved
@@ -30,6 +29,7 @@
 
 /*! \addtogroup sms
  *  @{
+ *  \file gsm0341.c
  */
 
 /*! Encode a 3GPP TS 03.41 SMS-CB message
diff --git a/src/gsm/gsm0411_smc.c b/src/gsm/gsm0411_smc.c
index 7414e95..f7c536b 100644
--- a/src/gsm/gsm0411_smc.c
+++ b/src/gsm/gsm0411_smc.c
@@ -1,5 +1,4 @@
-/*! \file gsm0411_smc.c
- * Point-to-Point (PP) Short Message Service (SMS).
+/* Point-to-Point (PP) Short Message Service (SMS).
  * Support on Mobile Radio Interface
  * 3GPP TS 04.11 version 7.1.0 Release 1998 / ETSI TS 100 942 V7.1.0. */
 /*
@@ -63,6 +62,7 @@
 
 /*! \addtogroup sms
  *  @{
+ *  \file gsm0411_smc.c
  *  Point-to-Point (PP) Short Message Service (SMS) as per TS 04.11
  */
 
diff --git a/src/gsm/gsm0411_smr.c b/src/gsm/gsm0411_smr.c
index 67bb249..0a25c7c 100644
--- a/src/gsm/gsm0411_smr.c
+++ b/src/gsm/gsm0411_smr.c
@@ -1,5 +1,4 @@
-/*! \file gsm0411_smr.c
- * Point-to-Point (PP) Short Message Service (SMS).
+/* Point-to-Point (PP) Short Message Service (SMS).
  * Support on Mobile Radio Interface
  * 3GPP TS 04.11 version 7.1.0 Release 1998 / ETSI TS 100 942 V7.1.0 */
 /*
@@ -65,6 +64,7 @@
 
 /*! \addtogroup sms
  *  @{
+ *  \file gsm0411_smr.c
  */
 
 static void rp_timer_expired(void *data);
diff --git a/src/gsm/gsm0411_utils.c b/src/gsm/gsm0411_utils.c
index a4e9d0d..acf7e23 100644
--- a/src/gsm/gsm0411_utils.c
+++ b/src/gsm/gsm0411_utils.c
@@ -1,5 +1,4 @@
-/*! \file gsm0411_utils.c
- * Point-to-Point (PP) Short Message Service (SMS).
+/* Point-to-Point (PP) Short Message Service (SMS).
  * Support on Mobile Radio Interface
  * 3GPP TS 04.11 version 7.1.0 Release 1998 / ETSI TS 100 942 V7.1.0. */
 /*
@@ -41,6 +40,7 @@
 
 /*! \addtogroup sms
  *  @{
+ *  \file gsm0411_utils.c
  */
 
 #define GSM411_ALLOC_SIZE	1024

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

Gerrit-MessageType: merged
Gerrit-Change-Id: I24c56ccb56d5b39cfb887808f91b715da54c0f8b
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