aboutsummaryrefslogtreecommitdiff
path: root/src/datacache/plugin_datacache_template.c
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2009-09-11 11:26:42 +0000
committerChristian Grothoff <christian@grothoff.org>2009-09-11 11:26:42 +0000
commitd0efe84c15166730f5ee3f7af74ca428ae37f7ff (patch)
tree493c44dae4e15c28db8e349e07d3c416b3340e0c /src/datacache/plugin_datacache_template.c
parentfa9d1957520372ba3575296f1edb53f48fe2b000 (diff)
downloadgnunet-d0efe84c15166730f5ee3f7af74ca428ae37f7ff.tar.gz
gnunet-d0efe84c15166730f5ee3f7af74ca428ae37f7ff.zip
fixing docu issues
Diffstat (limited to 'src/datacache/plugin_datacache_template.c')
-rw-r--r--src/datacache/plugin_datacache_template.c10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/datacache/plugin_datacache_template.c b/src/datacache/plugin_datacache_template.c
index 501284c30..163f72a7a 100644
--- a/src/datacache/plugin_datacache_template.c
+++ b/src/datacache/plugin_datacache_template.c
@@ -43,6 +43,7 @@ struct Plugin
43/** 43/**
44 * Store an item in the datastore. 44 * Store an item in the datastore.
45 * 45 *
46 * @param cls closure (our "struct Plugin")
46 * @param key key to store data under 47 * @param key key to store data under
47 * @param size number of bytes in data 48 * @param size number of bytes in data
48 * @param data data to store 49 * @param data data to store
@@ -67,9 +68,11 @@ template_plugin_put (void *cls,
67 * Iterate over the results for a particular key 68 * Iterate over the results for a particular key
68 * in the datastore. 69 * in the datastore.
69 * 70 *
71 * @param cls closure (our "struct Plugin")
70 * @param key 72 * @param key
71 * @param type entries of which type are relevant? 73 * @param type entries of which type are relevant?
72 * @param iter maybe NULL (to just count) 74 * @param iter maybe NULL (to just count)
75 * @param iter_cls closure for iter
73 * @return the number of results found 76 * @return the number of results found
74 */ 77 */
75static unsigned int 78static unsigned int
@@ -88,6 +91,7 @@ template_plugin_get (void *cls,
88 * Delete the entry with the lowest expiration value 91 * Delete the entry with the lowest expiration value
89 * from the datacache right now. 92 * from the datacache right now.
90 * 93 *
94 * @param cls closure (our "struct Plugin")
91 * @return GNUNET_OK on success, GNUNET_SYSERR on error 95 * @return GNUNET_OK on success, GNUNET_SYSERR on error
92 */ 96 */
93static int 97static int
@@ -100,6 +104,9 @@ template_plugin_del (void *cls)
100 104
101/** 105/**
102 * Entry point for the plugin. 106 * Entry point for the plugin.
107 *
108 * @param cls closure (the "struct GNUNET_DATACACHE_PluginEnvironmnet")
109 * @return the plugin's closure (our "struct Plugin")
103 */ 110 */
104void * 111void *
105libgnunet_plugin_datacache_template_init (void *cls) 112libgnunet_plugin_datacache_template_init (void *cls)
@@ -123,6 +130,9 @@ libgnunet_plugin_datacache_template_init (void *cls)
123 130
124/** 131/**
125 * Exit point from the plugin. 132 * Exit point from the plugin.
133 *
134 * @param cls closure (our "struct Plugin")
135 * @return NULL
126 */ 136 */
127void * 137void *
128libgnunet_plugin_datacache_template_done (void *cls) 138libgnunet_plugin_datacache_template_done (void *cls)