[gtk/ebassi/for-master: 8/9] docs: Add missing annotations for GtkTextTagTable




commit 4f67be1c8e7f44d0fbf1f99ca049f3be5ce0260f
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Tue Dec 1 15:04:09 2020 +0000

    docs: Add missing annotations for GtkTextTagTable

 gtk/gtktexttagtable.c | 9 +++++++++
 gtk/gtktexttagtable.h | 9 +++++++++
 2 files changed, 18 insertions(+)
---
diff --git a/gtk/gtktexttagtable.c b/gtk/gtktexttagtable.c
index 70980e3d8f..1435e7375c 100644
--- a/gtk/gtktexttagtable.c
+++ b/gtk/gtktexttagtable.c
@@ -126,6 +126,8 @@ gtk_text_tag_table_class_init (GtkTextTagTableClass *klass)
    * @texttagtable: the object which received the signal.
    * @tag: the changed tag.
    * @size_changed: whether the change affects the #GtkTextView layout.
+   *
+   * Emitted every time a tag in the #GtkTextTagTable changes.
    */
   signals[TAG_CHANGED] =
     g_signal_new (I_("tag-changed"),
@@ -146,6 +148,8 @@ gtk_text_tag_table_class_init (GtkTextTagTableClass *klass)
    * GtkTextTagTable::tag-added:
    * @texttagtable: the object which received the signal.
    * @tag: the added tag.
+   *
+   * Emitted every time a new tag is added in the #GtkTextTagTable.
    */
   signals[TAG_ADDED] =
     g_signal_new (I_("tag-added"),
@@ -162,6 +166,11 @@ gtk_text_tag_table_class_init (GtkTextTagTableClass *klass)
    * GtkTextTagTable::tag-removed:
    * @texttagtable: the object which received the signal.
    * @tag: the removed tag.
+   *
+   * Emitted every time a tag is removed from the #GtkTextTagTable.
+   *
+   * The @tag is still valid by the time the signal is emitted, but
+   * it is not associated with a tag table any more.
    */
   signals[TAG_REMOVED] =
     g_signal_new (I_("tag-removed"),  
diff --git a/gtk/gtktexttagtable.h b/gtk/gtktexttagtable.h
index 3602f17cf0..8076c77a68 100644
--- a/gtk/gtktexttagtable.h
+++ b/gtk/gtktexttagtable.h
@@ -37,6 +37,9 @@ G_BEGIN_DECLS
  * GtkTextTagTableForeach:
  * @tag: the #GtkTextTag
  * @data: (closure): data passed to gtk_text_tag_table_foreach()
+ *
+ * A function used with gtk_text_tag_table_foreach(), to iterate over every
+ * #GtkTextTag inside a #GtkTextTagTable.
  */
 typedef void (* GtkTextTagTableForeach) (GtkTextTag *tag, gpointer data);
 
@@ -44,6 +47,12 @@ typedef void (* GtkTextTagTableForeach) (GtkTextTag *tag, gpointer data);
 #define GTK_TEXT_TAG_TABLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TEXT_TAG_TABLE, 
GtkTextTagTable))
 #define GTK_IS_TEXT_TAG_TABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TEXT_TAG_TABLE))
 
+/**
+ * GtkTextTagTable:
+ *
+ * An object holding all the #GtkTextTag instances for a #GtkTextBuffer.
+ */
+
 GDK_AVAILABLE_IN_ALL
 GType          gtk_text_tag_table_get_type (void) G_GNUC_CONST;
 


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