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
diff --git a/include/osmocom/core/prim.h b/include/osmocom/core/prim.h
index f04e15e..7288ba6 100644
--- a/include/osmocom/core/prim.h
+++ b/include/osmocom/core/prim.h
@@ -12,12 +12,12 @@
#define OSMO_PRIM(prim, op) ((prim << 8) | (op & 0xFF))
#define OSMO_PRIM_HDR(oph) OSMO_PRIM((oph)->primitive, (oph)->operation)
-/*! \brief primitive operation */
+/*! primitive operation */
enum osmo_prim_operation {
- PRIM_OP_REQUEST, /*!< \brief request */
- PRIM_OP_RESPONSE, /*!< \brief response */
- PRIM_OP_INDICATION, /*!< \brief indication */
- PRIM_OP_CONFIRM, /*!< \brief confirm */
+ PRIM_OP_REQUEST, /*!< request */
+ PRIM_OP_RESPONSE, /*!< response */
+ PRIM_OP_INDICATION, /*!< indication */
+ PRIM_OP_CONFIRM, /*!< confirm */
};
extern const struct value_string osmo_prim_op_names[5];
@@ -28,15 +28,15 @@
#define _SAP_TETRA_BASE (0x02 << _SAP_GSM_SHIFT)
#define _SAP_SS7_BASE (0x03 << _SAP_GSM_SHIFT)
-/*! \brief primitive header */
+/*! primitive header */
struct osmo_prim_hdr {
- unsigned int sap; /*!< \brief Service Access Point */
- unsigned int primitive; /*!< \brief Primitive number */
- enum osmo_prim_operation operation; /*! \brief Primitive Operation */
- struct msgb *msg; /*!< \brief \ref msgb containing associated data */
+ unsigned int sap; /*!< Service Access Point */
+ unsigned int primitive; /*!< Primitive number */
+ enum osmo_prim_operation operation; /*! Primitive Operation */
+ struct msgb *msg; /*!< \ref msgb containing associated data */
};
-/*! \brief initialize a primitive header
+/*! initialize a primitive header
* \param[in,out] oph primitive header
* \param[in] sap Service Access Point
* \param[in] primitive Primitive Number
@@ -54,14 +54,14 @@
oph->msg = msg;
}
-/*! \brief primitive handler callback type */
+/*! primitive handler callback type */
typedef int (*osmo_prim_cb)(struct osmo_prim_hdr *oph, void *ctx);
-/*! \brief magic value to be used as final record of \ref
+/*! magic value to be used as final record of \ref
* osmo_prim_event_map */
#define OSMO_NO_EVENT 0xFFFFFFFF
-/*! \brief single entry in a SAP/PRIM/OP -> EVENT map */
+/*! single entry in a SAP/PRIM/OP -> EVENT map */
struct osmo_prim_event_map {
unsigned int sap; /*!< SAP to match */
unsigned int primitive; /*!< primtiive to match */