doc: describe return code according to option type in config functions (plugin API reference)

4 files changed, 184 insertions, 65 deletions

diff --git a/doc/en/weechat_plugin_api.en.asciidoc b/doc/en/weechat_plugin_api.en.asciidoc
index 677b904f3..7212082ec 100644
--- a/doc/en/weechat_plugin_api.en.asciidoc
+++ b/doc/en/weechat_plugin_api.en.asciidoc
@@ -5522,9 +5522,12 @@ Arguments:
 
 * 'option': option pointer
 
-Return value:
+Return value, depending on the option type:
 
-* boolean value of option (0 or 1)
+* 'boolean': boolean value of option (0 or 1)
+* 'integer': 0
+* 'string': 0
+* 'color': 0
 
 C example:
 
@@ -5569,9 +5572,12 @@ Arguments:
 
 * 'option': option pointer
 
-Return value:
+Return value, depending on the option type:
 
-* default boolean value of option (0 or 1)
+* 'boolean': default boolean value of option (0 or 1)
+* 'integer': 0
+* 'string': 0
+* 'color': 0
 
 C example:
 
@@ -5616,9 +5622,12 @@ Arguments:
 
 * 'option': option pointer
 
-Return value:
+Return value, depending on the option type:
 
-* integer value of option
+* 'boolean': boolean value of option (0 or 1)
+* 'integer': integer value of option
+* 'string': 0
+* 'color': color index
 
 C example:
 
@@ -5655,9 +5664,12 @@ Arguments:
 
 * 'option': option pointer
 
-Return value:
+Return value, depending on the option type:
 
-* default integer value of option
+* 'boolean': default boolean value of option (0 or 1)
+* 'integer': default integer value of option
+* 'string': 0
+* 'color': default color index
 
 C example:
 
@@ -5694,9 +5706,13 @@ Arguments:
 
 * 'option': option pointer
 
-Return value:
+Return value, depending on the option type:
 
-* string value of option
+* 'boolean': "on" if value is true, otherwise "off"
+* 'integer': string value if the option is an integer with string values,
+  otherwise NULL
+* 'string': string value of option
+* 'color': name of color
 
 C example:
 
@@ -5733,9 +5749,13 @@ Arguments:
 
 * 'option': option pointer
 
-Return value:
+Return value, depending on the option type:
 
-* default string value of option
+* 'boolean': "on" if default value is true, otherwise "off"
+* 'integer': default string value if the option is an integer with string
+  values, otherwise NULL
+* 'string': default string value of option
+* 'color': name of default color
 
 C example:
 
@@ -5772,9 +5792,12 @@ Arguments:
 
 * 'option': option pointer
 
-Return value:
+Return value, depending on the option type:
 
-* color value of option (string with name of color)
+* 'boolean': NULL
+* 'integer': NULL
+* 'string': NULL
+* 'color': name of color
 
 C example:
 
@@ -5811,9 +5834,12 @@ Arguments:
 
 * 'option': option pointer
 
-Return value:
+Return value, depending on the option type:
 
-* default color value of option (string with name of color)
+* 'boolean': NULL
+* 'integer': NULL
+* 'string': NULL
+* 'color': name of default color
 
 C example:
 
diff --git a/doc/fr/weechat_plugin_api.fr.asciidoc b/doc/fr/weechat_plugin_api.fr.asciidoc
index 88e76ac45..9dbee3f0f 100644
--- a/doc/fr/weechat_plugin_api.fr.asciidoc
+++ b/doc/fr/weechat_plugin_api.fr.asciidoc
@@ -5617,9 +5617,12 @@ Paramètres :
 
 * 'option' : pointeur vers l'option
 
-Valeur de retour :
+Valeur de retour, selon le type de l'option :
 
-* valeur booléenne de l'option (0 ou 1)
+* 'boolean' : valeur booléenne de l'option (0 ou 1)
+* 'integer' : 0
+* 'string' : 0
+* 'color' : 0
 
 Exemple en C :
 
@@ -5664,9 +5667,12 @@ Paramètres :
 
 * 'option' : pointeur vers l'option
 
-Valeur de retour :
+Valeur de retour, selon le type de l'option :
 
-* valeur booléenne par défaut de l'option (0 ou 1)
+* 'boolean' : valeur booléenne par défaut de l'option (0 ou 1)
+* 'integer' : 0
+* 'string' : 0
+* 'color' : 0
 
 Exemple en C :
 
@@ -5711,9 +5717,12 @@ Paramètres :
 
 * 'option' : pointeur vers l'option
 
-Valeur de retour :
+Valeur de retour, selon le type de l'option :
 
-* valeur entière de l'option
+* 'boolean' : valeur booléenne de l'option (0 ou 1)
+* 'integer' : valeur entière de l'option
+* 'string' : 0
+* 'color' : index de la couleur
 
 Exemple en C :
 
@@ -5750,9 +5759,12 @@ Paramètres :
 
 * 'option' : pointeur vers l'option
 
-Valeur de retour :
+Valeur de retour, selon le type de l'option :
 
-* valeur entière par défaut de l'option
+* 'boolean' : valeur booléenne par défaut de l'option (0 ou 1)
+* 'integer' : valeur entière par défaut de l'option
+* 'string' : 0
+* 'color' : index de la couleur par défaut
 
 Exemple en C :
 
@@ -5789,9 +5801,13 @@ Paramètres :
 
 * 'option' : pointeur vers l'option
 
-Valeur de retour :
+Valeur de retour, selon le type de l'option :
 
-* valeur de l'option, sous forme de chaîne
+* 'boolean' : "on" si la valeur est vraie, sinon "off"
+* 'integer' : valeur de l'option sous forme de chaîne si l'option est un entier
+  avec des valeurs sous forme de chaînes, sinon NULL
+* 'string' : valeur de l'option sous forme de chaîne
+* 'color' : nom de la couleur
 
 Exemple en C :
 
@@ -5828,9 +5844,13 @@ Paramètres :
 
 * 'option' : pointeur vers l'option
 
-Valeur de retour :
+Valeur de retour, selon le type de l'option :
 
-* valeur par défaut de l'option, sous forme de chaîne
+* 'boolean' : "on" si la valeur par défaut est vraie, sinon "off"
+* 'integer' : valeur par défaut de l'option sous forme de chaîne si l'option
+  est un entier avec des valeurs sous forme de chaînes, sinon NULL
+* 'string' : valeur par défaut de l'option sous forme de chaîne
+* 'color' : nom de la couleur par défaut
 
 Exemple en C :
 
@@ -5867,9 +5887,12 @@ Paramètres :
 
 * 'option' : pointeur vers l'option
 
-Valeur de retour :
+Valeur de retour, selon le type de l'option :
 
-* valeur de l'option sous forme de couleur (chaîne avec le nom de la couleur)
+* 'boolean' : NULL
+* 'integer' : NULL
+* 'string' : NULL
+* 'color' : nom de la couleur
 
 Exemple en C :
 
@@ -5906,10 +5929,12 @@ Paramètres :
 
 * 'option' : pointeur vers l'option
 
-Valeur de retour :
+Valeur de retour, selon le type de l'option :
 
-* valeur par défaut de l'option sous forme de couleur (chaîne avec le nom de la
-  couleur)
+* 'boolean' : NULL
+* 'integer' : NULL
+* 'string' : NULL
+* 'color' : nom de la couleur par défaut
 
 Exemple en C :
 
diff --git a/doc/it/weechat_plugin_api.it.asciidoc b/doc/it/weechat_plugin_api.it.asciidoc
index 3734d896d..641303e62 100644
--- a/doc/it/weechat_plugin_api.it.asciidoc
+++ b/doc/it/weechat_plugin_api.it.asciidoc
@@ -5672,9 +5672,13 @@ Argomenti:
 
 * 'option': puntatore all'opzione
 
-Valore restituito:
+// TRANSLATION MISSING
+Return value, depending on the option type:
 
-* valore bool di un'opzione (0 o 1)
+* 'boolean': boolean value of option (0 or 1)
+* 'integer': 0
+* 'string': 0
+* 'color': 0
 
 Esempio in C:
 
@@ -5719,9 +5723,13 @@ Argomenti:
 
 * 'option': puntatore all'opzione
 
-Valore restituito:
+// TRANSLATION MISSING
+Return value, depending on the option type:
 
-* il valore bool predefinito di un'opzione (0 o 1)
+* 'boolean': default boolean value of option (0 or 1)
+* 'integer': 0
+* 'string': 0
+* 'color': 0
 
 Esempio in C:
 
@@ -5766,9 +5774,13 @@ Argomenti:
 
 * 'option': puntatore all'opzione
 
-Valore restituito:
+// TRANSLATION MISSING
+Return value, depending on the option type:
 
-* valore intero di un'opzione
+* 'boolean': boolean value of option (0 or 1)
+* 'integer': integer value of option
+* 'string': 0
+* 'color': color index
 
 Esempio in C:
 
@@ -5805,9 +5817,13 @@ Argomenti:
 
 * 'option': puntatore all'opzione
 
-Valore restituito:
+// TRANSLATION MISSING
+Return value, depending on the option type:
 
-* valore intero predefinito di un'opzione
+* 'boolean': default boolean value of option (0 or 1)
+* 'integer': default integer value of option
+* 'string': 0
+* 'color': default color index
 
 Esempio in C:
 
@@ -5844,9 +5860,14 @@ Argomenti:
 
 * 'option': puntatore all'opzione
 
-Valore restituito:
+// TRANSLATION MISSING
+Return value, depending on the option type:
 
-* valore stringa di un'opzione
+* 'boolean': "on" if value is true, otherwise "off"
+* 'integer': string value if the option is an integer with string values,
+  otherwise NULL
+* 'string': string value of option
+* 'color': name of color
 
 Esempio in C:
 
@@ -5883,9 +5904,14 @@ Argomenti:
 
 * 'option': puntatore all'opzione
 
-Valore restituito:
+// TRANSLATION MISSING
+Return value, depending on the option type:
 
-* valore stringa predefinito di un'opzione
+* 'boolean': "on" if default value is true, otherwise "off"
+* 'integer': default string value if the option is an integer with string
+  values, otherwise NULL
+* 'string': default string value of option
+* 'color': name of default color
 
 Esempio in C:
 
@@ -5922,9 +5948,13 @@ Argomenti:
 
 * 'option': puntatore all'opzione
 
-Valore restituito:
+// TRANSLATION MISSING
+Return value, depending on the option type:
 
-* valore colore dell'opzione (stringa con il nome del colore)
+* 'boolean': NULL
+* 'integer': NULL
+* 'string': NULL
+* 'color': name of color
 
 Esempio in C:
 
@@ -5961,9 +5991,13 @@ Argomenti:
 
 * 'option': puntatore all'opzione
 
-Valore restituito:
+// TRANSLATION MISSING
+Return value, depending on the option type:
 
-* valore colore predefinito di un'opzione (stringa con il nome del colore)
+* 'boolean': NULL
+* 'integer': NULL
+* 'string': NULL
+* 'color': name of default color
 
 Esempio in C:
 
diff --git a/doc/ja/weechat_plugin_api.ja.asciidoc b/doc/ja/weechat_plugin_api.ja.asciidoc
index dfdd77b66..f49bc415f 100644
--- a/doc/ja/weechat_plugin_api.ja.asciidoc
+++ b/doc/ja/weechat_plugin_api.ja.asciidoc
@@ -5522,9 +5522,13 @@ int weechat_config_boolean (struct t_config_option *option);
 
 * 'option': オプションへのポインタ
 
-戻り値:
+// TRANSLATION MISSING
+Return value, depending on the option type:
 
-* オプションのブール値 (0 または 1)
+* 'boolean': boolean value of option (0 or 1)
+* 'integer': 0
+* 'string': 0
+* 'color': 0
 
 C 言語での使用例:
 
@@ -5569,9 +5573,13 @@ int weechat_config_boolean_default (struct t_config_option *option);
 
 * 'option': オプションへのポインタ
 
-戻り値:
+// TRANSLATION MISSING
+Return value, depending on the option type:
 
-* オプションのデフォルトブール値 (0 または 1)
+* 'boolean': default boolean value of option (0 or 1)
+* 'integer': 0
+* 'string': 0
+* 'color': 0
 
 C 言語での使用例:
 
@@ -5616,9 +5624,13 @@ int weechat_config_integer (struct t_config_option *option);
 
 * 'option': オプションへのポインタ
 
-戻り値:
+// TRANSLATION MISSING
+Return value, depending on the option type:
 
-* オプションの整数値
+* 'boolean': boolean value of option (0 or 1)
+* 'integer': integer value of option
+* 'string': 0
+* 'color': color index
 
 C 言語での使用例:
 
@@ -5655,9 +5667,13 @@ int weechat_config_integer_default (struct t_config_option *option);
 
 * 'option': オプションへのポインタ
 
-戻り値:
+// TRANSLATION MISSING
+Return value, depending on the option type:
 
-* オプションのデフォルト整数値
+* 'boolean': default boolean value of option (0 or 1)
+* 'integer': default integer value of option
+* 'string': 0
+* 'color': default color index
 
 C 言語での使用例:
 
@@ -5694,9 +5710,14 @@ const char *weechat_config_string (struct t_config_option *option);
 
 * 'option': オプションへのポインタ
 
-戻り値:
+// TRANSLATION MISSING
+Return value, depending on the option type:
 
-* オプションの文字列値
+* 'boolean': "on" if value is true, otherwise "off"
+* 'integer': string value if the option is an integer with string values,
+  otherwise NULL
+* 'string': string value of option
+* 'color': name of color
 
 C 言語での使用例:
 
@@ -5733,9 +5754,14 @@ const char *weechat_config_string_default (struct t_config_option *option);
 
 * 'option': オプションへのポインタ
 
-戻り値:
+// TRANSLATION MISSING
+Return value, depending on the option type:
 
-* オプションのデフォルト文字列値
+* 'boolean': "on" if default value is true, otherwise "off"
+* 'integer': default string value if the option is an integer with string
+  values, otherwise NULL
+* 'string': default string value of option
+* 'color': name of default color
 
 C 言語での使用例:
 
@@ -5772,9 +5798,13 @@ const char *weechat_config_color (struct t_config_option *option);
 
 * 'option': オプションへのポインタ
 
-戻り値:
+// TRANSLATION MISSING
+Return value, depending on the option type:
 
-* オプションの色値 (色の名前を収めた文字列)
+* 'boolean': NULL
+* 'integer': NULL
+* 'string': NULL
+* 'color': name of color
 
 C 言語での使用例:
 
@@ -5811,9 +5841,13 @@ const char *weechat_config_color_default (struct t_config_option *option);
 
 * 'option': オプションへのポインタ
 
-戻り値:
+// TRANSLATION MISSING
+Return value, depending on the option type:
 
-* オプションのデフォルト色値 (色の名前を収めた文字列)
+* 'boolean': NULL
+* 'integer': NULL
+* 'string': NULL
+* 'color': name of default color
 
 C 言語での使用例: