peerstore: doxygen

1 files changed, 22 insertions, 19 deletions

diff --git a/src/peerstore/peerstore_api.c b/src/peerstore/peerstore_api.c
index 81d287b53..3c67846e6 100644
--- a/src/peerstore/peerstore_api.c
+++ b/src/peerstore/peerstore_api.c
@@ -454,7 +454,8 @@ GNUNET_PEERSTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
 
 /**
  * Disconnect from the PEERSTORE service. Any pending ITERATE and WATCH requests
- * will be canceled. Any pending STORE requests will depend on @snyc_first flag.
+ * will be canceled.
+ * Any pending STORE requests will depend on @e snyc_first flag.
  *
  * @param h handle to disconnect
  * @param sync_first send any pending STORE requests before disconnecting
@@ -556,22 +557,23 @@ GNUNET_PEERSTORE_store_cancel (struct GNUNET_PEERSTORE_StoreContext *sc)
  * @param peer Peer Identity
  * @param key entry key
  * @param value entry value BLOB
- * @param size size of 'value'
+ * @param size size of @e value
  * @param expiry absolute time after which the entry is (possibly) deleted
+ * @param options options specific to the storage operation
  * @param cont Continuation function after the store request is sent
  * @param cont_cls Closure for 'cont'
  */
 struct GNUNET_PEERSTORE_StoreContext *
 GNUNET_PEERSTORE_store (struct GNUNET_PEERSTORE_Handle *h,
-    const char *sub_system,
-    const struct GNUNET_PeerIdentity *peer,
-    const char *key,
-    const void *value,
-    size_t size,
-    struct GNUNET_TIME_Absolute expiry,
-    enum GNUNET_PEERSTORE_StoreOption options,
-    GNUNET_PEERSTORE_Continuation cont,
-    void *cont_cls)
+                        const char *sub_system,
+                        const struct GNUNET_PeerIdentity *peer,
+                        const char *key,
+                        const void *value,
+                        size_t size,
+                        struct GNUNET_TIME_Absolute expiry,
+                        enum GNUNET_PEERSTORE_StoreOption options,
+                        GNUNET_PEERSTORE_Continuation cont,
+                        void *cont_cls)
 {
   struct GNUNET_MQ_Envelope *ev;
   struct GNUNET_PEERSTORE_StoreContext *sc;
@@ -580,13 +582,13 @@ GNUNET_PEERSTORE_store (struct GNUNET_PEERSTORE_Handle *h,
       "Storing value (size: %lu) for subsytem `%s', peer `%s', key `%s'\n",
       size, sub_system, GNUNET_i2s (peer), key);
   ev = PEERSTORE_create_record_mq_envelope(sub_system,
-      peer,
-      key,
-      value,
-      size,
-      &expiry,
-      options,
-      GNUNET_MESSAGE_TYPE_PEERSTORE_STORE);
+                                           peer,
+                                           key,
+                                           value,
+                                           size,
+                                           &expiry,
+                                           options,
+                                           GNUNET_MESSAGE_TYPE_PEERSTORE_STORE);
   sc = GNUNET_new(struct GNUNET_PEERSTORE_StoreContext);
   sc->ev = ev;
   sc->cont = cont;
@@ -681,6 +683,7 @@ static void iterate_request_sent (void *cls)
  * Called when the iterate request is timedout
  *
  * @param cls a 'struct GNUNET_PEERSTORE_IterateContext *'
+ * @param tc Scheduler task context (unused)
  */
 static void
 iterate_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
@@ -823,7 +826,7 @@ static void watch_request_sent (void *cls)
 /**
  * Cancel a watch request
  *
- * @wc handle to the watch request
+ * @param wc handle to the watch request
  */
 void
 GNUNET_PEERSTORE_watch_cancel(struct GNUNET_PEERSTORE_WatchContext *wc)