diff options
author | Julius Bünger <buenger@mytum.de> | 2014-12-27 12:32:03 +0000 |
---|---|---|
committer | Julius Bünger <buenger@mytum.de> | 2014-12-27 12:32:03 +0000 |
commit | 5cf128ef0009bdd2ba2210d364c23e8a34dc2a03 (patch) | |
tree | 3b04aad56b5cfecb1858d10911ed98f2a2e46ba9 /src | |
parent | 1a38e8ab9be3742fae293e968e43d7fa066ce6fc (diff) | |
download | gnunet-5cf128ef0009bdd2ba2210d364c23e8a34dc2a03.tar.gz gnunet-5cf128ef0009bdd2ba2210d364c23e8a34dc2a03.zip |
fixed doxygen
Diffstat (limited to 'src')
-rw-r--r-- | src/include/gnunet_rps_service.h | 4 | ||||
-rw-r--r-- | src/rps/rps_api.c | 19 |
2 files changed, 22 insertions, 1 deletions
diff --git a/src/include/gnunet_rps_service.h b/src/include/gnunet_rps_service.h index f7dd253e0..b6d1cb71f 100644 --- a/src/include/gnunet_rps_service.h +++ b/src/include/gnunet_rps_service.h | |||
@@ -106,6 +106,10 @@ GNUNET_RPS_request_peers (struct GNUNET_RPS_Handle *h, uint64_t n, | |||
106 | 106 | ||
107 | /** | 107 | /** |
108 | * Seed rps service with peerIDs. | 108 | * Seed rps service with peerIDs. |
109 | * | ||
110 | * @param h handle to the rps service | ||
111 | * @param n number of peers to seed | ||
112 | * @param ids the ids of the peers seeded | ||
109 | */ | 113 | */ |
110 | void | 114 | void |
111 | GNUNET_RPS_seed_ids (struct GNUNET_RPS_Handle *h, uint64_t n, | 115 | GNUNET_RPS_seed_ids (struct GNUNET_RPS_Handle *h, uint64_t n, |
diff --git a/src/rps/rps_api.c b/src/rps/rps_api.c index 6dd6c5748..460d8fca4 100644 --- a/src/rps/rps_api.c +++ b/src/rps/rps_api.c | |||
@@ -201,6 +201,9 @@ GNUNET_RPS_request_peers_single_call (const struct GNUNET_CONFIGURATION_Handle * | |||
201 | 201 | ||
202 | /** | 202 | /** |
203 | * Connect to the rps service | 203 | * Connect to the rps service |
204 | * | ||
205 | * @param cfg configuration to use | ||
206 | * @return a handle to the service | ||
204 | */ | 207 | */ |
205 | struct GNUNET_RPS_Handle * | 208 | struct GNUNET_RPS_Handle * |
206 | GNUNET_RPS_connect( const struct GNUNET_CONFIGURATION_Handle *cfg ) | 209 | GNUNET_RPS_connect( const struct GNUNET_CONFIGURATION_Handle *cfg ) |
@@ -228,6 +231,12 @@ GNUNET_RPS_connect( const struct GNUNET_CONFIGURATION_Handle *cfg ) | |||
228 | 231 | ||
229 | /** | 232 | /** |
230 | * Request n random peers. | 233 | * Request n random peers. |
234 | * | ||
235 | * @param h handle to the rps service | ||
236 | * @param n number of peers we want to receive | ||
237 | * @param ready_cb the callback called when the peers are available | ||
238 | * @param cls closure given to the callback | ||
239 | * @return a handle to cancel this request | ||
231 | */ | 240 | */ |
232 | struct GNUNET_RPS_Request_Handle * | 241 | struct GNUNET_RPS_Request_Handle * |
233 | GNUNET_RPS_request_peers (struct GNUNET_RPS_Handle *h, uint64_t n, | 242 | GNUNET_RPS_request_peers (struct GNUNET_RPS_Handle *h, uint64_t n, |
@@ -257,6 +266,10 @@ GNUNET_RPS_request_peers (struct GNUNET_RPS_Handle *h, uint64_t n, | |||
257 | 266 | ||
258 | /** | 267 | /** |
259 | * Seed rps service with peerIDs. | 268 | * Seed rps service with peerIDs. |
269 | * | ||
270 | * @param h handle to the rps service | ||
271 | * @param n number of peers to seed | ||
272 | * @param ids the ids of the peers seeded | ||
260 | */ | 273 | */ |
261 | void | 274 | void |
262 | GNUNET_RPS_seed_ids (struct GNUNET_RPS_Handle *h, uint64_t n, | 275 | GNUNET_RPS_seed_ids (struct GNUNET_RPS_Handle *h, uint64_t n, |
@@ -266,6 +279,8 @@ GNUNET_RPS_seed_ids (struct GNUNET_RPS_Handle *h, uint64_t n, | |||
266 | 279 | ||
267 | /** | 280 | /** |
268 | * Cancle an issued request. | 281 | * Cancle an issued request. |
282 | * | ||
283 | * @param rh request handle of request to cancle | ||
269 | */ | 284 | */ |
270 | void | 285 | void |
271 | GNUNET_RPS_request_cancel ( struct GNUNET_RPS_Request_Handle *rh ) | 286 | GNUNET_RPS_request_cancel ( struct GNUNET_RPS_Request_Handle *rh ) |
@@ -274,7 +289,9 @@ GNUNET_RPS_request_cancel ( struct GNUNET_RPS_Request_Handle *rh ) | |||
274 | } | 289 | } |
275 | 290 | ||
276 | /** | 291 | /** |
277 | * Disconnect to the rps service | 292 | * Disconnect from the rps service |
293 | * | ||
294 | * @param h the handle to the rps service | ||
278 | */ | 295 | */ |
279 | void | 296 | void |
280 | GNUNET_RPS_disconnect ( struct GNUNET_RPS_Handle *h ) | 297 | GNUNET_RPS_disconnect ( struct GNUNET_RPS_Handle *h ) |