ges: Add a few missing annotations
authorSebastian Dröge <sebastian@centricular.com>
Sat, 25 Sep 2021 13:34:49 +0000 (16:34 +0300)
committerGStreamer Marge Bot <gitlab-merge-bot@gstreamer-foundation.org>
Sun, 26 Sep 2021 06:59:04 +0000 (06:59 +0000)
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/921>

subprojects/gst-editing-services/ges/ges-clip-asset.c
subprojects/gst-editing-services/ges/ges-command-line-formatter.c
subprojects/gst-editing-services/ges/ges-effect-clip.c
subprojects/gst-editing-services/ges/ges-meta-container.c
subprojects/gst-editing-services/ges/ges-track-element-asset.c

index 38b8855..fa07545 100644 (file)
@@ -178,8 +178,8 @@ ges_clip_asset_get_supported_formats (GESClipAsset * self)
 /**
  * ges_clip_asset_get_natural_framerate:
  * @self: The object from which to retrieve the natural framerate
- * @framerate_n: The framerate numerator
- * @framerate_d: The framerate denominator
+ * @framerate_n: (out): The framerate numerator
+ * @framerate_d: (out): The framerate denominator
  *
  * Result: %TRUE if @self has a natural framerate %FALSE otherwise
  *
index 823d951..16607ba 100644 (file)
@@ -548,6 +548,17 @@ _ges_command_line_formatter_add_effect (GESTimeline * timeline,
   return _ges_container_add_child_from_struct (timeline, structure, error);
 }
 
+/**
+ * ges_command_line_formatter_get_help:
+ * @nargs: Number of commands in @commands
+ * @commands: (array length=nargs): Commands
+ *
+ * Creates a help string based on @commands.
+ *
+ * Result: (transfer full): A help string.
+ *
+ * Since: 1.20
+ */
 gchar *
 ges_command_line_formatter_get_help (gint nargs, gchar ** commands)
 {
@@ -1043,7 +1054,7 @@ _serialize_clip_effects (GESClip * clip, GString * res)
  * ges_command_line_formatter_get_timeline_uri:
  * @timeline: A GESTimeline to serialize
  *
- * Since: 1.20
+ * Since: 1.10
  */
 gchar *
 ges_command_line_formatter_get_timeline_uri (GESTimeline * timeline)
index 4b89054..de89acf 100644 (file)
@@ -251,8 +251,8 @@ _create_track_element (GESClip * self, GESTrackType type)
 
 /**
  * ges_effect_clip_new:
- * @video_bin_description: The gst-launch like bin description of the effect
- * @audio_bin_description: The gst-launch like bin description of the effect
+ * @video_bin_description: (nullable): The gst-launch like bin description of the effect
+ * @audio_bin_description: (nullable): The gst-launch like bin description of the effect
  *
  * Creates a new #GESEffectClip from the description of the bin.
  *
index 85fd902..28125db 100644 (file)
@@ -874,9 +874,9 @@ ges_meta_container_register_meta (GESMetaContainer * container,
  * ges_meta_container_check_meta_registered:
  * @container: A #GESMetaContainer
  * @meta_item: The key for the @container field to check
- * @flags: (out) (nullable): A destination to get the registered flags of
+ * @flags: (out) (optional): A destination to get the registered flags of
  * the field, or %NULL to ignore
- * @type: (out) (nullable): A destination to get the registered type of
+ * @type: (out) (optional): A destination to get the registered type of
  * the field, or %NULL to ignore
  *
  * Checks whether the specified field has been registered as static, and
index 87a9a19..f193500 100644 (file)
@@ -147,8 +147,8 @@ ges_track_element_asset_get_track_type (GESTrackElementAsset * asset)
 /**
  * ges_track_element_asset_get_natural_framerate:
  * @self: A #GESAsset
- * @framerate_n: The framerate numerator
- * @framerate_d: The framerate denominator
+ * @framerate_n: (out): The framerate numerator
+ * @framerate_d: (out): The framerate denominator
  *
  * Result: %TRUE if @self has a natural framerate %FALSE otherwise
  *