[gtk/ebassi/gidocgen: 128/501] editablelabel: Convert docs




commit d60cd16b997b310601781dc621ca8527ba423f33
Author: Matthias Clasen <mclasen redhat com>
Date:   Sun Feb 21 23:39:42 2021 -0500

    editablelabel: Convert docs
    
    Change link syntax, add an example image, generally clean things up.

 gtk/gtkeditablelabel.c | 39 ++++++++++++++++++++-------------------
 1 file changed, 20 insertions(+), 19 deletions(-)
---
diff --git a/gtk/gtkeditablelabel.c b/gtk/gtkeditablelabel.c
index 103b125649..15f8527616 100644
--- a/gtk/gtkeditablelabel.c
+++ b/gtk/gtkeditablelabel.c
@@ -34,16 +34,15 @@
 #include "gtkintl.h"
 
 /**
- * SECTION:gtkeditablelabel
- * @Short_description: A label that can be edited
- * @Title: GtkEditableLabel
- * @See_also: #GtkEditable, #GtkLabel, #GtkEntry
+ * GtkEditableLabel:
  *
- * A GtkEditableLabel is a #GtkLabel that allows users to
- * edit the text by switching the widget to an “edit mode”.
+ * A `GtkEditableLabel` is a label that allows users to
+ * edit the text by switching to an “edit mode”.
  *
- * GtkEditableLabel does not have API of its own, but it
- * implements the #GtkEditable interface.
+ * ![An example GtkEditableLabel](editable-label.png)
+ *
+ * `GtkEditableLabel` does not have API of its own, but it
+ * implements the [iface@Gtk.Editable] interface.
  *
  * The default bindings for activating the edit mode is
  * to click or press the Enter key. The default bindings
@@ -59,12 +58,12 @@
  *     ╰── text
  * ]|
  *
- * GtkEditableLabel has a main node with the name editablelabel.
+ * `GtkEditableLabel` has a main node with the name editablelabel.
  * When the entry is in editing mode, it gets the .editing style
  * class.
  *
  * For all the subnodes added to the text node in various situations,
- * see #GtkText.
+ * see [class Gtk Text].
  */
 
 struct _GtkEditableLabel
@@ -431,9 +430,9 @@ gtk_editable_label_class_init (GtkEditableLabelClass *class)
  * gtk_editable_label_new:
  * @str: the text for the label
  *
- * Creates a new #GtkEditableLabel widget.
+ * Creates a new `GtkEditableLabel` widget.
  *
- * Returns: the new #GtkEditableLabel
+ * Returns: the new `GtkEditableLabel`
  */
 GtkWidget *
 gtk_editable_label_new (const char *str)
@@ -445,7 +444,7 @@ gtk_editable_label_new (const char *str)
 
 /**
  * gtk_editable_label_get_editing:
- * @self: a #GtkEditableLabel
+ * @self: a `GtkEditableLabel`
  *
  * Returns whether the label is currently in “editing mode”.
  *
@@ -461,7 +460,7 @@ gtk_editable_label_get_editing (GtkEditableLabel *self)
 
 /**
  * gtk_editable_label_start_editing:
- * @self: a #GtkEditableLabel
+ * @self: a `GtkEditableLabel`
  *
  * Switches the label into “editing mode”.
  */
@@ -483,13 +482,15 @@ gtk_editable_label_start_editing (GtkEditableLabel *self)
 
 /**
  * gtk_editable_label_stop_editing:
- * @self: a #GtkEditableLabel
+ * @self: a `GtkEditableLabel`
  * @commit: whether to set the edited text on the label
  *
- * Switches the label out of “editing mode”. If @commit is %TRUE,
- * the resulting text is kept as the #GtkEditable:text property
- * value, otherwise the resulting text is discarded and the label
- * will keep its previous #GtkEditable:text property value.
+ * Switches the label out of “editing mode”.
+ *
+ * If @commit is %TRUE, the resulting text is kept as the
+ * [property@Gtk.Editable:text] property value, otherwise the
+ * resulting text is discarded and the label will keep its
+ * previous [property@Gtk.Editable:text] property value.
  */
 void
 gtk_editable_label_stop_editing (GtkEditableLabel *self,


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