From dd797c2c6c01520fa73b1fd335ccd42df86b1b4d Mon Sep 17 00:00:00 2001 From: Willow Liquorice Date: Wed, 7 Sep 2022 20:44:52 +0100 Subject: -DOC: Documentation cleanup pass through MESSENGER subsystem --- src/messenger/gnunet-service-messenger_tunnel.h | 26 ++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) (limited to 'src/messenger/gnunet-service-messenger_tunnel.h') diff --git a/src/messenger/gnunet-service-messenger_tunnel.h b/src/messenger/gnunet-service-messenger_tunnel.h index 7bd749281..13cf924f9 100644 --- a/src/messenger/gnunet-service-messenger_tunnel.h +++ b/src/messenger/gnunet-service-messenger_tunnel.h @@ -50,7 +50,7 @@ struct GNUNET_MESSENGER_SrvTunnel /** * Creates and allocates a tunnel of a room to a specific peer identity (called door). * - * @param[in/out] room Room + * @param[in,out] room Room * @param[in] door Peer identity * @return New tunnel */ @@ -61,7 +61,7 @@ create_tunnel (struct GNUNET_MESSENGER_SrvRoom *room, /** * Destroys a tunnel and frees its memory fully. * - * @param[in/out] tunnel + * @param[in,out] tunnel */ void destroy_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel); @@ -70,8 +70,8 @@ destroy_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel); * Binds a CADET channel to a tunnel and replaces its channel * the tunnel is currently bound to if necessary. * - * @param[in/out] tunnel Tunnel - * @param[in/out] channel CADET channel + * @param[in,out] tunnel Tunnel + * @param[in,out] channel CADET channel */ void bind_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel, @@ -81,7 +81,7 @@ bind_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel, * Tries to connect a tunnel by creating a new CADET channel and binding it. * The function returns #GNUNET_YES on success, otherwise #GNUNET_NO. * - * @param[in/out] tunnel Tunnel + * @param[in,out] tunnel Tunnel * @return #GNUNET_YES on success, otherwise #GNUNET_NO */ int @@ -91,7 +91,7 @@ connect_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel); * Disconnects and unbinds a channel from a tunnel. The actual disconnection * will be asynchronous. * - * @param[in/out] tunnel Tunnel + * @param[in,out] tunnel Tunnel */ void disconnect_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel); @@ -109,8 +109,8 @@ is_tunnel_connected (const struct GNUNET_MESSENGER_SrvTunnel *tunnel); * Sends an envelope containing a message with a given hash through * a tunnel. * - * @param[in/out] tunnel Tunnel - * @param[in/out] env Envelope + * @param[in,out] tunnel Tunnel + * @param[in,out] env Envelope * @param[in] hash Hash of message */ void @@ -123,9 +123,9 @@ send_tunnel_envelope (struct GNUNET_MESSENGER_SrvTunnel *tunnel, * through the tunnel. The used handle will sign the message and * the hash will be calculated and stored. * - * @param[in/out] tunnel Tunnel - * @param[in/out] handle Handle - * @param[in/out] message Message + * @param[in,out] tunnel Tunnel + * @param[in,out] handle Handle + * @param[in,out] message Message * @return #GNUNET_YES on success, GNUNET_NO otherwise */ int @@ -136,7 +136,7 @@ send_tunnel_message (struct GNUNET_MESSENGER_SrvTunnel *tunnel, /** * Forwards a given message with a known hash through a tunnel. * - * @param[in/out] tunnel Tunnel + * @param[in,out] tunnel Tunnel * @param[in] message Message * @param[in] hash Hash of message */ @@ -184,7 +184,7 @@ get_tunnel_messenger_version (const struct GNUNET_MESSENGER_SrvTunnel *tunnel); * it is compatible to the running peer of the service. Depending on success it * returns #GNUNET_OK or #GNUNET_SYSERR on failure. * - * @param[in/out] tunnel Tunnel + * @param[in,out] tunnel Tunnel * @param[in] version Version of messenger */ int -- cgit v1.2.3