[config] add missing documentation

This commit is contained in:
marco candrian 2008-03-28 02:12:55 +01:00 committed by Julien Danjou
parent 0e1dbe40d2
commit 9db8635523
1 changed files with 11 additions and 3 deletions

View File

@ -247,10 +247,10 @@ cfg_opt_t mouse_generic_opts[] =
CFG_STR_LIST((char *) "modkey", (char *) "{}", CFGF_NONE), CFG_STR_LIST((char *) "modkey", (char *) "{}", CFGF_NONE),
/** Mouse button. */ /** Mouse button. */
CFG_STR((char *) "button", (char *) "None", CFGF_NONE), CFG_STR((char *) "button", (char *) "None", CFGF_NONE),
CFG_STR((char *) "command", (char *) "", CFGF_NONE),
/** Uicb command to run. */ /** Uicb command to run. */
CFG_STR((char *) "arg", NULL, CFGF_NONE), CFG_STR((char *) "command", (char *) "", CFGF_NONE),
/** Argument to use for command. */ /** Argument to use for command. */
CFG_STR((char *) "arg", NULL, CFGF_NONE),
CFG_AWESOME_END() CFG_AWESOME_END()
}; };
/** This section defines common widgets options. */ /** This section defines common widgets options. */
@ -339,12 +339,19 @@ cfg_opt_t widget_tasklist_opts[] =
/** This section defines graph data widget options. */ /** This section defines graph data widget options. */
cfg_opt_t widget_graph_data_opts[] = cfg_opt_t widget_graph_data_opts[] =
{ {
/** Value of a full graph. */
CFG_FLOAT((char *) "max", 100.0f, CFGF_NONE), CFG_FLOAT((char *) "max", 100.0f, CFGF_NONE),
/** Scale graph when values are bigger than 'max' */
CFG_BOOL((char *) "scale", cfg_false, CFGF_NONE), CFG_BOOL((char *) "scale", cfg_false, CFGF_NONE),
/** Foreground color. */
CFG_STR((char *) "fg", NULL, CFGF_NONE), CFG_STR((char *) "fg", NULL, CFGF_NONE),
/** Foreground color in the center of the bar (as gradient). */
CFG_STR((char *) "fg_center", NULL, CFGF_NONE), CFG_STR((char *) "fg_center", NULL, CFGF_NONE),
/** Foreground color at the end of a bar (as gradient). */
CFG_STR((char *) "fg_end", NULL, CFGF_NONE), CFG_STR((char *) "fg_end", NULL, CFGF_NONE),
/** fg, fg_center and fg_end defines a vertical gradient */
CFG_BOOL((char *) "vertical_gradient", cfg_false, CFGF_NONE), CFG_BOOL((char *) "vertical_gradient", cfg_false, CFGF_NONE),
/** Draw style. */
CFG_STR((char *) "draw_style", (char *) "bottom", CFGF_NONE), CFG_STR((char *) "draw_style", (char *) "bottom", CFGF_NONE),
CFG_AWESOME_END() CFG_AWESOME_END()
}; };
@ -384,7 +391,7 @@ cfg_opt_t widget_progressbar_data_opts[] =
CFG_STR((char *) "fg_center", NULL, CFGF_NONE), CFG_STR((char *) "fg_center", NULL, CFGF_NONE),
/** Foreground color at the end of a bar (as gradient). */ /** Foreground color at the end of a bar (as gradient). */
CFG_STR((char *) "fg_end", NULL, CFGF_NONE), CFG_STR((char *) "fg_end", NULL, CFGF_NONE),
/** Foreground color of not filled bar. */ /** Foreground color of not filled bar/ticks. */
CFG_STR((char *) "fg_off", NULL, CFGF_NONE), CFG_STR((char *) "fg_off", NULL, CFGF_NONE),
/** Background color. */ /** Background color. */
CFG_STR((char *) "bg", NULL, CFGF_NONE), CFG_STR((char *) "bg", NULL, CFGF_NONE),
@ -409,6 +416,7 @@ cfg_opt_t widget_progressbar_opts[] =
CFG_SEC((char *) "data", widget_progressbar_data_opts, CFGF_TITLE | CFGF_MULTI | CFGF_NO_TITLE_DUPES), CFG_SEC((char *) "data", widget_progressbar_data_opts, CFGF_TITLE | CFGF_MULTI | CFGF_NO_TITLE_DUPES),
/** Widget width. */ /** Widget width. */
CFG_INT((char *) "width", 100, CFGF_NONE), CFG_INT((char *) "width", 100, CFGF_NONE),
/** Distance between individual bars. */
CFG_INT((char *) "gap", 2, CFGF_NONE), CFG_INT((char *) "gap", 2, CFGF_NONE),
/** Border width in pixels. */ /** Border width in pixels. */
CFG_INT((char *) "border_width", 1, CFGF_NONE), CFG_INT((char *) "border_width", 1, CFGF_NONE),