blackbeard420/weechat
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: mention weechat_plugin pointer used by plugin header

Browse Source
This commit is contained in:
Simmo Saan 2017-11-06 18:32:46 +02:00
parent eca8bce3fd
commit d1f530611c
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/en/weechat_plugin_api.en.adoc
View File

@ -41,6 +41,15 @@ The plugin has to include "weechat-plugin.h" file (available in WeeChat source
code).
This file defines structures and types used to communicate with WeeChat.
In order to call WeeChat functions in the format displayed in <<plugin_api>>,
the following global pointer must be declared and initialized in
<<_weechat_plugin_init,weechat_plugin_init>>:
[source,C]
----
struct t_weechat_plugin *weechat_plugin;
----
[[macros]]
=== Macros
@ -83,7 +92,8 @@ int weechat_plugin_init (struct t_weechat_plugin *plugin,
Arguments:
* _plugin_: pointer to WeeChat plugin structure
* _plugin_: pointer to WeeChat plugin structure, used to initialize the
convenience global pointer `weechat_plugin`
* _argc_: number of arguments for plugin (given on command line by user)
* _argv_: arguments for plugin