[gtk+] Improve doc of gtk_text_tag_table_remove()



commit 425deda2be024274efbd34d08c1d1da262b6bb7d
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Mon Aug 5 20:37:54 2013 +0200

    Improve doc of gtk_text_tag_table_remove()
    
    It's obvious, but it's better to say it.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=705529

 gtk/gtktexttagtable.c |    9 +++++----
 1 files changed, 5 insertions(+), 4 deletions(-)
---
diff --git a/gtk/gtktexttagtable.c b/gtk/gtktexttagtable.c
index 6c9e500..571fdf8 100644
--- a/gtk/gtktexttagtable.c
+++ b/gtk/gtktexttagtable.c
@@ -310,10 +310,11 @@ gtk_text_tag_table_lookup (GtkTextTagTable *table,
  * gtk_text_tag_table_remove:
  * @table: a #GtkTextTagTable
  * @tag: a #GtkTextTag
- * 
- * Remove a tag from the table. This will remove the table's
- * reference to the tag, so be careful - the tag will end
- * up destroyed if you don't have a reference to it.
+ *
+ * Remove a tag from the table. If a #GtkTextBuffer has @table as its tag table,
+ * the tag is removed from the buffer. The table's reference to the tag is
+ * removed, so the tag will end up destroyed if you don't have a reference to
+ * it.
  **/
 void
 gtk_text_tag_table_remove (GtkTextTagTable *table,


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