diff options
| author | Dennis Brentjes <d.brentjes@gmail.com> | 2016-09-28 13:18:18 +0200 |
|---|---|---|
| committer | Dennis Brentjes <d.brentjes@gmail.com> | 2016-09-28 13:18:18 +0200 |
| commit | 3fe7a5b6a18b6841ae51f294dc58fe9c8df6d375 (patch) | |
| tree | 345583aaf457ce5076d0d5f7c158628dfd971360 /libcmix-crypto/keypair.h | |
| parent | 85d25eebd38bb278ad598a291a007938854945a4 (diff) | |
| download | cmix-3fe7a5b6a18b6841ae51f294dc58fe9c8df6d375.tar.gz cmix-3fe7a5b6a18b6841ae51f294dc58fe9c8df6d375.tar.bz2 cmix-3fe7a5b6a18b6841ae51f294dc58fe9c8df6d375.zip | |
Finally made a initial doxygen documentation pass over all files.
Diffstat (limited to 'libcmix-crypto/keypair.h')
| -rw-r--r-- | libcmix-crypto/keypair.h | 18 |
1 files changed, 14 insertions, 4 deletions
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 <stdlib.h> +/*! + * \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 }; |
