diff options
author | Christian Grothoff <christian@grothoff.org> | 2009-09-25 22:10:51 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2009-09-25 22:10:51 +0000 |
commit | f1b9c5c115139b02cac1cae4f053792e1e5b1ccb (patch) | |
tree | cd9047d73ba498d05f67c7e06ae4bd5ed89511e7 /src/include/gnunet_plugin_lib.h | |
parent | c2d3d24cd9b4f552d7ca8ad6283f9819c1cfefc7 (diff) | |
download | gnunet-f1b9c5c115139b02cac1cae4f053792e1e5b1ccb.tar.gz gnunet-f1b9c5c115139b02cac1cae4f053792e1e5b1ccb.zip |
improving style and docs
Diffstat (limited to 'src/include/gnunet_plugin_lib.h')
-rw-r--r-- | src/include/gnunet_plugin_lib.h | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/src/include/gnunet_plugin_lib.h b/src/include/gnunet_plugin_lib.h index e4f603c4e..b8c7b99fe 100644 --- a/src/include/gnunet_plugin_lib.h +++ b/src/include/gnunet_plugin_lib.h | |||
@@ -41,6 +41,11 @@ extern "C" | |||
41 | 41 | ||
42 | /** | 42 | /** |
43 | * Signature of any function exported by a plugin. | 43 | * Signature of any function exported by a plugin. |
44 | * | ||
45 | * @param arg argument to the function (context) | ||
46 | * @return some pointer, NULL if the plugin was | ||
47 | * shutdown or if there was an error, otherwise | ||
48 | * the plugin's API on success | ||
44 | */ | 49 | */ |
45 | typedef void *(*GNUNET_PLUGIN_Callback) (void *arg); | 50 | typedef void *(*GNUNET_PLUGIN_Callback) (void *arg); |
46 | 51 | ||
@@ -55,7 +60,7 @@ typedef void *(*GNUNET_PLUGIN_Callback) (void *arg); | |||
55 | * | 60 | * |
56 | * @param library_name name of the plugin to load | 61 | * @param library_name name of the plugin to load |
57 | * @param arg argument to the plugin initialization function | 62 | * @param arg argument to the plugin initialization function |
58 | * @return whatever the initialization function returned | 63 | * @return whatever the initialization function returned, NULL on error |
59 | */ | 64 | */ |
60 | void *GNUNET_PLUGIN_load (const char *library_name, void *arg); | 65 | void *GNUNET_PLUGIN_load (const char *library_name, void *arg); |
61 | 66 | ||
@@ -66,7 +71,8 @@ void *GNUNET_PLUGIN_load (const char *library_name, void *arg); | |||
66 | * | 71 | * |
67 | * @param library_name name of the plugin to unload | 72 | * @param library_name name of the plugin to unload |
68 | * @param arg argument to the plugin shutdown function | 73 | * @param arg argument to the plugin shutdown function |
69 | * @return whatever the shutdown function returned | 74 | * @return whatever the shutdown function returned, typically NULL |
75 | * or a "char *" representing the error message | ||
70 | */ | 76 | */ |
71 | void *GNUNET_PLUGIN_unload (const char *library_name, void *arg); | 77 | void *GNUNET_PLUGIN_unload (const char *library_name, void *arg); |
72 | 78 | ||