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

StBoxLayout: Fix up some documentation

Browse Source 
`StBoxLayout` has a couple properties (`vertical` and `pack-start`)
improperly referenced as signals, and is somewhat unclear these
properties are wrappers around the underlying `ClutterBoxLayout`
properties.

Fix these up and add references to the underlying properties, rather
than redescribing them.

https://gitlab.gnome.org/GNOME/gnome-shell/-/issues/2816
This commit is contained in:
Andy Holmes 2020-05-20 12:47:35 -07:00 committed by Florian Müllner
parent 9c3c9a155e
commit 9dc421875b
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -190,6 +190,12 @@ st_box_layout_class_init (StBoxLayoutClass *klass)
widget_class->style_changed = st_box_layout_style_changed; widget_class->style_changed = st_box_layout_style_changed;
/**
* #StBoxLayout:vertical:
*
* A convenience property for getting the #ClutterBoxLayout:vertical
* property of the layout for #StBoxLayout.
*/
pspec = g_param_spec_boolean ("vertical", pspec = g_param_spec_boolean ("vertical",
"Vertical", "Vertical",
"Whether the layout should be vertical, rather" "Whether the layout should be vertical, rather"
@ -198,6 +204,12 @@ st_box_layout_class_init (StBoxLayoutClass *klass)
ST_PARAM_READWRITE); ST_PARAM_READWRITE);
g_object_class_install_property (object_class, PROP_VERTICAL, pspec); g_object_class_install_property (object_class, PROP_VERTICAL, pspec);
/**
* #StBoxLayout:pack-start:
*
* A convenience property for getting the #ClutterBoxLayout:pack-start
* property of the layout for #StBoxLayout.
*/
pspec = g_param_spec_boolean ("pack-start", pspec = g_param_spec_boolean ("pack-start",
"Pack Start", "Pack Start",
"Whether to pack items at the start of the box", "Whether to pack items at the start of the box",
@ -234,8 +246,7 @@ st_box_layout_new (void)
* @box: A #StBoxLayout * @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 * Set the value of the #StBoxLayout:vertical property
*
*/ */
void void
st_box_layout_set_vertical (StBoxLayout *box, st_box_layout_set_vertical (StBoxLayout *box,
@ -261,7 +272,7 @@ st_box_layout_set_vertical (StBoxLayout *box,
* st_box_layout_get_vertical: * st_box_layout_get_vertical:
* @box: A #StBoxLayout * @box: A #StBoxLayout
* *
* Get the value of the #StBoxLayout::vertical property. * Get the value of the #StBoxLayout:vertical property.
* *
* Returns: %TRUE if the layout is vertical * Returns: %TRUE if the layout is vertical
*/ */
@ -283,8 +294,7 @@ st_box_layout_get_vertical (StBoxLayout *box)
* @box: A #StBoxLayout * @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. * Set the value of the #StBoxLayout:pack-start property.
*
*/ */
void void
st_box_layout_set_pack_start (StBoxLayout *box, st_box_layout_set_pack_start (StBoxLayout *box,
@ -307,7 +317,7 @@ st_box_layout_set_pack_start (StBoxLayout *box,
* st_box_layout_get_pack_start: * st_box_layout_get_pack_start:
* @box: A #StBoxLayout * @box: A #StBoxLayout
* *
* Get the value of the #StBoxLayout::pack-start property. * Get the value of the #StBoxLayout:pack-start property.
* *
* Returns: %TRUE if pack-start is enabled * Returns: %TRUE if pack-start is enabled
*/ */