[GNUnet-SVN] r20687 - gnunet/src/gns

[gnunet]

Author: schanzen
Date: 2012-03-22 19:20:09 +0100 (Thu, 22 Mar 2012)
New Revision: 20687

Modified:
   gnunet/src/gns/gns_api.c
   gnunet/src/gns/gnunet-service-gns.c
   gnunet/src/gns/gnunet-service-gns_interceptor.c
   gnunet/src/gns/gnunet-service-gns_interceptor.h
   gnunet/src/gns/gnunet-service-gns_resolver.c
   gnunet/src/gns/gnunet-service-gns_resolver.h
Log:
-doxygen


Modified: gnunet/src/gns/gns_api.c
===================================================================
--- gnunet/src/gns/gns_api.c    2012-03-22 18:12:39 UTC (rev 20686)
+++ gnunet/src/gns/gns_api.c    2012-03-22 18:20:09 UTC (rev 20687)
@@ -342,9 +342,8 @@
  * 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 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 @@
  * 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 @@
 /**
  * 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)

Modified: gnunet/src/gns/gnunet-service-gns.c
===================================================================
--- gnunet/src/gns/gnunet-service-gns.c 2012-03-22 18:12:39 UTC (rev 20686)
+++ gnunet/src/gns/gnunet-service-gns.c 2012-03-22 18:20:09 UTC (rev 20687)
@@ -387,8 +387,8 @@
 /**
  * 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 @@
 /**
  * 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 @@
  * 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
  */

Modified: gnunet/src/gns/gnunet-service-gns_interceptor.c
===================================================================
--- gnunet/src/gns/gnunet-service-gns_interceptor.c     2012-03-22 18:12:39 UTC 
(rev 20686)
+++ gnunet/src/gns/gnunet-service-gns_interceptor.c     2012-03-22 18:20:09 UTC 
(rev 20687)
@@ -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 @@
  * 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
  */

Modified: gnunet/src/gns/gnunet-service-gns_interceptor.h
===================================================================
--- gnunet/src/gns/gnunet-service-gns_interceptor.h     2012-03-22 18:12:39 UTC 
(rev 20686)
+++ gnunet/src/gns/gnunet-service-gns_interceptor.h     2012-03-22 18:20:09 UTC 
(rev 20687)
@@ -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 @@
                      struct GNUNET_CRYPTO_RsaPrivateKey *key,
                      const struct GNUNET_CONFIGURATION_Handle *c);
 
+/**
+ * Stops the interceptor
+ */
 void
 gns_interceptor_stop(void){};
 

Modified: gnunet/src/gns/gnunet-service-gns_resolver.c
===================================================================
--- gnunet/src/gns/gnunet-service-gns_resolver.c        2012-03-22 18:12:39 UTC 
(rev 20686)
+++ gnunet/src/gns/gnunet-service-gns_resolver.c        2012-03-22 18:20:09 UTC 
(rev 20687)
@@ -350,6 +350,7 @@
  *
  * @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 @@
  *
  * @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 @@
 
 /**
  * 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 @@
 /**
  * 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 @@
       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 @@
  * 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 @@
  * @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
  */

Modified: gnunet/src/gns/gnunet-service-gns_resolver.h
===================================================================
--- gnunet/src/gns/gnunet-service-gns_resolver.h        2012-03-22 18:12:39 UTC 
(rev 20686)
+++ gnunet/src/gns/gnunet-service-gns_resolver.h        2012-03-22 18:20:09 UTC 
(rev 20687)
@@ -40,7 +40,6 @@
  * 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 @@
  * @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
  */