aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2017-10-16 18:34:14 +0200
committerHarald Welte <laforge@gnumonks.org>2017-10-17 07:53:02 +0200
commita338983d3bfd8d8475921df84b746d27f857d2e7 (patch)
tree7bb219b613b596c5ada567211284c384be9d84e3
parent381a1aa1c190697ccaa939081573268739aeea28 (diff)
[doc] Properly define 'oap' group and add introductory text
-rw-r--r--include/osmocom/gsm/oap.h13
-rw-r--r--src/gsm/oap.c3
2 files changed, 12 insertions, 4 deletions
diff --git a/include/osmocom/gsm/oap.h b/include/osmocom/gsm/oap.h
index ef83b794..ce1e1513 100644
--- a/include/osmocom/gsm/oap.h
+++ b/include/osmocom/gsm/oap.h
@@ -1,5 +1,12 @@
-/*! \file oap.h
- * Osmocom Authentication Protocol message encoder/decoder. */
+/*! \defgroup oap Osmocom Authentication Protocol
+ * @{
+ *
+ * The Osmocom Authentication Protocol (OAP) is a way to use the 3GPP
+ * AKA (Authentication and Key Agreement) as cryptographic
+ * authentication mechanism in other protocols that don't provide
+ * cryptographic authentication.
+ *
+ * \file oap.h */
/*
* (C) 2015-2016 by sysmocom s.f.m.c. GmbH
* All Rights Reserved
@@ -71,3 +78,5 @@ struct osmo_oap_message {
int osmo_oap_decode(struct osmo_oap_message *oap_msg, const uint8_t *data,
size_t data_len);
void osmo_oap_encode(struct msgb *msg, const struct osmo_oap_message *oap_msg);
+
+/*! @} */
diff --git a/src/gsm/oap.c b/src/gsm/oap.c
index b07eafcf..aab5caca 100644
--- a/src/gsm/oap.c
+++ b/src/gsm/oap.c
@@ -1,5 +1,3 @@
-/*! \file oap.c
- * Osmocom Authentication Protocol message encoder/decoder */
/*
* (C) 2015-2016 by sysmocom s.f.m.c. GmbH
* All Rights Reserved
@@ -31,6 +29,7 @@
/*! \addtogroup oap
* @{
+ * \file oap.c
* Osmocom Authentication Protocol
*/