[libadwaita/wip/exalm/gi-docgen: 24/49] indicator-bin: Convert docs
- From: Alexander Mikhaylenko <alexm src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libadwaita/wip/exalm/gi-docgen: 24/49] indicator-bin: Convert docs
- Date: Mon, 17 May 2021 11:22:35 +0000 (UTC)
commit d1e1ae04529dc766e3a7aef06eec181230258e93
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 | 19 +++++++++----------
1 file changed, 9 insertions(+), 10 deletions(-)
---
diff --git a/src/adw-indicator-bin.c b/src/adw-indicator-bin.c
index 364e5e1b..7530241c 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
@@ -273,7 +272,7 @@ adw_indicator_bin_class_init (AdwIndicatorBinClass *klass)
/**
* AdwIndicatorBin:child:
*
- * The child widget of the #AdwIndicatorBin.
+ * The child widget.
*
* 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]