diff options
author | Trygve Aaberge <trygveaa@gmail.com> | 2022-10-22 12:30:04 +0200 |
---|---|---|
committer | Sébastien Helleu <flashcode@flashtux.org> | 2022-12-11 15:33:11 +0100 |
commit | abdabb3ae46061c00e4cd975710e6415672fd8cb (patch) | |
tree | 9eea29f1f1824df3a878caf1429b69efc71a4bbf /doc | |
parent | a1b6d9622f65ab2e83fabd518805ef6d263ceb06 (diff) | |
download | weechat-abdabb3ae46061c00e4cd975710e6415672fd8cb.zip |
doc/api: Fix return values for callback_read in config_new_section
These return values were wrong in the description and C example. As can
be seen on lines 2835 and 2873-2903 of src/core/wee-config-file.c the
callback_read function should return the same as the function
config_file_option_set plus the value
WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND (which is also the same as
the possible return values of config_file_option_set_with_string).
The Python example was already correct and the C example was already
correct in the other languages apart from English.
These errors were introduced in commit 02e2b21d3 and commit 5210ff1ae.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/en/weechat_plugin_api.en.adoc | 14 | ||||
-rw-r--r-- | doc/fr/weechat_plugin_api.fr.adoc | 7 | ||||
-rw-r--r-- | doc/it/weechat_plugin_api.it.adoc | 7 | ||||
-rw-r--r-- | doc/ja/weechat_plugin_api.ja.adoc | 7 | ||||
-rw-r--r-- | doc/sr/weechat_plugin_api.sr.adoc | 7 |
5 files changed, 24 insertions, 18 deletions
diff --git a/doc/en/weechat_plugin_api.en.adoc b/doc/en/weechat_plugin_api.en.adoc index 5475efa8b..bf477304b 100644 --- a/doc/en/weechat_plugin_api.en.adoc +++ b/doc/en/weechat_plugin_api.en.adoc @@ -6264,9 +6264,10 @@ Arguments: ** _const char *option_name_: name of option ** _const char *value_: value ** return value: -*** _WEECHAT_CONFIG_READ_OK_ -*** _WEECHAT_CONFIG_READ_MEMORY_ERROR_ -*** _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ +*** _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ +*** _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ +*** _WEECHAT_CONFIG_OPTION_SET_ERROR_ +*** _WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND_ * _callback_read_pointer_: pointer given to callback when it is called by WeeChat * _callback_read_data_: pointer given to callback when it is called by WeeChat; @@ -6359,9 +6360,10 @@ my_section_read_cb (const void *pointer, void *data, { /* ... */ - return WEECHAT_CONFIG_READ_OK; - /* return WEECHAT_CONFIG_READ_MEMORY_ERROR; */ - /* return WEECHAT_CONFIG_READ_FILE_NOT_FOUND; */ + return WEECHAT_CONFIG_OPTION_SET_OK_CHANGED; + /* return WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE; */ + /* return WEECHAT_CONFIG_OPTION_SET_ERROR; */ + /* return WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND; */ } int diff --git a/doc/fr/weechat_plugin_api.fr.adoc b/doc/fr/weechat_plugin_api.fr.adoc index 0f8a4c7de..919f56c33 100644 --- a/doc/fr/weechat_plugin_api.fr.adoc +++ b/doc/fr/weechat_plugin_api.fr.adoc @@ -6362,9 +6362,10 @@ Paramètres : ** _const char *option_name_ : nom de l'option ** _const char *value_ : valeur ** valeur de retour : -*** _WEECHAT_CONFIG_READ_OK_ -*** _WEECHAT_CONFIG_READ_MEMORY_ERROR_ -*** _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ +*** _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ +*** _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ +*** _WEECHAT_CONFIG_OPTION_SET_ERROR_ +*** _WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND_ * _callback_read_pointer_ : pointeur donné à la fonction de rappel lorsqu'elle est appelée par WeeChat * _callback_read_data_ : pointeur donné à la fonction de rappel lorsqu'elle est diff --git a/doc/it/weechat_plugin_api.it.adoc b/doc/it/weechat_plugin_api.it.adoc index 52bc4cc66..6661153db 100644 --- a/doc/it/weechat_plugin_api.it.adoc +++ b/doc/it/weechat_plugin_api.it.adoc @@ -6500,9 +6500,10 @@ Argomenti: ** _const char *option_name_: nome dell'opzione ** _const char *value_: valore ** valore restituito: -*** _WEECHAT_CONFIG_READ_OK_ -*** _WEECHAT_CONFIG_READ_MEMORY_ERROR_ -*** _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ +*** _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ +*** _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ +*** _WEECHAT_CONFIG_OPTION_SET_ERROR_ +*** _WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND_ * _callback_read_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING diff --git a/doc/ja/weechat_plugin_api.ja.adoc b/doc/ja/weechat_plugin_api.ja.adoc index 045f58639..809730543 100644 --- a/doc/ja/weechat_plugin_api.ja.adoc +++ b/doc/ja/weechat_plugin_api.ja.adoc @@ -6308,9 +6308,10 @@ struct t_config_section *weechat_config_new_section ( ** _const char *option_name_: オプションの名前 ** _const char *value_: 値 ** 戻り値: -*** _WEECHAT_CONFIG_READ_OK_ -*** _WEECHAT_CONFIG_READ_MEMORY_ERROR_ -*** _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ +*** _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ +*** _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ +*** _WEECHAT_CONFIG_OPTION_SET_ERROR_ +*** _WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND_ * _callback_read_pointer_: WeeChat が _callback_read_ コールバックを呼び出す際にコールバックに渡すポインタ * _callback_read_data_: WeeChat が _callback_read_ コールバックを呼び出す際にコールバックに渡すポインタ; diff --git a/doc/sr/weechat_plugin_api.sr.adoc b/doc/sr/weechat_plugin_api.sr.adoc index d4e15f088..9c353049f 100644 --- a/doc/sr/weechat_plugin_api.sr.adoc +++ b/doc/sr/weechat_plugin_api.sr.adoc @@ -6099,9 +6099,10 @@ struct t_config_section *weechat_config_new_section ( ** _const char *option_name_: име опције ** _const char *value_: вредност ** повратна вредност: -*** _WEECHAT_CONFIG_READ_OK_ -*** _WEECHAT_CONFIG_READ_MEMORY_ERROR_ -*** _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ +*** _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ +*** _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ +*** _WEECHAT_CONFIG_OPTION_SET_ERROR_ +*** _WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND_ * _callback_read_pointer_: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat * _callback_read_data_: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се ослободи одељак * _callback_write_: функција која се позива када се одељак уписује у фајл (у већини случајева би требало да буде NULL, осим ако је потребно да се одељак упише прилагођеном функцијом), аргументи и повратна вредност су: |