From b57a34c4392be66883830b365b44afa8e1b21f6c Mon Sep 17 00:00:00 2001 From: Martin Schanzenbach Date: Thu, 22 Mar 2012 18:20:09 +0000 Subject: -doxygen --- src/gns/gns_api.c | 15 +++++---------- src/gns/gnunet-service-gns.c | 5 ++--- src/gns/gnunet-service-gns_interceptor.c | 3 +-- src/gns/gnunet-service-gns_interceptor.h | 4 ++++ src/gns/gnunet-service-gns_resolver.c | 18 +++++++++++++++--- src/gns/gnunet-service-gns_resolver.h | 2 +- 6 files changed, 28 insertions(+), 19 deletions(-) (limited to 'src') diff --git a/src/gns/gns_api.c b/src/gns/gns_api.c index 5733e1cf3..b0d2f3eac 100644 --- a/src/gns/gns_api.c +++ b/src/gns/gns_api.c @@ -342,9 +342,8 @@ transmit_pending (void *cls, size_t size, void *buf) * Process a given reply that might match the given * request. * - * @param cls the 'struct GNUNET_GNS_ClientResultMessage' - * @param key query of the request - * @param value the 'struct GNUNET_GNS_LookupHandle' of a request matching the same key + * @param qe a queue entry + * @param msg the shorten msg received */ static void process_shorten_reply (struct GNUNET_GNS_QueueEntry *qe, @@ -418,11 +417,8 @@ process_get_auth_reply (struct GNUNET_GNS_QueueEntry *qe, /** * Process a given reply to the lookup request * - * @param cls the 'struct GNUNET_GNS_ClientResultMessage' - * @param key query of the request - * @param value the 'struct GNUNET_GNS_LookupHandle' of a request matching the same key - * @return GNUNET_YES to continue to iterate over all results, - * GNUNET_NO if the reply is malformed + * @param qe a queue entry + * @param msg the lookup message received */ static void process_lookup_reply (struct GNUNET_GNS_QueueEntry *qe, @@ -587,7 +583,6 @@ process_message (void *cls, const struct GNUNET_MessageHeader *msg) * Initialize the connection with the GNS service. * * @param cfg configuration to use - * @param ht_len size of the internal hash table to use for parallel requests * @return handle to the GNS service, or NULL on error */ struct GNUNET_GNS_Handle * @@ -610,7 +605,7 @@ GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg) /** * Shutdown connection with the GNS service. * - * @param handle handle of the GNS connection to stop + * @param h handle of the GNS connection to stop */ void GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *h) diff --git a/src/gns/gnunet-service-gns.c b/src/gns/gnunet-service-gns.c index dff300bb7..31b3822fb 100644 --- a/src/gns/gnunet-service-gns.c +++ b/src/gns/gnunet-service-gns.c @@ -387,8 +387,8 @@ update_zone_dht_start(void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) /** * Send shorten response back to client * + * @param cls the closure containing a client shorten handle * @param name the shortened name result or NULL if cannot be shortened - * @param csh the handle to the shorten request */ static void send_shorten_response(void* cls, const char* name) @@ -500,8 +500,8 @@ static void handle_shorten(void *cls, /** * Send get authority response back to client * + * @param cls the closure containing a client get auth handle * @param name the shortened name result or NULL if cannot be shortened - * @param cah the handle to the get authority request */ static void send_get_auth_response(void *cls, const char* name) @@ -631,7 +631,6 @@ static void handle_get_authority(void *cls, * Reply to client with the result from our lookup. * * @param cls the closure (our client lookup handle) - * @param rh the request handle of the lookup * @param rd_count the number of records * @param rd the record data */ diff --git a/src/gns/gnunet-service-gns_interceptor.c b/src/gns/gnunet-service-gns_interceptor.c index cd3aeb581..f6d56d048 100644 --- a/src/gns/gnunet-service-gns_interceptor.c +++ b/src/gns/gnunet-service-gns_interceptor.c @@ -20,7 +20,7 @@ /** * - * @file gns/gns_interceptor.c + * @file gns/gnunet-service-gns_interceptor.c * @brief GNUnet GNS interceptor logic * @author Martin Schanzenbach */ @@ -70,7 +70,6 @@ static struct GNUNET_CRYPTO_RsaPrivateKey *our_key; * Reply to dns request with the result from our lookup. * * @param cls the closure to the request (an InterceptLookupHandle) - * @param rh the request handle of the lookup * @param rd_count the number of records to return * @param rd the record data */ diff --git a/src/gns/gnunet-service-gns_interceptor.h b/src/gns/gnunet-service-gns_interceptor.h index be7250b52..c3ea809f9 100644 --- a/src/gns/gnunet-service-gns_interceptor.h +++ b/src/gns/gnunet-service-gns_interceptor.h @@ -5,6 +5,7 @@ * Initialize dns interceptor * * @param zone the zone + * @param key the private key of the local zone * @param c the configuration * @return GNUNET_YES on success GNUNET_SYSERR on error */ @@ -13,6 +14,9 @@ gns_interceptor_init(struct GNUNET_CRYPTO_ShortHashCode zone, struct GNUNET_CRYPTO_RsaPrivateKey *key, const struct GNUNET_CONFIGURATION_Handle *c); +/** + * Stops the interceptor + */ void gns_interceptor_stop(void){}; diff --git a/src/gns/gnunet-service-gns_resolver.c b/src/gns/gnunet-service-gns_resolver.c index c4d06e410..2bdc1bc2b 100644 --- a/src/gns/gnunet-service-gns_resolver.c +++ b/src/gns/gnunet-service-gns_resolver.c @@ -350,6 +350,7 @@ process_zone_to_name_discover(void *cls, * * @param name the name given by delegation * @param zone the authority + * @param our_zone our local zone * @param the private key of our authority */ static void process_discovered_authority(char* name, @@ -384,6 +385,7 @@ static void process_discovered_authority(char* name, * * @param nh the namestore handle * @param dh the dht handle + * @param lz the local zone's hash * @return GNUNET_OK on success */ int @@ -408,6 +410,12 @@ gns_resolver_init(struct GNUNET_NAMESTORE_Handle *nh, /** * Cleanup background lookups + * + * @param cks closure to iterator + * @param node heap nodes + * @param element the resolver handle + * @param cost heap cost + * @return always GNUNET_YES */ static int cleanup_pending_background_queries(void* cls, @@ -445,7 +453,7 @@ gns_resolver_cleanup() /** * Helper function to free resolver handle * - * @rh the handle to free + * @param rh the handle to free */ static void free_resolver_handle(struct ResolverHandle* rh) @@ -871,8 +879,9 @@ process_record_result_ns(void* cls, return; } - GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Found %d answer(s) to query!\n", - rh->answered); + GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, + "Found %d answer(s) to query in %d records!\n", + rh->answered, rd_count); rh->proc(rh->proc_cls, rh, rd_count, rd); } @@ -1406,6 +1415,7 @@ pop_tld(char* name, char* dest) * Checks if name is in tld * * @param name the name to check + * @param tld the TLD to check for * @return GNUNET_YES or GNUNET_NO */ int @@ -1804,6 +1814,8 @@ resolve_delegation_ns(struct ResolverHandle *rh) * @param zone the root zone * @param record_type the record type to look up * @param name the name to look up + * @param key a private key for use with PSEU import (can be NULL) + * @param timeout timeout for resolution * @param proc the processor to call on result * @param cls the closure to pass to proc */ diff --git a/src/gns/gnunet-service-gns_resolver.h b/src/gns/gnunet-service-gns_resolver.h index 073c19192..a63abab9d 100644 --- a/src/gns/gnunet-service-gns_resolver.h +++ b/src/gns/gnunet-service-gns_resolver.h @@ -40,7 +40,6 @@ struct ResolverHandle; * processor for a resultion result * * @param cls the closure - * @param rh the resolution handle * @param rd_count number of results * @pram rd resukt data */ @@ -269,6 +268,7 @@ gns_resolver_cleanup(void); * @param record_type the record type to look up * @param name the name to look up * @param key optional private key for authority caching + * @param timeout timeout for the resolution * @param proc the processor to call * @param cls the closure to pass to proc */ -- cgit v1.2.3