mirror of https://gerrit.osmocom.org/libosmocore
[doc] Properly define 'oap' group and add introductory text
Change-Id: I1e875991ae1dd93862f850f85d40b3dac61ece72
This commit is contained in:
parent
381a1aa1c1
commit
a338983d3b
|
@ -1,5 +1,12 @@
|
||||||
/*! \file oap.h
|
/*! \defgroup oap Osmocom Authentication Protocol
|
||||||
* Osmocom Authentication Protocol message encoder/decoder. */
|
* @{
|
||||||
|
*
|
||||||
|
* 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
|
* (C) 2015-2016 by sysmocom s.f.m.c. GmbH
|
||||||
* All Rights Reserved
|
* 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,
|
int osmo_oap_decode(struct osmo_oap_message *oap_msg, const uint8_t *data,
|
||||||
size_t data_len);
|
size_t data_len);
|
||||||
void osmo_oap_encode(struct msgb *msg, const struct osmo_oap_message *oap_msg);
|
void osmo_oap_encode(struct msgb *msg, const struct osmo_oap_message *oap_msg);
|
||||||
|
|
||||||
|
/*! @} */
|
||||||
|
|
|
@ -1,5 +1,3 @@
|
||||||
/*! \file oap.c
|
|
||||||
* Osmocom Authentication Protocol message encoder/decoder */
|
|
||||||
/*
|
/*
|
||||||
* (C) 2015-2016 by sysmocom s.f.m.c. GmbH
|
* (C) 2015-2016 by sysmocom s.f.m.c. GmbH
|
||||||
* All Rights Reserved
|
* All Rights Reserved
|
||||||
|
@ -31,6 +29,7 @@
|
||||||
|
|
||||||
/*! \addtogroup oap
|
/*! \addtogroup oap
|
||||||
* @{
|
* @{
|
||||||
|
* \file oap.c
|
||||||
* Osmocom Authentication Protocol
|
* Osmocom Authentication Protocol
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue