[libadwaita/wip/exalm/gi-docgen] flap: Convert docs

From: Alexander Mikhaylenko <alexm src gnome org>
To: commits-list gnome org
Cc:
Subject: [libadwaita/wip/exalm/gi-docgen] flap: Convert docs
Date: Tue, 11 May 2021 11:09:33 +0000 (UTC)
commit 030fe07336f33843b05eb96b38811a4acd5ec972
Author: Alexander Mikhaylenko <alexm gnome org>
Date:   Mon May 10 21:56:11 2021 +0500

    flap: Convert docs

 src/adw-flap.c | 359 +++++++++++++++++++++++++++------------------------------
 1 file changed, 173 insertions(+), 186 deletions(-)
---
diff --git a/src/adw-flap.c b/src/adw-flap.c
index c49606b..df4eba1 100644
--- a/src/adw-flap.c
+++ b/src/adw-flap.c
@@ -17,51 +17,55 @@
 #include "adw-swipe-tracker-private.h"
 
 /**
- * SECTION:adwflap
- * @short_description: An adaptive container acting like a box or an overlay.
- * @Title: AdwFlap
+ * AdwFlap:
  *
- * The #AdwFlap widget can display its children like a #GtkBox does or like a
- * #GtkOverlay does, according to the #AdwFlap:fold-policy value.
+ * An adaptive container acting like a box or an overlay.
  *
- * #AdwFlap has at most three children: #AdwFlap:content, #AdwFlap:flap and
- * #AdwFlap:separator. Content is the primary child, flap is displayed next to
- * it when unfolded, or overlays it when folded. Flap can be shown or hidden by
- * changing the #AdwFlap:reveal-flap value, as well as via swipe gestures if
- * #AdwFlap:swipe-to-open and/or #AdwFlap:swipe-to-close are set to %TRUE.
+ * The `AdwFlap` widget can display its children like a [class Gtk Box] does or
+ * like a [class@Gtk.Overlay] does, according to the
+ * [property Adw Flap:fold-policy] value.
+ *
+ * `AdwFlap` has at most three children: [property Adw Flap:content],
+ * [property Adw Flap:flap] and [property Adw Flap:separator]. Content is the
+ * primary child, flap is displayed next to it when unfolded, or overlays it
+ * when folded. Flap can be shown or hidden by changing th
+ * [property Adw Flap:reveal-flap] value, as well as via swipe gestures if
+ * [property Adw Flap:swipe-to-open] and/or [property Adw Flap:swipe-to-close] are
+ * set to `TRUE`.
  *
  * Optionally, a separator can be provided, which would be displayed between
  * the content and the flap when there's no shadow to separate them, depending
  * on the transition type.
  *
- * #AdwFlap:flap is transparent by default; add the .background style class to
- * it if this is unwanted.
+ * [property Adw Flap:flap] is transparent by default; add the `.background`
+ * style class to it if this is unwanted.
  *
- * If #AdwFlap:modal is set to %TRUE, content becomes completely inaccessible
- * when the flap is revealed when folded.
+ * If [property Adw Flap:modal] is set to `TRUE`, content becomes completely
+ * inaccessible when the flap is revealed while folded.
  *
  * The position of the flap and separator children relative to the content is
- * determined by orientation, as well as  #AdwFlap:flap-position value.
+ * determined by orientation, as well as the [property Adw Flap:flap-position]
+ * value.
  *
  * Folding the flap will automatically hide the flap widget, and unfolding it
  * will automatically reveal it. If this behavior is not desired, the
- * #AdwFlap:locked property can be used to override it.
+ * [property Adw Flap:locked] property can be used to override it.
  *
  * Common use cases include sidebars, header bars that need to be able to
  * overlap the window content (for example, in fullscreen mode) and bottom
  * sheets.
  *
- * # AdwFlap as GtkBuildable
+ * ## AdwFlap as GtkBuildable
  *
- * The #AdwFlap implementation of the #GtkBuildable interface supports setting
- * the flap child by specifying “flap” as the “type” attribute of a
- * &lt;child&gt; element, and separator by specifying “separator”. Specifying
+ * The `AdwFlap` implementation of the [iface@Gtk.Buildable] interface supports
+ * setting the flap child by specifying “flap” as the “type” attribute of a
+ * <child> element, and separator by specifying “separator”. Specifying
  * “content” child type or omitting it results in setting the content child.
  *
- * # CSS nodes
+ * ## CSS nodes
  *
- * #AdwFlap has a single CSS node with name flap. The node will get the style
- * classes .folded when it is folded, and .unfolded when it's not.
+ * `AdwFlap` has a single CSS node with name `flap`. The node will get the style
+ * classes `.folded` when it is folded, and `.unfolded` when it's not.
  *
  * Since: 1.0
  */
@@ -74,8 +78,7 @@
  * @ADW_FLAP_FOLD_POLICY_AUTO: Fold and unfold the flap based on available
  *   space.
  *
- * These enumeration values describe the possible folding behavior in a #AdwFlap
- * widget.
+ * Describes the possible folding behavior in a [class Adw Flap] widget.
  *
  * Since: 1.0
  */
@@ -90,9 +93,11 @@
  *   neither the flap nor content overlap each other. Both widgets can be
  *   swiped.
  *
- * These enumeration values describe the possible transitions between children
- * in a #AdwFlap widget, as well as which areas can be swiped via
- * #AdwFlap:swipe-to-open and #AdwFlap:swipe-to-close.
+ * Describes [class Adw Flap] transitions types.
+ *
+ * It determines the type of animation when transitioning between children in a
+ * [class Adw Flap] widget, as well as which areas can be swiped via
+ * [property Adw Flap:swipe-to-open] and [property Adw Flap:swipe-to-close].
  *
  * New values may be added to this enum over time.
  *
@@ -1242,9 +1247,11 @@ adw_flap_class_init (AdwFlapClass *klass)
   widget_class->direction_changed = adw_flap_direction_changed;
 
   /**
-   * AdwFlap:content:
+   * AdwFlap:content: (attributes org.gtk.Property.get=adw_flap_get_content 
org.gtk.Property.set=adw_flap_set_content)
    *
-   * The content widget, always displayed when unfolded, and partially visible
+   * The content widget.
+   *
+   * It's always displayed when unfolded, and partially visible
    * when folded.
    *
    * Since: 1.0
@@ -1252,14 +1259,16 @@ adw_flap_class_init (AdwFlapClass *klass)
   props[PROP_CONTENT] =
     g_param_spec_object ("content",
                          "Content",
-                         "The content Widget",
+                         "The content widget",
                          GTK_TYPE_WIDGET,
                          G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY);
 
   /**
-   * AdwFlap:flap:
+   * AdwFlap:flap: (attributes org.gtk.Property.get=adw_flap_get_flap org.gtk.Property.set=adw_flap_set_flap)
+   *
+   * The flap widget.
    *
-   * The flap widget, only visible when #AdwFlap:reveal-progress is greater than
+   * It's only visible when [property Adw Flap:reveal-progress] is greater than
    * 0.
    *
    * Since: 1.0
@@ -1272,11 +1281,13 @@ adw_flap_class_init (AdwFlapClass *klass)
                          G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY);
 
   /**
-   * AdwFlap:separator:
+   * AdwFlap:separator: (attributes org.gtk.Property.get=adw_flap_get_separator 
org.gtk.Property.set=adw_flap_set_separator)
    *
-   * The separator widget, displayed between content and flap when there's no
-   * shadow to display. When exactly it's visible depends on the
-   * #AdwFlap:transition-type value. If %NULL, no separator will be used.
+   * The separator widget.
+   *
+   * It's displayed between content and flap when there's no shadow to display.
+   * When exactly it's visible depends on the
+   * [property Adw Flap:transition-type] value.
    *
    * Since: 1.0
    */
@@ -1288,10 +1299,12 @@ adw_flap_class_init (AdwFlapClass *klass)
                          G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY);
 
   /**
-   * AdwFlap:flap-position:
+   * AdwFlap:flap-position: (attributes org.gtk.Property.get=adw_flap_get_flap_position 
org.gtk.Property.set=adw_flap_set_flap_position)
+   *
+   * The flap position.
    *
-   * The flap position for @self. If @GTK_PACK_START, the flap is displayed
-   * before the content, if @GTK_PACK_END, it's displayed after the content.
+   * If it's set to `GTK_PACK_START`, the flap is displayed before the content,
+   * if `GTK_PACK_END`, it's displayed after the content.
    *
    * Since: 1.0
    */
@@ -1304,7 +1317,7 @@ adw_flap_class_init (AdwFlapClass *klass)
                        G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY);
 
   /**
-   * AdwFlap:reveal-flap:
+   * AdwFlap:reveal-flap: (attributes org.gtk.Property.get=adw_flap_get_reveal_flap 
org.gtk.Property.set=adw_flap_set_reveal_flap)
    *
    * Whether the flap widget is revealed.
    *
@@ -1318,7 +1331,7 @@ adw_flap_class_init (AdwFlapClass *klass)
                           G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY);
 
   /**
-   * AdwFlap:reveal-duration:
+   * AdwFlap:reveal-duration: (attributes org.gtk.Property.get=adw_flap_get_reveal_duration 
org.gtk.Property.set=adw_flap_set_reveal_duration)
    *
    * The reveal transition animation duration, in milliseconds.
    *
@@ -1333,10 +1346,13 @@ adw_flap_class_init (AdwFlapClass *klass)
                        G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY);
 
   /**
-   * AdwFlap:reveal-progress:
+   * AdwFlap:reveal-progress: (attributes org.gtk.Property.get=adw_flap_get_reveal_progress)
+   *
+   * The current reveal transition progress.
    *
-   * The current reveal transition progress. 0 means fully hidden, 1 means fully
-   * revealed See #AdwFlap:reveal-flap.
+   * 0 means fully hidden, 1 means fully revealed.
+   *
+   * See [property Adw Flap:reveal-flap].
    *
    * Since: 1.0
    */
@@ -1348,23 +1364,22 @@ adw_flap_class_init (AdwFlapClass *klass)
                           G_PARAM_READABLE);
 
   /**
-   * AdwFlap:fold-policy:
+   * AdwFlap:fold-policy: (attributes org.gtk.Property.get=adw_flap_get_fold_policy)
    *
-   * The current fold policy. See #AdwFlapFoldPolicy for available
-   * policies.
+   * The fold policy for the flap.
    *
    * Since: 1.0
    */
   props[PROP_FOLD_POLICY] =
     g_param_spec_enum ("fold-policy",
                        "Fold Policy",
-                       "The current fold policy",
+                       "The fold policy for the flap",
                        ADW_TYPE_FLAP_FOLD_POLICY,
                        ADW_FLAP_FOLD_POLICY_AUTO,
                        G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY);
 
   /**
-   * AdwFlap:fold-duration:
+   * AdwFlap:fold-duration: (attributes org.gtk.Property.get=adw_flap_get_fold_duration 
org.gtk.Property.set=adw_flap_set_fold_duration)
    *
    * The fold transition animation duration, in milliseconds.
    *
@@ -1379,11 +1394,11 @@ adw_flap_class_init (AdwFlapClass *klass)
                        G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY);
 
   /**
-   * AdwFlap:folded:
+   * AdwFlap:folded: (attributes org.gtk.Property.get=adw_flap_get_folded)
    *
    * Whether the flap is currently folded.
    *
-   * See #AdwFlap:fold-policy.
+   * See [property Adw Flap:fold-policy].
    *
    * Since: 1.0
    */
@@ -1395,13 +1410,13 @@ adw_flap_class_init (AdwFlapClass *klass)
                           G_PARAM_READABLE);
 
   /**
-   * AdwFlap:locked:
+   * AdwFlap:locked: (attributes org.gtk.Property.get=adw_flap_get_locked 
org.gtk.Property.set=adw_flap_set_locked)
    *
    * Whether the flap is locked.
    *
-   * If %FALSE, folding when the flap is revealed automatically closes it, and
-   * unfolding it when the flap is not revealed opens it. If %TRUE,
-   * #AdwFlap:reveal-flap value never changes on its own.
+   * If `FALSE`, folding when the flap is revealed automatically closes it, and
+   * unfolding it when the flap is not revealed opens it. If `TRUE`,
+   * [property Adw Flap:reveal-flap] value never changes on its own.
    *
    * Since: 1.0
    */
@@ -1413,14 +1428,13 @@ adw_flap_class_init (AdwFlapClass *klass)
                           G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY);
 
   /**
-   * AdwFlap:transition-type:
+   * AdwFlap:transition-type: (attributes org.gtk.Property.get=adw_flap_get_transition_type 
org.gtk.Property.set=adw_flap_set_transition_type)
    *
-   * The type of animation that will be used for reveal and fold transitions
-   * in @self.
+   * the type of animation used for reveal and fold transitions.
    *
-   * #AdwFlap:flap is transparent by default, which means the content will be
-   * seen through it with %ADW_FLAP_TRANSITION_TYPE_OVER transitions; add the
-   * .background style class to it if this is unwanted.
+   * [property Adw Flap:flap] is transparent by default, which means the content
+   * will be seen through it with `ADW_FLAP_TRANSITION_TYPE_OVER` transitions;
+   * add the `.background` style class to it if this is unwanted.
    *
    * Since: 1.0
    */
@@ -1433,12 +1447,12 @@ adw_flap_class_init (AdwFlapClass *klass)
                        G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY);
 
   /**
-   * AdwFlap:modal:
+   * AdwFlap:modal: (attributes org.gtk.Property.get=adw_flap_get_modal 
org.gtk.Property.set=adw_flap_set_modal)
    *
    * Whether the flap is modal.
    *
-   * If %TRUE, clicking the content widget while flap is revealed, as well as
-   * pressing Escape key, will close the flap. If %FALSE, clicks are passed
+   * If `TRUE`, clicking the content widget while flap is revealed, as well as
+   * pressing Escape key, will close the flap. If `FALSE`, clicks are passed
    * through to the content widget.
    *
    * Since: 1.0
@@ -1451,11 +1465,12 @@ adw_flap_class_init (AdwFlapClass *klass)
                           G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY);
 
   /**
-   * AdwFlap:swipe-to-open:
+   * AdwFlap:swipe-to-open: (attributes org.gtk.Property.get=adw_flap_get_swipe_to_open 
org.gtk.Property.set=adw_flap_set_swipe_to_open)
    *
    * Whether the flap can be opened with a swipe gesture.
    *
-   * The area that can be swiped depends on the #AdwFlap:transition-type value.
+   * The area that can be swiped depends on the
+   * [property Adw Flap:transition-type] value.
    *
    * Since: 1.0
    */
@@ -1467,11 +1482,12 @@ adw_flap_class_init (AdwFlapClass *klass)
                           G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY);
 
   /**
-   * AdwFlap:swipe-to-close:
+   * AdwFlap:swipe-to-close: (attributes org.gtk.Property.get=adw_flap_get_swipe_to_close 
org.gtk.Property.set=adw_flap_set_swipe_to_close)
    *
    * Whether the flap can be closed with a swipe gesture.
    *
-   * The area that can be swiped depends on the #AdwFlap:transition-type value.
+   * The area that can be swiped depends on the
+   * [property Adw Flap:transition-type] value.
    *
    * Since: 1.0
    */
@@ -1743,9 +1759,9 @@ adw_flap_swipeable_init (AdwSwipeableInterface *iface)
 /**
  * adw_flap_new:
  *
- * Creates a new #AdwFlap.
+ * Creates a new `AdwFlap`.
  *
- * Returns: a new #AdwFlap
+ * Returns: the newly created `AdwFlap`
  *
  * Since: 1.0
  */
@@ -1756,10 +1772,10 @@ adw_flap_new (void)
 }
 
 /**
- * adw_flap_get_content:
- * @self: a #AdwFlap
+ * adw_flap_get_content: (attributes org.gtk.Method.get_property=content)
+ * @self: a `AdwFlap`
  *
- * Gets the content widget for @self
+ * Gets the content widget for @self.
  *
  * Returns: (transfer none) (nullable): the content widget for @self
  *
@@ -1774,12 +1790,11 @@ adw_flap_get_content (AdwFlap *self)
 }
 
 /**
- * adw_flap_set_content:
- * @self: a #AdwFlap
- * @content: (nullable): the content widget, or %NULL
+ * adw_flap_set_content: (attributes org.gtk.Method.set_property=content)
+ * @self: a `AdwFlap`
+ * @content: (nullable): the content widget
  *
- * Sets the content widget for @self, always displayed when unfolded, and
- * partially visible when folded.
+ * Sets the content widget for @self.
  *
  * Since: 1.0
  */
@@ -1807,10 +1822,10 @@ adw_flap_set_content (AdwFlap   *self,
 }
 
 /**
- * adw_flap_get_flap:
- * @self: a #AdwFlap
+ * adw_flap_get_flap: (attributes org.gtk.Method.get_property=flap)
+ * @self: a `AdwFlap`
  *
- * Gets the flap widget for @self
+ * Gets the flap widget for @self.
  *
  * Returns: (transfer none) (nullable): the flap widget for @self
  *
@@ -1825,12 +1840,11 @@ adw_flap_get_flap (AdwFlap *self)
 }
 
 /**
- * adw_flap_set_flap:
- * @self: a #AdwFlap
- * @flap: (nullable): the flap widget, or %NULL
+ * adw_flap_set_flap: (attributes org.gtk.Method.set_property=flap)
+ * @self: a `AdwFlap`
+ * @flap: (nullable): the flap widget
  *
- * Sets the flap widget for @self, only visible when #AdwFlap:reveal-progress is
- * greater than 0.
+ * Sets the flap widget for @self.
  *
  * Since: 1.0
  */
@@ -1859,8 +1873,8 @@ adw_flap_set_flap (AdwFlap   *self,
 }
 
 /**
- * adw_flap_get_separator:
- * @self: a #AdwFlap
+ * adw_flap_get_separator: (attributes org.gtk.Method.get_property=separator)
+ * @self: a `AdwFlap`
  *
  * Gets the separator widget for @self.
  *
@@ -1877,13 +1891,11 @@ adw_flap_get_separator (AdwFlap *self)
 }
 
 /**
- * adw_flap_set_separator:
- * @self: a #AdwFlap
- * @separator: (nullable): the separator widget, or %NULL
+ * adw_flap_set_separator: (attributes org.gtk.Method.set_property=separator)
+ * @self: a `AdwFlap`
+ * @separator: (nullable): the separator widget
  *
- * Sets the separator widget for @self, displayed between content and flap when
- * there's no shadow to display. When exactly it's visible depends on the
- * #AdwFlap:transition-type value. If %NULL, no separator will be used.
+ * Sets the separator widget for @self.
  *
  * Since: 1.0
  */
@@ -1911,8 +1923,8 @@ adw_flap_set_separator (AdwFlap   *self,
 }
 
 /**
- * adw_flap_get_flap_position:
- * @self: a #AdwFlap
+ * adw_flap_get_flap_position: (attributes org.gtk.Method.get_property=flap-position)
+ * @self: a `AdwFlap`
  *
  * Gets the flap position for @self.
  *
@@ -1929,12 +1941,11 @@ adw_flap_get_flap_position (AdwFlap *self)
 }
 
 /**
- * adw_flap_set_flap_position:
- * @self: a #AdwFlap
+ * adw_flap_set_flap_position: (attributes org.gtk.Method.set_property=flap-position)
+ * @self: a `AdwFlap`
  * @position: the new value
  *
- * Sets the flap position for @self. If @GTK_PACK_START, the flap is displayed
- * before the content, if @GTK_PACK_END, it's displayed after the content.
+ * Sets the flap position for @self.
  *
  * Since: 1.0
  */
@@ -1957,12 +1968,12 @@ adw_flap_set_flap_position (AdwFlap     *self,
 }
 
 /**
- * adw_flap_get_reveal_flap:
- * @self: a #AdwFlap
+ * adw_flap_get_reveal_flap: (attributes org.gtk.Method.get_property=reveal-flap)
+ * @self: a `AdwFlap`
  *
  * Gets whether the flap widget is revealed for @self.
  *
- * Returns: %TRUE if the flap widget is revealed, %FALSE otherwise.
+ * Returns: `TRUE` if the flap widget is revealed
  *
  * Since: 1.0
  */
@@ -1975,9 +1986,9 @@ adw_flap_get_reveal_flap (AdwFlap *self)
 }
 
 /**
- * adw_flap_set_reveal_flap:
- * @self: a #AdwFlap
- * @reveal_flap: %TRUE to reveal the flap widget, %FALSE otherwise
+ * adw_flap_set_reveal_flap: (attributes org.gtk.Method.set_property=reveal-flap)
+ * @self: a `AdwFlap`
+ * @reveal_flap: whether to reveal the flap widget
  *
  * Sets whether the flap widget is revealed for @self.
  *
@@ -1993,11 +2004,10 @@ adw_flap_set_reveal_flap (AdwFlap  *self,
 }
 
 /**
- * adw_flap_get_reveal_duration:
- * @self: a #AdwFlap
+ * adw_flap_get_reveal_duration: (attributes org.gtk.Method.get_property=reveal-progress)
+ * @self: a `AdwFlap`
  *
- * Returns the amount of time (in milliseconds) that reveal transitions in @self
- * will take.
+ * Returns the duration that reveal transitions in @self will take.
  *
  * Returns: the reveal transition duration
  *
@@ -2012,8 +2022,8 @@ adw_flap_get_reveal_duration (AdwFlap *self)
 }
 
 /**
- * adw_flap_set_reveal_duration:
- * @self: a #AdwFlap
+ * adw_flap_set_reveal_duration: (attributes org.gtk.Method.set_property=reveal-progress)
+ * @self: a `AdwFlap`
  * @duration: the new duration, in milliseconds
  *
  * Sets the duration that reveal transitions in @self will take.
@@ -2035,11 +2045,10 @@ adw_flap_set_reveal_duration (AdwFlap *self,
 }
 
 /**
- * adw_flap_get_reveal_progress:
- * @self: a #AdwFlap
+ * adw_flap_get_reveal_progress: (attributes org.gtk.Method.get_property=reveal-progress)
+ * @self: a `AdwFlap`
  *
- * Gets the current reveal transition progress for @self. 0 means fully hidden,
- * 1 means fully revealed. See #AdwFlap:reveal-flap.
+ * Gets the current reveal progress for @self.
  *
  * Returns: the current reveal progress for @self
  *
@@ -2054,12 +2063,12 @@ adw_flap_get_reveal_progress (AdwFlap *self)
 }
 
 /**
- * adw_flap_get_fold_policy:
- * @self: a #AdwFlap
+ * adw_flap_get_fold_policy: (attributes org.gtk.Method.get_property=fold-policy)
+ * @self: a `AdwFlap`
  *
- * Gets the current fold policy of @self. See adw_flap_set_fold_policy().
+ * Gets the fold policy for @self.
  *
- * Returns: the current fold policy of @self
+ * Returns: the fold policy for @self
  *
  * Since: 1.0
  */
@@ -2072,12 +2081,11 @@ adw_flap_get_fold_policy (AdwFlap *self)
 }
 
 /**
- * adw_flap_set_fold_policy:
- * @self: a #AdwFlap
- * @policy: Fold policy
+ * adw_flap_set_fold_policy: (attributes org.gtk.Method.set_property=fold-policy)
+ * @self: a `AdwFlap`
+ * @policy: the fold policy
  *
- * Sets the current fold policy for @self. See #AdwFlapFoldPolicy for available
- * policies.
+ * Sets the fold policy for @self.
  *
  * Since: 1.0
  */
@@ -2114,11 +2122,10 @@ adw_flap_set_fold_policy (AdwFlap           *self,
 }
 
 /**
- * adw_flap_get_fold_duration:
- * @self: a #AdwFlap
+ * adw_flap_get_fold_duration: (attributes org.gtk.Method.get_property=fold-duration)
+ * @self: a `AdwFlap`
  *
- * Returns the amount of time (in milliseconds) that fold transitions in @self
- * will take.
+ * Gets the duration that fold transitions in @self will take.
  *
  * Returns: the fold transition duration
  *
@@ -2133,8 +2140,8 @@ adw_flap_get_fold_duration (AdwFlap *self)
 }
 
 /**
- * adw_flap_set_fold_duration:
- * @self: a #AdwFlap
+ * adw_flap_set_fold_duration: (attributes org.gtk.Method.set_property=fold-duration)
+ * @self: a `AdwFlap`
  * @duration: the new duration, in milliseconds
  *
  * Sets the duration that fold transitions in @self will take.
@@ -2156,14 +2163,12 @@ adw_flap_set_fold_duration (AdwFlap *self,
 }
 
 /**
- * adw_flap_get_folded:
- * @self: a #AdwFlap
+ * adw_flap_get_folded: (attributes org.gtk.Method.get_property=folded)
+ * @self: a `AdwFlap`
  *
  * Gets whether @self is currently folded.
  *
- * See #AdwFlap:fold-policy.
- *
- * Returns: %TRUE if @self is currently folded, %FALSE otherwise
+ * Returns: `TRUE` if @self is currently folded
  *
  * Since: 1.0
  */
@@ -2176,12 +2181,12 @@ adw_flap_get_folded (AdwFlap *self)
 }
 
 /**
- * adw_flap_get_locked:
- * @self: a #AdwFlap
+ * adw_flap_get_locked: (attributes org.gtk.Method.get_property=locked)
+ * @self: a `AdwFlap`
  *
  * Gets whether @self is locked.
  *
- * Returns: %TRUE if @self is locked, %FALSE otherwise
+ * Returns: `TRUE` if @self is locked
  *
  * Since: 1.0
  */
@@ -2194,16 +2199,12 @@ adw_flap_get_locked (AdwFlap *self)
 }
 
 /**
- * adw_flap_set_locked:
- * @self: a #AdwFlap
+ * adw_flap_set_locked: (attributes org.gtk.Method.set_property=locked)
+ * @self: a `AdwFlap`
  * @locked: the new value
  *
  * Sets whether @self is locked.
  *
- * If %FALSE, folding @self when the flap is revealed automatically closes it,
- * and unfolding it when the flap is not revealed opens it. If %TRUE,
- * #AdwFlap:reveal-flap value never changes on its own.
- *
  * Since: 1.0
  */
 void
@@ -2223,11 +2224,10 @@ adw_flap_set_locked (AdwFlap  *self,
 }
 
 /**
- * adw_flap_get_transition_type:
- * @self: a #AdwFlap
+ * adw_flap_get_transition_type: (attributes org.gtk.Method.get_property=transition-type)
+ * @self: a `AdwFlap`
  *
- * Gets the type of animation that will be used for reveal and fold transitions
- * in @self.
+ * Gets the type of animation used for reveal and fold transitions in @self.
  *
  * Returns: the current transition type of @self
  *
@@ -2242,16 +2242,11 @@ adw_flap_get_transition_type (AdwFlap *self)
 }
 
 /**
- * adw_flap_set_transition_type:
- * @self: a #AdwFlap
+ * adw_flap_set_transition_type: (attributes org.gtk.Method.set_property=transition-type)
+ * @self: a `AdwFlap`
  * @transition_type: the new transition type
  *
- * Sets the type of animation that will be used for reveal and fold transitions
- * in @self.
- *
- * #AdwFlap:flap is transparent by default, which means the content will be seen
- * through it with %ADW_FLAP_TRANSITION_TYPE_OVER transitions; add the
- * .background style class to it if this is unwanted.
+ * Sets the type of animation used for reveal and fold transitions in @self.
  *
  * Since: 1.0
  */
@@ -2276,12 +2271,12 @@ adw_flap_set_transition_type (AdwFlap               *self,
 }
 
 /**
- * adw_flap_get_modal:
- * @self: a #AdwFlap
+ * adw_flap_get_modal: (attributes org.gtk.Method.get_property=modal)
+ * @self: a `AdwFlap`
  *
- * Gets whether the @self is modal. See adw_flap_set_modal().
+ * Gets whether @self is modal.
  *
- * Returns: %TRUE if @self is modal
+ * Returns: `TRUE` if @self is modal
  *
  * Since: 1.0
  */
@@ -2294,15 +2289,11 @@ adw_flap_get_modal (AdwFlap *self)
 }
 
 /**
- * adw_flap_set_modal:
- * @self: a #AdwFlap
- * @modal: Whether @self can be closed with a click
+ * adw_flap_set_modal: (attributes org.gtk.Method.set_property=modal)
+ * @self: a `AdwFlap`
+ * @modal: whether @self is modal
  *
- * Sets whether the @self can be closed with a click.
- *
- * If @modal is %TRUE, clicking the content widget while flap is revealed, or
- * pressing Escape key, will close the flap. If %FALSE, clicks are passed
- * through to the content widget.
+ * Sets whether @self is modal.
  *
  * Since: 1.0
  */
@@ -2328,12 +2319,12 @@ adw_flap_set_modal (AdwFlap  *self,
 }
 
 /**
- * adw_flap_get_swipe_to_open:
- * @self: a #AdwFlap
+ * adw_flap_get_swipe_to_open: (attributes org.gtk.Method.get_property=swipe-to-open)
+ * @self: a `AdwFlap`
  *
  * Gets whether @self can be opened with a swipe gesture.
  *
- * Returns: %TRUE if @self can be opened with a swipe gesture
+ * Returns: `TRUE` if @self can be opened with a swipe gesture
  *
  * Since: 1.0
  */
@@ -2346,14 +2337,12 @@ adw_flap_get_swipe_to_open (AdwFlap *self)
 }
 
 /**
- * adw_flap_set_swipe_to_open:
- * @self: a #AdwFlap
- * @swipe_to_open: Whether @self can be opened with a swipe gesture
+ * adw_flap_set_swipe_to_open: (attributes org.gtk.Method.set_property=swipe-to-open)
+ * @self: a `AdwFlap`
+ * @swipe_to_open: whether @self can be opened with a swipe gesture
  *
  * Sets whether @self can be opened with a swipe gesture.
  *
- * The area that can be swiped depends on the #AdwFlap:transition-type value.
- *
  * Since: 1.0
  */
 void
@@ -2375,12 +2364,12 @@ adw_flap_set_swipe_to_open (AdwFlap  *self,
 }
 
 /**
- * adw_flap_get_swipe_to_close:
- * @self: a #AdwFlap
+ * adw_flap_get_swipe_to_close: (attributes org.gtk.Method.get_property=swipe-to-close)
+ * @self: a `AdwFlap`
  *
  * Gets whether @self can be closed with a swipe gesture.
  *
- * Returns: %TRUE if @self can be closed with a swipe gesture
+ * Returns: `TRUE` if @self can be closed with a swipe gesture
  *
  * Since: 1.0
  */
@@ -2393,14 +2382,12 @@ adw_flap_get_swipe_to_close (AdwFlap *self)
 }
 
 /**
- * adw_flap_set_swipe_to_close:
- * @self: a #AdwFlap
- * @swipe_to_close: Whether @self can be closed with a swipe gesture
+ * adw_flap_set_swipe_to_close: (attributes org.gtk.Method.set_property=swipe-to-close)
+ * @self: a `AdwFlap`
+ * @swipe_to_close: whether @self can be closed with a swipe gesture
  *
  * Sets whether @self can be closed with a swipe gesture.
  *
- * The area that can be swiped depends on the #AdwFlap:transition-type value.
- *
  * Since: 1.0
  */
 void
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]