Amebis/GEANTLink
Amebis/GEANTLink
1
1
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Releases 50 Wiki Activity

Doxygen documentation update

Browse Source
This commit is contained in:
Simon Rozman 2016-06-12 09:07:42 +02:00
parent cf7ca9c8e9
commit f675083891
1 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
lib/PAP/include/Config.h
View File

@ -30,8 +30,29 @@ namespace eap
namespace eapserial namespace eapserial
{ {
///
/// Packs a PAP based method configuration
///
/// \param[inout] cursor Memory cursor
/// \param[in] val Configuration to pack
///
inline void pack(_Inout_ unsigned char *&cursor, _In_ const eap::config_pap &val); inline void pack(_Inout_ unsigned char *&cursor, _In_ const eap::config_pap &val);
///
/// Returns packed size of a PAP based method configuration
///
/// \param[in] val Configuration to pack
///
/// \returns Size of data when packed (in bytes)
///
inline size_t get_pk_size(const eap::config_pap &val); inline size_t get_pk_size(const eap::config_pap &val);
///
/// Unpacks a PAP based method configuration
///
/// \param[inout] cursor Memory cursor
/// \param[out] val Configuration to unpack to
///
inline void unpack(_Inout_ const unsigned char *&cursor, _Out_ eap::config_pap &val); inline void unpack(_Inout_ const unsigned char *&cursor, _Out_ eap::config_pap &val);
} }
@ -107,37 +128,18 @@ namespace eap
namespace eapserial namespace eapserial
{ {
///
/// Packs a PAP based method configuration
///
/// \param[inout] cursor Memory cursor
/// \param[in] val Configuration to pack
///
inline void pack(_Inout_ unsigned char *&cursor, _In_ const eap::config_pap &val) inline void pack(_Inout_ unsigned char *&cursor, _In_ const eap::config_pap &val)
{ {
pack(cursor, (const eap::config_pass&)val); pack(cursor, (const eap::config_pass&)val);
} }
///
/// Returns packed size of a PAP based method configuration
///
/// \param[in] val Configuration to pack
///
/// \returns Size of data when packed (in bytes)
///
inline size_t get_pk_size(const eap::config_pap &val) inline size_t get_pk_size(const eap::config_pap &val)
{ {
return get_pk_size((const eap::config_pass&)val); return get_pk_size((const eap::config_pass&)val);
} }
///
/// Unpacks a PAP based method configuration
///
/// \param[inout] cursor Memory cursor
/// \param[out] val Configuration to unpack to
///
inline void unpack(_Inout_ const unsigned char *&cursor, _Out_ eap::config_pap &val) inline void unpack(_Inout_ const unsigned char *&cursor, _Out_ eap::config_pap &val)
{ {
unpack(cursor, (eap::config_pass&)val); unpack(cursor, (eap::config_pass&)val);