brl/gnome-shell
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

St: minor gtk-doc fixage (%NULL, %TRUE, %FALSE, not #)

Browse Source
This commit is contained in:
Dan Winship 2010-03-23 19:56:10 -04:00
parent aefa8af60e
commit 23e11175f8
5 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/st/st-box-layout.c
View File

@ -1172,7 +1172,7 @@ st_box_layout_new (void)
/**
* st_box_layout_set_vertical:
* @box: A #StBoxLayout
* @vertical: #TRUE if the layout should be vertical
* @vertical: %TRUE if the layout should be vertical
*
* Set the value of the #StBoxLayout::vertical property
*
@ -1198,7 +1198,7 @@ st_box_layout_set_vertical (StBoxLayout *box,
*
* Get the value of the #StBoxLayout::vertical property.
*
* Returns: #TRUE if the layout is vertical
* Returns: %TRUE if the layout is vertical
*/
gboolean
st_box_layout_get_vertical (StBoxLayout *box)
@ -1211,7 +1211,7 @@ st_box_layout_get_vertical (StBoxLayout *box)
/**
* st_box_layout_set_pack_start:
* @box: A #StBoxLayout
* @pack_start: #TRUE if the layout should use pack-start
* @pack_start: %TRUE if the layout should use pack-start
*
* Set the value of the #StBoxLayout::pack-start property.
*
@ -1237,7 +1237,7 @@ st_box_layout_set_pack_start (StBoxLayout *box,
*
* Get the value of the #StBoxLayout::pack-start property.
*
* Returns: #TRUE if pack-start is enabled
* Returns: %TRUE if pack-start is enabled
*/
gboolean
st_box_layout_get_pack_start (StBoxLayout *box)

10
src/st/st-button.c
View File

@ -494,7 +494,7 @@ st_button_set_label (StButton *button,
*
* Get the toggle mode status of the button.
*
* Returns: #TRUE if toggle mode is set, otherwise #FALSE
* Returns: %TRUE if toggle mode is set, otherwise %FALSE
*/
gboolean
st_button_get_toggle_mode (StButton *button)
@ -507,7 +507,7 @@ st_button_get_toggle_mode (StButton *button)
/**
* st_button_set_toggle_mode:
* @button: a #Stbutton
* @toggle: #TRUE or #FALSE
* @toggle: %TRUE or %FALSE
*
* Enables or disables toggle mode for the button. In toggle mode, the active
* state will be "toggled" when the user clicks the button.
@ -529,7 +529,7 @@ st_button_set_toggle_mode (StButton *button,
*
* Get the state of the button that is in toggle mode.
*
* Returns: #TRUE if the button is checked, or #FALSE if not
* Returns: %TRUE if the button is checked, or %FALSE if not
*/
gboolean
st_button_get_checked (StButton *button)
@ -542,10 +542,10 @@ st_button_get_checked (StButton *button)
/**
* st_button_set_checked:
* @button: a #Stbutton
* @checked: #TRUE or #FALSE
* @checked: %TRUE or %FALSE
*
* Sets the pressed state of the button. This is only really useful if the
* button has #toggle-mode mode set to #TRUE.
* button has #toggle-mode mode set to %TRUE.
*/
void
st_button_set_checked (StButton *button,

2
src/st/st-overflow-box.c
View File

@ -504,7 +504,7 @@ st_overflow_box_init (StOverflowBox *self)
*
* Get the value of the #StOverflowBox::pack-start property.
*
* Returns: #TRUE if pack-start is enabled
* Returns: %TRUE if pack-start is enabled
*/
gboolean
st_overflow_box_get_min_children (StOverflowBox *box)

12
src/st/st-table-child.c
View File

@ -422,7 +422,7 @@ st_table_child_set_row_span (StTable *table,
*
* Get the x-fill state of the child
*
* Returns: #TRUE if the child is set to x-fill
* Returns: %TRUE if the child is set to x-fill
*/
gboolean
st_table_child_get_x_fill (StTable *table,
@ -473,7 +473,7 @@ st_table_child_set_x_fill (StTable *table,
*
* Get the y-fill state of the child
*
* Returns: #TRUE if the child is set to y-fill
* Returns: %TRUE if the child is set to y-fill
*/
gboolean
st_table_child_get_y_fill (StTable *table,
@ -523,7 +523,7 @@ st_table_child_set_y_fill (StTable *table,
*
* Get the x-expand property of the child
*
* Returns: #TRUE if the child is set to x-expand
* Returns: %TRUE if the child is set to x-expand
*/
gboolean
st_table_child_get_x_expand (StTable *table,
@ -602,7 +602,7 @@ st_table_child_set_y_expand (StTable *table,
*
* Get the y-expand property of the child.
*
* Returns: #TRUE if the child is set to y-expand
* Returns: %TRUE if the child is set to y-expand
*/
gboolean
st_table_child_get_y_expand (StTable *table,
@ -721,7 +721,7 @@ st_table_child_set_y_align (StTable *table,
* st_table_child_set_allocate_hidden:
* @table: A #StTable
* @child: A #ClutterActor
* @value: #TRUE if the actor should be allocated when hidden
* @value: %TRUE if the actor should be allocated when hidden
*
* Set whether the child should be allocate even if it is hidden
*/
@ -754,7 +754,7 @@ st_table_child_set_allocate_hidden (StTable *table,
*
* Determine if the child is allocated even if it is hidden
*
* Returns: #TRUE if the actor is allocated when hidden
* Returns: %TRUE if the actor is allocated when hidden
*/
gboolean
st_table_child_get_allocate_hidden (StTable *table,

6
src/st/st-widget.c
View File

@ -1579,11 +1579,11 @@ st_widget_set_direction (StWidget *self, StTextDirection dir)
/**
* st_widget_set_has_tooltip:
* @widget: A #StWidget
* @has_tooltip: #TRUE if the widget should display a tooltip
* @has_tooltip: %TRUE if the widget should display a tooltip
*
* Enables tooltip support on the #StWidget.
*
* Note that setting has-tooltip to #TRUE will cause the widget to be set
* Note that setting has-tooltip to %TRUE will cause the widget to be set
* reactive. If you no longer need tooltip support and do not need the widget
* to be reactive, you need to set ClutterActor::reactive to FALSE.
*
@ -1644,7 +1644,7 @@ st_widget_get_has_tooltip (StWidget *widget)
* @text: text to set as the tooltip
*
* Set the tooltip text of the widget. This will set StWidget::has-tooltip to
* #TRUE. A value of #NULL will unset the tooltip and set has-tooltip to #FALSE.
* %TRUE. A value of %NULL will unset the tooltip and set has-tooltip to %FALSE.
*
*/
void