Code

plugin: fix plugin_callback_t documentation
authorJonathan Neuschäfer <j.neuschaefer@gmx.net>
Sun, 21 Aug 2011 22:19:14 +0000 (00:19 +0200)
committerJonathan Neuschäfer <j.neuschaefer@gmx.net>
Mon, 29 Aug 2011 20:48:32 +0000 (22:48 +0200)
src/plugin.h

index d82fc7387d3486c03ab722b2504c00c84988316a..5e216bc5513d69a2c7d2a3dbee320f0b79f3a148 100644 (file)
@@ -38,8 +38,8 @@ struct plugin_list {
  * messages on failure as determined by success
  * @param success result of the plugin cycle; true if result is meaningful
  * output, false if result contains error messages
- * @param plugin_name the name of the plugin which succeeded; may become invalid
- * once the callback returns (i.e. strdup it if you need it afterwards).
+ * @param plugin_name the name of the plugin which succeeded; becomes invalid
+ * when plugin_stop is called (i.e. strdup it if you need it afterwards).
  * @param data the caller defined pointer passed to plugin_run()
  */
 typedef void (*plugin_callback_t)(const GString *result, const bool success,