-document new API

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

diff --git a/src/include/gnunet_datastore_plugin.h b/src/include/gnunet_datastore_plugin.h
index 08093d55e78082d7f908104e441a101baef3bcd6..71c69ffaf4910881692fde2c8f6404f4a5e73850 100644 (file)
--- a/src/include/gnunet_datastore_plugin.h
+++ b/src/include/gnunet_datastore_plugin.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet
-     Copyright (C) 2009, 2011 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2009, 2011 GNUnet e.V.
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -19,9 +19,14 @@
 */
 
 /**
- * @file include/gnunet_datastore_plugin.h
- * @brief API for the database backend plugins.
  * @author Christian Grothoff
+ *
+ * @file
+ * API for the database backend plugins.
+ *
+ * @defgroup datastore-plugin  Data Store service plugin API
+ * API for the database backend plugins.
+ * @{
  */
 #ifndef PLUGIN_DATASTORE_H
 #define PLUGIN_DATASTORE_H
@@ -48,8 +53,8 @@
  * @param delta change in disk utilization,
  *        0 for "reset to empty"
  */
-typedef void 
-(*GNUNET_DATASTORE_DiskUtilizationChange) (void *cls, 
+typedef void
+(*GNUNET_DATASTORE_DiskUtilizationChange) (void *cls,
                                           int delta);
 
 
@@ -93,13 +98,13 @@ struct GNUNET_DATASTORE_PluginEnvironment
  * @return #GNUNET_OK to keep the item
  *         #GNUNET_NO to delete the item
  */
-typedef int 
-(*PluginDatumProcessor) (void *cls, 
+typedef int
+(*PluginDatumProcessor) (void *cls,
                         const struct GNUNET_HashCode *key,
-                        uint32_t size, 
+                        uint32_t size,
                         const void *data,
                         enum GNUNET_BLOCK_Type type,
-                        uint32_t priority, 
+                        uint32_t priority,
                         uint32_t anonymity,
                         struct GNUNET_TIME_Absolute expiration,
                         uint64_t uid);
@@ -130,11 +135,11 @@ typedef void
  * @param status #GNUNET_OK or #GNUNET_SYSERROR
  * @param msg error message on error
  */
-typedef void 
-(*PluginPutCont) (void *cls, 
+typedef void
+(*PluginPutCont) (void *cls,
                  const struct GNUNET_HashCode *key,
                  uint32_t size,
-                 int status, 
+                 int status,
                  const char *msg);
 
 
@@ -155,16 +160,17 @@ typedef void
  * @param cont continuation called with success or failure status
  * @param cont_cls continuation closure for @a cont
  */
-typedef void 
-(*PluginPut) (void *cls, const struct GNUNET_HashCode *key,
+typedef void
+(*PluginPut) (void *cls,
+              const struct GNUNET_HashCode *key,
              uint32_t size,
              const void *data,
              enum GNUNET_BLOCK_Type type,
-             uint32_t priority, 
+             uint32_t priority,
              uint32_t anonymity,
              uint32_t replication,
              struct GNUNET_TIME_Absolute expiration,
-             PluginPutCont cont, 
+             PluginPutCont cont,
              void *cont_cls);
 
 
@@ -175,7 +181,7 @@ typedef void
  * @param key key in the data store, if NULL iteration is finished
  * @param count how many values are stored under this key in the datastore
  */
-typedef void 
+typedef void
 (*PluginKeyProcessor) (void *cls,
                       const struct GNUNET_HashCode *key,
                       unsigned int count);
@@ -190,7 +196,8 @@ typedef void
  */
 typedef void
 (*PluginGetKeys) (void *cls,
-                 PluginKeyProcessor proc, void *proc_cls);
+                 PluginKeyProcessor proc,
+                  void *proc_cls);
 
 
 /**
@@ -211,8 +218,8 @@ typedef void
  *        proc should be called with NULL if there is no result
  * @param proc_cls closure for @a proc
  */
-typedef void 
-(*PluginGetKey) (void *cls, 
+typedef void
+(*PluginGetKey) (void *cls,
                 uint64_t offset,
                 const struct GNUNET_HashCode *key,
                 const struct GNUNET_HashCode *vhash,
@@ -231,8 +238,8 @@ typedef void
  * @param proc function to call the value (once only).
  * @param proc_cls closure for @a proc
  */
-typedef void 
-(*PluginGetRandom) (void *cls, 
+typedef void
+(*PluginGetRandom) (void *cls,
                    PluginDatumProcessor proc,
                    void *proc_cls);
 
@@ -241,11 +248,11 @@ typedef void
  * Update continuation.
  *
  * @param cls closure
- * @param status #GNUNET_OK or #GNUNET_SYSERROR
+ * @param status #GNUNET_OK or #GNUNET_SYSERR
  * @param msg error message on error
  */
-typedef void 
-(*PluginUpdateCont) (void *cls, 
+typedef void
+(*PluginUpdateCont) (void *cls,
                     int status,
                     const char *msg);
 
@@ -270,12 +277,12 @@ typedef void
  * @param cont continuation called with success or failure status
  * @param cons_cls continuation closure
  */
-typedef void 
+typedef void
 (*PluginUpdate) (void *cls,
                 uint64_t uid,
                 int delta,
                 struct GNUNET_TIME_Absolute expire,
-                PluginUpdateCont cont, 
+                PluginUpdateCont cont,
                 void *cont_cls);
 
 
@@ -291,7 +298,7 @@ typedef void
  * @param proc function to call on the matching value
  * @param proc_cls closure for @a proc
  */
-typedef void 
+typedef void
 (*PluginGetType) (void *cls,
                  uint64_t offset,
                  enum GNUNET_BLOCK_Type type,
@@ -304,7 +311,7 @@ typedef void
  *
  * @param cls closure
  */
-typedef void 
+typedef void
 (*PluginDrop) (void *cls);
 
 
@@ -384,5 +391,6 @@ struct GNUNET_DATASTORE_PluginFunctions
 
 };
 
-
 #endif
+
+/** @} */  /* end of group */