From 3fe7a5b6a18b6841ae51f294dc58fe9c8df6d375 Mon Sep 17 00:00:00 2001
From: Dennis Brentjes <d.brentjes@gmail.com>
Date: Wed, 28 Sep 2016 13:18:18 +0200
Subject: Finally made a initial doxygen documentation pass over all files.

---
 libcmix-crypto/sharedkey.h | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

(limited to 'libcmix-crypto/sharedkey.h')

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
-- 
cgit v1.2.3-70-g09d2