summaryrefslogtreecommitdiff
path: root/doc/en/weechat_plugin_api.en.adoc
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2017-05-10 20:24:17 +0200
committerSébastien Helleu <flashcode@flashtux.org>2017-05-10 20:24:17 +0200
commit93361c95d23a8a87c5d648b8a40d4aa6000645b1 (patch)
tree27420a7dd5dae9710277433e76e9b8bcf31b458c /doc/en/weechat_plugin_api.en.adoc
parent36187a240a488fbc06bde997a4c7bb2a9fbf295e (diff)
downloadweechat-93361c95d23a8a87c5d648b8a40d4aa6000645b1.zip
doc: move note in function hook_command_run (plugin API reference)
Diffstat (limited to 'doc/en/weechat_plugin_api.en.adoc')
-rw-r--r--doc/en/weechat_plugin_api.en.adoc6
1 files changed, 1 insertions, 5 deletions
diff --git a/doc/en/weechat_plugin_api.en.adoc b/doc/en/weechat_plugin_api.en.adoc
index c55080a33..5584571d2 100644
--- a/doc/en/weechat_plugin_api.en.adoc
+++ b/doc/en/weechat_plugin_api.en.adoc
@@ -8104,17 +8104,13 @@ Arguments:
** _const char *command_: the command executed, with its arguments
** return value:
*** _WEECHAT_RC_OK_
-*** _WEECHAT_RC_OK_EAT_
+*** _WEECHAT_RC_OK_EAT_: command will not be executed by WeeChat after callback
*** _WEECHAT_RC_ERROR_
* _callback_pointer_: pointer given to callback when it is called by WeeChat
* _callback_data_: pointer given to callback when it is called by WeeChat;
if not NULL, it must have been allocated with malloc (or similar function)
and it is automatically freed when the hook is deleted
-[NOTE]
-Callback can return _WEECHAT_RC_OK_ or _WEECHAT_RC_OK_EAT_ (command will not
-be executed by WeeChat after callback).
-
Return value:
* pointer to new hook, NULL if error occurred