Misc documentation fixing

2024-07-02 04:35:55 +00:00 · 2012-08-10 12:39:10 -04:00 · 2012-08-10 12:39:10 -04:00 · 37e6cb43cf
parent cc6200292f
commit 37e6cb43cf
20 changed files with 59 additions and 76 deletions
--- a/docs/libs/ges-sections.txt
+++ b/docs/libs/ges-sections.txt
@ -383,11 +383,9 @@ ges_timeline_pipeline_preview_get_audio_sink
 ges_timeline_pipeline_preview_get_video_sink
 ges_timeline_pipeline_preview_set_audio_sink
 ges_timeline_pipeline_preview_set_video_sink
-ges_timeline_pipeline_get_thumbnail_buffer
+ges_timeline_pipeline_get_thumbnail
 ges_timeline_pipeline_get_thumbnail_rgb24
 ges_timeline_pipeline_save_thumbnail
-ges_timeline_pipeline_preview_get_video_sink
-ges_timeline_pipeline_preview_set_video_sink
 <SUBSECTION Standard>
 GESTimelinePipelineClass
 GESTimelinePipelinePrivate
--- a/ges/ges-formatter.h
+++ b/ges/ges-formatter.h
@ -121,7 +121,7 @@ typedef gboolean (*GESFormatterSourceMovedMethod)        (GESFormatter *formatte
 					   GESTimelineFileSource *tfs, gchar *new_uri);

 /**
- * GESFormatterLoadedMethod
+ * GESFormatterLoadedMethod:
 * @formatter: The #GESFormatter that is done loading
 * @timeline: The #GESTimeline that has finnished to load
 *
--- a/ges/ges-simple-timeline-layer.c
+++ b/ges/ges-simple-timeline-layer.c
@ -131,7 +131,7 @@ ges_simple_timeline_layer_class_init (GESSimpleTimelineLayerClass * klass)
          "Layer is in a valid configuration", FALSE, G_PARAM_READABLE));

  /**
-   * GESSimpleTimelineLayer::object-moved
+   * GESSimpleTimelineLayer::object-moved:
   * @layer: the #GESSimpleTimelineLayer
   * @object: the #GESTimelineObject that was added
   * @old: the previous position of the object
@ -211,9 +211,9 @@ gstl_recalculate (GESSimpleTimelineLayer * self)
      if (pos < 0)
        pos = 0;

-      GST_LOG ("%p obj: height: %d: trans_priority %d Position: %" G_GINT64_FORMAT
-          ", duration %" G_GINT64_FORMAT, obj, height, transition_priority, pos,
-          dur);
+      GST_LOG ("%p obj: height: %d: trans_priority %d Position: %"
+          G_GINT64_FORMAT ", duration %" G_GINT64_FORMAT, obj, height,
+          transition_priority, pos, dur);

      g_assert (transition_priority != -1);

--- a/ges/ges-timeline-effect.c
+++ b/ges/ges-timeline-effect.c
@ -27,8 +27,6 @@
 * In a #GESSimpleTimelineLayer, the priorities will be set for you but if
 * you use another type of #GESTimelineLayer, you will have to handle it
 * yourself.
- *
- * @Since: 0.10.2
 */

 #include <ges/ges.h>
--- a/ges/ges-timeline-file-source.h
+++ b/ges/ges-timeline-file-source.h
@ -47,11 +47,6 @@ G_BEGIN_DECLS

 typedef struct _GESTimelineFileSourcePrivate GESTimelineFileSourcePrivate;

-/**
- * GESTimelineSource:
- * 
- */
-
 struct _GESTimelineFileSource {
  GESTimelineSource parent;

--- a/ges/ges-timeline-layer.c
+++ b/ges/ges-timeline-layer.c
@ -135,7 +135,7 @@ ges_timeline_layer_class_init (GESTimelineLayerClass * klass)
  object_class->dispose = ges_timeline_layer_dispose;

  /**
-   * GESTimelineLayer:priority
+   * GESTimelineLayer:priority:
   *
   * The priority of the layer in the #GESTimeline. 0 is the highest
   * priority. Conceptually, a #GESTimeline is a stack of GESTimelineLayers,
@ -147,7 +147,7 @@ ges_timeline_layer_class_init (GESTimelineLayerClass * klass)
          "The priority of the layer", 0, G_MAXUINT, 0, G_PARAM_READWRITE));

  /**
-   * GESTimelineLayer:auto-transition
+   * GESTimelineLayer:auto-transition:
   *
   * Sets whether transitions are added automagically when timeline objects overlap.
   */
@ -156,7 +156,7 @@ ges_timeline_layer_class_init (GESTimelineLayerClass * klass)
          "whether the transitions are added", FALSE, G_PARAM_READWRITE));

  /**
-   * GESTimelineLayer::object-added
+   * GESTimelineLayer::object-added:
   * @layer: the #GESTimelineLayer
   * @object: the #GESTimelineObject that was added.
   *
@ -169,7 +169,7 @@ ges_timeline_layer_class_init (GESTimelineLayerClass * klass)
      GES_TYPE_TIMELINE_OBJECT);

  /**
-   * GESTimelineLayer::object-removed
+   * GESTimelineLayer::object-removed:
   * @layer: the #GESTimelineLayer
   * @object: the #GESTimelineObject that was removed
   *
--- a/ges/ges-timeline-object.c
+++ b/ges/ges-timeline-object.c
@ -242,7 +242,7 @@ ges_timeline_object_class_init (GESTimelineObjectClass * klass)
  klass->track_object_released = NULL;

  /**
-   * GESTimelineObject:start
+   * GESTimelineObject:start:
   *
   * The position of the object in the #GESTimelineLayer (in nanoseconds).
   */
@ -252,7 +252,7 @@ ges_timeline_object_class_init (GESTimelineObjectClass * klass)
      properties[PROP_START]);

  /**
-   * GESTimelineObject:in-point
+   * GESTimelineObject:in-point:
   *
   * The in-point at which this #GESTimelineObject will start outputting data
   * from its contents (in nanoseconds).
@ -267,7 +267,7 @@ ges_timeline_object_class_init (GESTimelineObjectClass * klass)
      properties[PROP_INPOINT]);

  /**
-   * GESTimelineObject:duration
+   * GESTimelineObject:duration:
   *
   * The duration (in nanoseconds) which will be used in the container #GESTrack
   * starting from 'in-point'.
@ -279,7 +279,7 @@ ges_timeline_object_class_init (GESTimelineObjectClass * klass)
      properties[PROP_DURATION]);

  /**
-   * GESTimelineObject:priority
+   * GESTimelineObject:priority:
   *
   * The layer priority of the timeline object.
   */
@ -289,7 +289,7 @@ ges_timeline_object_class_init (GESTimelineObjectClass * klass)
      properties[PROP_PRIORITY]);

  /**
-   * GESTimelineObject:height
+   * GESTimelineObject:height:
   *
   * The span of layer priorities which this object occupies.
   */
@ -315,7 +315,7 @@ ges_timeline_object_class_init (GESTimelineObjectClass * klass)
      properties[PROP_SUPPORTED_FORMATS]);

  /**
-   * GESTimelineObject:layer
+   * GESTimelineObject:layer:
   *
   * The GESTimelineLayer where this object is being used.
   */
@ -326,7 +326,7 @@ ges_timeline_object_class_init (GESTimelineObjectClass * klass)
      properties[PROP_LAYER]);

  /**
-   * GESTimelineObject::effect-added
+   * GESTimelineObject::effect-added:
   * @object: the #GESTimelineObject
   * @effect: the #GESTrackEffect that was added.
   *
@ -340,7 +340,7 @@ ges_timeline_object_class_init (GESTimelineObjectClass * klass)
      G_TYPE_NONE, 1, GES_TYPE_TRACK_EFFECT);

  /**
-   * GESTimelineObject::effect-removed
+   * GESTimelineObject::effect-removed:
   * @object: the #GESTimelineObject
   * @effect: the #GESTrackEffect that was added.
   *
@ -354,7 +354,7 @@ ges_timeline_object_class_init (GESTimelineObjectClass * klass)
      G_TYPE_NONE, 1, GES_TYPE_TRACK_EFFECT);

  /**
-   * GESTimelineObject::track-object-added
+   * GESTimelineObject::track-object-added:
   * @object: the #GESTimelineObject
   * @tckobj: the #GESTrackObject that was added.
   *
@ -368,7 +368,7 @@ ges_timeline_object_class_init (GESTimelineObjectClass * klass)
      G_TYPE_NONE, 1, GES_TYPE_TRACK_OBJECT);

  /**
-   * GESTimelineObject::track-object-removed
+   * GESTimelineObject::track-object-removed:
   * @object: the #GESTimelineObject
   * @tckobj: the #GESTrackObject that was removed.
   *
@ -1404,9 +1404,7 @@ ges_timeline_object_edit (GESTimelineObject * object, GList * layers,
 * The function modifies @object, and creates another #GESTimelineObject so
 * we have two clips at the end, splitted at the time specified by @position.
 *
- * Returns: The newly created #GESTimelineObject resulting from the splitting
- *
- * Since: 0.10.XX
+ * Returns: (transfer floating): The newly created #GESTimelineObject resulting from the splitting
 */
 GESTimelineObject *
 ges_timeline_object_split (GESTimelineObject * object, guint64 position)
--- a/ges/ges-timeline-parse-launch-effect.c
+++ b/ges/ges-timeline-parse-launch-effect.c
@ -30,8 +30,6 @@
 * In a #GESSimpleTimelineLayer, the priorities will be set for you but if
 * you use another type of #GESTimelineLayer, you will have to handle it
 * yourself.
- *
- * @Since: 0.10.2
 */

 #include <ges/ges.h>
--- a/ges/ges-timeline-standard-transition.c
+++ b/ges/ges-timeline-standard-transition.c
@ -124,7 +124,7 @@ ges_timeline_standard_transition_class_init (GESTimelineStandardTransitionClass
  object_class->set_property = ges_timeline_standard_transition_set_property;

  /**
-   * GESTimelineStandardTransition:vtype
+   * GESTimelineStandardTransition:vtype:
   *
   * a #GESVideoStandardTransitionType representing the wipe to use
   */
--- a/ges/ges-timeline-test-source.c
+++ b/ges/ges-timeline-test-source.c
@ -130,7 +130,7 @@ ges_timeline_test_source_class_init (GESTimelineTestSourceClass * klass)
          GES_VIDEO_TEST_PATTERN_BLACK, G_PARAM_READWRITE | G_PARAM_CONSTRUCT));

  /**
-   * GESTimelineTestSource:freq
+   * GESTimelineTestSource:freq:
   *
   * The frequency to generate for audio track objects.
   */
@ -140,7 +140,7 @@ ges_timeline_test_source_class_init (GESTimelineTestSourceClass * klass)
          0, 20000, 440, G_PARAM_READWRITE | G_PARAM_CONSTRUCT));

  /**
-   * GESTimelineTestSource:volume
+   * GESTimelineTestSource:volume:
   *
   * The volume for the audio track objects.
   */
--- a/ges/ges-timeline-text-overlay.c
+++ b/ges/ges-timeline-text-overlay.c
@ -161,7 +161,7 @@ ges_timeline_text_overlay_class_init (GESTimelineTextOverlayClass * klass)
  object_class->dispose = ges_timeline_text_overlay_dispose;

  /**
-   * GESTimelineTextOverlay:text
+   * GESTimelineTextOverlay:text:
   *
   * The text to diplay
   */
@ -171,7 +171,7 @@ ges_timeline_text_overlay_class_init (GESTimelineTextOverlayClass * klass)
          DEFAULT_PROP_TEXT, G_PARAM_READWRITE | G_PARAM_CONSTRUCT));

  /**
-   * GESTimelineTextOverlay:font-desc
+   * GESTimelineTextOverlay:font-desc:
   *
   * Pango font description string
   */
@ -184,7 +184,7 @@ ges_timeline_text_overlay_class_init (GESTimelineTextOverlayClass * klass)
          G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));

  /**
-   * GESTimelineTextOverlay:valignment
+   * GESTimelineTextOverlay:valignment:
   *
   * Vertical alignent of the text
   */
@ -194,7 +194,7 @@ ges_timeline_text_overlay_class_init (GESTimelineTextOverlayClass * klass)
          DEFAULT_PROP_VALIGNMENT, G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
          G_PARAM_STATIC_STRINGS));
  /**
-   * GESTimelineTextOverlay:halignment
+   * GESTimelineTextOverlay:halignment:
   *
   * Horizontal alignment of the text
   */
@ -209,7 +209,7 @@ ges_timeline_text_overlay_class_init (GESTimelineTextOverlayClass * klass)
  timobj_class->need_fill_track = FALSE;

  /**
-   * GESTimelineTextOverlay:color
+   * GESTimelineTextOverlay:color:
   *
   * The color of the text
   */
@ -219,7 +219,7 @@ ges_timeline_text_overlay_class_init (GESTimelineTextOverlayClass * klass)
          0, G_MAXUINT32, G_MAXUINT32, G_PARAM_READWRITE | G_PARAM_CONSTRUCT));

  /**
-   * GESTimelineTextOverlay:xpos
+   * GESTimelineTextOverlay:xpos:
   *
   * The horizontal position of the text
   */
@ -229,7 +229,7 @@ ges_timeline_text_overlay_class_init (GESTimelineTextOverlayClass * klass)
          0, 1, 0.5, G_PARAM_READWRITE | G_PARAM_CONSTRUCT));

  /**
-   * GESTimelineTextOverlay:ypos
+   * GESTimelineTextOverlay:ypos:
   *
   * The vertical position of the text
   */
--- a/ges/ges-timeline-title-source.c
+++ b/ges/ges-timeline-title-source.c
@ -238,7 +238,7 @@ ges_timeline_title_source_class_init (GESTimelineTitleSourceClass * klass)
      ges_timeline_title_source_track_object_released;

  /**
-   * GESTimelineTitleSource:color
+   * GESTimelineTitleSource:color:
   *
   * The color of the text
   */
@ -248,7 +248,7 @@ ges_timeline_title_source_class_init (GESTimelineTitleSourceClass * klass)
          0, G_MAXUINT32, G_MAXUINT32, G_PARAM_READWRITE | G_PARAM_CONSTRUCT));

  /**
-   * GESTimelineTitleSource:xpos
+   * GESTimelineTitleSource:xpos:
   *
   * The horizontal position of the text
   */
@ -258,7 +258,7 @@ ges_timeline_title_source_class_init (GESTimelineTitleSourceClass * klass)
          0, 1, 0.5, G_PARAM_READWRITE | G_PARAM_CONSTRUCT));

  /**
-   * GESTimelineTitleSource:ypos
+   * GESTimelineTitleSource:ypos:
   *
   * The vertical position of the text
   */
--- a/ges/ges-timeline.c
+++ b/ges/ges-timeline.c
@ -301,7 +301,7 @@ ges_timeline_class_init (GESTimelineClass * klass)
  object_class->finalize = ges_timeline_finalize;

  /**
-   * GESTimeline:duration
+   * GESTimeline:duration:
   *
   * Current duration (in nanoseconds) of the #GESTimeline
   */
@ -313,7 +313,7 @@ ges_timeline_class_init (GESTimelineClass * klass)
      properties[PROP_DURATION]);

  /**
-   * GESTimeline:snapping-distance
+   * GESTimeline:snapping-distance:
   *
   * Distance (in nanoseconds) from which a moving object will snap
   * with it neighboors. 0 means no snapping.
@ -347,7 +347,7 @@ ges_timeline_class_init (GESTimelineClass * klass)
      properties[PROP_UPDATE]);

  /**
-   * GESTimeline::track-added
+   * GESTimeline::track-added:
   * @timeline: the #GESTimeline
   * @track: the #GESTrack that was added to the timeline
   *
@ -359,7 +359,7 @@ ges_timeline_class_init (GESTimelineClass * klass)
      NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 1, GES_TYPE_TRACK);

  /**
-   * GESTimeline::track-removed
+   * GESTimeline::track-removed:
   * @timeline: the #GESTimeline
   * @track: the #GESTrack that was removed from the timeline
   *
@ -371,7 +371,7 @@ ges_timeline_class_init (GESTimelineClass * klass)
      NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 1, GES_TYPE_TRACK);

  /**
-   * GESTimeline::layer-added
+   * GESTimeline::layer-added:
   * @timeline: the #GESTimeline
   * @layer: the #GESTimelineLayer that was added to the timeline
   *
@ -384,7 +384,7 @@ ges_timeline_class_init (GESTimelineClass * klass)
      GES_TYPE_TIMELINE_LAYER);

  /**
-   * GESTimeline::layer-removed
+   * GESTimeline::layer-removed:
   * @timeline: the #GESTimeline
   * @layer: the #GESTimelineLayer that was removed from the timeline
   *
@ -2465,7 +2465,7 @@ ges_timeline_enable_update (GESTimeline * timeline, gboolean enabled)
 }

 /**
- * ges_timeline_get_duration
+ * ges_timeline_get_duration:
 * @timeline: a #GESTimeline
 *
 * Get the current duration of @timeline
--- a/ges/ges-track-effect.c
+++ b/ges/ges-track-effect.c
@ -21,8 +21,6 @@
 * SECTION:ges-track-effect
 * @short_description: adds an effect to a stream in a #GESTimelineSource or a
 * #GESTimelineLayer
- *
- * @Since: 0.10.2
 */

 #include <glib/gprintf.h>
--- a/ges/ges-track-filesource.c
+++ b/ges/ges-track-filesource.c
@ -108,7 +108,7 @@ ges_track_filesource_class_init (GESTrackFileSourceClass * klass)
  object_class->dispose = ges_track_filesource_dispose;

  /**
-   * GESTrackFileSource:uri
+   * GESTrackFileSource:uri:
   *
   * The location of the file/resource to use.
   */
--- a/ges/ges-track-image-source.c
+++ b/ges/ges-track-image-source.c
@ -160,7 +160,7 @@ ges_track_image_source_class_init (GESTrackImageSourceClass * klass)
  object_class->dispose = ges_track_image_source_dispose;

  /**
-   * GESTrackImageSource:uri
+   * GESTrackImageSource:uri:
   *
   * The location of the file/resource to use.
   */
--- a/ges/ges-track-object.c
+++ b/ges/ges-track-object.c
@ -242,7 +242,7 @@ ges_track_object_class_init (GESTrackObjectClass * klass)
  object_class->finalize = ges_track_object_finalize;

  /**
-   * GESTrackObject:start
+   * GESTrackObject:start:
   *
   * The position of the object in the container #GESTrack (in nanoseconds).
   */
@ -252,7 +252,7 @@ ges_track_object_class_init (GESTrackObjectClass * klass)
      properties[PROP_START]);

  /**
-   * GESTrackObject:in-point
+   * GESTrackObject:in-point:
   *
   * The in-point at which this #GESTrackObject will start outputting data
   * from its contents (in nanoseconds).
@ -267,7 +267,7 @@ ges_track_object_class_init (GESTrackObjectClass * klass)
      properties[PROP_INPOINT]);

  /**
-   * GESTrackObject:duration
+   * GESTrackObject:duration:
   *
   * The duration (in nanoseconds) which will be used in the container #GESTrack
   * starting from 'in-point'.
@ -280,7 +280,7 @@ ges_track_object_class_init (GESTrackObjectClass * klass)
      properties[PROP_DURATION]);

  /**
-   * GESTrackObject:priority
+   * GESTrackObject:priority:
   *
   * The priority of the object within the containing #GESTrack.
   * If two objects intersect over the same region of time, the @priority
@ -296,7 +296,7 @@ ges_track_object_class_init (GESTrackObjectClass * klass)
      properties[PROP_PRIORITY]);

  /**
-   * GESTrackObject:active
+   * GESTrackObject:active:
   *
   * Whether the object should be taken into account in the #GESTrack output.
   * If #FALSE, then its contents will not be used in the resulting track.
@ -308,7 +308,7 @@ ges_track_object_class_init (GESTrackObjectClass * klass)
      properties[PROP_ACTIVE]);

  /**
-   * GESTrackObject:locked
+   * GESTrackObject:locked:
   *
   * If %TRUE, then moves in sync with its controlling #GESTimelineObject
   */
@ -1554,7 +1554,7 @@ ges_track_object_set_max_duration (GESTrackObject * object, guint64 maxduration)
 *
 * Copies @object
 *
- * Returns: The newly create #GESTrackObject, copied from @object
+ * Returns: (transfer floating): The newly create #GESTrackObject, copied from @object
 *
 * Since: 0.10.XX
 */
--- a/ges/ges-track-parse-launch-effect.c
+++ b/ges/ges-track-parse-launch-effect.c
@ -21,8 +21,6 @@
 * SECTION:ges-track-parse-launch-effect
 * @short_description: adds an effect build from a parse-launch style 
 * bin description to a stream in a #GESTimelineSource or a #GESTimelineLayer
- *
- * @Since: 0.10.2
 */

 #include "ges-internal.h"
--- a/ges/ges-track-video-transition.c
+++ b/ges/ges-track-video-transition.c
@ -121,7 +121,7 @@ ges_track_video_transition_class_init (GESTrackVideoTransitionClass * klass)
  object_class->finalize = ges_track_video_transition_finalize;

  /**
-   * GESTrackVideoTransition:border
+   * GESTrackVideoTransition:border:
   *
   * This value represents the border width of the transition.
   *
@ -133,7 +133,7 @@ ges_track_video_transition_class_init (GESTrackVideoTransitionClass * klass)
      properties[PROP_BORDER]);

  /**
-   * GESTrackVideoTransition:type
+   * GESTrackVideoTransition:type:
   *
   * The #GESVideoStandardTransitionType currently applied on the object
   *
@ -146,7 +146,7 @@ ges_track_video_transition_class_init (GESTrackVideoTransitionClass * klass)
      properties[PROP_TRANSITION_TYPE]);

  /**
-   * GESTrackVideoTransition:invert
+   * GESTrackVideoTransition:invert:
   *
   * This value represents the direction of the transition.
   *
@ -789,7 +789,7 @@ ges_track_video_transition_get_border (GESTrackVideoTransition * self)
 /**
 * ges_track_video_transition_set_inverted:
 * @self: The #GESTrackVideoTransition to set invert on
- * @value: The value of the  to set on @object
+ * @inverted: %TRUE if the transition should be inverted %FALSE otherwise
 *
 * Set the invert property of @self, this value represents
 * the direction of the transition. In case this value does
--- a/ges/ges-track.c
+++ b/ges/ges-track.c
@ -536,7 +536,7 @@ ges_track_class_init (GESTrackClass * klass)
  object_class->finalize = ges_track_finalize;

  /**
-   * GESTrack:caps
+   * GESTrack:caps:
   *
   * Caps used to filter/choose the output stream. This is generally set to
   * a generic set of caps like 'video/x-raw' for raw video.
@ -550,7 +550,7 @@ ges_track_class_init (GESTrackClass * klass)
      properties[ARG_CAPS]);

  /**
-   * GESTrack:duration
+   * GESTrack:duration:
   *
   * Current duration of the track
   *
@ -563,7 +563,7 @@ ges_track_class_init (GESTrackClass * klass)
      properties[ARG_DURATION]);

  /**
-   * GESTrack:track-type
+   * GESTrack:track-type:
   *
   * Type of stream the track outputs. This is used when creating the #GESTrack
   * to specify in generic terms what type of content will be outputted.
@ -580,7 +580,7 @@ ges_track_class_init (GESTrackClass * klass)
      properties[ARG_TYPE]);

  /**
-   * GESTrack::track-object-added
+   * GESTrack::track-object-added:
   * @object: the #GESTrack
   * @effect: the #GESTrackObject that was added.
   *
@ -594,7 +594,7 @@ ges_track_class_init (GESTrackClass * klass)
      G_TYPE_NONE, 1, GES_TYPE_TRACK_OBJECT);

  /**
-   * GESTrack::track-object-removed
+   * GESTrack::track-object-removed:
   * @object: the #GESTrack
   * @effect: the #GESTrackObject that was removed.
   *