[gtk/ebassi/gidocgen: 472/481] shortcutlabel: Convert docs
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk/ebassi/gidocgen: 472/481] shortcutlabel: Convert docs
- Date: Sun, 7 Mar 2021 23:55:18 +0000 (UTC)
commit fbcc8f635f487d4cb01cf5ed1156e594822abcb7
Author: Matthias Clasen <mclasen redhat com>
Date: Mon Mar 1 22:54:37 2021 -0500
shortcutlabel: Convert docs
gtk/gtkshortcutlabel.c | 38 +++++++++++++++++++-------------------
1 file changed, 19 insertions(+), 19 deletions(-)
---
diff --git a/gtk/gtkshortcutlabel.c b/gtk/gtkshortcutlabel.c
index 39a7aef069..262ae34251 100644
--- a/gtk/gtkshortcutlabel.c
+++ b/gtk/gtkshortcutlabel.c
@@ -26,13 +26,11 @@
#include "gtkintl.h"
/**
- * SECTION:gtkshortcutlabel
- * @Title: GtkShortcutLabel
- * @Short_description: Displays a keyboard shortcut
- * @See_also: #GtkCellRendererAccel
+ * GtkShortcutLabel:
*
- * #GtkShortcutLabel is a widget that represents a single keyboard shortcut or gesture
- * in the user interface.
+ * `GtkShortcutLabel` displays a single keyboard shortcut or gesture.
+ *
+ * The main use case for `GtkShortcutLabel` is inside a [class@Gtk.ShortcutsWindow].
*/
struct _GtkShortcutLabel
@@ -476,9 +474,11 @@ gtk_shortcut_label_class_init (GtkShortcutLabelClass *klass)
object_class->set_property = gtk_shortcut_label_set_property;
/**
- * GtkShortcutLabel:accelerator:
+ * GtkShortcutLabel:accelerator: (attributes org.gtk.Property.get=gtk_shortcut_label_get_accelerator
org.gtk.Property.set=gtk_shortcut_label_set_accelerator)
+ *
+ * The accelerator that @self displays.
*
- * The accelerator that @self displays. See #GtkShortcutsShortcut:accelerator
+ * See [property@Gtk.ShortcutsShortcut:accelerator]
* for the accepted syntax.
*/
properties[PROP_ACCELERATOR] =
@@ -487,7 +487,7 @@ gtk_shortcut_label_class_init (GtkShortcutLabelClass *klass)
(G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
- * GtkShortcutLabel:disabled-text:
+ * GtkShortcutLabel:disabled-text: (attributes org.gtk.Property.get=gtk_shortcut_label_get_disabled_text
org.gtk.Property.set=gtk_shortcut_label_set_disabled_text)
*
* The text that is displayed when no accelerator is set.
*/
@@ -513,9 +513,9 @@ gtk_shortcut_label_init (GtkShortcutLabel *self)
* gtk_shortcut_label_new:
* @accelerator: the initial accelerator
*
- * Creates a new #GtkShortcutLabel with @accelerator set.
+ * Creates a new `GtkShortcutLabel` with @accelerator set.
*
- * Returns: (transfer full): a newly-allocated #GtkShortcutLabel
+ * Returns: (transfer full): a newly-allocated `GtkShortcutLabel`
*/
GtkWidget *
gtk_shortcut_label_new (const char *accelerator)
@@ -526,8 +526,8 @@ gtk_shortcut_label_new (const char *accelerator)
}
/**
- * gtk_shortcut_label_get_accelerator:
- * @self: a #GtkShortcutLabel
+ * gtk_shortcut_label_get_accelerator: (attributes org.gtk.Method.get_property=accelerator)
+ * @self: a `GtkShortcutLabel`
*
* Retrieves the current accelerator of @self.
*
@@ -542,8 +542,8 @@ gtk_shortcut_label_get_accelerator (GtkShortcutLabel *self)
}
/**
- * gtk_shortcut_label_set_accelerator:
- * @self: a #GtkShortcutLabel
+ * gtk_shortcut_label_set_accelerator: (attributes org.gtk.Method.set_property=accelerator)
+ * @self: a `GtkShortcutLabel`
* @accelerator: the new accelerator
*
* Sets the accelerator to be displayed by @self.
@@ -564,8 +564,8 @@ gtk_shortcut_label_set_accelerator (GtkShortcutLabel *self,
}
/**
- * gtk_shortcut_label_get_disabled_text:
- * @self: a #GtkShortcutLabel
+ * gtk_shortcut_label_get_disabled_text: (attributes org.gtk.Method.get_property=disabled-text)
+ * @self: a `GtkShortcutLabel`
*
* Retrieves the text that is displayed when no accelerator is set.
*
@@ -581,8 +581,8 @@ gtk_shortcut_label_get_disabled_text (GtkShortcutLabel *self)
}
/**
- * gtk_shortcut_label_set_disabled_text:
- * @self: a #GtkShortcutLabel
+ * gtk_shortcut_label_set_disabled_text: (attributes org.gtk.Method.set_property=disabled-text)
+ * @self: a `GtkShortcutLabel`
* @disabled_text: the text to be displayed when no accelerator is set
*
* Sets the text to be displayed by @self when no accelerator is set.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]