diff options
author | Christian Grothoff <christian@grothoff.org> | 2009-09-29 20:29:26 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2009-09-29 20:29:26 +0000 |
commit | b275b6e4ee9f03351397e46e5e2c7db0390b38a3 (patch) | |
tree | 8b4225974b492f32efee84cd35ed3014e7afe46b /src/datastore/plugin_datastore_template.c | |
parent | 37acb875ba2259b0ed23092480c8fc39069d6679 (diff) | |
download | gnunet-b275b6e4ee9f03351397e46e5e2c7db0390b38a3.tar.gz gnunet-b275b6e4ee9f03351397e46e5e2c7db0390b38a3.zip |
fixing comments and minor bugs
Diffstat (limited to 'src/datastore/plugin_datastore_template.c')
-rw-r--r-- | src/datastore/plugin_datastore_template.c | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/src/datastore/plugin_datastore_template.c b/src/datastore/plugin_datastore_template.c index 4bfb452ed..7f31ff703 100644 --- a/src/datastore/plugin_datastore_template.c +++ b/src/datastore/plugin_datastore_template.c | |||
@@ -43,6 +43,8 @@ struct Plugin | |||
43 | /** | 43 | /** |
44 | * Get an estimate of how much space the database is | 44 | * Get an estimate of how much space the database is |
45 | * currently using. | 45 | * currently using. |
46 | * | ||
47 | * @param cls our "struct Plugin*" | ||
46 | * @return number of bytes used on disk | 48 | * @return number of bytes used on disk |
47 | */ | 49 | */ |
48 | static unsigned long long template_plugin_get_size (void *cls) | 50 | static unsigned long long template_plugin_get_size (void *cls) |
@@ -142,6 +144,7 @@ template_plugin_get (void *cls, | |||
142 | * Note that it is possible for multiple values to match this put. | 144 | * Note that it is possible for multiple values to match this put. |
143 | * In that case, all of the respective values are updated. | 145 | * In that case, all of the respective values are updated. |
144 | * | 146 | * |
147 | * @param cls our "struct Plugin*" | ||
145 | * @param uid unique identifier of the datum | 148 | * @param uid unique identifier of the datum |
146 | * @param delta by how much should the priority | 149 | * @param delta by how much should the priority |
147 | * change? If priority + delta < 0 the | 150 | * change? If priority + delta < 0 the |
@@ -169,6 +172,7 @@ template_plugin_update (void *cls, | |||
169 | * Select a subset of the items in the datastore and call | 172 | * Select a subset of the items in the datastore and call |
170 | * the given iterator for each of them. | 173 | * the given iterator for each of them. |
171 | * | 174 | * |
175 | * @param cls our "struct Plugin*" | ||
172 | * @param type entries of which type should be considered? | 176 | * @param type entries of which type should be considered? |
173 | * Use 0 for any type. | 177 | * Use 0 for any type. |
174 | * @param iter function to call on each matching value; | 178 | * @param iter function to call on each matching value; |
@@ -211,6 +215,7 @@ template_plugin_iter_zero_anonymity (void *cls, | |||
211 | * Select a subset of the items in the datastore and call | 215 | * Select a subset of the items in the datastore and call |
212 | * the given iterator for each of them. | 216 | * the given iterator for each of them. |
213 | * | 217 | * |
218 | * @param cls our "struct Plugin*" | ||
214 | * @param type entries of which type should be considered? | 219 | * @param type entries of which type should be considered? |
215 | * Use 0 for any type. | 220 | * Use 0 for any type. |
216 | * @param iter function to call on each matching value; | 221 | * @param iter function to call on each matching value; |
@@ -232,6 +237,7 @@ template_plugin_iter_ascending_expiration (void *cls, | |||
232 | * Select a subset of the items in the datastore and call | 237 | * Select a subset of the items in the datastore and call |
233 | * the given iterator for each of them. | 238 | * the given iterator for each of them. |
234 | * | 239 | * |
240 | * @param cls our "struct Plugin*" | ||
235 | * @param type entries of which type should be considered? | 241 | * @param type entries of which type should be considered? |
236 | * Use 0 for any type. | 242 | * Use 0 for any type. |
237 | * @param iter function to call on each matching value; | 243 | * @param iter function to call on each matching value; |
@@ -253,6 +259,7 @@ template_plugin_iter_migration_order (void *cls, | |||
253 | * Select a subset of the items in the datastore and call | 259 | * Select a subset of the items in the datastore and call |
254 | * the given iterator for each of them. | 260 | * the given iterator for each of them. |
255 | * | 261 | * |
262 | * @param cls our "struct Plugin*" | ||
256 | * @param type entries of which type should be considered? | 263 | * @param type entries of which type should be considered? |
257 | * Use 0 for any type. | 264 | * Use 0 for any type. |
258 | * @param iter function to call on each matching value; | 265 | * @param iter function to call on each matching value; |
@@ -281,6 +288,9 @@ template_plugin_drop (void *cls) | |||
281 | 288 | ||
282 | /** | 289 | /** |
283 | * Entry point for the plugin. | 290 | * Entry point for the plugin. |
291 | * | ||
292 | * @param cls the "struct GNUNET_DATASTORE_PluginEnvironment*" | ||
293 | * @return our "struct Plugin*" | ||
284 | */ | 294 | */ |
285 | void * | 295 | void * |
286 | libgnunet_plugin_datastore_template_init (void *cls) | 296 | libgnunet_plugin_datastore_template_init (void *cls) |
@@ -312,6 +322,8 @@ libgnunet_plugin_datastore_template_init (void *cls) | |||
312 | 322 | ||
313 | /** | 323 | /** |
314 | * Exit point from the plugin. | 324 | * Exit point from the plugin. |
325 | * @param cls our "struct Plugin*" | ||
326 | * @return always NULL | ||
315 | */ | 327 | */ |
316 | void * | 328 | void * |
317 | libgnunet_plugin_datastore_template_done (void *cls) | 329 | libgnunet_plugin_datastore_template_done (void *cls) |