summaryrefslogtreecommitdiffstats
path: root/src/gsm/oap.c
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2017-06-12 21:44:18 +0200
committerHarald Welte <laforge@gnumonks.org>2017-06-12 21:55:54 +0000
commit96e2a00d7a9044d0b1a83909c11d8f24955bc7c8 (patch)
tree4bbe6cb49a766df4cdefa9fffd56bb953d51da75 /src/gsm/oap.c
parent7165880ac279a9d2d7403749f171eb9c60e70657 (diff)
update/extend doxygen documentation
It's a pity that even with this patch we still are fare away from having the whole API documented. However, at least we have a more solid foundation. Updates not only extend the documentation, but also make sure it is rendered properly in the doxygen HTML. Change-Id: I1344bd1a6869fb00de7c1899a8db93bba9bafce3
Diffstat (limited to 'src/gsm/oap.c')
-rw-r--r--src/gsm/oap.c7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/gsm/oap.c b/src/gsm/oap.c
index 1494a6a6..5706e8ff 100644
--- a/src/gsm/oap.c
+++ b/src/gsm/oap.c
@@ -28,6 +28,11 @@
#include <stdint.h>
+/*! \addtogroup oap
+ * @{
+ * \brief Osmocom Authentication Protocol
+ */
+
/*! \brief Decode OAP message data.
* \param[out] oap_msg Parsed data is written to this instance.
* \param[in] data Pointer to the data buffer containing the OAP message.
@@ -182,3 +187,5 @@ void osmo_oap_encode(struct msgb *msg, const struct osmo_oap_message *oap_msg)
msg->l2h = msg->data;
}
+
+/*! @} */