summaryrefslogtreecommitdiffstats
path: root/include/osmocom/gsm/lapdm.h
diff options
context:
space:
mode:
authorNeels Hofmeyr <nhofmeyr@sysmocom.de>2017-06-20 00:17:59 +0200
committerNeels Hofmeyr <nhofmeyr@sysmocom.de>2017-06-23 00:18:22 +0000
commit87e4550585c643e97e0003119b254251ac5ed1d4 (patch)
tree9287f66aba70e9253f4d62926c54dddeb492895e /include/osmocom/gsm/lapdm.h
parent249fb71a2e124acb191b7cd4d2c3af6a45da4a5e (diff)
doxygen: enable AUTOBRIEF, drop \brief
Especially for short descriptions, it is annoying to have to type \brief for every single API doc. Drop all \brief and enable the AUTOBRIEF feature of doxygen, which always takes the first sentence of an API doc as the brief description. Change-Id: I11a8a821b065a128108641a2a63fb5a2b1916e87
Diffstat (limited to 'include/osmocom/gsm/lapdm.h')
-rw-r--r--include/osmocom/gsm/lapdm.h52
1 files changed, 26 insertions, 26 deletions
diff --git a/include/osmocom/gsm/lapdm.h b/include/osmocom/gsm/lapdm.h
index 84d109d5..ec14cddc 100644
--- a/include/osmocom/gsm/lapdm.h
+++ b/include/osmocom/gsm/lapdm.h
@@ -9,15 +9,15 @@
/*! \file lapdm.h */
-/*! \brief LAPDm mode/role */
+/*! LAPDm mode/role */
enum lapdm_mode {
- LAPDM_MODE_MS, /*!< \brief behave like a MS (mobile phone) */
- LAPDM_MODE_BTS, /*!< \brief behave like a BTS (network) */
+ LAPDM_MODE_MS, /*!< behave like a MS (mobile phone) */
+ LAPDM_MODE_BTS, /*!< behave like a BTS (network) */
};
struct lapdm_entity;
-/*! \brief LAPDm message context */
+/*! LAPDm message context */
struct lapdm_msg_ctx {
struct lapdm_datalink *dl;
int lapdm_fmt;
@@ -27,18 +27,18 @@ struct lapdm_msg_ctx {
uint8_t tx_power_ind; /* MS power indicated by network */
};
-/*! \brief LAPDm datalink like TS 04.06 / Section 3.5.2 */
+/*! LAPDm datalink like TS 04.06 / Section 3.5.2 */
struct lapdm_datalink {
- struct lapd_datalink dl; /* \brief common LAPD */
- struct lapdm_msg_ctx mctx; /*!< \brief context of established connection */
+ struct lapd_datalink dl; /* common LAPD */
+ struct lapdm_msg_ctx mctx; /*!< context of established connection */
- struct lapdm_entity *entity; /*!< \brief LAPDm entity we are part of */
+ struct lapdm_entity *entity; /*!< LAPDm entity we are part of */
};
-/*! \brief LAPDm datalink SAPIs */
+/*! LAPDm datalink SAPIs */
enum lapdm_dl_sapi {
- DL_SAPI0 = 0, /*!< \brief SAPI 0 */
- DL_SAPI3 = 1, /*!< \brief SAPI 1 */
+ DL_SAPI0 = 0, /*!< SAPI 0 */
+ DL_SAPI3 = 1, /*!< SAPI 1 */
_NR_DL_SAPI
};
@@ -47,34 +47,34 @@ typedef int (*lapdm_cb_t)(struct msgb *msg, struct lapdm_entity *le, void *ctx);
#define LAPDM_ENT_F_EMPTY_FRAME 0x0001
#define LAPDM_ENT_F_POLLING_ONLY 0x0002
-/*! \brief a LAPDm Entity */
+/*! a LAPDm Entity */
struct lapdm_entity {
- /*! \brief the SAPIs of the LAPDm entity */
+ /*! the SAPIs of the LAPDm entity */
struct lapdm_datalink datalink[_NR_DL_SAPI];
- int last_tx_dequeue; /*!< \brief last entity that was dequeued */
- int tx_pending; /*!< \brief currently a pending frame not confirmed by L1 */
- enum lapdm_mode mode; /*!< \brief are we in BTS mode or MS mode */
+ int last_tx_dequeue; /*!< last entity that was dequeued */
+ int tx_pending; /*!< currently a pending frame not confirmed by L1 */
+ enum lapdm_mode mode; /*!< are we in BTS mode or MS mode */
unsigned int flags;
- void *l1_ctx; /*!< \brief context for layer1 instance */
- void *l3_ctx; /*!< \brief context for layer3 instance */
+ void *l1_ctx; /*!< context for layer1 instance */
+ void *l3_ctx; /*!< context for layer3 instance */
- osmo_prim_cb l1_prim_cb;/*!< \brief callback for sending prims to L1 */
- lapdm_cb_t l3_cb; /*!< \brief callback for sending stuff to L3 */
+ osmo_prim_cb l1_prim_cb;/*!< callback for sending prims to L1 */
+ lapdm_cb_t l3_cb; /*!< callback for sending stuff to L3 */
- /*! \brief pointer to \ref lapdm_channel of which we're part */
+ /*! pointer to \ref lapdm_channel of which we're part */
struct lapdm_channel *lapdm_ch;
uint8_t ta; /* TA used and indicated to network */
uint8_t tx_power; /* MS power used and indicated to network */
};
-/*! \brief the two lapdm_entities that form a GSM logical channel (ACCH + DCCH) */
+/*! the two lapdm_entities that form a GSM logical channel (ACCH + DCCH) */
struct lapdm_channel {
- struct llist_head list; /*!< \brief internal linked list */
- char *name; /*!< \brief human-readable name */
- struct lapdm_entity lapdm_acch; /*!< \brief Associated Control Channel */
- struct lapdm_entity lapdm_dcch; /*!< \brief Dedicated Control Channel */
+ struct llist_head list; /*!< internal linked list */
+ char *name; /*!< human-readable name */
+ struct lapdm_entity lapdm_acch; /*!< Associated Control Channel */
+ struct lapdm_entity lapdm_dcch; /*!< Dedicated Control Channel */
};
const char *get_rsl_name(int value);