[libadwaita/wip/exalm/gi-docgen: 34/56] indicator-bin: Convert docs




commit 5b8abc75cccca6925426a41855c55bb6308f8a93
Author: Alexander Mikhaylenko <alexm gnome org>
Date:   Tue May 11 12:45:04 2021 +0500

    indicator-bin: Convert docs
    
    Don't add missing docs here - it's private. Just convert the few comments
    we had to markdown.

 src/adw-indicator-bin.c | 17 ++++++++---------
 1 file changed, 8 insertions(+), 9 deletions(-)
---
diff --git a/src/adw-indicator-bin.c b/src/adw-indicator-bin.c
index 364e5e1b..1604a04a 100644
--- a/src/adw-indicator-bin.c
+++ b/src/adw-indicator-bin.c
@@ -12,12 +12,11 @@
 #include "adw-gizmo-private.h"
 
 /**
- * PRIVATE:adwindicatorbin
- * @short_description: A helper object for #AdwViewSwitcherButton
- * @title: AdwIndicatorBin
- * @stability: Private
+ * AdwIndicatorBin:
  *
- * The AdwIndicatorBin widget shows an unread indicator over the child widget
+ * A helper object for [class@Adw.ViewSwitcherButton]
+ *
+ * The `AdwIndicatorBin` widget shows an unread indicator over the child widget
  * masking it if they overlap.
  *
  * Since: 1.0
@@ -353,9 +352,9 @@ adw_indicator_bin_buildable_init (GtkBuildableIface *iface)
 /**
  * adw_indicator_bin_new:
  *
- * Creates a new #AdwIndicatorBin.
+ * Creates a new `AdwIndicatorBin`.
  *
- * Returns: a new #AdwIndicatorBin
+ * Returns: the newly created `AdwIndicatorBin`
  *
  * Since: 1.0
  */
@@ -367,7 +366,7 @@ adw_indicator_bin_new (void)
 
 /**
  * adw_indicator_bin_get_child:
- * @self: an #AdwIndicatorBin
+ * @self: an `AdwIndicatorBin`
  *
  * Gets the child widget of @self.
  *
@@ -385,7 +384,7 @@ adw_indicator_bin_get_child (AdwIndicatorBin *self)
 
 /**
  * adw_indicator_bin_set_child:
- * @self: an #AdwIndicatorBin
+ * @self: an `AdwIndicatorBin`
  * @child: (nullable): the child widget
  *
  * Sets the child widget of @self.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]