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/sharedkey.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/sharedkey.h')
| -rw-r--r-- | libcmix-crypto/sharedkey.h | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/libcmix-crypto/sharedkey.h b/libcmix-crypto/sharedkey.h index 9c959fe..c37ae41 100644 --- a/libcmix-crypto/sharedkey.h +++ b/libcmix-crypto/sharedkey.h @@ -1,12 +1,21 @@ #pragma once +/*! + * \file + */ + #ifdef __cplusplus extern "C" { #endif +/*! + * \brief The SharedKey struct. + * + * Stored the derived shared secret after for instance Diffie-Hellman. + */ struct SharedKey { - unsigned char* shared; - unsigned int shared_len; + unsigned char* shared; ///< The Shared key. + unsigned int shared_len; ///< The shared key length. }; #ifdef __cplusplus |