From ba6da37569dde1ed7616c14d591134575e6a6879 Mon Sep 17 00:00:00 2001 From: Dennis Brentjes Date: Sun, 16 Oct 2016 21:39:18 +0200 Subject: Updates all the documentation. Mainly covers the network rewrites. --- libcmix-common/receiver.hpp | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'libcmix-common/receiver.hpp') diff --git a/libcmix-common/receiver.hpp b/libcmix-common/receiver.hpp index a70cde0..2b05790 100644 --- a/libcmix-common/receiver.hpp +++ b/libcmix-common/receiver.hpp @@ -4,10 +4,21 @@ #include "protobufclient.hpp" +/*! + * \file + */ + struct SenderReceiver; +/*! + * \brief The Receiver struct is a shim around ProtobufClient and only exposes things needed + * for receiving messages. + */ struct Receiver : private ProtobufClient { + /*! + * \brief friend decleration allowing Receivers to be upgraded to SenderReceivers. + */ friend SenderReceiver; using ProtobufClient::ProtobufClient; -- cgit v1.2.3-70-g09d2