From c83780d7be3f1a744f72437220b351ce2ce0d68e Mon Sep 17 00:00:00 2001 From: Martin Schanzenbach Date: Fri, 23 Mar 2012 15:59:56 +0000 Subject: [PATCH] -doxygen --- src/gns/gns_api.c | 21 +++++++++++---------- src/gns/gnunet-service-gns_interceptor.c | 2 +- src/gns/gnunet-service-gns_resolver.c | 19 ++++++++++--------- src/gns/gnunet-service-gns_resolver.h | 12 ++++++------ 4 files changed, 28 insertions(+), 26 deletions(-) diff --git a/src/gns/gns_api.c b/src/gns/gns_api.c index b0d2f3eac..09e5426f9 100644 --- a/src/gns/gns_api.c +++ b/src/gns/gns_api.c @@ -605,18 +605,18 @@ GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg) /** * Shutdown connection with the GNS service. * - * @param h handle of the GNS connection to stop + * @param handle handle of the GNS connection to stop */ void -GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *h) +GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle) { - GNUNET_CLIENT_disconnect (h->client, GNUNET_NO); - if (GNUNET_SCHEDULER_NO_TASK != h->reconnect_task) + GNUNET_CLIENT_disconnect (handle->client, GNUNET_NO); + if (GNUNET_SCHEDULER_NO_TASK != handle->reconnect_task) { - GNUNET_SCHEDULER_cancel (h->reconnect_task); - h->reconnect_task = GNUNET_SCHEDULER_NO_TASK; + GNUNET_SCHEDULER_cancel (handle->reconnect_task); + handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK; } - GNUNET_free(h); + GNUNET_free(handle); /* disco from GNS */ } @@ -639,9 +639,10 @@ get_request_id (struct GNUNET_GNS_Handle *h) * * @param handle handle to the GNS service * @param name the name to look up - * @param iter function to call on each result - * @param iter_cls closure for iter - * @return handle to stop the async get + * @param type the record type to look up + * @param proc processor to call on result + * @param proc_cls closure for processor + * @return handle to the get */ struct GNUNET_GNS_QueueEntry * GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle, diff --git a/src/gns/gnunet-service-gns_interceptor.c b/src/gns/gnunet-service-gns_interceptor.c index f6d56d048..5ddffdd4b 100644 --- a/src/gns/gnunet-service-gns_interceptor.c +++ b/src/gns/gnunet-service-gns_interceptor.c @@ -331,7 +331,7 @@ handle_dns_request(void *cls, * Initialized the interceptor * * @param zone the zone to work in - * @param the prov key of the zone (can be null, needed for caching) + * @param key the prov key of the zone (can be null, needed for caching) * @param c the configuration * @return GNUNET_OK on success */ diff --git a/src/gns/gnunet-service-gns_resolver.c b/src/gns/gnunet-service-gns_resolver.c index aef9df4d7..b905c73ae 100644 --- a/src/gns/gnunet-service-gns_resolver.c +++ b/src/gns/gnunet-service-gns_resolver.c @@ -358,7 +358,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 + * @param key the private key of our authority */ static void process_discovered_authority(char* name, struct GNUNET_CRYPTO_ShortHashCode zone, @@ -394,6 +394,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 + * @param max_bg_queries maximum number of parallel background queries in dht * @return GNUNET_OK on success */ int @@ -2196,13 +2197,13 @@ handle_delegation_ns_shorten(void* cls, * @param zone the zone to use * @param name the name to shorten * @param proc the processor to call with result - * @param cls closure to pass to proc + * @param proc_cls closure to pass to proc */ void gns_resolver_shorten_name(struct GNUNET_CRYPTO_ShortHashCode zone, const char* name, ShortenResultProcessor proc, - void* cls) + void* proc_cls) { struct ResolverHandle *rh; struct NameShortenHandle *nsh; @@ -2215,7 +2216,7 @@ gns_resolver_shorten_name(struct GNUNET_CRYPTO_ShortHashCode zone, { GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "%s is canonical. Returning verbatim\n", name); - proc(cls, name); + proc(proc_cls, name); return; } @@ -2223,7 +2224,7 @@ gns_resolver_shorten_name(struct GNUNET_CRYPTO_ShortHashCode zone, nsh->proc = proc; - nsh->proc_cls = cls; + nsh->proc_cls = proc_cls; rh = GNUNET_malloc(sizeof (struct ResolverHandle)); rh->authority = zone; @@ -2254,7 +2255,7 @@ gns_resolver_shorten_name(struct GNUNET_CRYPTO_ShortHashCode zone, "Cannot convert ZKEY %s to hash!\n", string_hash); GNUNET_free(rh); GNUNET_free(nsh); - proc(cls, name); + proc(proc_cls, name); return; } @@ -2365,13 +2366,13 @@ handle_delegation_result_ns_get_auth(void* cls, * @param zone the root zone to look up for * @param name the name to lookup up * @param proc the processor to call when finished - * @param cls the closure to pass to the processor + * @param proc_cls the closure to pass to the processor */ void gns_resolver_get_authority(struct GNUNET_CRYPTO_ShortHashCode zone, const char* name, GetAuthorityResultProcessor proc, - void* cls) + void* proc_cls) { struct ResolverHandle *rh; struct GetNameAuthorityHandle *nah; @@ -2406,7 +2407,7 @@ gns_resolver_get_authority(struct GNUNET_CRYPTO_ShortHashCode zone, rh->proc_cls = (void*)nah; nah->proc = proc; - nah->proc_cls = cls; + nah->proc_cls = proc_cls; /* Start delegation resolution in our namestore */ resolve_delegation_ns(rh); diff --git a/src/gns/gnunet-service-gns_resolver.h b/src/gns/gnunet-service-gns_resolver.h index 7290e927c..fd5d2a5d3 100644 --- a/src/gns/gnunet-service-gns_resolver.h +++ b/src/gns/gnunet-service-gns_resolver.h @@ -248,14 +248,14 @@ struct GetPseuAuthorityHandle * * @param nh handle to the namestore * @param dh handle to the dht - * @param local_zone the local zone + * @param lz the local zone * @param max_bg_queries maximum amount of background queries * @returns GNUNET_OK on success */ int gns_resolver_init(struct GNUNET_NAMESTORE_Handle *nh, struct GNUNET_DHT_Handle *dh, - struct GNUNET_CRYPTO_ShortHashCode local_zone, + struct GNUNET_CRYPTO_ShortHashCode lz, unsigned long long max_bg_queries); /** @@ -297,13 +297,13 @@ gns_resolver_lookup_record(struct GNUNET_CRYPTO_ShortHashCode zone, * @param zone the zone to perform the operation in * @param name name to shorten * @param proc the processor to call on shorten result - * @param proc_cls teh closure to pass to proc + * @param proc_cls the closure to pass to proc */ void gns_resolver_shorten_name(struct GNUNET_CRYPTO_ShortHashCode zone, const char* name, ShortenResultProcessor proc, - void* cls); + void* proc_cls); /** * Tries to resolve the authority for name @@ -312,13 +312,13 @@ gns_resolver_shorten_name(struct GNUNET_CRYPTO_ShortHashCode zone, * @param zone the root zone to look up for * @param name the name to lookup up * @param proc the processor to call when finished - * @param cls the closure to pass to the processor + * @param proc_cls the closure to pass to the processor */ void gns_resolver_get_authority(struct GNUNET_CRYPTO_ShortHashCode zone, const char* name, GetAuthorityResultProcessor proc, - void* cls); + void* proc_cls); /** * Generic function to check for TLDs -- 2.25.1