glib r7539 - in trunk: . glib

[herzi svn gnome org]

Author: herzi
Date: Wed Sep 24 13:44:27 2008
New Revision: 7539
URL: http://svn.gnome.org/viewvc/glib?rev=7539&view=rev

Log:
2008-09-24  Sven Herzberg  <sven imendio com>

	Be a little more explcit in the docs. Includes Owen's requested
	changes.

	* glib/gmain.c: improved documentation for g_source_attach() and
	g_source_destroy()



Modified:
   trunk/ChangeLog
   trunk/glib/gmain.c

Modified: trunk/glib/gmain.c
==============================================================================
--- trunk/glib/gmain.c	(original)
+++ trunk/glib/gmain.c	Wed Sep 24 13:44:27 2008
@@ -639,7 +639,7 @@
  * @context: a #GMainContext (if %NULL, the default context will be used)
  * 
  * Adds a #GSource to a @context so that it will be executed within
- * that context.
+ * that context. Remove it by calling g_source_destroy().
  *
  * Return value: the ID (greater than 0) for the source within the 
  *   #GMainContext. 
@@ -1364,7 +1364,8 @@
  * g_timeout_add(), g_timeout_add_full(), g_child_watch_add(),
  * g_child_watch_add_full(), g_io_add_watch(), and g_io_add_watch_full().
  *
- * See also g_source_destroy().
+ * See also g_source_destroy(). You must use g_source_destroy() for sources
+ * added to a non-default main context.
  *
  * Return value: %TRUE if the source was found and removed.
  **/