-DOC: Established neovim workflow for checking and stripping comments, first pass over the ATS subsystem.

8 files changed, 3 insertions, 79 deletions

diff --git a/src/ats/gnunet-service-ats_addresses.c b/src/ats/gnunet-service-ats_addresses.c
index d02efd939..9c9856094 100644
--- a/src/ats/gnunet-service-ats_addresses.c
+++ b/src/ats/gnunet-service-ats_addresses.c
@@ -196,17 +196,6 @@ find_exact_address (const struct GNUNET_PeerIdentity *peer,
 }
 
 
-/**
- * Add a new address for a peer.
- *
- * @param peer peer
- * @param plugin_name transport plugin name
- * @param plugin_addr plugin address
- * @param plugin_addr_len length of the plugin address in @a plugin_addr
- * @param local_address_info the local address for the address
- * @param session_id session id, can be 0
- * @param prop performance information for this address
- */
 void
 GAS_addresses_add (const struct GNUNET_PeerIdentity *peer,
                    const char *plugin_name,
@@ -265,13 +254,6 @@ GAS_addresses_add (const struct GNUNET_PeerIdentity *peer,
 }
 
 
-/**
- * Update an address with new performance information for a peer.
- *
- * @param peer peer
- * @param session_id session id, never 0
- * @param prop performance information for this address
- */
 void
 GAS_addresses_update (const struct GNUNET_PeerIdentity *peer,
                       uint32_t session_id,
@@ -465,13 +447,6 @@ peerinfo_it (void *cls,
 }
 
 
-/**
- * Return information all peers currently known to ATS
- *
- * @param peer the respective peer, NULL for 'all' peers
- * @param pi_it the iterator to call for every peer
- * @param pi_it_cls the closure for @a pi_it
- */
 void
 GAS_addresses_get_peer_info (const struct GNUNET_PeerIdentity *peer,
                              GNUNET_ATS_PeerInfo_Iterator pi_it,
@@ -665,12 +640,6 @@ req_addr_peerinfo_it (void *cls,
 }
 
 
-/**
- * Handle 'address list request' messages from clients.
- *
- * @param cls client that sent the request
- * @param alrm the request message
- */
 void
 GAS_handle_request_address_list (struct GNUNET_SERVICE_Client *client,
                                  const struct AddressListRequestMessage *alrm)
diff --git a/src/ats/gnunet-service-ats_addresses.h b/src/ats/gnunet-service-ats_addresses.h
index b39484f59..8e6f40f38 100644
--- a/src/ats/gnunet-service-ats_addresses.h
+++ b/src/ats/gnunet-service-ats_addresses.h
@@ -464,7 +464,7 @@ typedef void
 /**
  * Return information all peers currently known to ATS
  *
- * @param peer the respective peer
+ * @param peer the respective peer, NULL for 'all' peers
  * @param pi_it the iterator to call for every peer
  * @param pi_it_cls the closure for @a pi_it
  */
diff --git a/src/ats/gnunet-service-ats_plugins.c b/src/ats/gnunet-service-ats_plugins.c
index d8d6be11d..d3db69caa 100644
--- a/src/ats/gnunet-service-ats_plugins.c
+++ b/src/ats/gnunet-service-ats_plugins.c
@@ -70,11 +70,6 @@ GAS_plugin_notify_preference_changed (const struct GNUNET_PeerIdentity *peer,
 }
 
 
-/**
- * The relative value for a property changed.
- *
- * @param address the peer for which a property changed
- */
 void
 GAS_plugin_notify_property_changed (struct ATS_Address *address)
 {
@@ -425,13 +420,6 @@ load_quotas (const struct GNUNET_CONFIGURATION_Handle *cfg,
 }
 
 
-/**
- * Initialize plugins subsystem.
- *
- * @param cfg configuration to use
- * @return #GNUNET_OK on success, #GNUNET_SYSERR on error (failed to load
- *         solver plugin)
- */
 int
 GAS_plugin_init (const struct GNUNET_CONFIGURATION_Handle *cfg)
 {
@@ -493,12 +481,6 @@ GAS_plugin_done ()
 }
 
 
-/**
- * Tell the solver that the given address can now be used
- * for talking to the respective peer.
- *
- * @param new_address the new address
- */
 void
 GAS_plugin_new_address (struct ATS_Address *new_address)
 {
diff --git a/src/ats/gnunet-service-ats_plugins.h b/src/ats/gnunet-service-ats_plugins.h
index 0bd358917..1abdbbd80 100644
--- a/src/ats/gnunet-service-ats_plugins.h
+++ b/src/ats/gnunet-service-ats_plugins.h
@@ -67,7 +67,7 @@ GAS_plugin_notify_preference_changed (const struct GNUNET_PeerIdentity *peer,
 /**
  * The relative value for a property changed.
  *
- * @param address the peer
+ * @param address The peer for which a property changed.
  */
 void
 GAS_plugin_notify_property_changed (struct ATS_Address *address);
@@ -78,7 +78,6 @@ GAS_plugin_notify_property_changed (struct ATS_Address *address);
  * for talking to the respective peer.
  *
  * @param new_address the new address
- * @param addr_net network scope the address is in
  */
 void
 GAS_plugin_new_address (struct ATS_Address *new_address);
diff --git a/src/ats/gnunet-service-ats_preferences.c b/src/ats/gnunet-service-ats_preferences.c
index 0869c65dc..c2b2dc4c1 100644
--- a/src/ats/gnunet-service-ats_preferences.c
+++ b/src/ats/gnunet-service-ats_preferences.c
@@ -747,11 +747,6 @@ GAS_preference_get_by_peer (void *cls,
 }
 
 
-/**
- * A performance client disconnected
- *
- * @param client the client
- */
 void
 GAS_preference_client_disconnect (struct GNUNET_SERVICE_Client *client)
 {
diff --git a/src/ats/gnunet-service-ats_reservations.c b/src/ats/gnunet-service-ats_reservations.c
index a50e9d5b7..471a19859 100644
--- a/src/ats/gnunet-service-ats_reservations.c
+++ b/src/ats/gnunet-service-ats_reservations.c
@@ -135,12 +135,6 @@ GAS_reservations_set_bandwidth (const struct GNUNET_PeerIdentity *peer,
 }
 
 
-/**
- * Handle 'reservation request' messages from clients.
- *
- * @param client client that sent the request
- * @param msg the request message
- */
 void
 GAS_handle_reservation_request (struct GNUNET_SERVICE_Client *client,
                                 const struct ReservationRequestMessage *msg)
diff --git a/src/ats/gnunet-service-ats_scheduling.c b/src/ats/gnunet-service-ats_scheduling.c
index 456c222a9..2dfb70343 100644
--- a/src/ats/gnunet-service-ats_scheduling.c
+++ b/src/ats/gnunet-service-ats_scheduling.c
@@ -71,15 +71,6 @@ GAS_scheduling_remove_client (struct GNUNET_SERVICE_Client *client)
 }
 
 
-/**
- * Transmit the given address suggestion and bandwidth update to all scheduling
- * clients.
- *
- * @param peer peer for which this is an address suggestion
- * @param session_id session ID to use for the given client
- * @param bandwidth_out assigned outbound bandwidth
- * @param bandwidth_in assigned inbound bandwidth
- */
 void
 GAS_scheduling_transmit_address_suggestion (const struct
                                             GNUNET_PeerIdentity *peer,
@@ -114,11 +105,6 @@ GAS_scheduling_transmit_address_suggestion (const struct
 }
 
 
-/**
- * Handle 'address add' messages from clients.
- *
- * @param m the request message
- */
 void
 GAS_handle_address_add (const struct AddressAddMessage *m)
 {
diff --git a/src/ats/gnunet-service-ats_scheduling.h b/src/ats/gnunet-service-ats_scheduling.h
index d68306988..ca6c1bd57 100644
--- a/src/ats/gnunet-service-ats_scheduling.h
+++ b/src/ats/gnunet-service-ats_scheduling.h
@@ -55,7 +55,7 @@ GAS_scheduling_remove_client (struct GNUNET_SERVICE_Client *client);
  * clients.
  *
  * @param peer peer for which this is an address suggestion
- * @param session_id session ID to use
+ * @param session_id session ID to use for the given client
  * @param bandwidth_out assigned outbound bandwidth
  * @param bandwidth_in assigned inbound bandwidth
  */
@@ -72,7 +72,6 @@ GAS_scheduling_transmit_address_suggestion (const struct
 /**
  * Handle 'address add' messages from clients.
  *
- * @param client client that sent the request
  * @param m the request message
  */
 void