From 3fe7a5b6a18b6841ae51f294dc58fe9c8df6d375 Mon Sep 17 00:00:00 2001 From: Dennis Brentjes Date: Wed, 28 Sep 2016 13:18:18 +0200 Subject: Finally made a initial doxygen documentation pass over all files. --- libcmix-crypto/keypair.h | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) (limited to 'libcmix-crypto/keypair.h') diff --git a/libcmix-crypto/keypair.h b/libcmix-crypto/keypair.h index 9587db3..838291d 100644 --- a/libcmix-crypto/keypair.h +++ b/libcmix-crypto/keypair.h @@ -1,16 +1,26 @@ #pragma once +/*! + * \file + */ + #ifdef __cplusplus extern "C" { #endif #include +/*! + * \brief The KeyPair struct contains the private and public key, and the private and public key lengths. + * + * Is used as a generic storage container for multiple implementations. So the implementations are + * responsible for memory meanagement. See the Api struct for examples of this. + */ struct KeyPair { - unsigned char* sec; - unsigned char* pub; - unsigned int sec_len; - unsigned int pub_len; + unsigned char* sec; ///< Private key + unsigned char* pub; ///< Public key + unsigned int sec_len; ///< Private key length + unsigned int pub_len; ///< Public key length }; -- cgit v1.2.3-70-g09d2