1
0
mirror of https://github.com/weechat/weechat.git synced 2026-06-27 13:26:38 +02:00

doc: add call to config_get in examples of functions config_<type>(_default) (plugin API reference)

This commit is contained in:
Sebastien Helleu
2012-10-05 22:05:34 +02:00
parent 33d90d75c3
commit 8caeed6c4e
3 changed files with 62 additions and 20 deletions
+22 -8
View File
@@ -4942,6 +4942,7 @@ C example:
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
if (weechat_config_boolean (option))
{
/* value is "true" */
@@ -4960,6 +4961,7 @@ Script (Python):
value = weechat.config_boolean(option)
# example
option = weechat.config_get("plugin.section.option")
if weechat.config_boolean(option):
# ...
----------------------------------------
@@ -4988,6 +4990,7 @@ C example:
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
if (weechat_config_boolean_default (option))
{
/* value is "true" */
@@ -5006,6 +5009,7 @@ Script (Python):
value = weechat.config_boolean_default(option)
# example
option = weechat.config_get("plugin.section.option")
if weechat.config_boolean_default(option):
# ...
----------------------------------------
@@ -5034,6 +5038,7 @@ C example:
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
int value = weechat_config_integer (option);
----------------------------------------
@@ -5045,8 +5050,8 @@ Script (Python):
value = weechat.config_integer(option)
# example
if weechat.config_integer(option):
# ...
option = weechat.config_get("plugin.section.option")
value = weechat.config_integer(option)
----------------------------------------
weechat_config_integer_default
@@ -5073,6 +5078,7 @@ C example:
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
int value = weechat_config_integer_default (option);
----------------------------------------
@@ -5084,8 +5090,8 @@ Script (Python):
value = weechat.config_integer_default(option)
# example
if weechat.config_integer_default(option):
# ...
option = weechat.config_get("plugin.section.option")
value = weechat.config_integer_default(option)
----------------------------------------
weechat_config_string
@@ -5112,6 +5118,7 @@ C example:
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
const char *value = weechat_config_string (option);
----------------------------------------
@@ -5123,7 +5130,8 @@ Script (Python):
value = weechat.config_string(option)
# example
value = weechat.config_string(option):
option = weechat.config_get("plugin.section.option")
value = weechat.config_string(option)
----------------------------------------
weechat_config_string_default
@@ -5150,6 +5158,7 @@ C example:
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
const char *value = weechat_config_string_default (option);
----------------------------------------
@@ -5161,7 +5170,8 @@ Script (Python):
value = weechat.config_string_default(option)
# example
value = weechat.config_string_default(option):
option = weechat.config_get("plugin.section.option")
value = weechat.config_string_default(option)
----------------------------------------
weechat_config_color
@@ -5188,6 +5198,7 @@ C example:
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
const char *color = weechat_config_color (option);
----------------------------------------
@@ -5199,7 +5210,8 @@ Script (Python):
value = weechat.config_color(option)
# example
value = weechat.config_color(option):
option = weechat.config_get("plugin.section.option")
value = weechat.config_color(option)
----------------------------------------
weechat_config_color_default
@@ -5226,6 +5238,7 @@ C example:
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
const char *color = weechat_config_color_default (option);
----------------------------------------
@@ -5237,7 +5250,8 @@ Script (Python):
value = weechat.config_color_default(option)
# example
value = weechat.config_color_default(option):
option = weechat.config_get("plugin.section.option")
value = weechat.config_color_default(option)
----------------------------------------
weechat_config_write_option
+18 -4
View File
@@ -5001,6 +5001,7 @@ Exemple en C :
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
if (weechat_config_boolean (option))
{
/* la valeur est "vrai" */
@@ -5019,6 +5020,7 @@ Script (Python) :
value = weechat.config_boolean(option)
# exemple
option = weechat.config_get("plugin.section.option")
if weechat.config_boolean(option):
# ...
----------------------------------------
@@ -5047,6 +5049,7 @@ Exemple en C :
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
if (weechat_config_boolean_default (option))
{
/* la valeur est "vrai" */
@@ -5065,6 +5068,7 @@ Script (Python) :
value = weechat.config_boolean_default(option)
# exemple
option = weechat.config_get("plugin.section.option")
if weechat.config_boolean_default(option):
# ...
----------------------------------------
@@ -5093,6 +5097,7 @@ Exemple en C :
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
int value = weechat_config_integer (option);
----------------------------------------
@@ -5104,8 +5109,8 @@ Script (Python) :
value = weechat.config_integer(option)
# exemple
if weechat.config_integer(option):
# ...
option = weechat.config_get("plugin.section.option")
value = weechat.config_integer(option)
----------------------------------------
weechat_config_integer_default
@@ -5132,6 +5137,7 @@ Exemple en C :
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
int value = weechat_config_integer_default (option);
----------------------------------------
@@ -5143,8 +5149,8 @@ Script (Python) :
value = weechat.config_integer_default(option)
# exemple
if weechat.config_integer_default(option):
# ...
option = weechat.config_get("plugin.section.option")
value = weechat.config_integer_default(option)
----------------------------------------
weechat_config_string
@@ -5171,6 +5177,7 @@ Exemple en C :
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
const char *value = weechat_config_string (option);
----------------------------------------
@@ -5182,6 +5189,7 @@ Script (Python) :
value = weechat.config_string(option)
# exemple
option = weechat.config_get("plugin.section.option")
value = weechat.config_string(option)
----------------------------------------
@@ -5209,6 +5217,7 @@ Exemple en C :
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
const char *value = weechat_config_string_default (option);
----------------------------------------
@@ -5220,6 +5229,7 @@ Script (Python) :
value = weechat.config_string_default(option)
# exemple
option = weechat.config_get("plugin.section.option")
value = weechat.config_string_default(option)
----------------------------------------
@@ -5247,6 +5257,7 @@ Exemple en C :
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
const char *color = weechat_config_color (option);
----------------------------------------
@@ -5258,6 +5269,7 @@ Script (Python) :
value = weechat.config_color(option)
# exemple
option = weechat.config_get("plugin.section.option")
value = weechat.config_color(option)
----------------------------------------
@@ -5286,6 +5298,7 @@ Exemple en C :
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
const char *color = weechat_config_color_default (option);
----------------------------------------
@@ -5297,6 +5310,7 @@ Script (Python) :
value = weechat.config_color_default(option)
# exemple
option = weechat.config_get("plugin.section.option")
value = weechat.config_color_default(option)
----------------------------------------
+22 -8
View File
@@ -4947,6 +4947,7 @@ Esempio in C:
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
if (weechat_config_boolean (option))
{
/* il valore è "true" */
@@ -4965,6 +4966,7 @@ Script (Python):
value = weechat.config_boolean(option)
# esempio
option = weechat.config_get("plugin.section.option")
if weechat.config_boolean(option):
# ...
----------------------------------------
@@ -4993,6 +4995,7 @@ Esempio in C:
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
if (weechat_config_boolean_default (option))
{
/* il valore è "true" */
@@ -5011,6 +5014,7 @@ Script (Python):
value = weechat.config_boolean_default(option)
# esempio
option = weechat.config_get("plugin.section.option")
if weechat.config_boolean_default(option):
# ...
----------------------------------------
@@ -5039,6 +5043,7 @@ Esempio in C:
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
int value = weechat_config_integer (option);
----------------------------------------
@@ -5050,8 +5055,8 @@ Script (Python):
value = weechat.config_integer(option)
# esempio
if weechat.config_integer(option):
# ...
option = weechat.config_get("plugin.section.option")
value = weechat.config_integer(option)
----------------------------------------
weechat_config_integer_default
@@ -5078,6 +5083,7 @@ Esempio in C:
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
int value = weechat_config_integer_default (option);
----------------------------------------
@@ -5089,8 +5095,8 @@ Script (Python):
value = weechat.config_integer_default(option)
# esempio
if weechat.config_integer_default(option):
# ...
option = weechat.config_get("plugin.section.option")
value = weechat.config_integer_default(option)
----------------------------------------
weechat_config_string
@@ -5117,6 +5123,7 @@ Esempio in C:
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
const char *value = weechat_config_string (option);
----------------------------------------
@@ -5128,7 +5135,8 @@ Script (Python):
value = weechat.config_string(option)
# esempio
value = weechat.config_string(option):
option = weechat.config_get("plugin.section.option")
value = weechat.config_string(option)
----------------------------------------
weechat_config_string_default
@@ -5155,6 +5163,7 @@ Esempio in C:
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
const char *value = weechat_config_string_default (option);
----------------------------------------
@@ -5166,7 +5175,8 @@ Script (Python):
value = weechat.config_string_default(option)
# esempio
value = weechat.config_string_default(option):
option = weechat.config_get("plugin.section.option")
value = weechat.config_string_default(option)
----------------------------------------
weechat_config_color
@@ -5193,6 +5203,7 @@ Esempio in C:
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
const char *color = weechat_config_color (option);
----------------------------------------
@@ -5204,7 +5215,8 @@ Script (Python):
value = weechat.config_color(option)
# esempio
value = weechat.config_color(option):
option = weechat.config_get("plugin.section.option")
value = weechat.config_color(option)
----------------------------------------
weechat_config_color_default
@@ -5231,6 +5243,7 @@ Esempio in C:
[source,C]
----------------------------------------
struct t_config_option *option = weechat_config_get ("plugin.section.option");
const char *color = weechat_config_color_default (option);
----------------------------------------
@@ -5242,7 +5255,8 @@ Script (Python):
value = weechat.config_color_default(option)
# esempio
value = weechat.config_color_default(option):
option = weechat.config_get("plugin.section.option")
value = weechat.config_color_default(option)
----------------------------------------
weechat_config_write_option