[GNUnet-SVN] r29018 - gnunet/src/include

[gnunet]

Author: grothoff
Date: 2013-09-05 13:37:29 +0200 (Thu, 05 Sep 2013)
New Revision: 29018

Modified:
   gnunet/src/include/gnunet_datastore_plugin.h
   gnunet/src/include/gnunet_namestore_plugin.h
Log:
-doxygen

Modified: gnunet/src/include/gnunet_datastore_plugin.h
===================================================================
--- gnunet/src/include/gnunet_datastore_plugin.h        2013-09-05 11:23:06 UTC 
(rev 29017)
+++ gnunet/src/include/gnunet_datastore_plugin.h        2013-09-05 11:37:29 UTC 
(rev 29018)
@@ -88,9 +88,8 @@
  * @param anonymity anonymity-level for the content
  * @param expiration expiration time for the content
  * @param uid unique identifier for the datum
- *
- * @return GNUNET_OK to keep the item
- *         GNUNET_NO to delete the item
+ * @return #GNUNET_OK to keep the item
+ *         #GNUNET_NO to delete the item
  */
 typedef int (*PluginDatumProcessor) (void *cls, const struct GNUNET_HashCode * 
key,
                                      uint32_t size, const void *data,
@@ -116,7 +115,7 @@
  *
  * @param cls closure
  * @param key key for the item
- * @param size number of bytes in data
+ * @param size number of bytes in @a data
  * @param data content stored
  * @param type type of the content
  * @param priority priority of the content
@@ -124,8 +123,8 @@
  * @param replication replication-level for the content
  * @param expiration expiration time for the content
  * @param msg set to an error message (on failure)
- * @return GNUNET_OK on success,
- *         GNUNET_SYSERR on failure
+ * @return #GNUNET_OK on success,
+ *         #GNUNET_SYSERR on failure
  */
 typedef int (*PluginPut) (void *cls, const struct GNUNET_HashCode * key, 
uint32_t size,
                           const void *data, enum GNUNET_BLOCK_Type type,
@@ -142,8 +141,8 @@
  * @param count how many values are stored under this key in the datastore
  */
 typedef void (*PluginKeyProcessor) (void *cls, 
-                                  const struct GNUNET_HashCode *key,
-                                  unsigned int count);
+                                   const struct GNUNET_HashCode *key,
+                                   unsigned int count);
 
 
 /**
@@ -151,7 +150,7 @@
  *
  * @param cls closure
  * @param proc function to call on each key
- * @param proc_cls closure for proc
+ * @param proc_cls closure for @a proc
  */
 typedef void (*PluginGetKeys) (void *cls,
                               PluginKeyProcessor proc, void *proc_cls);
@@ -175,7 +174,7 @@
  *            NULL for no minimum (return smallest key)
  * @param proc function to call on the matching value;
  *        proc should be called with NULL if there is no result
- * @param proc_cls closure for proc
+ * @param proc_cls closure for @a proc
  */
 typedef void (*PluginGetKey) (void *cls, uint64_t offset,
                               const struct GNUNET_HashCode * key,
@@ -186,13 +185,13 @@
 
 /**
  * Get a random item (additional constraints may apply depending on
- * the specific implementation).  Calls 'proc' with all values ZERO or
- * NULL if no item applies, otherwise 'proc' is called once and only
+ * the specific implementation).  Calls @a proc with all values ZERO or
+ * NULL if no item applies, otherwise @a proc is called once and only
  * once with an item.
  *
  * @param cls closure
  * @param proc function to call the value (once only).
- * @param proc_cls closure for proc
+ * @param proc_cls closure for @a proc
  */
 typedef void (*PluginGetRandom) (void *cls, PluginDatumProcessor proc,
                                  void *proc_cls);
@@ -218,7 +217,7 @@
  *     MAX of any existing expiration time and
  *     this value
  * @param msg set to an error message (on error)
- * @return GNUNET_OK on success
+ * @return #GNUNET_OK on success
  */
 typedef int (*PluginUpdate) (void *cls, uint64_t uid, int delta,
                              struct GNUNET_TIME_Absolute expire, char **msg);
@@ -234,7 +233,7 @@
  * @param type entries of which type should be considered?
  *        Must not be zero (ANY).
  * @param proc function to call on the matching value
- * @param proc_cls closure for proc
+ * @param proc_cls closure for @a proc
  */
 typedef void (*PluginGetType) (void *cls, uint64_t offset,
                                enum GNUNET_BLOCK_Type type,

Modified: gnunet/src/include/gnunet_namestore_plugin.h
===================================================================
--- gnunet/src/include/gnunet_namestore_plugin.h        2013-09-05 11:23:06 UTC 
(rev 29017)
+++ gnunet/src/include/gnunet_namestore_plugin.h        2013-09-05 11:37:29 UTC 
(rev 29018)
@@ -55,7 +55,7 @@
  * @param cls closure
  * @param zone_key private key of the zone
  * @param label name that is being mapped (at most 255 characters long)
- * @param rd_count number of entries in 'rd' array
+ * @param rd_count number of entries in @a rd array
  * @param rd array of records with data to store
  */
 typedef void (*GNUNET_NAMESTORE_RecordIterator) (void *cls,