[GNUnet-SVN] r30792 - in gnunet/src: datastore fs

[gnunet]

Author: grothoff
Date: 2013-11-18 21:58:26 +0100 (Mon, 18 Nov 2013)
New Revision: 30792

Modified:
   gnunet/src/datastore/datastore_api.c
   gnunet/src/fs/gnunet-service-fs_pr.c
Log:
-doxygen fixes

Modified: gnunet/src/datastore/datastore_api.c
===================================================================
--- gnunet/src/datastore/datastore_api.c        2013-11-18 20:43:19 UTC (rev 
30791)
+++ gnunet/src/datastore/datastore_api.c        2013-11-18 20:58:26 UTC (rev 
30792)
@@ -293,10 +293,10 @@
 /**
  * Transmit DROP message to datastore service.
  *
- * @param cls the 'struct GNUNET_DATASTORE_Handle'
- * @param size number of bytes that can be copied to buf
+ * @param cls the `struct GNUNET_DATASTORE_Handle`
+ * @param size number of bytes that can be copied to @a buf
  * @param buf where to copy the drop message
- * @return number of bytes written to buf
+ * @return number of bytes written to @a buf
  */
 static size_t
 transmit_drop (void *cls, size_t size, void *buf)
@@ -327,7 +327,7 @@
  * associated resources).
  *
  * @param h handle to the datastore
- * @param drop set to GNUNET_YES to delete all data in datastore (!)
+ * @param drop set to #GNUNET_YES to delete all data in datastore (!)
  */
 void
 GNUNET_DATASTORE_disconnect (struct GNUNET_DATASTORE_Handle *h, int drop)
@@ -512,7 +512,7 @@
 /**
  * Try reconnecting to the datastore service.
  *
- * @param cls the 'struct GNUNET_DATASTORE_Handle'
+ * @param cls the `struct GNUNET_DATASTORE_Handle`
  * @param tc scheduler context
  */
 static void
@@ -594,10 +594,10 @@
 /**
  * Transmit request from queue to datastore service.
  *
- * @param cls the 'struct GNUNET_DATASTORE_Handle'
- * @param size number of bytes that can be copied to buf
+ * @param cls the `struct GNUNET_DATASTORE_Handle`
+ * @param size number of bytes that can be copied to @a buf
  * @param buf where to copy the drop message
- * @return number of bytes written to buf
+ * @return number of bytes written to @a buf
  */
 static size_t
 transmit_request (void *cls, size_t size, void *buf)
@@ -835,7 +835,7 @@
  *        (if other requests of higher priority are in the queue)
  * @param timeout timeout for the operation
  * @param cont continuation to call when done
- * @param cont_cls closure for cont
+ * @param cont_cls closure for @a cont
  * @return NULL if the entry was not queued, otherwise a handle that can be 
used to
  *         cancel; note that even if NULL is returned, the callback will be 
invoked
  *         (or rather, will already have been invoked)
@@ -908,7 +908,7 @@
  * @param timeout how long to wait at most for a response (or before dying in 
queue)
  * @param cont continuation to call when done; "success" will be set to
  *             a positive reservation value if space could be reserved.
- * @param cont_cls closure for cont
+ * @param cont_cls closure for @a cont
  * @return NULL if the entry was not queued, otherwise a handle that can be 
used to
  *         cancel; note that even if NULL is returned, the callback will be 
invoked
  *         (or rather, will already have been invoked)
@@ -936,7 +936,8 @@
                          max_queue_size, timeout, &process_status_message, 
&qc);
   if (qe == NULL)
   {
-    LOG (GNUNET_ERROR_TYPE_DEBUG, "Could not create queue entry to reserve\n");
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+         "Could not create queue entry to reserve\n");
     return NULL;
   }
   GNUNET_STATISTICS_update (h->stats,
@@ -968,7 +969,7 @@
  *        (if other requests of higher priority are in the queue)
  * @param timeout how long to wait at most for a response
  * @param cont continuation to call when done
- * @param cont_cls closure for cont
+ * @param cont_cls closure for @a cont
  * @return NULL if the entry was not queued, otherwise a handle that can be 
used to
  *         cancel; note that even if NULL is returned, the callback will be 
invoked
  *         (or rather, will already have been invoked)
@@ -1024,7 +1025,7 @@
  *        (if other requests of higher priority are in the queue)
  * @param timeout how long to wait at most for a response
  * @param cont continuation to call when done
- * @param cont_cls closure for cont
+ * @param cont_cls closure for @a cont
  * @return NULL if the entry was not queued, otherwise a handle that can be 
used to
  *         cancel; note that even if NULL is returned, the callback will be 
invoked
  *         (or rather, will already have been invoked)
@@ -1056,7 +1057,8 @@
                          max_queue_size, timeout, &process_status_message, 
&qc);
   if (qe == NULL)
   {
-    LOG (GNUNET_ERROR_TYPE_DEBUG, "Could not create queue entry for UPDATE\n");
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+         "Could not create queue entry for UPDATE\n");
     return NULL;
   }
   GNUNET_STATISTICS_update (h->stats,
@@ -1075,9 +1077,9 @@
 
 /**
  * Explicitly remove some content from the database.
- * The "cont"inuation will be called with status
- * "GNUNET_OK" if content was removed, "GNUNET_NO"
- * if no matching entry was found and "GNUNET_SYSERR"
+ * The @a cont continuation will be called with `status`
+ * #GNUNET_OK" if content was removed, #GNUNET_NO
+ * if no matching entry was found and #GNUNET_SYSERR
  * on all other types of errors.
  *
  * @param h handle to the datastore
@@ -1089,7 +1091,7 @@
  *        (if other requests of higher priority are in the queue)
  * @param timeout how long to wait at most for a response
  * @param cont continuation to call when done
- * @param cont_cls closure for cont
+ * @param cont_cls closure for @a cont
  * @return NULL if the entry was not queued, otherwise a handle that can be 
used to
  *         cancel; note that even if NULL is returned, the callback will be 
invoked
  *         (or rather, will already have been invoked)
@@ -1147,7 +1149,7 @@
  * Type of a function to call when we receive a message
  * from the service.
  *
- * @param cls closure
+ * @param cls closure with the `struct GNUNET_DATASTORE_Handle *`
  * @param msg message received, NULL on timeout or fatal error
  */
 static void
@@ -1262,7 +1264,7 @@
  * @param proc function to call on a random value; it
  *        will be called once with a value (if available)
  *        and always once with a value of NULL.
- * @param proc_cls closure for proc
+ * @param proc_cls closure for @a proc
  * @return NULL if the entry was not queued, otherwise a handle that can be 
used to
  *         cancel
  */
@@ -1321,7 +1323,7 @@
  * @param proc function to call on a random value; it
  *        will be called once with a value (if available)
  *        or with NULL if none value exists.
- * @param proc_cls closure for proc
+ * @param proc_cls closure for @a proc
  * @return NULL if the entry was not queued, otherwise a handle that can be 
used to
  *         cancel
  */
@@ -1387,7 +1389,7 @@
  * @param timeout how long to wait at most for a response
  * @param proc function to call on each matching value;
  *        will be called once with a NULL value at the end
- * @param proc_cls closure for proc
+ * @param proc_cls closure for @a proc
  * @return NULL if the entry was not queued, otherwise a handle that can be 
used to
  *         cancel
  */

Modified: gnunet/src/fs/gnunet-service-fs_pr.c
===================================================================
--- gnunet/src/fs/gnunet-service-fs_pr.c        2013-11-18 20:43:19 UTC (rev 
30791)
+++ gnunet/src/fs/gnunet-service-fs_pr.c        2013-11-18 20:58:26 UTC (rev 
30792)
@@ -87,7 +87,7 @@
   GSF_PendingRequestReplyHandler rh;
 
   /**
-   * Closure for 'rh'
+   * Closure for @e rh
    */
   void *rh_cls;
 
@@ -271,7 +271,7 @@
  * @param query key for the lookup
  * @param target preferred target for the request, NULL for none
  * @param bf_data raw data for bloom filter for known replies, can be NULL
- * @param bf_size number of bytes in bf_data
+ * @param bf_size number of bytes in @a bf_data
  * @param mingle mingle value for bf
  * @param anonymity_level desired anonymity level
  * @param priority maximum outgoing cummulative request priority to use
@@ -279,9 +279,9 @@
  * @param sender_pid peer ID to use for the sender when forwarding, 0 for none
  * @param origin_pid peer ID of origin of query (do not loop back)
  * @param replies_seen hash codes of known local replies
- * @param replies_seen_count size of the 'replies_seen' array
+ * @param replies_seen_count size of the @a replies_seen array
  * @param rh handle to call when we get a reply
- * @param rh_cls closure for rh
+ * @param rh_cls closure for @a rh
  * @return handle for the new pending request
  */
 struct GSF_PendingRequest *
@@ -416,7 +416,7 @@
  *
  * @param pra a pending request
  * @param prb another pending request
- * @return GNUNET_OK if the requests are compatible
+ * @return #GNUNET_OK if the requests are compatible
  */
 int
 GSF_pending_request_is_compatible_ (struct GSF_PendingRequest *pra,
@@ -494,9 +494,9 @@
  * transmission to other peers (or at least determine its size).
  *
  * @param pr request to generate the message for
- * @param buf_size number of bytes available in buf
+ * @param buf_size number of bytes available in @a buf
  * @param buf where to copy the message (can be NULL)
- * @return number of bytes needed (if > buf_size) or used
+ * @return number of bytes needed (if `>` @a buf_size) or used
  */
 size_t
 GSF_pending_request_get_message_ (struct GSF_PendingRequest *pr,
@@ -586,7 +586,7 @@
  * @param cls closure, unused
  * @param key current key code
  * @param value value in the hash map (pending request)
- * @return GNUNET_YES (we should continue to iterate)
+ * @return #GNUNET_YES (we should continue to iterate)
  */
 static int
 clean_request (void *cls, const struct GNUNET_HashCode * key, void *value)
@@ -794,7 +794,7 @@
  * @param cls response (struct ProcessReplyClosure)
  * @param key our query
  * @param value value in the hash map (info about the query)
- * @return GNUNET_YES (we should continue to iterate)
+ * @return #GNUNET_YES (we should continue to iterate)
  */
 static int
 process_reply (void *cls, const struct GNUNET_HashCode * key, void *value)
@@ -1043,7 +1043,7 @@
  * @param put_path peers on the PUT path (or NULL if not recorded)
  * @param put_path_length number of entries in @a get_path
  * @param type type of the result
- * @param size number of bytes in data
+ * @param size number of bytes in @a data
  * @param data pointer to the result data
  */
 static void