TrackEffect: Fixe the documentation
authorThibault Saunier <thibault.saunier@collabora.co.uk>
Mon, 31 Jan 2011 12:26:50 +0000 (13:26 +0100)
committerEdward Hervey <edward.hervey@collabora.co.uk>
Fri, 6 May 2011 08:39:00 +0000 (10:39 +0200)
docs/libs/ges-docs.sgml
ges/ges-track-effect.c

index f2c9d7f..94f614d 100644 (file)
@@ -67,6 +67,7 @@ platform as well as Windows. It is released under the GNU Library General Public
     <xi:include href="xml/ges-track-video-transition.xml"/>
     <xi:include href="xml/ges-track-audio-transition.xml"/>
     <xi:include href="xml/ges-track-image-source.xml"/>
+    <xi:include href="xml/ges-track-effect.xml"/>
   </chapter>
 
   <chapter>
index b0a496d..e608c7e 100644 (file)
@@ -166,6 +166,16 @@ ges_track_effect_create_element (GESTrackObject * object)
   return ret;
 }
 
+/**
+* ges_track_effect_new_from_bin_desc:
+* @bin_description: The gst-launch like bin description of the effect
+*
+* Creates a new #GESTrackEffect from the description of the bin. This is
+* a convenience method for testing puposes.
+*
+* Returns: a newly created #GESTrackEffect, or %NULL if something went
+* wrong.
+*/
 GESTrackEffect *
 ges_track_effect_new_from_bin_desc (const gchar * bin_description)
 {