From 55d724addc3184a7fd6bb77160bbdbd0ec772d9f Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Mon, 16 Oct 2017 18:25:45 +0200 Subject: [doc] make sure all SMS related code is part of the 'sms' group Change-Id: I24c56ccb56d5b39cfb887808f91b715da54c0f8b --- include/osmocom/gsm/gsm0341.h | 6 +++++- include/osmocom/gsm/gsm0411_smc.h | 6 +++++- include/osmocom/gsm/gsm0411_smr.h | 6 +++++- include/osmocom/gsm/gsm0411_utils.h | 6 +++++- src/gsm/gsm0341.c | 2 +- src/gsm/gsm0411_smc.c | 4 ++-- src/gsm/gsm0411_smr.c | 4 ++-- src/gsm/gsm0411_utils.c | 4 ++-- 8 files changed, 27 insertions(+), 11 deletions(-) diff --git a/include/osmocom/gsm/gsm0341.h b/include/osmocom/gsm/gsm0341.h index 2fc83e4b..834dbf93 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 @@ gsm0341_build_msg(void *ctx, uint8_t geo_scope, uint8_t msg_code, 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 0cd1f94a..7dfaa150 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 @@ int gsm411_smc_send(struct gsm411_smc_inst *inst, int msg_type, /* 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 19f9c5da..28f43dea 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 @@ int gsm411_smr_send(struct gsm411_smr_inst *inst, int msg_type, /* 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 1c51111e..2cd87b82 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 @@ int gsm411_push_rp_header(struct msgb *msg, uint8_t rp_msg_type, /* 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 05a0b4a8..485023f3 100644 --- a/src/gsm/gsm0341.c +++ b/src/gsm/gsm0341.c @@ -1,4 +1,3 @@ -/*! \file gsm0341.c */ /* * (C) 2014 by Harald Welte * 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 7414e95a..f7c536b6 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 67bb2494..0a25c7c4 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 a4e9d0d1..acf7e234 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 -- cgit v1.2.3