1
0
mirror of https://github.com/weechat/weechat.git synced 2026-06-28 05:46:38 +02:00

doc: add function "register" in the plugin API reference

This commit is contained in:
Sébastien Helleu
2019-07-11 21:12:33 +02:00
parent c463b84421
commit f6bc6fec2e
4 changed files with 96 additions and 0 deletions
+23
View File
@@ -273,6 +273,29 @@ For each function, we give:
* C example,
* example in Python script (syntax for other scripting languages is similar).
[[registering]]
=== Registering
Functions to register a script: used only by scripting API, not the C API.
==== register
Register the script.
For more information, see the
link:weechat_scripting.en.html#register_function[WeeChat scripting guide].
Script (Python):
[source,python]
----
# prototype
weechat.register(name, author, version, license, description, shutdown_function, charset)
----
[NOTE]
This function is not available in the C API.
[[plugins]]
=== Plugins
+25
View File
@@ -280,6 +280,31 @@ Pour chaque fonction, on donne :
* un exemple en script Python (la syntaxe pour les autres langages de script est
similaire).
// TRANSLATION MISSING
[[registering]]
=== Enregistrement
Functions pour enregistrer un script : utilisées seulement par l'API script,
pas l'API C.
==== register
Enregistrer le script.
Pour plus d'informations, voir le
link:weechat_scripting.fr.html#register_function[Guide pour scripts WeeChat].
Script (Python) :
[source,python]
----
# prototype
weechat.register(name, author, version, license, description, shutdown_function, charset)
----
[NOTE]
Cette fonction n'est pas disponible dans l'API C.
[[plugins]]
=== Extensions
+24
View File
@@ -294,6 +294,30 @@ Per ogni funzione, viene fornita:
* esempio nello script Python (la sintassi è simile per gli altri linguaggi di
scripting).
// TRANSLATION MISSING
[[registering]]
=== Registering
Functions to register a script: used only by scripting API, not the C API.
==== register
Register the script.
For more information, see the
link:weechat_scripting.it.html#register_function[WeeChat scripting guide].
Script (Python):
[source,python]
----
# prototype
weechat.register(name, author, version, license, description, shutdown_function, charset)
----
[NOTE]
This function is not available in the C API.
[[plugins]]
=== Plugin
+24
View File
@@ -281,6 +281,30 @@ weechat_plugin_end (struct t_weechat_plugin *plugin)
* C 言語での使用例、
* Python スクリプトでの使用例 (他のスクリプト言語を使う場合も文法は似ています)。
// TRANSLATION MISSING
[[registering]]
=== Registering
Functions to register a script: used only by scripting API, not the C API.
==== register
Register the script.
For more information, see the
link:weechat_scripting.ja.html#register_function[WeeChat scripting guide].
スクリプト (Python) での使用例:
[source,python]
----
# プロトタイプ
weechat.register(name, author, version, license, description, shutdown_function, charset)
----
[NOTE]
This function is not available in the C API.
[[plugins]]
=== プラグイン