From 3b2be11385b8b4626b86d4438008eb0508f856fa Mon Sep 17 00:00:00 2001 From: Matthias Wachs Date: Mon, 13 Feb 2012 17:00:10 +0000 Subject: [PATCH] - doxygen errors --- src/ats/ats_api_scheduling.c | 1 + src/ats/gnunet-service-ats_addresses.c | 4 ++-- src/ats/gnunet-service-ats_addresses_mlp.c | 13 +++++++++---- src/ats/gnunet-service-ats_addresses_mlp.h | 2 +- src/include/gnunet_ats_service.h | 1 + src/transport/gnunet-service-transport.c | 4 ++-- src/transport/gnunet-service-transport_neighbours.c | 6 +++--- src/transport/transport_api_address_lookup.c | 2 +- 8 files changed, 20 insertions(+), 13 deletions(-) diff --git a/src/ats/ats_api_scheduling.c b/src/ats/ats_api_scheduling.c index dd70b634f..e64c69a9a 100644 --- a/src/ats/ats_api_scheduling.c +++ b/src/ats/ats_api_scheduling.c @@ -754,6 +754,7 @@ get_addresses (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) /** * Returns where the address is located: LAN or WAN or ... + * @param sh the scheduling handle * @param addr address * @param addrlen address length * @return location as GNUNET_ATS_Information diff --git a/src/ats/gnunet-service-ats_addresses.c b/src/ats/gnunet-service-ats_addresses.c index 556214f80..04cc07c8b 100644 --- a/src/ats/gnunet-service-ats_addresses.c +++ b/src/ats/gnunet-service-ats_addresses.c @@ -39,14 +39,14 @@ enum ATS_Mode { - /** + /* * Assign each peer an equal amount of bandwidth (bw) * * bw_per_peer = bw_total / #active addresses */ SIMPLE, - /** + /* * Use MLP solver to assign bandwidth */ MLP diff --git a/src/ats/gnunet-service-ats_addresses_mlp.c b/src/ats/gnunet-service-ats_addresses_mlp.c index 602925e1f..cdda9d790 100644 --- a/src/ats/gnunet-service-ats_addresses_mlp.c +++ b/src/ats/gnunet-service-ats_addresses_mlp.c @@ -151,7 +151,7 @@ mlp_status_to_string (int retcode) * Translate ATS properties to text * Just intended for debugging * - * @param retcode return code + * @param ats_index the ATS index * @return string with result */ const char * @@ -195,7 +195,9 @@ mlp_ats_to_string (int ats_index) /** * Find a peer in the DLL - * @param the peer to find + * + * @param mlp the mlp handle + * @param peer the peer to find * @return the peer struct */ static struct ATS_Peer * @@ -381,6 +383,7 @@ mlp_lookup_ats (struct ATS_Address *addr, int ats_index) * Adds the problem constraints for all addresses * Required for problem recreation after address deletion * + * @param mlp the mlp handle * @param addresses all addresses */ @@ -684,6 +687,7 @@ create_columns_it (void *cls, const GNUNET_HashCode * key, void *value) * Create the MLP problem * * @param mlp the MLP handle + * @param addresses the hashmap containing all adresses * @return GNUNET_OK or GNUNET_SYSERR */ static int @@ -1022,6 +1026,7 @@ GAS_mlp_solve_problem (struct GAS_MLP_Handle *mlp) /** * Init the MLP problem solving component * + * @param cfg the GNUNET_CONFIGURATION_Handle handle * @param stats the GNUNET_STATISTICS handle * @param max_duration maximum numbers of iterations for the LP/MLP Solver * @param max_iterations maximum time limit for the LP/MLP Solver @@ -1393,13 +1398,13 @@ GAS_mlp_address_delete (struct GAS_MLP_Handle *mlp, struct GNUNET_CONTAINER_Mult * @param mlp the MLP Handle * @param peer the peer * @param kind the kind to change the preference - * @param float the score + * @param score the score */ void GAS_mlp_address_change_preference (struct GAS_MLP_Handle *mlp, const struct GNUNET_PeerIdentity *peer, enum GNUNET_ATS_PreferenceKind kind, - float score) + float ) { GNUNET_STATISTICS_update (mlp->stats,"# LP address preference changes", 1, GNUNET_NO); diff --git a/src/ats/gnunet-service-ats_addresses_mlp.h b/src/ats/gnunet-service-ats_addresses_mlp.h index 43c2b66ad..52631eb3c 100644 --- a/src/ats/gnunet-service-ats_addresses_mlp.h +++ b/src/ats/gnunet-service-ats_addresses_mlp.h @@ -339,7 +339,7 @@ GAS_mlp_address_delete (struct GAS_MLP_Handle *mlp, struct GNUNET_CONTAINER_Mult * @param mlp the MLP Handle * @param peer the peer * @param kind the kind to change the preference - * @param float the score + * @param score the score */ void GAS_mlp_address_change_preference (struct GAS_MLP_Handle *mlp, diff --git a/src/include/gnunet_ats_service.h b/src/include/gnunet_ats_service.h index 9f5fed29d..2c1b929fa 100644 --- a/src/include/gnunet_ats_service.h +++ b/src/include/gnunet_ats_service.h @@ -538,6 +538,7 @@ GNUNET_ATS_suggest_address_cancel (struct GNUNET_ATS_SchedulingHandle *sh, /** * Returns where the address is located: LAN or WAN or ... + * @param sh the GNUNET_ATS_SchedulingHandle handle * @param addr address * @param addrlen address length * @return location as GNUNET_ATS_Information diff --git a/src/transport/gnunet-service-transport.c b/src/transport/gnunet-service-transport.c index 8b96babc3..cd9bb5c65 100644 --- a/src/transport/gnunet-service-transport.c +++ b/src/transport/gnunet-service-transport.c @@ -120,7 +120,7 @@ process_hello_update (void *cls, const struct GNUNET_MessageHeader *hello) * @param peer (claimed) identity of the other peer * @param address the address * @param session session used - * @param msg the message to process + * @param message the message to process * @param ats performance information * @param ats_count number of records in ats * @return how long the plugin should wait until receiving more data @@ -408,7 +408,7 @@ plugin_env_address_to_type (void *cls, * @param bandwidth_out assigned outbound bandwidth for the connection, 0 to disconnect from peer * @param bandwidth_in assigned inbound bandwidth for the connection, 0 to disconnect from peer * @param ats ATS information - * @param number of ATS elements + * @param ats_count number of ATS elements */ static void ats_request_address_change (void *cls, diff --git a/src/transport/gnunet-service-transport_neighbours.c b/src/transport/gnunet-service-transport_neighbours.c index 12a3cd171..6c072130b 100644 --- a/src/transport/gnunet-service-transport_neighbours.c +++ b/src/transport/gnunet-service-transport_neighbours.c @@ -791,19 +791,19 @@ transmission_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) * @param cls closure for callbacks * @param connect_cb function to call if we connect to a peer * @param disconnect_cb function to call if we disconnect from a peer - * @param address_cb function to call if we change an active address + * @param peer_address_cb function to call if we change an active address * of a neighbour */ void GST_neighbours_start (void *cls, GNUNET_TRANSPORT_NotifyConnect connect_cb, GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb, - GNUNET_TRANSPORT_PeerIterateCallback address_cb) + GNUNET_TRANSPORT_PeerIterateCallback peer_address_cb) { callback_cls = cls; connect_notify_cb = connect_cb; disconnect_notify_cb = disconnect_cb; - address_change_cb = address_cb; + address_change_cb = peer_address_cb; neighbours = GNUNET_CONTAINER_multihashmap_create (NEIGHBOUR_TABLE_SIZE); } diff --git a/src/transport/transport_api_address_lookup.c b/src/transport/transport_api_address_lookup.c index 32bb41d55..6e03945c5 100644 --- a/src/transport/transport_api_address_lookup.c +++ b/src/transport/transport_api_address_lookup.c @@ -19,7 +19,7 @@ */ /** - * @file transport/transport_api_peer_address_lookup.c + * @file transport/transport_api_address_lookup.c * @brief given a peer id, get all known addresses from transport service * * This api provides the ability to query the transport service about -- 2.25.1