- doxygen

git-svn-id: https://gnunet.org/svn/gnunet@25436 140774ce-b5e7-0310-ab8b-a85725594a96

9 files changed, 66 insertions, 20 deletions

diff --git a/src/ats/gnunet-service-ats_addresses.c b/src/ats/gnunet-service-ats_addresses.c
index 65f9ce89ae..36070f9991 100644
--- a/src/ats/gnunet-service-ats_addresses.c
+++ b/src/ats/gnunet-service-ats_addresses.c
@@ -321,6 +321,7 @@ create_address (const struct GNUNET_PeerIdentity *peer,
 /**
  * Destroy the given address.
  *
+ * @param handle the address handle
  * @param addr address to destroy
  * @return GNUNET_YES if bandwidth allocations should be recalcualted
  */
@@ -421,6 +422,7 @@ compare_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
  * Compares by peer identity and network address OR by session ID
  * (one of the two must match).
  *
+ * @param handle the address handle
  * @param peer peer to lookup addresses for
  * @param addr existing address record
  * @return existing address record, NULL for none
@@ -794,6 +796,7 @@ GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
 /**
  * Cancel address suggestions for a peer
  *
+ * @param handle the address handle
  * @param peer the respective peer
  */
 void
@@ -829,6 +832,7 @@ GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
 /**
  * Add an address suggestions for a peer
  *
+ * @param handle the address handle
  * @param peer the respective peer
  */
 void
@@ -1268,6 +1272,7 @@ peer_it (void *cls,
 /**
  * Return all peers currently known to ATS
  *
+ * @param handle the address handle
  * @param p_it the iterator to call for every peer, callbach with id == NULL
  *        when done
  * @param p_it_cls the closure for the iterator
@@ -1332,6 +1337,7 @@ peerinfo_it (void *cls,
 /**
  * Return all peers currently known to ATS
  *
+ * @param handle the address handle
  * @param peer the respective peer
  * @param pi_it the iterator to call for every peer
  * @param pi_it_cls the closure for the iterator
diff --git a/src/ats/gnunet-service-ats_addresses_mlp.c b/src/ats/gnunet-service-ats_addresses_mlp.c
index 2ba939982c..8e852ad751 100644
--- a/src/ats/gnunet-service-ats_addresses_mlp.c
+++ b/src/ats/gnunet-service-ats_addresses_mlp.c
@@ -339,6 +339,7 @@ create_constraint_it (void *cls, const struct GNUNET_HashCode * key, void *value
   return GNUNET_OK;
 }
 
+#if 0
 /**
  * Find the required ATS information for an address
  *
@@ -347,7 +348,6 @@ create_constraint_it (void *cls, const struct GNUNET_HashCode * key, void *value
  *
  * @return the index on success, otherwise GNUNET_SYSERR
  */
-#if 0
 static int
 mlp_lookup_ats (struct ATS_Address *addr, int ats_index)
 {
@@ -1073,6 +1073,12 @@ GAS_mlp_solve_problem (void *solver, struct GAS_MLP_SolutionContext *ctx)
  *
  * @param cfg the GNUNET_CONFIGURATION_Handle handle
  * @param stats the GNUNET_STATISTICS handle
+ * @param network array of GNUNET_ATS_NetworkType with length dest_length
+ * @param out_dest array of outbound quotas
+ * @param in_dest array of outbound quota
+ * @param dest_length array length for quota arrays
+ * @param bw_changed_cb callback for changed bandwidth amounts
+ * @param bw_changed_cb_cls cls for callback
  * @return struct GAS_MLP_Handle on success, NULL on fail
  */
 void *
@@ -1544,10 +1550,13 @@ GAS_mlp_address_add (void *solver, struct GNUNET_CONTAINER_MultiHashMap * addres
  * Otherwise the addresses' values can be updated and the existing base can
  * be reused
  *
- * @param solver the MLP Handle
- * @param addresses the address hashmap
- *        the address has to be already removed from the hashmap
- * @param address the address to update
+ * @param solver the solver Handle
+ * @param addresses the address hashmap containing all addresses
+ * @param address the update address
+ * @param session the new session (if changed otherwise current)
+ * @param in_use the new address in use state (if changed otherwise current)
+ * @param atsi the latest ATS information
+ * @param atsi_count the atsi count
  */
 void
 GAS_mlp_address_update (void *solver,
diff --git a/src/ats/gnunet-service-ats_addresses_mlp.h b/src/ats/gnunet-service-ats_addresses_mlp.h
index ce0a348a34..2f09bd269f 100644
--- a/src/ats/gnunet-service-ats_addresses_mlp.h
+++ b/src/ats/gnunet-service-ats_addresses_mlp.h
@@ -316,7 +316,12 @@ struct MLP_information
  *
  * @param cfg configuration handle
  * @param stats the GNUNET_STATISTICS handle
- * @param bw_changed_cb callback to call when assigned changes
+ * @param network array of GNUNET_ATS_NetworkType with length dest_length
+ * @param out_dest array of outbound quotas
+ * @param in_dest array of outbound quota
+ * @param dest_length array length for quota arrays
+ * @param bw_changed_cb callback for changed bandwidth amounts
+ * @param bw_changed_cb_cls cls for callback
  * @return struct GAS_MLP_Handle on success, NULL on fail
  */
 void *
@@ -349,10 +354,13 @@ GAS_mlp_address_add (void *solver, struct GNUNET_CONTAINER_MultiHashMap * addres
  * Otherwise the addresses' values can be updated and the existing base can
  * be reused
  *
- * @param solver the MLP Handle
- * @param addresses the address hashmap
- *        the address has to be already added from the hashmap
- * @param address the address to update
+ * @param solver the solver Handle
+ * @param addresses the address hashmap containing all addresses
+ * @param address the update address
+ * @param session the new session (if changed otherwise current)
+ * @param in_use the new address in use state (if changed otherwise current)
+ * @param atsi the latest ATS information
+ * @param atsi_count the atsi count
  */
 void
 GAS_mlp_address_update (void *solver,
diff --git a/src/ats/gnunet-service-ats_addresses_simplistic.c b/src/ats/gnunet-service-ats_addresses_simplistic.c
index c0b708b870..2c31359f57 100644
--- a/src/ats/gnunet-service-ats_addresses_simplistic.c
+++ b/src/ats/gnunet-service-ats_addresses_simplistic.c
@@ -135,7 +135,10 @@ struct AddressWrapper
  * @param stats the GNUNET_STATISTICS handle
  * @param network array of GNUNET_ATS_NetworkType with length dest_length
  * @param out_quota array of outbound quotas
- * param in_quota array of outbound quota
+ * @param in_quota array of outbound quota
+ * @param dest_length array length for quota arrays
+ * @param bw_changed_cb callback for changed bandwidth amounts
+ * @param bw_changed_cb_cls cls for callback
  * @return handle for the solver on success, NULL on fail
  */
 void *
@@ -241,7 +244,8 @@ GAS_simplistic_done (void *solver)
 /**
  * Update the quotas for a network type
  *
- * @param network the network type to update
+ * @param s the solver handle
+ * @param net the network type to update
  * @param address_except address excluded from notifcation, since we suggest
  * this address
  */
@@ -415,6 +419,10 @@ GAS_simplistic_address_delete (void *solver,
  * @param solver the solver Handle
  * @param addresses the address hashmap containing all addresses
  * @param address the update address
+ * @param session the new session (if changed otherwise current)
+ * @param in_use the new address in use state (if changed otherwise current)
+ * @param atsi the latest ATS information
+ * @param atsi_count the atsi count
  */
 void
 GAS_simplistic_address_update (void *solver,
diff --git a/src/ats/gnunet-service-ats_addresses_simplistic.h b/src/ats/gnunet-service-ats_addresses_simplistic.h
index 029a740371..0a3eee4bd3 100644
--- a/src/ats/gnunet-service-ats_addresses_simplistic.h
+++ b/src/ats/gnunet-service-ats_addresses_simplistic.h
@@ -48,8 +48,10 @@
  * @param stats the GNUNET_STATISTICS handle
  * @param network array of GNUNET_ATS_NetworkType with length dest_length
  * @param out_quota array of outbound quotas
- * param in_quota array of outbound quota
- * @param bw_changed_cb callback to call when assigned changes
+ * @param in_quota array of outbound quota
+ * @param dest_length array length for quota arrays
+ * @param bw_changed_cb callback for changed bandwidth amounts
+ * @param bw_changed_cb_cls cls for callback
  * @return handle for the solver on success, NULL on fail
  */
 void *
@@ -87,6 +89,10 @@ GAS_simplistic_address_add (void *solver, struct GNUNET_CONTAINER_MultiHashMap *
  * @param solver the solver Handle
  * @param addresses the address hashmap containing all addresses
  * @param address the update address
+ * @param session the new session (if changed otherwise current)
+ * @param in_use the new address in use state (if changed otherwise current)
+ * @param atsi the latest ATS information
+ * @param atsi_count the atsi count
  */
 void
 GAS_simplistic_address_update (void *solver,
diff --git a/src/ats/gnunet-service-ats_performance.c b/src/ats/gnunet-service-ats_performance.c
index ef6e5572a5..6ebd021cf8 100644
--- a/src/ats/gnunet-service-ats_performance.c
+++ b/src/ats/gnunet-service-ats_performance.c
@@ -554,7 +554,8 @@ GAS_handle_reservation_request (void *cls, struct GNUNET_SERVER_Client *client,
  * @param message the request message
  */
 void
-GAS_handle_preference_change (void *cls, struct GNUNET_SERVER_Client *client,
+GAS_handle_preference_change (void *cls,
+                              struct GNUNET_SERVER_Client *client,
                               const struct GNUNET_MessageHeader *message)
 {
   const struct ChangePreferenceMessage *msg;
@@ -598,6 +599,7 @@ GAS_handle_preference_change (void *cls, struct GNUNET_SERVER_Client *client,
  * Initialize performance subsystem.
  *
  * @param server handle to our server
+ * @param addresses the address handle to use
  */
 void
 GAS_performance_init (struct GNUNET_SERVER_Handle *server,
diff --git a/src/ats/gnunet-service-ats_performance.h b/src/ats/gnunet-service-ats_performance.h
index 0ef481d48c..6d527ae194 100644
--- a/src/ats/gnunet-service-ats_performance.h
+++ b/src/ats/gnunet-service-ats_performance.h
@@ -87,7 +87,8 @@ GAS_performance_notify_all_clients (const struct GNUNET_PeerIdentity *peer,
  * @param message the request message
  */
 void
-GAS_handle_request_address_list (void *cls, struct GNUNET_SERVER_Client *client,
+GAS_handle_request_address_list (void *cls,
+                                 struct GNUNET_SERVER_Client *client,
                                  const struct GNUNET_MessageHeader *message);
 
 /**
@@ -98,7 +99,8 @@ GAS_handle_request_address_list (void *cls, struct GNUNET_SERVER_Client *client,
  * @param message the request message
  */
 void
-GAS_handle_reservation_request (void *cls, struct GNUNET_SERVER_Client *client,
+GAS_handle_reservation_request (void *cls,
+                                struct GNUNET_SERVER_Client *client,
                                 const struct GNUNET_MessageHeader *message);
 
 
@@ -110,7 +112,8 @@ GAS_handle_reservation_request (void *cls, struct GNUNET_SERVER_Client *client,
  * @param message the request message
  */
 void
-GAS_handle_preference_change (void *cls, struct GNUNET_SERVER_Client *client,
+GAS_handle_preference_change (void *cls,
+                              struct GNUNET_SERVER_Client *client,
                               const struct GNUNET_MessageHeader *message);
 
 
@@ -118,6 +121,7 @@ GAS_handle_preference_change (void *cls, struct GNUNET_SERVER_Client *client,
  * Initialize performance subsystem.
  *
  * @param server handle to our server
+ * @param addresses the address handle to use
  */
 void
 GAS_performance_init (struct GNUNET_SERVER_Handle *server,
diff --git a/src/ats/gnunet-service-ats_scheduling.c b/src/ats/gnunet-service-ats_scheduling.c
index 70009b310d..4a20f909db 100644
--- a/src/ats/gnunet-service-ats_scheduling.c
+++ b/src/ats/gnunet-service-ats_scheduling.c
@@ -482,6 +482,7 @@ GAS_handle_address_destroyed (void *cls, struct GNUNET_SERVER_Client *client,
  * Initialize scheduling subsystem.
  *
  * @param server handle to our server
+ * @param ah the address handle to use
  */
 void
 GAS_scheduling_init (struct GNUNET_SERVER_Handle *server, struct GAS_Addresses_Handle *ah)
diff --git a/src/ats/gnunet-service-ats_scheduling.h b/src/ats/gnunet-service-ats_scheduling.h
index e1ac166c50..d7b5e9cde3 100644
--- a/src/ats/gnunet-service-ats_scheduling.h
+++ b/src/ats/gnunet-service-ats_scheduling.h
@@ -159,7 +159,8 @@ GAS_handle_address_in_use (void *cls, struct GNUNET_SERVER_Client *client,
  * @param message the request message
  */
 void
-GAS_handle_address_destroyed (void *cls, struct GNUNET_SERVER_Client *client,
+GAS_handle_address_destroyed (void *cls,
+                              struct GNUNET_SERVER_Client *client,
                               const struct GNUNET_MessageHeader *message);
 
 
@@ -167,9 +168,10 @@ GAS_handle_address_destroyed (void *cls, struct GNUNET_SERVER_Client *client,
  * Initialize scheduling subsystem.
  *
  * @param server handle to our server
+ * @param ah the address handle to use
  */
 void
-GAS_scheduling_init (struct GNUNET_SERVER_Handle *server, struct GAS_Addresses_Handle *addresses);
+GAS_scheduling_init (struct GNUNET_SERVER_Handle *server, struct GAS_Addresses_Handle *ah);
 
 
 /**