Commit 088a8bd6 authored by Dominik Charousset's avatar Dominik Charousset

Fix documentation warnings

parent 9d24c002
...@@ -42,7 +42,7 @@ namespace io { ...@@ -42,7 +42,7 @@ namespace io {
/// // reuse:_addr: Enables or disables SO_REUSEPORT option. /// // reuse:_addr: Enables or disables SO_REUSEPORT option.
/// (publish_atom, uint16_t port, strong_actor_ptr whom, /// (publish_atom, uint16_t port, strong_actor_ptr whom,
/// set<string> ifs, string addr, bool reuse_addr) /// set<string> ifs, string addr, bool reuse_addr)
/// -> expected<uint16_t> /// -> (uint16_t)
/// ///
/// // Opens a new port other CAF instances can connect to. The /// // Opens a new port other CAF instances can connect to. The
/// // difference between `PUBLISH` and `OPEN` is that no actor is mapped to /// // difference between `PUBLISH` and `OPEN` is that no actor is mapped to
...@@ -52,8 +52,7 @@ namespace io { ...@@ -52,8 +52,7 @@ namespace io {
/// // addr: IP address to listen to or empty for any. /// // addr: IP address to listen to or empty for any.
/// // reuse:_addr: Enables or disables SO_REUSEPORT option. /// // reuse:_addr: Enables or disables SO_REUSEPORT option.
/// (open_atom, uint16_t port, string addr, bool reuse_addr) /// (open_atom, uint16_t port, string addr, bool reuse_addr)
/// -> expected<uint16_t) /// -> (uint16_t)
/// or (error_atom, string error_string)
/// ///
/// // Queries a remote node and returns an ID to this node as well as /// // Queries a remote node and returns an ID to this node as well as
/// // an `strong_actor_ptr` to a remote actor if an actor was published at this /// // an `strong_actor_ptr` to a remote actor if an actor was published at this
...@@ -62,20 +61,19 @@ namespace io { ...@@ -62,20 +61,19 @@ namespace io {
/// // hostname: IP address or DNS hostname. /// // hostname: IP address or DNS hostname.
/// // port: TCP port. /// // port: TCP port.
/// (connect_atom, string hostname, uint16_t port) /// (connect_atom, string hostname, uint16_t port)
/// -> either (node_id nid, strong_actor_ptr remote_actor, set<string> ifs) /// -> (node_id nid, strong_actor_ptr remote_actor, set<string> ifs)
/// or (error_atom, string error_string)
/// ///
/// // Closes `port` if it is mapped to `whom`. /// // Closes `port` if it is mapped to `whom`.
/// // whom: A published actor. /// // whom: A published actor.
/// // port: Used TCP port. /// // port: Used TCP port.
/// (unpublish_atom, strong_actor_ptr whom, uint16_t port) /// (unpublish_atom, strong_actor_ptr whom, uint16_t port)
/// -> expected<void> /// -> void
/// ///
/// // Unconditionally closes `port`, removing any actor /// // Unconditionally closes `port`, removing any actor
/// // published at this port. /// // published at this port.
/// // port: Used TCP port. /// // port: Used TCP port.
/// (close_atom, uint16_t port) /// (close_atom, uint16_t port)
/// -> expected<void> /// -> void
/// ///
/// // Spawns an actor on a remote node, initializing it using the arguments /// // Spawns an actor on a remote node, initializing it using the arguments
/// // stored in `msg` and returns the address of the spawned actor and its /// // stored in `msg` and returns the address of the spawned actor and its
...@@ -84,7 +82,7 @@ namespace io { ...@@ -84,7 +82,7 @@ namespace io {
/// // name: Announced type name of the actor. /// // name: Announced type name of the actor.
/// // args: Initialization arguments for the actor. /// // args: Initialization arguments for the actor.
/// (spawn_atom, node_id nid, string name, message args) /// (spawn_atom, node_id nid, string name, message args)
/// -> expected<strong_actor_ptr, set<string>> /// -> (strong_actor_ptr, set<string>)
/// ///
/// } /// }
/// ~~~ /// ~~~
......
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