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

1 files changed, 50 insertions, 16 deletions

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 言語での使用例: