Document the ::event signal (#420703).

2007-03-21  Ross Burton  <ross@burtonini.com>

	* gtk/gtktexttag.c:
	Document the ::event signal (#420703).

svn path=/trunk/; revision=17547

diff --git a/ChangeLog b/ChangeLog
index ba24fd110083ad0809ee0467831aff11d86ff833..0e3d298ea90ebbb3bdd0ff9f1ec77c90001f4d48 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2007-03-21  Ross Burton  <ross@burtonini.com>
+
+       * gtk/gtktexttag.c:
+       Document the ::event signal (#420703).
+
 2007-03-20  Kristian Rietveld  <kris@gtk.org>
 
        * gtk/gtktreeviewcolumn.c:

diff --git a/gtk/gtktexttag.c b/gtk/gtktexttag.c
index 3746f5704abff0448367864d9782d13ece4cac88..c1e42ec76d07d0997d3c181ed84b4ede7cbd6886 100644 (file)
--- a/gtk/gtktexttag.c
+++ b/gtk/gtktexttag.c
@@ -649,7 +649,20 @@ gtk_text_tag_class_init (GtkTextTagClass *klass)
   ADD_SET_PROP ("paragraph-background-set", PROP_PARAGRAPH_BACKGROUND_SET,
                 P_("Paragraph background set"),
                 P_("Whether this tag affects the paragraph background color"));
-  
+
+  /**
+   * GtkTextTag::event:
+   * @tag: the #GtkTextTag on which the signal is emitted
+   * @object: the object the event was fired from (typically a #GtkTextView)
+   * @event: the event which triggered the signal
+   * @iter: a #GtkTextIter pointing at the location the event occured
+   *
+   * The ::event signal is emitted when an event occurs on a region of the
+   * buffer marked with this tag.
+   *
+   * Returns: %TRUE to stop other handlers from being invoked for the
+   * event. %FALSE to propagate the event further.
+   */
   signals[EVENT] =
     g_signal_new (I_("event"),
                   G_OBJECT_CLASS_TYPE (object_class),