From a338983d3bfd8d8475921df84b746d27f857d2e7 Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Mon, 16 Oct 2017 18:34:14 +0200 Subject: [doc] Properly define 'oap' group and add introductory text Change-Id: I1e875991ae1dd93862f850f85d40b3dac61ece72 --- include/osmocom/gsm/oap.h | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) (limited to 'include') 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); + +/*! @} */ -- cgit v1.2.3