[PATCH] libosmocore[master]: [doc] Properly define 'oap' group and add introductory text

[Harald Welte]

Review at  https://gerrit.osmocom.org/4302

[doc] Properly define 'oap' group and add introductory text

Change-Id: I1e875991ae1dd93862f850f85d40b3dac61ece72
---
M include/osmocom/gsm/oap.h
M src/gsm/oap.c
2 files changed, 12 insertions(+), 4 deletions(-)


  git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/02/4302/1

diff --git a/include/osmocom/gsm/oap.h b/include/osmocom/gsm/oap.h
index ef83b79..ce1e151 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 @@
 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 b07eafc..aab5cac 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
  */
 

-- 
To view, visit https://gerrit.osmocom.org/4302
To unsubscribe, visit https://gerrit.osmocom.org/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I1e875991ae1dd93862f850f85d40b3dac61ece72
Gerrit-PatchSet: 1
Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-Owner: Harald Welte <laforge at gnumonks.org>