From 9dc421875ba43993c4c2bb41a4f5881b61ea73f7 Mon Sep 17 00:00:00 2001
From: Andy Holmes <andrew.g.r.holmes@gmail.com>
Date: Wed, 20 May 2020 12:47:35 -0700
Subject: [PATCH] StBoxLayout: Fix up some documentation

`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
---
 src/st/st-box-layout.c | 22 ++++++++++++++++------
 1 file changed, 16 insertions(+), 6 deletions(-)

diff --git a/src/st/st-box-layout.c b/src/st/st-box-layout.c
index 57705d320..298c499ea 100644
--- a/src/st/st-box-layout.c
+++ b/src/st/st-box-layout.c
@@ -190,6 +190,12 @@ st_box_layout_class_init (StBoxLayoutClass *klass)
 
   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",
                                 "Vertical",
                                 "Whether the layout should be vertical, rather"
@@ -198,6 +204,12 @@ st_box_layout_class_init (StBoxLayoutClass *klass)
                                 ST_PARAM_READWRITE);
   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",
                                 "Pack Start",
                                 "Whether to pack items at the start of the box",
@@ -234,8 +246,7 @@ st_box_layout_new (void)
  * @box: A #StBoxLayout
  * @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
 st_box_layout_set_vertical (StBoxLayout *box,
@@ -261,7 +272,7 @@ st_box_layout_set_vertical (StBoxLayout *box,
  * st_box_layout_get_vertical:
  * @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
  */
@@ -283,8 +294,7 @@ st_box_layout_get_vertical (StBoxLayout *box)
  * @box: A #StBoxLayout
  * @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
 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:
  * @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
  */