Tiny fixes in the documentation
authorCorentin Noël <corentin@elementary.io>
Sun, 2 Apr 2017 21:03:18 +0000 (23:03 +0200)
committerThibault Saunier <thibault.saunier@osg.samsung.com>
Mon, 3 Apr 2017 00:25:38 +0000 (21:25 -0300)
https://bugzilla.gnome.org/show_bug.cgi?id=780854

ges/ges-layer.c
ges/ges-pipeline.c
ges/ges-timeline.c

index ce94993..86eaaef 100644 (file)
@@ -356,7 +356,7 @@ ges_layer_get_duration (GESLayer * layer)
  * removed. If you wish to use the @clip after this function, make sure you
  * call gst_object_ref() before removing it from the @layer.
  *
- * Returns: TRUE if the clip could be removed, FALSE if the layer does
+ * Returns: %TRUE if the clip could be removed, %FALSE if the layer does
  * not want to remove the clip.
  */
 gboolean
index 2391de6..3458279 100644 (file)
@@ -928,8 +928,8 @@ _unlink_track (GESPipeline * self, GESTrack * track)
  *
  * The reference to the @timeline will be stolen by the @pipeline.
  *
- * Returns: TRUE if the @timeline could be successfully set on the @pipeline,
- * else FALSE.
+ * Returns: %TRUE if the @timeline could be successfully set on the @pipeline,
+ * else %FALSE.
  */
 gboolean
 ges_pipeline_set_timeline (GESPipeline * pipeline, GESTimeline * timeline)
index 0d0fd47..3b62226 100644 (file)
@@ -2819,8 +2819,8 @@ ges_timeline_new (void)
  *
  * Creates a timeline from the given URI.
  *
- * Returns (transfer floating) (nullable): A new timeline if the uri was loaded
- * successfully, or NULL if the uri could not be loaded.
+ * Returns: (transfer floating) (nullable): A new timeline if the uri was loaded
+ * successfully, or %NULL if the uri could not be loaded.
  */
 GESTimeline *
 ges_timeline_new_from_uri (const gchar * uri, GError ** error)
@@ -3413,7 +3413,7 @@ ges_timeline_commit_unlocked (GESTimeline * timeline)
  * directly executed in the non-linear engine. Call this method once you are
  * done with a set of changes and want it to be executed.
  *
- * The GESTimeline::commited signal will be emitted when the (possibly updated)
+ * The #GESTimeline::commited signal will be emitted when the (possibly updated)
  * #GstPipeline is ready to output data again, except if the state of the
  * timeline was #GST_STATE_READY or #GST_STATE_NULL.
  *
@@ -3423,7 +3423,7 @@ ges_timeline_commit_unlocked (GESTimeline * timeline)
  *
  * You should not try to change the state of the timeline, seek it or add
  * tracks to it during a commit operation, that is between a call to this
- * function and after receiving the GESTimeline::commited signal.
+ * function and after receiving the #GESTimeline::commited signal.
  *
  * See #ges_timeline_commit_sync if you don't want to bother with waiting
  * for the signal.