From ba6da37569dde1ed7616c14d591134575e6a6879 Mon Sep 17 00:00:00 2001
From: Dennis Brentjes <d.brentjes@gmail.com>
Date: Sun, 16 Oct 2016 21:39:18 +0200
Subject: Updates all the documentation.

Mainly covers the network rewrites.
---
 client/cmixclient.hpp | 23 ++++++++++++++++++++---
 1 file changed, 20 insertions(+), 3 deletions(-)

(limited to 'client')

diff --git a/client/cmixclient.hpp b/client/cmixclient.hpp
index 1edb08e..d87c4b3 100644
--- a/client/cmixclient.hpp
+++ b/client/cmixclient.hpp
@@ -11,11 +11,21 @@
 #include <string>
 #include <vector>
 
+/*!
+ * \file
+ */
+
+/*!
+ * \brief The NodeDetails struct
+ */
 struct NodeDetails {
-	std::string host;
-	std::string port;
+	std::string host; ///< The host of the node.
+	std::string port; ///< The port of the node.
 };
 
+/*!
+ * \brief The CMixClient class
+ */
 class CMixClient {
 
 	struct NodeData {
@@ -39,9 +49,16 @@ class CMixClient {
 
 	void handle_message(int node_id, cmix_proto::CMixMessage message);
 
-public: 
+public:
+	/*!
+	 * \brief CMixClient
+	 * \param details A vector of the connectiondetails for the cmix network
+	 */
 	CMixClient(std::vector<NodeDetails> details);
 	~CMixClient();
 	
+	/*!
+	 * \brief run Runs the underlying io_service.
+	 */
 	void run();
 };
\ No newline at end of file
-- 
cgit v1.2.3-70-g09d2