use -Wl on -no-undefined as it is a linker option:

[oweals/gnunet.git] / src / include / gnunet_block_plugin.h

diff --git a/src/include/gnunet_block_plugin.h b/src/include/gnunet_block_plugin.h
index 3d3fb4001b46683c9158f907cb536c44ff1c15b3..91f278d38608388338a219796eaedb4dc814582e 100644 (file)
--- a/src/include/gnunet_block_plugin.h
+++ b/src/include/gnunet_block_plugin.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet
-     (C) 2010 Christian Grothoff (and other contributing authors)
+     (C) 2010,2013 Christian Grothoff (and other contributing authors)
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -20,22 +20,23 @@
 
 /**
  * @file include/gnunet_block_plugin.h
- * @brief API for block plugins.  Each block plugin must conform to 
+ * @brief API for block plugins.  Each block plugin must conform to
  *        the API specified by this header.
  * @author Christian Grothoff
+ * @defgroup block API to be implemented by applications storing data in the DHT
+ * @{
  */
 #ifndef PLUGIN_BLOCK_H
 #define PLUGIN_BLOCK_H
 
 #include "gnunet_util_lib.h"
-#include "gnunet_container_lib.h"
 #include "gnunet_block_lib.h"
 
 
 /**
  * Function called to validate a reply or a request.  For
- * request evaluation, simply pass "NULL" for the reply_block.
- * Note that it is assumed that the reply has already been 
+ * request evaluation, simply pass "NULL" for the @a reply_block.
+ * Note that it is assumed that the reply has already been
  * matched to the key (and signatures checked) as it would
  * be done with the "get_key" function.
  *
@@ -43,23 +44,23 @@
  * @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 extrended 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
  */
 typedef enum GNUNET_BLOCK_EvaluationResult
-  (*GNUNET_BLOCK_EvaluationFunction) (void *cls,
-                                     enum GNUNET_BLOCK_Type type,
-                                     const GNUNET_HashCode *query,
-                                     struct GNUNET_CONTAINER_BloomFilter **bf,
-                                     int32_t bf_mutator,
-                                     const void *xquery,
-                                     size_t xquery_size,
-                                     const void *reply_block,
-                                     size_t reply_block_size);
+(*GNUNET_BLOCK_EvaluationFunction) (void *cls,
+                                   enum GNUNET_BLOCK_Type type,
+                                   const struct GNUNET_HashCode *query,
+                                   struct GNUNET_CONTAINER_BloomFilter **bf,
+                                   int32_t bf_mutator,
+                                   const void *xquery,
+                                   size_t xquery_size,
+                                   const void *reply_block,
+                                   size_t reply_block_size);
 
 
 /**
@@ -68,20 +69,19 @@ typedef enum GNUNET_BLOCK_EvaluationResult
  * @param cls closure
  * @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_YES on success, 
- *         GNUNET_NO if the block is malformed
- *         GNUNET_SYSERR if type not supported
+ * @return #GNUNET_YES on success,
+ *         #GNUNET_NO if the block is malformed
+ *         #GNUNET_SYSERR if type not supported
  *         (or if extracting a key from a block of this type does not work)
  */
-typedef int
-  (*GNUNET_BLOCK_GetKeyFunction) (void *cls,
-                                 enum GNUNET_BLOCK_Type type,
-                                 const void *block,
-                                 size_t block_size,
-                                 GNUNET_HashCode *key);
-                                 
+typedef int (*GNUNET_BLOCK_GetKeyFunction) (void *cls,
+                                            enum GNUNET_BLOCK_Type type,
+                                            const void *block,
+                                            size_t block_size,
+                                            struct GNUNET_HashCode * key);
+
 
 
 /**
@@ -102,7 +102,7 @@ struct GNUNET_BLOCK_PluginFunctions
   const enum GNUNET_BLOCK_Type *types;
 
   /**
-   * Main function of a block plugin.  Allows us to check if a 
+   * Main function of a block plugin.  Allows us to check if a
    * block matches a query.
    */
   GNUNET_BLOCK_EvaluationFunction evaluate;
@@ -114,5 +114,6 @@ struct GNUNET_BLOCK_PluginFunctions
 
 };
 
+/** @} */ /* end of group block */
 
 #endif