diff options
| author | Dennis Brentjes <d.brentjes@gmail.com> | 2016-10-16 21:39:18 +0200 |
|---|---|---|
| committer | Dennis Brentjes <d.brentjes@gmail.com> | 2016-10-16 21:39:36 +0200 |
| commit | ba6da37569dde1ed7616c14d591134575e6a6879 (patch) | |
| tree | 5562cad589f8c495bd02e61042cf633cd7f0e706 /libcmix-common/sender.hpp | |
| parent | c9082aa07394e15cd800bd5ad396c37a2334c98d (diff) | |
| download | cmix-ba6da37569dde1ed7616c14d591134575e6a6879.tar.gz cmix-ba6da37569dde1ed7616c14d591134575e6a6879.tar.bz2 cmix-ba6da37569dde1ed7616c14d591134575e6a6879.zip | |
Updates all the documentation.
Mainly covers the network rewrites.
Diffstat (limited to 'libcmix-common/sender.hpp')
| -rw-r--r-- | libcmix-common/sender.hpp | 14 |
1 files changed, 14 insertions, 0 deletions
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; |