From c98e2e920ee8c27d3b319217056116c4f13d1c6a Mon Sep 17 00:00:00 2001 From: Matthias Wachs Date: Thu, 16 Jan 2014 14:03:36 +0000 Subject: more fixed documentation --- src/ats/gnunet-service-ats_addresses.c | 1 + src/transport/gnunet-service-transport_clients.c | 8 +++++--- src/transport/gnunet-service-transport_clients.h | 11 +++++++++++ src/transport/gnunet-service-transport_manipulation.c | 4 +--- src/transport/gnunet-service-transport_manipulation.h | 4 +--- src/transport/gnunet-service-transport_neighbours.c | 1 - src/transport/gnunet-service-transport_validation.c | 2 ++ src/transport/gnunet-service-transport_validation.h | 3 +++ src/transport/plugin_transport_tcp.c | 2 +- src/transport/plugin_transport_udp.c | 3 +-- src/transport/plugin_transport_unix.c | 6 ++---- src/transport/plugin_transport_wlan.c | 2 +- src/transport/transport_api_monitoring.c | 4 ++-- 13 files changed, 31 insertions(+), 20 deletions(-) (limited to 'src') diff --git a/src/ats/gnunet-service-ats_addresses.c b/src/ats/gnunet-service-ats_addresses.c index a8c859450..61d76e770 100644 --- a/src/ats/gnunet-service-ats_addresses.c +++ b/src/ats/gnunet-service-ats_addresses.c @@ -472,6 +472,7 @@ free_address (struct ATS_Address *addr) * @param plugin_name plugin * @param plugin_addr address * @param plugin_addr_len address length + * @param local_address_info additional local info for the address * @param session_id session * @return the ATS_Address */ diff --git a/src/transport/gnunet-service-transport_clients.c b/src/transport/gnunet-service-transport_clients.c index 7b47bb6f5..653becf39 100644 --- a/src/transport/gnunet-service-transport_clients.c +++ b/src/transport/gnunet-service-transport_clients.c @@ -1379,12 +1379,14 @@ GST_clients_broadcast_peer_notification (const struct GNUNET_PeerIdentity *peer, } /** - * Broadcast the new active address to all clients monitoring the peer. + * Broadcast the new validation changes to all clients monitoring the peer. * * @param peer peer this update is about (never NULL) * @param address address, NULL on disconnect - * @param state the current state of the peer - * @param state_timeout the time out for the state + * @param last_validation point in time when last validation was performed + * @param valid_until point in time how long address is valid + * @param next_validation point in time when next validation will be performed + * @param state state of validation notification */ void GST_clients_broadcast_validation_notification ( diff --git a/src/transport/gnunet-service-transport_clients.h b/src/transport/gnunet-service-transport_clients.h index 29c46c06b..f6d95eacc 100644 --- a/src/transport/gnunet-service-transport_clients.h +++ b/src/transport/gnunet-service-transport_clients.h @@ -85,6 +85,17 @@ GST_clients_broadcast_peer_notification (const struct GNUNET_PeerIdentity *peer, enum GNUNET_TRANSPORT_PeerState state, struct GNUNET_TIME_Absolute state_timeout); + +/** + * Broadcast the new validation changes to all clients monitoring the peer. + * + * @param peer peer this update is about (never NULL) + * @param address address, NULL on disconnect + * @param last_validation point in time when last validation was performed + * @param valid_until point in time how long address is valid + * @param next_validation point in time when next validation will be performed + * @param state state of validation notification + */ void GST_clients_broadcast_validation_notification ( const struct GNUNET_PeerIdentity *peer, diff --git a/src/transport/gnunet-service-transport_manipulation.c b/src/transport/gnunet-service-transport_manipulation.c index 06171d306..bb90e1892 100644 --- a/src/transport/gnunet-service-transport_manipulation.c +++ b/src/transport/gnunet-service-transport_manipulation.c @@ -521,11 +521,9 @@ GST_manipulation_manipulate_metrics(const struct GNUNET_PeerIdentity *peer, * manipulation delays for next send. * * @param cls the closure for transport - * @param peer the peer the message was received from + * @param address the address and the peer the message was received from * @param message the message received * @param session the session the message was received on - * @param sender_address the sender address - * @param sender_address_len the length of the sender address * @return manipulated delay for next receive */ struct GNUNET_TIME_Relative diff --git a/src/transport/gnunet-service-transport_manipulation.h b/src/transport/gnunet-service-transport_manipulation.h index 3b6beb8b7..668e91716 100644 --- a/src/transport/gnunet-service-transport_manipulation.h +++ b/src/transport/gnunet-service-transport_manipulation.h @@ -70,11 +70,9 @@ GST_manipulation_send (const struct GNUNET_PeerIdentity *target, * manipulation delays for next send. * * @param cls the closure for transport - * @param peer the peer the message was received from + * @param address the address and the peer the message was received from * @param message the message received * @param session the session the message was received on - * @param sender_address the sender address - * @param sender_address_len the length of the sender address * @return manipulated delay for next receive */ struct GNUNET_TIME_Relative diff --git a/src/transport/gnunet-service-transport_neighbours.c b/src/transport/gnunet-service-transport_neighbours.c index fbd524f3b..ad649ec0a 100644 --- a/src/transport/gnunet-service-transport_neighbours.c +++ b/src/transport/gnunet-service-transport_neighbours.c @@ -659,7 +659,6 @@ set_timeout (struct NeighbourMapEntry *n, * address must be setup) * @param bandwidth_in inbound quota to be used when connection is up * @param bandwidth_out outbound quota to be used when connection is up - * @param is_active #GNUNET_YES to mark this as the active address with ATS */ static void set_alternative_address (struct NeighbourMapEntry *n, diff --git a/src/transport/gnunet-service-transport_validation.c b/src/transport/gnunet-service-transport_validation.c index e18412588..8596c1f8d 100644 --- a/src/transport/gnunet-service-transport_validation.c +++ b/src/transport/gnunet-service-transport_validation.c @@ -863,6 +863,8 @@ process_peerinfo_hello (void *cls, const struct GNUNET_PeerIdentity *peer, /** * Start the validation subsystem. * + * @param cb callback to call with changes to valdidation entries + * @param cb_cls cls for the callback * @param max_fds maximum number of fds to use */ void diff --git a/src/transport/gnunet-service-transport_validation.h b/src/transport/gnunet-service-transport_validation.h index 179070454..71c095c1b 100644 --- a/src/transport/gnunet-service-transport_validation.h +++ b/src/transport/gnunet-service-transport_validation.h @@ -51,9 +51,12 @@ typedef void (*GST_ValidationChangedCallback) (void *cls, struct GNUNET_TIME_Absolute next_validation, enum GNUNET_TRANSPORT_ValidationState state); + /** * Start the validation subsystem. * + * @param cb callback to call with changes to valdidation entries + * @param cb_cls cls for the callback * @param max_fds maximum number of fds to use */ void diff --git a/src/transport/plugin_transport_tcp.c b/src/transport/plugin_transport_tcp.c index 011b112c0..657043c24 100644 --- a/src/transport/plugin_transport_tcp.c +++ b/src/transport/plugin_transport_tcp.c @@ -877,7 +877,7 @@ reschedule_session_timeout (struct Session *s) * Create a new session. Also queues a welcome message. * * @param plugin the plugin - * @param target peer to connect to + * @param address the address to create the session for * @param client client to use, reference counter must have already been increased * @param is_nat this a NAT session, we should wait for a client to * connect to us from an address, then assign that to diff --git a/src/transport/plugin_transport_udp.c b/src/transport/plugin_transport_udp.c index e7ab1a818..e44a32e44 100644 --- a/src/transport/plugin_transport_udp.c +++ b/src/transport/plugin_transport_udp.c @@ -1385,7 +1385,6 @@ udp_get_network (void *cls, struct Session *session) * * @param cls the plugin * @param address the address - * @param inbound look for inbound session * @return the session or NULL of max connections exceeded */ static struct Session * @@ -1758,7 +1757,7 @@ udp_plugin_send (void *cls, struct Session *s, const char *msgbuf, * @param cls closure, the 'struct LocalAddrList' * @param add_remove GNUNET_YES to mean the new public IP address, GNUNET_NO to mean * the previous (now invalid) one - * @param address either the previous or the new public IP address + * @param addr either the previous or the new public IP address * @param addrlen actual lenght of the address */ static void diff --git a/src/transport/plugin_transport_unix.c b/src/transport/plugin_transport_unix.c index 384787ae9..9fc4ba735 100644 --- a/src/transport/plugin_transport_unix.c +++ b/src/transport/plugin_transport_unix.c @@ -499,9 +499,7 @@ lookup_session_it (void *cls, * Find an existing session by address. * * @param plugin the plugin - * @param sender for which peer should the session be? - * @param ua address to look for - * @param ua_len length of the address + * @param address the address to find * @return NULL if session was not found */ static struct Session * @@ -1503,7 +1501,7 @@ address_notification (void *cls, /** * Increment session timeout due to activity * - * @param res session for which the timeout should be moved + * @param s session for which the timeout should be rescheduled */ static void reschedule_session_timeout (struct Session *s) diff --git a/src/transport/plugin_transport_wlan.c b/src/transport/plugin_transport_wlan.c index 77bb28ebc..e3dd24fdb 100644 --- a/src/transport/plugin_transport_wlan.c +++ b/src/transport/plugin_transport_wlan.c @@ -1060,7 +1060,7 @@ macendpoint_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) * Find (or create) a MacEndpoint with a specific MAC address * * @param plugin pointer to the plugin struct - * @param addr the MAC address of the endpoint + * @param mac the MAC address of the endpoint * @return handle to our data structure for this MAC */ static struct MacEndpoint * diff --git a/src/transport/transport_api_monitoring.c b/src/transport/transport_api_monitoring.c index 49520797d..810bca0cb 100644 --- a/src/transport/transport_api_monitoring.c +++ b/src/transport/transport_api_monitoring.c @@ -304,7 +304,7 @@ send_peer_mon_request (struct GNUNET_TRANSPORT_PeerMonitoringContext *pal_ctx) /** * Send our subscription request to the service. * - * @param pal_ctx our context + * @param val_ctx our context */ static void send_val_mon_request (struct GNUNET_TRANSPORT_ValidationMonitoringContext *val_ctx) @@ -382,7 +382,7 @@ do_val_connect (void *cls, /** * Cut the existing connection and reconnect. * - * @param pal_ctx our context + * @param val_ctx our context */ static void reconnect_val_ctx (struct GNUNET_TRANSPORT_ValidationMonitoringContext *val_ctx) -- cgit v1.2.3