gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[GNUnet-SVN] r29474 - in gnunet/src: block include


From: gnunet
Subject: [GNUnet-SVN] r29474 - in gnunet/src: block include
Date: Mon, 23 Sep 2013 10:38:44 +0200

Author: grothoff
Date: 2013-09-23 10:38:43 +0200 (Mon, 23 Sep 2013)
New Revision: 29474

Modified:
   gnunet/src/block/block.c
   gnunet/src/block/plugin_block_test.c
   gnunet/src/include/gnunet_plugin_lib.h
Log:
-doxygen

Modified: gnunet/src/block/block.c
===================================================================
--- gnunet/src/block/block.c    2013-09-23 08:29:18 UTC (rev 29473)
+++ gnunet/src/block/block.c    2013-09-23 08:38:43 UTC (rev 29474)
@@ -78,8 +78,9 @@
  * @param hc where to store the result.
  */
 void
-GNUNET_BLOCK_mingle_hash (const struct GNUNET_HashCode * in, uint32_t 
mingle_number,
-                          struct GNUNET_HashCode * hc)
+GNUNET_BLOCK_mingle_hash (const struct GNUNET_HashCode *in,
+                         uint32_t mingle_number,
+                          struct GNUNET_HashCode *hc)
 {
   struct GNUNET_HashCode m;
 
@@ -96,15 +97,18 @@
  * @param lib_ret the plugin API
  */
 static void
-add_plugin (void *cls, const char *library_name, void *lib_ret)
+add_plugin (void *cls, 
+           const char *library_name, 
+           void *lib_ret)
 {
   struct GNUNET_BLOCK_Context *ctx = cls;
   struct GNUNET_BLOCK_PluginFunctions *api = lib_ret;
   struct Plugin *plugin;
 
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, _("Loading block plugin `%s'\n"),
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, 
+             "Loading block plugin `%s'\n",
               library_name);
-  plugin = GNUNET_malloc (sizeof (struct Plugin));
+  plugin = GNUNET_new (struct Plugin);
   plugin->api = api;
   plugin->library_name = GNUNET_strdup (library_name);
   GNUNET_array_append (ctx->plugins, ctx->num_plugins, plugin);
@@ -123,7 +127,7 @@
 {
   struct GNUNET_BLOCK_Context *ctx;
 
-  ctx = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_Context));
+  ctx = GNUNET_new (struct GNUNET_BLOCK_Context);
   ctx->cfg = cfg;
   GNUNET_PLUGIN_load_all ("libgnunet_plugin_block_", NULL, &add_plugin, ctx);
   return ctx;
@@ -162,7 +166,8 @@
  * @return NULL if no matching plugin exists
  */
 static struct GNUNET_BLOCK_PluginFunctions *
-find_plugin (struct GNUNET_BLOCK_Context *ctx, enum GNUNET_BLOCK_Type type)
+find_plugin (struct GNUNET_BLOCK_Context *ctx,
+            enum GNUNET_BLOCK_Type type)
 {
   struct Plugin *plugin;
   unsigned int i;
@@ -194,11 +199,11 @@
  * @param type block type
  * @param query original query (hash)
  * @param bf pointer to bloom filter associated with query; possibly updated 
(!)
- * @param bf_mutator mutation value for bf
+ * @param bf_mutator mutation value for @a bf
  * @param xquery extended query data (can be NULL, depending on type)
- * @param xquery_size number of bytes in xquery
+ * @param xquery_size number of bytes in @a xquery
  * @param reply_block response to validate
- * @param reply_block_size number of bytes in reply block
+ * @param reply_block_size number of bytes in @a reply_block
  * @return characterization of result
  */
 enum GNUNET_BLOCK_EvaluationResult
@@ -225,9 +230,9 @@
  * @param ctx block context
  * @param type block type
  * @param block block to get the key for
- * @param block_size number of bytes in block
+ * @param block_size number of bytes in @a block
  * @param key set to the key (query) for the given block
- * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
  *         (or if extracting a key from a block of this type does not work)
  */
 int
@@ -253,6 +258,7 @@
  * we should generally pick a slightly larger size than what the
  * strict math would suggest.
  *
+ * @param entry_count expected number of entries in the Bloom filter
  * @return must be a power of two and smaller or equal to 2^15.
  */
 static size_t
@@ -279,7 +285,7 @@
  *
  * @param bf_mutator mutation value to use
  * @param seen_results results already seen
- * @param seen_results_count number of entries in 'seen_results'
+ * @param seen_results_count number of entries in @a seen_results
  * @return NULL if seen_results_count is 0, otherwise a BF
  *         that would match the given results.
  */

Modified: gnunet/src/block/plugin_block_test.c
===================================================================
--- gnunet/src/block/plugin_block_test.c        2013-09-23 08:29:18 UTC (rev 
29473)
+++ gnunet/src/block/plugin_block_test.c        2013-09-23 08:38:43 UTC (rev 
29474)
@@ -98,7 +98,7 @@
  * @param block block to get the key for
  * @param block_size number of bytes in @a block
  * @param key set to the key (query) for the given block
- * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
  *         (or if extracting a key from a block of this type does not work)
  */
 static int
@@ -114,6 +114,9 @@
 
 /**
  * Entry point for the plugin.
+ *
+ * @param cls NULL
+ * @return the exported block API 
  */
 void *
 libgnunet_plugin_block_test_init (void *cls)
@@ -125,7 +128,7 @@
   };
   struct GNUNET_BLOCK_PluginFunctions *api;
 
-  api = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_PluginFunctions));
+  api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
   api->evaluate = &block_plugin_test_evaluate;
   api->get_key = &block_plugin_test_get_key;
   api->types = types;
@@ -135,6 +138,9 @@
 
 /**
  * Exit point from the plugin.
+ *
+ * @param cls the return value from #libgnunet_plugin_block_test_init
+ * @return NULL
  */
 void *
 libgnunet_plugin_block_test_done (void *cls)

Modified: gnunet/src/include/gnunet_plugin_lib.h
===================================================================
--- gnunet/src/include/gnunet_plugin_lib.h      2013-09-23 08:29:18 UTC (rev 
29473)
+++ gnunet/src/include/gnunet_plugin_lib.h      2013-09-23 08:38:43 UTC (rev 
29474)
@@ -84,9 +84,9 @@
  *
  * @param cls closure
  * @param library_name full name of the library (to be used with
- *        'GNUNET_PLUGIN_unload')
+ *        #GNUNET_PLUGIN_unload)
  * @param lib_ret return value from the initialization function
- *        of the library (same as what 'GNUNET_PLUGIN_load' would
+ *        of the library (same as what #GNUNET_PLUGIN_load would
  *        have returned for the given library name)
  */
 typedef void (*GNUNET_PLUGIN_LoaderCallback) (void *cls,
@@ -104,7 +104,7 @@
  * @param basename basename of the plugins to load
  * @param arg argument to the plugin initialization function
  * @param cb function to call for each plugin found
- * @param cb_cls closure for 'cb'
+ * @param cb_cls closure for @a cb
  */
 void
 GNUNET_PLUGIN_load_all (const char *basename, void *arg,




reply via email to

[Prev in Thread] Current Thread [Next in Thread]