Clarify docs of g_async_result_get_source_object
authorMatthias Clasen <mclasen@redhat.com>
Wed, 30 Sep 2009 00:33:39 +0000 (20:33 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Wed, 30 Sep 2009 00:33:39 +0000 (20:33 -0400)
It returns a new reference. Reported in bug 596748

gio/gasyncresult.c

index 4eb2a36..936a7bd 100644 (file)
@@ -176,12 +176,13 @@ g_async_result_get_user_data (GAsyncResult *res)
 
 /**
  * g_async_result_get_source_object:
- * @res: a #GAsyncResult.
- * 
+ * @res: a #GAsyncResult
+ *
  * Gets the source object from a #GAsyncResult.
- * 
- * Returns: the source object for the @res.
- **/
+ *
+ * Returns: a new reference to the source object for the @res,
+ *    or %NULL if there is none.
+ */
 GObject *
 g_async_result_get_source_object (GAsyncResult *res)
 {