diff options
author | Christian Grothoff <christian@grothoff.org> | 2013-11-18 20:58:26 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2013-11-18 20:58:26 +0000 |
commit | 52a8cdf68084f35bde47132849cf0243eca35c35 (patch) | |
tree | 741f6a031b12aa5df68b6b662312b4fc05a855dd | |
parent | e1f3b5eb1559882ec646b297c9fb7bd9c7b17307 (diff) | |
download | gnunet-52a8cdf68084f35bde47132849cf0243eca35c35.tar.gz gnunet-52a8cdf68084f35bde47132849cf0243eca35c35.zip |
-doxygen fixes
-rw-r--r-- | src/datastore/datastore_api.c | 46 | ||||
-rw-r--r-- | src/fs/gnunet-service-fs_pr.c | 20 |
2 files changed, 34 insertions, 32 deletions
diff --git a/src/datastore/datastore_api.c b/src/datastore/datastore_api.c index 13e0a1162..6a994fbb0 100644 --- a/src/datastore/datastore_api.c +++ b/src/datastore/datastore_api.c | |||
@@ -293,10 +293,10 @@ disconnect_after_drop (void *cls, | |||
293 | /** | 293 | /** |
294 | * Transmit DROP message to datastore service. | 294 | * Transmit DROP message to datastore service. |
295 | * | 295 | * |
296 | * @param cls the 'struct GNUNET_DATASTORE_Handle' | 296 | * @param cls the `struct GNUNET_DATASTORE_Handle` |
297 | * @param size number of bytes that can be copied to buf | 297 | * @param size number of bytes that can be copied to @a buf |
298 | * @param buf where to copy the drop message | 298 | * @param buf where to copy the drop message |
299 | * @return number of bytes written to buf | 299 | * @return number of bytes written to @a buf |
300 | */ | 300 | */ |
301 | static size_t | 301 | static size_t |
302 | transmit_drop (void *cls, size_t size, void *buf) | 302 | transmit_drop (void *cls, size_t size, void *buf) |
@@ -327,7 +327,7 @@ transmit_drop (void *cls, size_t size, void *buf) | |||
327 | * associated resources). | 327 | * associated resources). |
328 | * | 328 | * |
329 | * @param h handle to the datastore | 329 | * @param h handle to the datastore |
330 | * @param drop set to GNUNET_YES to delete all data in datastore (!) | 330 | * @param drop set to #GNUNET_YES to delete all data in datastore (!) |
331 | */ | 331 | */ |
332 | void | 332 | void |
333 | GNUNET_DATASTORE_disconnect (struct GNUNET_DATASTORE_Handle *h, int drop) | 333 | GNUNET_DATASTORE_disconnect (struct GNUNET_DATASTORE_Handle *h, int drop) |
@@ -512,7 +512,7 @@ process_queue (struct GNUNET_DATASTORE_Handle *h); | |||
512 | /** | 512 | /** |
513 | * Try reconnecting to the datastore service. | 513 | * Try reconnecting to the datastore service. |
514 | * | 514 | * |
515 | * @param cls the 'struct GNUNET_DATASTORE_Handle' | 515 | * @param cls the `struct GNUNET_DATASTORE_Handle` |
516 | * @param tc scheduler context | 516 | * @param tc scheduler context |
517 | */ | 517 | */ |
518 | static void | 518 | static void |
@@ -594,10 +594,10 @@ receive_cb (void *cls, const struct GNUNET_MessageHeader *msg) | |||
594 | /** | 594 | /** |
595 | * Transmit request from queue to datastore service. | 595 | * Transmit request from queue to datastore service. |
596 | * | 596 | * |
597 | * @param cls the 'struct GNUNET_DATASTORE_Handle' | 597 | * @param cls the `struct GNUNET_DATASTORE_Handle` |
598 | * @param size number of bytes that can be copied to buf | 598 | * @param size number of bytes that can be copied to @a buf |
599 | * @param buf where to copy the drop message | 599 | * @param buf where to copy the drop message |
600 | * @return number of bytes written to buf | 600 | * @return number of bytes written to @a buf |
601 | */ | 601 | */ |
602 | static size_t | 602 | static size_t |
603 | transmit_request (void *cls, size_t size, void *buf) | 603 | transmit_request (void *cls, size_t size, void *buf) |
@@ -835,7 +835,7 @@ process_status_message (void *cls, const struct GNUNET_MessageHeader *msg) | |||
835 | * (if other requests of higher priority are in the queue) | 835 | * (if other requests of higher priority are in the queue) |
836 | * @param timeout timeout for the operation | 836 | * @param timeout timeout for the operation |
837 | * @param cont continuation to call when done | 837 | * @param cont continuation to call when done |
838 | * @param cont_cls closure for cont | 838 | * @param cont_cls closure for @a cont |
839 | * @return NULL if the entry was not queued, otherwise a handle that can be used to | 839 | * @return NULL if the entry was not queued, otherwise a handle that can be used to |
840 | * cancel; note that even if NULL is returned, the callback will be invoked | 840 | * cancel; note that even if NULL is returned, the callback will be invoked |
841 | * (or rather, will already have been invoked) | 841 | * (or rather, will already have been invoked) |
@@ -908,7 +908,7 @@ GNUNET_DATASTORE_put (struct GNUNET_DATASTORE_Handle *h, uint32_t rid, | |||
908 | * @param timeout how long to wait at most for a response (or before dying in queue) | 908 | * @param timeout how long to wait at most for a response (or before dying in queue) |
909 | * @param cont continuation to call when done; "success" will be set to | 909 | * @param cont continuation to call when done; "success" will be set to |
910 | * a positive reservation value if space could be reserved. | 910 | * a positive reservation value if space could be reserved. |
911 | * @param cont_cls closure for cont | 911 | * @param cont_cls closure for @a cont |
912 | * @return NULL if the entry was not queued, otherwise a handle that can be used to | 912 | * @return NULL if the entry was not queued, otherwise a handle that can be used to |
913 | * cancel; note that even if NULL is returned, the callback will be invoked | 913 | * cancel; note that even if NULL is returned, the callback will be invoked |
914 | * (or rather, will already have been invoked) | 914 | * (or rather, will already have been invoked) |
@@ -936,7 +936,8 @@ GNUNET_DATASTORE_reserve (struct GNUNET_DATASTORE_Handle *h, uint64_t amount, | |||
936 | max_queue_size, timeout, &process_status_message, &qc); | 936 | max_queue_size, timeout, &process_status_message, &qc); |
937 | if (qe == NULL) | 937 | if (qe == NULL) |
938 | { | 938 | { |
939 | LOG (GNUNET_ERROR_TYPE_DEBUG, "Could not create queue entry to reserve\n"); | 939 | LOG (GNUNET_ERROR_TYPE_DEBUG, |
940 | "Could not create queue entry to reserve\n"); | ||
940 | return NULL; | 941 | return NULL; |
941 | } | 942 | } |
942 | GNUNET_STATISTICS_update (h->stats, | 943 | GNUNET_STATISTICS_update (h->stats, |
@@ -968,7 +969,7 @@ GNUNET_DATASTORE_reserve (struct GNUNET_DATASTORE_Handle *h, uint64_t amount, | |||
968 | * (if other requests of higher priority are in the queue) | 969 | * (if other requests of higher priority are in the queue) |
969 | * @param timeout how long to wait at most for a response | 970 | * @param timeout how long to wait at most for a response |
970 | * @param cont continuation to call when done | 971 | * @param cont continuation to call when done |
971 | * @param cont_cls closure for cont | 972 | * @param cont_cls closure for @a cont |
972 | * @return NULL if the entry was not queued, otherwise a handle that can be used to | 973 | * @return NULL if the entry was not queued, otherwise a handle that can be used to |
973 | * cancel; note that even if NULL is returned, the callback will be invoked | 974 | * cancel; note that even if NULL is returned, the callback will be invoked |
974 | * (or rather, will already have been invoked) | 975 | * (or rather, will already have been invoked) |
@@ -1024,7 +1025,7 @@ GNUNET_DATASTORE_release_reserve (struct GNUNET_DATASTORE_Handle *h, | |||
1024 | * (if other requests of higher priority are in the queue) | 1025 | * (if other requests of higher priority are in the queue) |
1025 | * @param timeout how long to wait at most for a response | 1026 | * @param timeout how long to wait at most for a response |
1026 | * @param cont continuation to call when done | 1027 | * @param cont continuation to call when done |
1027 | * @param cont_cls closure for cont | 1028 | * @param cont_cls closure for @a cont |
1028 | * @return NULL if the entry was not queued, otherwise a handle that can be used to | 1029 | * @return NULL if the entry was not queued, otherwise a handle that can be used to |
1029 | * cancel; note that even if NULL is returned, the callback will be invoked | 1030 | * cancel; note that even if NULL is returned, the callback will be invoked |
1030 | * (or rather, will already have been invoked) | 1031 | * (or rather, will already have been invoked) |
@@ -1056,7 +1057,8 @@ GNUNET_DATASTORE_update (struct GNUNET_DATASTORE_Handle *h, uint64_t uid, | |||
1056 | max_queue_size, timeout, &process_status_message, &qc); | 1057 | max_queue_size, timeout, &process_status_message, &qc); |
1057 | if (qe == NULL) | 1058 | if (qe == NULL) |
1058 | { | 1059 | { |
1059 | LOG (GNUNET_ERROR_TYPE_DEBUG, "Could not create queue entry for UPDATE\n"); | 1060 | LOG (GNUNET_ERROR_TYPE_DEBUG, |
1061 | "Could not create queue entry for UPDATE\n"); | ||
1060 | return NULL; | 1062 | return NULL; |
1061 | } | 1063 | } |
1062 | GNUNET_STATISTICS_update (h->stats, | 1064 | GNUNET_STATISTICS_update (h->stats, |
@@ -1075,9 +1077,9 @@ GNUNET_DATASTORE_update (struct GNUNET_DATASTORE_Handle *h, uint64_t uid, | |||
1075 | 1077 | ||
1076 | /** | 1078 | /** |
1077 | * Explicitly remove some content from the database. | 1079 | * Explicitly remove some content from the database. |
1078 | * The "cont"inuation will be called with status | 1080 | * The @a cont continuation will be called with `status` |
1079 | * "GNUNET_OK" if content was removed, "GNUNET_NO" | 1081 | * #GNUNET_OK" if content was removed, #GNUNET_NO |
1080 | * if no matching entry was found and "GNUNET_SYSERR" | 1082 | * if no matching entry was found and #GNUNET_SYSERR |
1081 | * on all other types of errors. | 1083 | * on all other types of errors. |
1082 | * | 1084 | * |
1083 | * @param h handle to the datastore | 1085 | * @param h handle to the datastore |
@@ -1089,7 +1091,7 @@ GNUNET_DATASTORE_update (struct GNUNET_DATASTORE_Handle *h, uint64_t uid, | |||
1089 | * (if other requests of higher priority are in the queue) | 1091 | * (if other requests of higher priority are in the queue) |
1090 | * @param timeout how long to wait at most for a response | 1092 | * @param timeout how long to wait at most for a response |
1091 | * @param cont continuation to call when done | 1093 | * @param cont continuation to call when done |
1092 | * @param cont_cls closure for cont | 1094 | * @param cont_cls closure for @a cont |
1093 | * @return NULL if the entry was not queued, otherwise a handle that can be used to | 1095 | * @return NULL if the entry was not queued, otherwise a handle that can be used to |
1094 | * cancel; note that even if NULL is returned, the callback will be invoked | 1096 | * cancel; note that even if NULL is returned, the callback will be invoked |
1095 | * (or rather, will already have been invoked) | 1097 | * (or rather, will already have been invoked) |
@@ -1147,7 +1149,7 @@ GNUNET_DATASTORE_remove (struct GNUNET_DATASTORE_Handle *h, | |||
1147 | * Type of a function to call when we receive a message | 1149 | * Type of a function to call when we receive a message |
1148 | * from the service. | 1150 | * from the service. |
1149 | * | 1151 | * |
1150 | * @param cls closure | 1152 | * @param cls closure with the `struct GNUNET_DATASTORE_Handle *` |
1151 | * @param msg message received, NULL on timeout or fatal error | 1153 | * @param msg message received, NULL on timeout or fatal error |
1152 | */ | 1154 | */ |
1153 | static void | 1155 | static void |
@@ -1262,7 +1264,7 @@ process_result_message (void *cls, const struct GNUNET_MessageHeader *msg) | |||
1262 | * @param proc function to call on a random value; it | 1264 | * @param proc function to call on a random value; it |
1263 | * will be called once with a value (if available) | 1265 | * will be called once with a value (if available) |
1264 | * and always once with a value of NULL. | 1266 | * and always once with a value of NULL. |
1265 | * @param proc_cls closure for proc | 1267 | * @param proc_cls closure for @a proc |
1266 | * @return NULL if the entry was not queued, otherwise a handle that can be used to | 1268 | * @return NULL if the entry was not queued, otherwise a handle that can be used to |
1267 | * cancel | 1269 | * cancel |
1268 | */ | 1270 | */ |
@@ -1321,7 +1323,7 @@ GNUNET_DATASTORE_get_for_replication (struct GNUNET_DATASTORE_Handle *h, | |||
1321 | * @param proc function to call on a random value; it | 1323 | * @param proc function to call on a random value; it |
1322 | * will be called once with a value (if available) | 1324 | * will be called once with a value (if available) |
1323 | * or with NULL if none value exists. | 1325 | * or with NULL if none value exists. |
1324 | * @param proc_cls closure for proc | 1326 | * @param proc_cls closure for @a proc |
1325 | * @return NULL if the entry was not queued, otherwise a handle that can be used to | 1327 | * @return NULL if the entry was not queued, otherwise a handle that can be used to |
1326 | * cancel | 1328 | * cancel |
1327 | */ | 1329 | */ |
@@ -1387,7 +1389,7 @@ GNUNET_DATASTORE_get_zero_anonymity (struct GNUNET_DATASTORE_Handle *h, | |||
1387 | * @param timeout how long to wait at most for a response | 1389 | * @param timeout how long to wait at most for a response |
1388 | * @param proc function to call on each matching value; | 1390 | * @param proc function to call on each matching value; |
1389 | * will be called once with a NULL value at the end | 1391 | * will be called once with a NULL value at the end |
1390 | * @param proc_cls closure for proc | 1392 | * @param proc_cls closure for @a proc |
1391 | * @return NULL if the entry was not queued, otherwise a handle that can be used to | 1393 | * @return NULL if the entry was not queued, otherwise a handle that can be used to |
1392 | * cancel | 1394 | * cancel |
1393 | */ | 1395 | */ |
diff --git a/src/fs/gnunet-service-fs_pr.c b/src/fs/gnunet-service-fs_pr.c index 70ec0699a..ee71019bb 100644 --- a/src/fs/gnunet-service-fs_pr.c +++ b/src/fs/gnunet-service-fs_pr.c | |||
@@ -87,7 +87,7 @@ struct GSF_PendingRequest | |||
87 | GSF_PendingRequestReplyHandler rh; | 87 | GSF_PendingRequestReplyHandler rh; |
88 | 88 | ||
89 | /** | 89 | /** |
90 | * Closure for 'rh' | 90 | * Closure for @e rh |
91 | */ | 91 | */ |
92 | void *rh_cls; | 92 | void *rh_cls; |
93 | 93 | ||
@@ -271,7 +271,7 @@ refresh_bloomfilter (struct GSF_PendingRequest *pr) | |||
271 | * @param query key for the lookup | 271 | * @param query key for the lookup |
272 | * @param target preferred target for the request, NULL for none | 272 | * @param target preferred target for the request, NULL for none |
273 | * @param bf_data raw data for bloom filter for known replies, can be NULL | 273 | * @param bf_data raw data for bloom filter for known replies, can be NULL |
274 | * @param bf_size number of bytes in bf_data | 274 | * @param bf_size number of bytes in @a bf_data |
275 | * @param mingle mingle value for bf | 275 | * @param mingle mingle value for bf |
276 | * @param anonymity_level desired anonymity level | 276 | * @param anonymity_level desired anonymity level |
277 | * @param priority maximum outgoing cummulative request priority to use | 277 | * @param priority maximum outgoing cummulative request priority to use |
@@ -279,9 +279,9 @@ refresh_bloomfilter (struct GSF_PendingRequest *pr) | |||
279 | * @param sender_pid peer ID to use for the sender when forwarding, 0 for none | 279 | * @param sender_pid peer ID to use for the sender when forwarding, 0 for none |
280 | * @param origin_pid peer ID of origin of query (do not loop back) | 280 | * @param origin_pid peer ID of origin of query (do not loop back) |
281 | * @param replies_seen hash codes of known local replies | 281 | * @param replies_seen hash codes of known local replies |
282 | * @param replies_seen_count size of the 'replies_seen' array | 282 | * @param replies_seen_count size of the @a replies_seen array |
283 | * @param rh handle to call when we get a reply | 283 | * @param rh handle to call when we get a reply |
284 | * @param rh_cls closure for rh | 284 | * @param rh_cls closure for @a rh |
285 | * @return handle for the new pending request | 285 | * @return handle for the new pending request |
286 | */ | 286 | */ |
287 | struct GSF_PendingRequest * | 287 | struct GSF_PendingRequest * |
@@ -416,7 +416,7 @@ GSF_pending_request_get_data_ (struct GSF_PendingRequest *pr) | |||
416 | * | 416 | * |
417 | * @param pra a pending request | 417 | * @param pra a pending request |
418 | * @param prb another pending request | 418 | * @param prb another pending request |
419 | * @return GNUNET_OK if the requests are compatible | 419 | * @return #GNUNET_OK if the requests are compatible |
420 | */ | 420 | */ |
421 | int | 421 | int |
422 | GSF_pending_request_is_compatible_ (struct GSF_PendingRequest *pra, | 422 | GSF_pending_request_is_compatible_ (struct GSF_PendingRequest *pra, |
@@ -494,9 +494,9 @@ GSF_pending_request_update_ (struct GSF_PendingRequest *pr, | |||
494 | * transmission to other peers (or at least determine its size). | 494 | * transmission to other peers (or at least determine its size). |
495 | * | 495 | * |
496 | * @param pr request to generate the message for | 496 | * @param pr request to generate the message for |
497 | * @param buf_size number of bytes available in buf | 497 | * @param buf_size number of bytes available in @a buf |
498 | * @param buf where to copy the message (can be NULL) | 498 | * @param buf where to copy the message (can be NULL) |
499 | * @return number of bytes needed (if > buf_size) or used | 499 | * @return number of bytes needed (if `>` @a buf_size) or used |
500 | */ | 500 | */ |
501 | size_t | 501 | size_t |
502 | GSF_pending_request_get_message_ (struct GSF_PendingRequest *pr, | 502 | GSF_pending_request_get_message_ (struct GSF_PendingRequest *pr, |
@@ -586,7 +586,7 @@ GSF_pending_request_get_message_ (struct GSF_PendingRequest *pr, | |||
586 | * @param cls closure, unused | 586 | * @param cls closure, unused |
587 | * @param key current key code | 587 | * @param key current key code |
588 | * @param value value in the hash map (pending request) | 588 | * @param value value in the hash map (pending request) |
589 | * @return GNUNET_YES (we should continue to iterate) | 589 | * @return #GNUNET_YES (we should continue to iterate) |
590 | */ | 590 | */ |
591 | static int | 591 | static int |
592 | clean_request (void *cls, const struct GNUNET_HashCode * key, void *value) | 592 | clean_request (void *cls, const struct GNUNET_HashCode * key, void *value) |
@@ -794,7 +794,7 @@ update_request_performance_data (struct ProcessReplyClosure *prq, | |||
794 | * @param cls response (struct ProcessReplyClosure) | 794 | * @param cls response (struct ProcessReplyClosure) |
795 | * @param key our query | 795 | * @param key our query |
796 | * @param value value in the hash map (info about the query) | 796 | * @param value value in the hash map (info about the query) |
797 | * @return GNUNET_YES (we should continue to iterate) | 797 | * @return #GNUNET_YES (we should continue to iterate) |
798 | */ | 798 | */ |
799 | static int | 799 | static int |
800 | process_reply (void *cls, const struct GNUNET_HashCode * key, void *value) | 800 | process_reply (void *cls, const struct GNUNET_HashCode * key, void *value) |
@@ -1043,7 +1043,7 @@ test_put_load_too_high (uint32_t priority) | |||
1043 | * @param put_path peers on the PUT path (or NULL if not recorded) | 1043 | * @param put_path peers on the PUT path (or NULL if not recorded) |
1044 | * @param put_path_length number of entries in @a get_path | 1044 | * @param put_path_length number of entries in @a get_path |
1045 | * @param type type of the result | 1045 | * @param type type of the result |
1046 | * @param size number of bytes in data | 1046 | * @param size number of bytes in @a data |
1047 | * @param data pointer to the result data | 1047 | * @param data pointer to the result data |
1048 | */ | 1048 | */ |
1049 | static void | 1049 | static void |