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/senderreceiver.hpp | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) (limited to 'libcmix-common/senderreceiver.hpp') diff --git a/libcmix-common/senderreceiver.hpp b/libcmix-common/senderreceiver.hpp index 9a07f78..c7fed3a 100644 --- a/libcmix-common/senderreceiver.hpp +++ b/libcmix-common/senderreceiver.hpp @@ -6,12 +6,28 @@ #include "protobufclient.hpp" +/*! + * \file + */ + +/*! + * \brief The SenderReciever struct is a shim around ProtobufClient and only exposes things needed + * for Sending and Receiving messages. + */ struct SenderReceiver : private ProtobufClient { + /*! + * \brief SenderReceiver Explicit conversion to SenderReceiver + * \param r The Receiver to upgrade + */ explicit SenderReceiver(Receiver&& r); + /*! + * \brief SenderReceiver Explicit conversion to SenderReceiver + * \param s The Sender to upgrade + */ explicit SenderReceiver(Sender&& s); - + using ProtobufClient::ProtobufClient; using ProtobufClient::async_receive; -- cgit v1.2.3-70-g09d2