gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[gnunet] 31/90: -DOC: Major doc comment stripping pass through TRANSPORT


From: gnunet
Subject: [gnunet] 31/90: -DOC: Major doc comment stripping pass through TRANSPORT
Date: Tue, 18 Oct 2022 03:06:30 +0200

This is an automated email from the git hooks/post-receive script.

martin-schanzenbach pushed a commit to branch master
in repository gnunet.

commit f878edd42b1774c6f7bbe5a5fce3f3251f38e4f3
Author: Willow Liquorice <willow@howhill.com>
AuthorDate: Sun Sep 4 02:47:03 2022 +0100

    -DOC: Major doc comment stripping pass through TRANSPORT
---
 .../gnunet_transport_communication_service.h       |  3 +-
 src/include/gnunet_transport_service.h             |  5 +-
 src/transport/gnunet-service-tng.c                 |  6 +-
 src/transport/gnunet-service-transport.c           |  5 --
 src/transport/gnunet-service-transport_ats.c       | 14 -----
 src/transport/gnunet-service-transport_ats.h       |  3 +-
 src/transport/gnunet-service-transport_hello.c     | 10 ---
 .../gnunet-service-transport_neighbours.c          | 24 --------
 .../gnunet-service-transport_neighbours.h          |  2 +-
 src/transport/gnunet-service-transport_plugins.c   | 18 ------
 src/transport/gnunet-service-transport_plugins.h   |  4 --
 src/transport/plugin_transport_http_client.c       |  6 --
 src/transport/plugin_transport_http_common.c       | 45 --------------
 src/transport/plugin_transport_http_common.h       |  6 +-
 src/transport/tcp_server_legacy.c                  | 20 ------
 src/transport/transport-testing-filenames.c        | 28 ---------
 src/transport/transport-testing2.c                 | 33 ----------
 src/transport/transport-testing2.h                 |  2 +-
 src/transport/transport_api2_communication.c       | 71 ----------------------
 src/transport/transport_api_cmd_send_simple.c      | 10 ---
 src/transport/transport_api_monitor_peers.c        | 26 --------
 src/transport/transport_api_offer_hello.c          |  5 --
 22 files changed, 14 insertions(+), 332 deletions(-)

diff --git a/src/include/gnunet_transport_communication_service.h 
b/src/include/gnunet_transport_communication_service.h
index 9b536297e..7bab86e1a 100644
--- a/src/include/gnunet_transport_communication_service.h
+++ b/src/include/gnunet_transport_communication_service.h
@@ -138,7 +138,8 @@ typedef void (*GNUNET_TRANSPORT_CommunicatorNotify) (
  * Connect to the transport service.
  *
  * @param cfg configuration to use
- * @param config_section section of the configuration to use for options
+ * @param config_section_name section of the configuration to use for 
+ *                            options
  * @param addr_prefix address prefix for addresses supported by this
  *        communicator, could be NULL for incoming-only communicators
  * @param cc what characteristics does the communicator have?
diff --git a/src/include/gnunet_transport_service.h 
b/src/include/gnunet_transport_service.h
index 99246f136..daa79bf1c 100644
--- a/src/include/gnunet_transport_service.h
+++ b/src/include/gnunet_transport_service.h
@@ -360,8 +360,9 @@ typedef void
  * @param cfg configuration to use
  * @param peer a specific peer identity to obtain information for,
  *      NULL for all peers
- * @param one_shot #GNUNET_YES to return the current state and then end (with
- * NULL+NULL), #GNUNET_NO to monitor peers continuously
+ * @param one_shot #GNUNET_YES to return the current state and 
+ *                 then end (with NULL+NULL), 
+ *                 #GNUNET_NO to monitor peers continuously
  * @param peer_callback function to call with the results
  * @param peer_callback_cls closure for @a peer_callback
  */
diff --git a/src/transport/gnunet-service-tng.c 
b/src/transport/gnunet-service-tng.c
index 7ea34735b..9b2b920d1 100644
--- a/src/transport/gnunet-service-tng.c
+++ b/src/transport/gnunet-service-tng.c
@@ -4668,7 +4668,7 @@ dv_hmac (const struct DVKeyState *key,
  * Perform backchannel encryption using symmetric secret in @a key
  * to encrypt data from @a in to @a dst.
  *
- * @param key[in,out] key material to use
+ * @param[in,out] key key material to use
  * @param dst where to write the result
  * @param in input data to encrypt (plaintext)
  * @param in_size number of bytes of input in @a in and available at @a dst
@@ -4685,9 +4685,9 @@ dv_encrypt (struct DVKeyState *key, const void *in, void 
*dst, size_t in_size)
  * Perform backchannel encryption using symmetric secret in @a key
  * to encrypt data from @a in to @a dst.
  *
- * @param key[in,out] key material to use
+ * @param[in,out] key key material to use
  * @param ciph cipher text to decrypt
- * @param out[out] output data to generate (plaintext)
+ * @param[out] out output data to generate (plaintext)
  * @param out_size number of bytes of input in @a ciph and available in @a out
  */
 static void
diff --git a/src/transport/gnunet-service-transport.c 
b/src/transport/gnunet-service-transport.c
index 345a0d949..463bcc628 100644
--- a/src/transport/gnunet-service-transport.c
+++ b/src/transport/gnunet-service-transport.c
@@ -2486,11 +2486,6 @@ GST_blacklist_test_allowed (const struct 
GNUNET_PeerIdentity *peer,
 }
 
 
-/**
- * Cancel a blacklist check.
- *
- * @param bc check to cancel
- */
 void
 GST_blacklist_test_cancel (struct GST_BlacklistCheck *bc)
 {
diff --git a/src/transport/gnunet-service-transport_ats.c 
b/src/transport/gnunet-service-transport_ats.c
index 130311e15..2438a0a48 100644
--- a/src/transport/gnunet-service-transport_ats.c
+++ b/src/transport/gnunet-service-transport_ats.c
@@ -477,13 +477,6 @@ GST_ats_add_inbound_address (const struct 
GNUNET_HELLO_Address *address,
 }
 
 
-/**
- * Notify ATS about the new address including the network this address is
- * located in.  The address must NOT be inbound and must be new to ATS.
- *
- * @param address the address
- * @param prop performance information
- */
 void
 GST_ats_add_address (const struct GNUNET_HELLO_Address *address,
                      const struct GNUNET_ATS_Properties *prop)
@@ -755,13 +748,6 @@ GST_ats_update_distance (const struct GNUNET_HELLO_Address 
*address,
 }
 
 
-/**
- * Notify ATS about @a delay changes to properties of an @a address.
- * Does nothing if the @a address is not known to us.
- *
- * @param address the address
- * @param delay new delay value
- */
 void
 GST_ats_update_delay (const struct GNUNET_HELLO_Address *address,
                       struct GNUNET_TIME_Relative delay)
diff --git a/src/transport/gnunet-service-transport_ats.h 
b/src/transport/gnunet-service-transport_ats.h
index d536714ec..ca972d1cc 100644
--- a/src/transport/gnunet-service-transport_ats.h
+++ b/src/transport/gnunet-service-transport_ats.h
@@ -110,7 +110,7 @@ GST_ats_add_inbound_address (const struct 
GNUNET_HELLO_Address *address,
 
 
 /**
- * Notify ATS about a new address including the network this address is
+ * Notify ATS about a new address including the network the address is
  * located in.  The address must NOT be inbound and must be new to ATS.
  *
  * @param address the address
@@ -154,7 +154,6 @@ GST_ats_update_utilization (const struct 
GNUNET_HELLO_Address *address,
  * Does nothing if the @a address is not known to us.
  *
  * @param address the address
- * @param session the session
  * @param delay new delay value
  */
 void
diff --git a/src/transport/gnunet-service-transport_hello.c 
b/src/transport/gnunet-service-transport_hello.c
index 472c77c27..1e5e8a225 100644
--- a/src/transport/gnunet-service-transport_hello.c
+++ b/src/transport/gnunet-service-transport_hello.c
@@ -334,16 +334,6 @@ GST_hello_modify_addresses (int addremove,
 }
 
 
-/**
- * Test if a particular address is one of ours.
- *
- * @param address address to test
- * @param sig location where to cache PONG signatures for this address [set]
- * @param sig_expiration how long until the current 'sig' expires?
- *            (ZERO if sig was never created) [set]
- * @return #GNUNET_YES if this is one of our addresses,
- *         #GNUNET_NO if not
- */
 int
 GST_hello_test_address (const struct GNUNET_HELLO_Address *address,
                         struct GNUNET_CRYPTO_EddsaSignature **sig,
diff --git a/src/transport/gnunet-service-transport_neighbours.c 
b/src/transport/gnunet-service-transport_neighbours.c
index ca1b4d1da..e61441d9f 100644
--- a/src/transport/gnunet-service-transport_neighbours.c
+++ b/src/transport/gnunet-service-transport_neighbours.c
@@ -1768,16 +1768,6 @@ GST_neighbours_calculate_receive_delay (const struct
 }
 
 
-/**
- * Transmit a message to the given target using the active connection.
- *
- * @param target destination
- * @param msg message to send
- * @param msg_size number of bytes in msg
- * @param timeout when to fail with timeout
- * @param cont function to call when done
- * @param cont_cls closure for @a cont
- */
 void
 GST_neighbours_send (const struct GNUNET_PeerIdentity *target,
                      const void *msg,
@@ -3019,13 +3009,6 @@ GST_neighbours_notify_data_sent (const struct 
GNUNET_HELLO_Address *address,
 }
 
 
-/**
- * Master task run for every neighbour.  Performs all of the time-related
- * activities (keep alive, send next message, disconnect if idle, finish
- * clean up after disconnect).
- *
- * @param cls the 'struct NeighbourMapEntry' for which we are running
- */
 static void
 master_task (void *cls)
 {
@@ -3646,13 +3629,6 @@ delayed_disconnect (void *cls)
 }
 
 
-/**
- * We received a quota message from the given peer,
- * validate and process.
- *
- * @param peer sender of the message
- * @param msg the quota message
- */
 void
 GST_neighbours_handle_quota_message (const struct GNUNET_PeerIdentity *peer,
                                      const struct GNUNET_MessageHeader *msg)
diff --git a/src/transport/gnunet-service-transport_neighbours.h 
b/src/transport/gnunet-service-transport_neighbours.h
index 13aeab4e6..7ce911aa1 100644
--- a/src/transport/gnunet-service-transport_neighbours.h
+++ b/src/transport/gnunet-service-transport_neighbours.h
@@ -292,7 +292,7 @@ GST_neighbour_get_current_address (const struct 
GNUNET_PeerIdentity *peer);
 
 
 /**
- * We received a quoat message from the given peer,
+ * We received a quota message from the given peer,
  * validate and process.
  *
  * @param peer sender of the message
diff --git a/src/transport/gnunet-service-transport_plugins.c 
b/src/transport/gnunet-service-transport_plugins.c
index c88532806..1a22335f4 100644
--- a/src/transport/gnunet-service-transport_plugins.c
+++ b/src/transport/gnunet-service-transport_plugins.c
@@ -121,18 +121,6 @@ plugin_env_address_to_type (void *cls,
 }
 
 
-/**
- * Load and initialize all plugins.  The respective functions will be
- * invoked by the plugins when the respective events happen.  The
- * closure will be set to a 'const char*' containing the name of the
- * plugin that caused the call.
- *
- * @param recv_cb function to call when data is received
- * @param address_cb function to call when our public addresses changed
- * @param session_start_cb function to call when a session was created
- * @param session_end_cb function to call when a session was terminated
- * @param address_type_cb function to call when a address type is requested
- */
 void
 GST_plugins_load (GNUNET_TRANSPORT_PluginReceiveCallback recv_cb,
                   GNUNET_TRANSPORT_AddressNotification address_cb,
@@ -431,12 +419,6 @@ GST_plugins_a2s (const struct GNUNET_HELLO_Address 
*address)
 }
 
 
-/**
- * Register callback with all plugins to monitor their status.
- *
- * @param cb callback to register, NULL to unsubscribe
- * @param cb_cls closure for @a cb
- */
 void
 GST_plugins_monitor_subscribe (GNUNET_TRANSPORT_SessionInfoCallback cb,
                                void *cb_cls)
diff --git a/src/transport/gnunet-service-transport_plugins.h 
b/src/transport/gnunet-service-transport_plugins.h
index 0e69da074..fdd819fc5 100644
--- a/src/transport/gnunet-service-transport_plugins.h
+++ b/src/transport/gnunet-service-transport_plugins.h
@@ -40,13 +40,9 @@
  * plugin that caused the call.
  *
  * @param recv_cb function to call when data is received
- * @param register_quota_cb function to call to register a quota callback
- * @param unregister_quota_cb function to call to unregister a quota callback
  * @param address_cb function to call when our public addresses changed
  * @param session_start_cb function to call when a session was created
  * @param session_end_cb function to call when a session was terminated
- * @param address_type_cb function to call when a address type is requested
- * @param metric_update_cb function to call when address metrics change
  */
 void
 GST_plugins_load (GNUNET_TRANSPORT_PluginReceiveCallback recv_cb,
diff --git a/src/transport/plugin_transport_http_client.c 
b/src/transport/plugin_transport_http_client.c
index 476a3cd52..82468992b 100644
--- a/src/transport/plugin_transport_http_client.c
+++ b/src/transport/plugin_transport_http_client.c
@@ -556,7 +556,6 @@ client_reschedule_session_timeout (struct 
GNUNET_ATS_Session *s)
  * Task performing curl operations
  *
  * @param cls plugin as closure
- * @param tc gnunet scheduler task context
  */
 static void
 client_run (void *cls);
@@ -1289,11 +1288,6 @@ client_receive (void *stream,
 }
 
 
-/**
- * Task performing curl operations
- *
- * @param cls plugin as closure
- */
 static void
 client_run (void *cls)
 {
diff --git a/src/transport/plugin_transport_http_common.c 
b/src/transport/plugin_transport_http_common.c
index 75bf8b74a..40353daeb 100644
--- a/src/transport/plugin_transport_http_common.c
+++ b/src/transport/plugin_transport_http_common.c
@@ -407,20 +407,6 @@ http_common_dns_ip_lookup (const char *name,
 }
 
 
-/**
- * Convert the transports address to a nice, human-readable
- * format.
- *
- * @param cls closure
- * @param type name of the transport that generated the address
- * @param addr one of the addresses of the host, NULL for the last address
- *        the specific address format depends on the transport
- * @param addrlen length of the @a addr
- * @param numeric should (IP) addresses be displayed in numeric form?
- * @param timeout after how long should we give up?
- * @param asc function to call on each string
- * @param asc_cls closure for @a asc
- */
 void
 http_common_plugin_address_pretty_printer (void *cls, const char *type,
                                            const void *addr,
@@ -597,17 +583,6 @@ http_common_plugin_address_to_url (void *cls,
 }
 
 
-/**
- * Function called for a quick conversion of the binary address to
- * a numeric address.  Note that the caller must not free the
- * address and that the next call to this function is allowed
- * to override the address again.
- *
- * @param plugin the name of the plugin
- * @param addr binary address
- * @param addrlen length of the address
- * @return string representing the same address
- */
 const char *
 http_common_plugin_address_to_string (const char *plugin,
                                       const void *addr,
@@ -642,18 +617,6 @@ http_common_plugin_address_to_string (const char *plugin,
 }
 
 
-/**
- * Function called to convert a string address to
- * a binary address.
- *
- * @param cls closure ('struct Plugin*')
- * @param addr string address
- * @param addrlen length of the @a addr
- * @param buf location to store the buffer
- *        If the function returns #GNUNET_SYSERR, its contents are undefined.
- * @param added length of created address
- * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
- */
 int
 http_common_plugin_string_to_address (void *cls,
                                       const char *addr,
@@ -721,14 +684,6 @@ http_common_plugin_string_to_address (void *cls,
 }
 
 
-/**
- * Create a HTTP address from a socketaddr
- *
- * @param protocol protocol
- * @param addr sockaddr * address
- * @param addrlen length of the address
- * @return the HttpAddress
- */
 struct HttpAddress *
 http_common_address_from_socket (const char *protocol,
                                  const struct sockaddr *addr,
diff --git a/src/transport/plugin_transport_http_common.h 
b/src/transport/plugin_transport_http_common.h
index 299dc0e68..7a532249d 100644
--- a/src/transport/plugin_transport_http_common.h
+++ b/src/transport/plugin_transport_http_common.h
@@ -137,7 +137,7 @@ http_split_address (const char *addr);
  * @param type name of the transport that generated the address
  * @param addr one of the addresses of the host, NULL for the last address
  *        the specific address format depends on the transport
- * @param addrlen length of the address
+ * @param addrlen length of @a addr
  * @param numeric should (IP) addresses be displayed in numeric form?
  * @param timeout after how long should we give up?
  * @param asc function to call on each string
@@ -178,7 +178,7 @@ http_common_plugin_address_to_string (const char *plugin,
  *
  * @param cls closure (`struct Plugin*`)
  * @param addr string address
- * @param addrlen length of the address
+ * @param addrlen length of @a addr
  * @param buf location to store the buffer
  *        If the function returns #GNUNET_SYSERR, its contents are undefined.
  * @param added length of created address
@@ -198,7 +198,7 @@ http_common_plugin_string_to_address (void *cls,
  * @param protocol protocol
  * @param addr `sockaddr *` address
  * @param addrlen length of the @a addr
- * @return the string
+ * @return A pointer to a `struct HttpAddress` derived from @a addr
  */
 struct HttpAddress *
 http_common_address_from_socket (const char *protocol,
diff --git a/src/transport/tcp_server_legacy.c 
b/src/transport/tcp_server_legacy.c
index f4d48d4f6..bb572c843 100644
--- a/src/transport/tcp_server_legacy.c
+++ b/src/transport/tcp_server_legacy.c
@@ -699,11 +699,6 @@ GNUNET_SERVER_suspend (struct GNUNET_SERVER_Handle *server)
 }
 
 
-/**
- * Resume accepting connections from the listen socket.
- *
- * @param server server to stop accepting connections.
- */
 void
 GNUNET_SERVER_resume (struct GNUNET_SERVER_Handle *server)
 {
@@ -1620,21 +1615,6 @@ transmit_ready_callback_wrapper (void *cls, size_t size, 
void *buf)
 }
 
 
-/**
- * Notify us when the server has enough space to transmit
- * a message of the given size to the given client.
- *
- * @param client client to transmit message to
- * @param size requested amount of buffer space
- * @param timeout after how long should we give up (and call
- *        notify with buf NULL and size 0)?
- * @param callback function to call when space is available
- * @param callback_cls closure for @a callback
- * @return non-NULL if the notify callback was queued; can be used
- *         to cancel the request using
- *         #GNUNET_SERVER_notify_transmit_ready_cancel().
- *         NULL if we are already going to notify someone else (busy)
- */
 struct GNUNET_SERVER_TransmitHandle *
 GNUNET_SERVER_notify_transmit_ready (struct GNUNET_SERVER_Client *client,
                                      size_t size,
diff --git a/src/transport/transport-testing-filenames.c 
b/src/transport/transport-testing-filenames.c
index 7c136b690..70c1ee55a 100644
--- a/src/transport/transport-testing-filenames.c
+++ b/src/transport/transport-testing-filenames.c
@@ -61,13 +61,6 @@ extract_filename (const char *file)
 }
 
 
-/**
- * Extracts the test filename from an absolute file name and removes
- * the extension
- *
- * @param file absolute file name
- * @return the result
- */
 char *
 GNUNET_TRANSPORT_TESTING_get_test_name (const char *file)
 {
@@ -96,12 +89,6 @@ GNUNET_TRANSPORT_TESTING_get_test_name (const char *file)
 }
 
 
-/**
- * Extracts the filename from an absolute file name and removes the extension
- *
- * @param file absolute file name
- * @return the result
- */
 char *
 GNUNET_TRANSPORT_TESTING_get_test_source_name (const char *file)
 {
@@ -115,13 +102,6 @@ GNUNET_TRANSPORT_TESTING_get_test_source_name (const char 
*file)
 }
 
 
-/**
- * Extracts the plugin name from an absolute file name and the test name
- *
- * @param file absolute file name
- * @param test test name
- * @return the result
- */
 char *
 GNUNET_TRANSPORT_TESTING_get_test_plugin_name (const char *file,
                                                const char *test)
@@ -161,14 +141,6 @@ suc:
 }
 
 
-/**
- * This function takes the filename (e.g. argv[0), removes a "lt-"-prefix and
- * if existing ".exe"-prefix and adds the peer-number
- *
- * @param file filename of the test, e.g. argv[0]
- * @param count peer number
- * @return the result
- */
 char *
 GNUNET_TRANSPORT_TESTING_get_config_name (const char *file,
                                           int count)
diff --git a/src/transport/transport-testing2.c 
b/src/transport/transport-testing2.c
index 6d41ec098..f0dee7388 100644
--- a/src/transport/transport-testing2.c
+++ b/src/transport/transport-testing2.c
@@ -379,19 +379,6 @@ retrieve_hello (void *cls)
 }
 
 
-/**
- * Start a peer with the given configuration
- * @param tth the testing handle
- * @param cfgname configuration file
- * @param peer_id a unique number to identify the peer
- * @param handlers functions for receiving messages
- * @param nc connect callback
- * @param nd disconnect callback
- * @param cb_cls closure for callback
- * @param start_cb start callback
- * @param start_cb_cls closure for callback
- * @return the peer context
- */
 struct GNUNET_TRANSPORT_TESTING_PeerContext *
 GNUNET_TRANSPORT_TESTING_start_peer (struct
                                      GNUNET_TRANSPORT_TESTING_Handle *tth,
@@ -545,14 +532,6 @@ GNUNET_TRANSPORT_TESTING_start_peer (struct
 }
 
 
-/**
- * Stops and restarts the given peer, sleeping (!) for 5s in between.
- *
- * @param p the peer
- * @param restart_cb callback to call when restarted
- * @param restart_cb_cls callback closure
- * @return #GNUNET_OK in success otherwise #GNUNET_SYSERR
- */
 int
 GNUNET_TRANSPORT_TESTING_restart_peer (struct
                                        GNUNET_TRANSPORT_TESTING_PeerContext *p,
@@ -751,11 +730,6 @@ GNUNET_TRANSPORT_TESTING_stop_peer (struct
    }*/
 
 
-/**
- * Offer the current HELLO of P2 to P1.
- *
- * @param cls our `struct GNUNET_TRANSPORT_TESTING_ConnectRequest`
- */
 static void
 offer_hello (void *cls)
 {
@@ -859,13 +833,6 @@ GNUNET_TRANSPORT_TESTING_connect_peers (struct
 }
 
 
-/**
- * Cancel the request to connect two peers
- * Tou MUST cancel the request if you stop the peers before the peers 
connected successfully
- *
- * @param tth transport testing handle
- * @param cc a connect request handle
- */
 void
 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (struct
                                                
GNUNET_TRANSPORT_TESTING_ConnectRequest
diff --git a/src/transport/transport-testing2.h 
b/src/transport/transport-testing2.h
index e2167ca7e..b5db28500 100644
--- a/src/transport/transport-testing2.h
+++ b/src/transport/transport-testing2.h
@@ -288,7 +288,7 @@ GNUNET_TRANSPORT_TESTING_done (struct 
GNUNET_TRANSPORT_TESTING_Handle *tth);
  *
  * @param tth the testing handle
  * @param cfgname configuration file
- * @param peer_id the peer_id
+ * @param peer_id an identification number for the peer
  * @param handlers functions for receiving messages
  * @param nc connect callback
  * @param nd disconnect callback
diff --git a/src/transport/transport_api2_communication.c 
b/src/transport/transport_api2_communication.c
index 2a80db87b..aaab5df1c 100644
--- a/src/transport/transport_api2_communication.c
+++ b/src/transport/transport_api2_communication.c
@@ -793,24 +793,6 @@ reconnect (struct GNUNET_TRANSPORT_CommunicatorHandle *ch)
 }
 
 
-/**
- * Connect to the transport service.
- *
- * @param cfg configuration to use
- * @param config_section section of the configuration to use for options
- * @param addr_prefix address prefix for addresses supported by this
- *        communicator, could be NULL for incoming-only communicators
- * @param cc what characteristics does the communicator have?
- * @param mtu maximum message size supported by communicator, 0 if
- *            sending is not supported, SIZE_MAX for no MTU
- * @param mq_init function to call to initialize a message queue given
- *                the address of another peer, can be NULL if the
- *                communicator only supports receiving messages
- * @param mq_init_cls closure for @a mq_init
- * @param notify_cb function to pass backchannel messages to communicator
- * @param notify_cb_cls closure for @a notify_cb
- * @return NULL on error
- */
 struct GNUNET_TRANSPORT_CommunicatorHandle *
 GNUNET_TRANSPORT_communicator_connect (
   const struct GNUNET_CONFIGURATION_Handle *cfg,
@@ -871,26 +853,6 @@ GNUNET_TRANSPORT_communicator_disconnect (
 /* ************************* Receiving *************************** */
 
 
-/**
- * Notify transport service that the communicator has received
- * a message.
- *
- * @param ch connection to transport service
- * @param sender presumed sender of the message (details to be checked
- *        by higher layers)
- * @param msg the message
- * @param expected_addr_validity how long does the communicator believe it
- *        will continue to be able to receive messages from the same address
- *        on which it received this message?
- * @param cb function to call once handling the message is done, NULL if
- *         flow control is not supported by this communicator
- * @param cb_cls closure for @a cb
- * @return #GNUNET_OK if all is well, #GNUNET_NO if the message was
- *         immediately dropped due to memory limitations (communicator
- *         should try to apply back pressure),
- *         #GNUNET_SYSERR if the message could not be delivered because
- *         the transport service is not yet up
- */
 int
 GNUNET_TRANSPORT_communicator_receive (
   struct GNUNET_TRANSPORT_CommunicatorHandle *ch,
@@ -957,25 +919,6 @@ GNUNET_TRANSPORT_communicator_receive (
 /* ************************* Discovery *************************** */
 
 
-/**
- * Notify transport service that an MQ became available due to an
- * "inbound" connection or because the communicator discovered the
- * presence of another peer.
- *
- * @param ch connection to transport service
- * @param peer peer with which we can now communicate
- * @param address address in human-readable format, 0-terminated, UTF-8
- * @param mtu maximum message size supported by queue, 0 if
- *            sending is not supported, SIZE_MAX for no MTU
- * @param q_len number of messages that can be send through this queue
- * @param priority queue priority. Queues with highest priority should be
- *                 used
- * @param nt which network type does the @a address belong to?
- * @param cc what characteristics does the communicator have?
- * @param cs what is the connection status of the queue?
- * @param mq message queue of the @a peer
- * @return API handle identifying the new MQ
- */
 struct GNUNET_TRANSPORT_QueueHandle *
 GNUNET_TRANSPORT_communicator_mq_add (
   struct GNUNET_TRANSPORT_CommunicatorHandle *ch,
@@ -1124,20 +1067,6 @@ GNUNET_TRANSPORT_communicator_address_remove_all (
 /* ************************* Backchannel *************************** */
 
 
-/**
- * The communicator asks the transport service to route a message via
- * a different path to another communicator service at another peer.
- * This must only be done for special control traffic (as there is no
- * flow control for this API), such as acknowledgements, and generally
- * only be done if the communicator is uni-directional (i.e. cannot
- * send the message back itself).
- *
- * @param ch handle of this communicator
- * @param pid peer to send the message to
- * @param comm name of the communicator to send the message to
- * @param header header of the message to transmit and pass via the
- *        notify-API to @a pid's communicator @a comm
- */
 void
 GNUNET_TRANSPORT_communicator_notify (
   struct GNUNET_TRANSPORT_CommunicatorHandle *ch,
diff --git a/src/transport/transport_api_cmd_send_simple.c 
b/src/transport/transport_api_cmd_send_simple.c
index ade0cc914..1ddb81f17 100644
--- a/src/transport/transport_api_cmd_send_simple.c
+++ b/src/transport/transport_api_cmd_send_simple.c
@@ -175,16 +175,6 @@ send_simple_run (void *cls,
 }
 
 
-/**
- * Create command.
- *
- * @param label name for command.
- * @param start_peer_label Label of the cmd to start a peer.
- * @param start_peer_label Label of the cmd which started the test system.
- * @param num Number globally identifying the node.
- * @param The topology for the test setup.
- * @return command.
- */
 struct GNUNET_TESTING_Command
 GNUNET_TRANSPORT_cmd_send_simple (const char *label,
                                   const char *start_peer_label,
diff --git a/src/transport/transport_api_monitor_peers.c 
b/src/transport/transport_api_monitor_peers.c
index 2f0f07f23..ef1dc6087 100644
--- a/src/transport/transport_api_monitor_peers.c
+++ b/src/transport/transport_api_monitor_peers.c
@@ -389,32 +389,6 @@ do_peer_connect (void *cls)
 }
 
 
-/**
- * Return information about a specific peer or all peers currently known to
- * transport service once or in monitoring mode. To obtain information about
- * a specific peer, a peer identity can be passed. To obtain information about
- * all peers currently known to transport service, NULL can be passed as peer
- * identity.
- *
- * For each peer, the callback is called with information about the address 
used
- * to communicate with this peer, the state this peer is currently in and the
- * the current timeout for this state.
- *
- * Upon completion, the 'GNUNET_TRANSPORT_PeerIterateCallback' is called one
- * more time with 'NULL'. After this, the operation must no longer be
- * explicitly canceled.
- *
- * The #GNUNET_TRANSPORT_monitor_peers_cancel call MUST not be called in the
- * the peer_callback!
- *
- * @param cfg configuration to use
- * @param peer a specific peer identity to obtain information for,
- *      NULL for all peers
- * @param one_shot #GNUNET_YES to return the current state and then end (with 
NULL+NULL),
- *                 #GNUNET_NO to monitor peers continuously
- * @param peer_callback function to call with the results
- * @param peer_callback_cls closure for @a peer_address_callback
- */
 struct GNUNET_TRANSPORT_PeerMonitoringContext *
 GNUNET_TRANSPORT_monitor_peers (const struct GNUNET_CONFIGURATION_Handle *cfg,
                                 const struct GNUNET_PeerIdentity *peer,
diff --git a/src/transport/transport_api_offer_hello.c 
b/src/transport/transport_api_offer_hello.c
index eb342f57c..1b611aa6b 100644
--- a/src/transport/transport_api_offer_hello.c
+++ b/src/transport/transport_api_offer_hello.c
@@ -125,11 +125,6 @@ GNUNET_TRANSPORT_offer_hello (const struct 
GNUNET_CONFIGURATION_Handle *cfg,
 }
 
 
-/**
- * Cancel the request to transport to offer the HELLO message
- *
- * @param ohh the handle for the operation to cancel
- */
 void
 GNUNET_TRANSPORT_offer_hello_cancel (struct
                                      GNUNET_TRANSPORT_OfferHelloHandle *ohh)

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]