Commit bd962d17 authored by Dominik Charousset's avatar Dominik Charousset

Improve doxygen comments

parent 85bee49f
......@@ -11,7 +11,8 @@
namespace caf::net {
/// Lifts `Socket` to a `expected<Socket>` and sets an error if `fd` is invalid.
/// Lifts `Socket` to an `expected<Socket>` and sets an error if `fd` is
/// invalid.
template <class Socket>
expected<Socket> checked_socket(Socket fd) {
using res_t = expected<Socket>;
......
......@@ -80,3 +80,10 @@ actor_shell_ptr_t<Handle>
make_actor_shell(actor_system&, async::execution_context_ptr);
} // namespace caf::net
namespace caf::net::stream_oriented {
class lower_layer;
class upper_layer;
} // namespace caf::net::stream_oriented
......@@ -5,6 +5,7 @@
namespace caf::net {
/// Creates a new @ref actor_shell and registers it at the actor system.
template <class Handle>
actor_shell_ptr_t<Handle>
make_actor_shell(actor_system& sys, async::execution_context_ptr loop) {
......
......@@ -20,6 +20,7 @@
namespace caf::net {
/// Provides a network backend for running protocol stacks.
class CAF_NET_EXPORT middleman : public actor_system::module {
public:
// -- member types -----------------------------------------------------------
......
......@@ -12,8 +12,6 @@
namespace caf::net::stream_oriented {
class lower_layer;
/// The upper layer requests bytes from the lower layer and consumes raw chunks
/// of data.
class CAF_NET_EXPORT upper_layer : public generic_upper_layer {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment