From: Christian Grothoff <christian@grothoff.org>
Date: Mon, 13 Jun 2011 19:21:39 +0000 (+0000)
Subject: doxygen
X-Git-Tag: initial-import-from-subversion-38251~18240
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=18db9a2fc6584fe35b327650534cf0672f4686e7;p=oweals%2Fgnunet.git

doxygen
---

diff --git a/src/datastore/datastore_api.c b/src/datastore/datastore_api.c
index a3196530e..5126de050 100644
--- a/src/datastore/datastore_api.c
+++ b/src/datastore/datastore_api.c
@@ -1405,7 +1405,7 @@ GNUNET_DATASTORE_get_for_replication (struct GNUNET_DATASTORE_Handle *h,
  * Get a single zero-anonymity value from the datastore.
  *
  * @param h handle to the datastore
- * @param offset offset of the result (mod #num-results); set to
+ * @param offset offset of the result (modulo num-results); set to
  *               a random 64-bit value initially; then increment by
  *               one each time; detect that all results have been found by uid
  *               being again the first uid ever returned.
@@ -1476,7 +1476,7 @@ GNUNET_DATASTORE_get_zero_anonymity (struct GNUNET_DATASTORE_Handle *h,
  * will only be called once.
  *
  * @param h handle to the datastore
- * @param offset offset of the result (mod #num-results); set to
+ * @param offset offset of the result (modulo num-results); set to
  *               a random 64-bit value initially; then increment by
  *               one each time; detect that all results have been found by uid
  *               being again the first uid ever returned.
@@ -1508,7 +1508,7 @@ GNUNET_DATASTORE_get_key (struct GNUNET_DATASTORE_Handle *h,
   union QueueContext qc;
 
   GNUNET_assert (NULL != proc);
-#if DEBUG_DATASTORE
+##if DEBUG_DATASTORE
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 	      "Asked to look for data of type %u under key `%s'\n",
 	      (unsigned int) type,
diff --git a/src/datastore/gnunet-service-datastore.c b/src/datastore/gnunet-service-datastore.c
index f95f09921..9ae400292 100644
--- a/src/datastore/gnunet-service-datastore.c
+++ b/src/datastore/gnunet-service-datastore.c
@@ -290,7 +290,6 @@ delete_expired (void *cls,
  * expired items, re-schedule the "delete_expired" task.
  *
  * @param cls not used
- * @param next_cls closure to pass to the "next" function.
  * @param key key for the content
  * @param size number of bytes in data
  * @param data content stored
@@ -383,7 +382,6 @@ delete_expired (void *cls,
  * that deletes until we're happy with respect to our quota.
  *
  * @param cls closure
- * @param next_cls closure to pass to the "next" function.
  * @param key key for the content
  * @param size number of bytes in data
  * @param data content stored
@@ -517,8 +515,6 @@ transmit_callback (void *cls,
  *
  * @param client target of the message
  * @param msg message to transmit, will be freed!
- * @param tc function to call afterwards
- * @param tc_cls closure for tc
  */
 static void
 transmit (struct GNUNET_SERVER_Client *client,
@@ -598,7 +594,6 @@ transmit_status (struct GNUNET_SERVER_Client *client,
  * to the client.
  *
  * @param cls closure, pointer to the client (of type GNUNET_SERVER_Client).
- * @param next_cls closure to use to ask for the next item
  * @param key key for the content
  * @param size number of bytes in data
  * @param data content stored
diff --git a/src/datastore/plugin_datastore_mysql.c b/src/datastore/plugin_datastore_mysql.c
index db547cb30..fb271d8d3 100644
--- a/src/datastore/plugin_datastore_mysql.c
+++ b/src/datastore/plugin_datastore_mysql.c
@@ -1071,7 +1071,7 @@ execute_select (struct Plugin *plugin,
  * Get one of the results for a particular key in the datastore.
  *
  * @param cls closure
- * @param offset offset of the result (mod #num-results); 
+ * @param offset offset of the result (modulo num-results); 
  *               specific ordering does not matter for the offset
  * @param key key to match, never NULL
  * @param vhash hash of the value, maybe NULL (to
@@ -1081,12 +1081,8 @@ execute_select (struct Plugin *plugin,
  *        there may be!
  * @param type entries of which type are relevant?
  *     Use 0 for any type.
- * @param proc function to call on each matching value; however,
- *        after the first call to "proc", the plugin must wait
- *        until "NextRequest" was called before giving the processor
- *        the next item; finally, the "proc" should be called once
- *        once with a NULL value at the end ("next_cls" should be NULL
- *        for that last call)
+ * @param proc function to call on the matching value, 
+ *        with NULL for if no value matches
  * @param proc_cls closure for proc
  */
 static void
@@ -1234,9 +1230,8 @@ mysql_plugin_get_key (void *cls,
  * @param offset offset of the result
  * @param type entries of which type should be considered?
  *        Use 0 for any type.
- * @param iter function to call on each matching value;
- *        will be called once with a NULL value at the end
- * @param iter_cls closure for iter
+ * @param proc function to call on a matching value or NULL
+ * @param proc_cls closure for iter
  */
 static void
 mysql_plugin_get_zero_anonymity (void *cls,
@@ -1351,7 +1346,7 @@ repl_proc (void *cls,
  *
  * @param cls closure
  * @param proc function to call the value (once only).
- * @param iter_cls closure for proc
+ * @param proc_cls closure for proc
  */
 static void
 mysql_plugin_get_replication (void *cls,
diff --git a/src/datastore/plugin_datastore_postgres.c b/src/datastore/plugin_datastore_postgres.c
index 9d60100cf..115259dbf 100644
--- a/src/datastore/plugin_datastore_postgres.c
+++ b/src/datastore/plugin_datastore_postgres.c
@@ -529,6 +529,7 @@ postgres_plugin_put (void *cls,
  * @param proc function to call the value (once only).
  * @param proc_cls closure for proc
  * @param res result from exec
+ * @param line line number for error messages
  */
 static void 
 process_result (struct Plugin *plugin,
@@ -663,6 +664,8 @@ process_result (struct Plugin *plugin,
  * in the datastore.
  *
  * @param cls closure
+ * @param offset offset of the result (modulo num-results); 
+ *        specific ordering does not matter for the offset
  * @param key maybe NULL (to match all entries)
  * @param vhash hash of the value, maybe NULL (to
  *        match all values that have the right key).
@@ -671,9 +674,9 @@ process_result (struct Plugin *plugin,
  *        there may be!
  * @param type entries of which type are relevant?
  *     Use 0 for any type.
- * @param iter function to call on each matching value;
- *        will be called once with a NULL value at the end
- * @param iter_cls closure for iter
+ * @param proc function to call on the matching value;
+ *        will be called once with a NULL if no value matches
+ * @param proc_cls closure for iter
  */
 static void
 postgres_plugin_get_key (void *cls,
@@ -820,9 +823,9 @@ postgres_plugin_get_key (void *cls,
  * @param cls our "struct Plugin*"
  * @param type entries of which type should be considered?
  *        Use 0 for any type.
- * @param iter function to call on each matching value;
- *        will be called once with a NULL value at the end
- * @param iter_cls closure for iter
+ * @param proc function to call on the matching value;
+ *        will be called with a NULL if no value matches
+ * @param proc_cls closure for proc
  */
 static void
 postgres_plugin_get_zero_anonymity (void *cls,
@@ -951,7 +954,7 @@ repl_proc (void *cls,
  *
  * @param cls closure
  * @param proc function to call the value (once only).
- * @param proc_cls closure for iter
+ * @param proc_cls closure for proc
  */
 static void
 postgres_plugin_get_replication (void *cls,
@@ -976,11 +979,11 @@ postgres_plugin_get_replication (void *cls,
 
 /**
  * Get a random item for expiration.
- * Call 'iter' with all values ZERO or NULL if the datastore is empty.
+ * Call 'proc' with all values ZERO or NULL if the datastore is empty.
  *
  * @param cls closure
  * @param proc function to call the value (once only).
- * @param proc_cls closure for iter
+ * @param proc_cls closure for proc
  */
 static void
 postgres_plugin_get_expiration (void *cls,
diff --git a/src/datastore/plugin_datastore_sqlite.c b/src/datastore/plugin_datastore_sqlite.c
index 613b6a1a7..6a2a86b61 100644
--- a/src/datastore/plugin_datastore_sqlite.c
+++ b/src/datastore/plugin_datastore_sqlite.c
@@ -718,6 +718,8 @@ execute_get (struct Plugin *plugin,
  * the given processor for the item.
  *
  * @param cls our plugin context
+ * @param offset offset of the result (modulo num-results); 
+ *               specific ordering does not matter for the offset
  * @param type entries of which type should be considered?
  *        Use 0 for any type.
  * @param proc function to call on each matching value;
diff --git a/src/datastore/plugin_datastore_template.c b/src/datastore/plugin_datastore_template.c
index 6228e8c0c..8975c0a70 100644
--- a/src/datastore/plugin_datastore_template.c
+++ b/src/datastore/plugin_datastore_template.c
@@ -92,7 +92,7 @@ template_plugin_put (void *cls,
  * Get one of the results for a particular key in the datastore.
  *
  * @param cls closure
- * @param offset offset of the result (mod #num-results); 
+ * @param offset offset of the result (modulo num-results); 
  *               specific ordering does not matter for the offset
  * @param key maybe NULL (to match all entries)
  * @param vhash hash of the value, maybe NULL (to
@@ -194,7 +194,7 @@ template_plugin_update (void *cls,
  * Call the given processor on an item with zero anonymity.
  *
  * @param cls our "struct Plugin*"
- * @param offset offset of the result (mod #num-results); 
+ * @param offset offset of the result (modulo num-results); 
  *               specific ordering does not matter for the offset
  * @param type entries of which type should be considered?
  *        Use 0 for any type.