[docs] Document the destructor for Timeline
authorEmmanuele Bassi <ebassi@linux.intel.com>
Wed, 6 May 2009 15:42:57 +0000 (16:42 +0100)
committerEmmanuele Bassi <ebassi@linux.intel.com>
Wed, 6 May 2009 15:42:57 +0000 (16:42 +0100)
The rest of the API reference lists the destructor for the class
inside the constructor's return value -- except Timeline.

clutter/clutter-timeline.c

index e21a5ec..761c5e1 100644 (file)
@@ -1109,7 +1109,8 @@ clutter_timeline_clone (ClutterTimeline *timeline)
  * the value of the ClutterTimeline:fps property to compute the
  * equivalent number of frames.
  *
- * Return value: the newly created #ClutterTimeline
+ * Return value: the newly created #ClutterTimeline instance. Use
+ *   g_object_unref() when done using it
  *
  * Since: 0.6
  */
@@ -1128,7 +1129,8 @@ clutter_timeline_new_for_duration (guint msecs)
  *
  * Create a new  #ClutterTimeline instance.
  *
- * Return Value: a new #ClutterTimeline
+ * Return Value: the newly created #ClutterTimeline instance. Use
+ *   g_object_unref() when done using it
  */
 ClutterTimeline*
 clutter_timeline_new (guint n_frames,