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.
---
 libcmix-common/sender.hpp | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'libcmix-common/sender.hpp')

diff --git a/libcmix-common/sender.hpp b/libcmix-common/sender.hpp
index 72f0b3d..ea16a81 100644
--- a/libcmix-common/sender.hpp
+++ b/libcmix-common/sender.hpp
@@ -4,10 +4,24 @@
 
 #include "protobufclient.hpp"
 
+/*!
+ * \file
+ */
+
+/*!
+ * \brief forward declaration for SenderReceiver to allow for the friend declaration.
+ */
 struct SenderReceiver;
 
+/*!
+ * \brief The Sender struct is a shim around ProtobufClient and only exposes things needed
+ * for sending messages.
+ */
 struct Sender : private ProtobufClient<CMixProtoFunctor>
 {
+	/*!
+	 * The friend declaration that allows for the Sender to be upgraded to a SenderReceiver.
+	 */
 	friend SenderReceiver;
 	
 	using ProtobufClient::ProtobufClient;
-- 
cgit v1.2.3-70-g09d2