Re: gst-editing-services: ges: Doc fixes

[Stefan Sauer]

Am 06.05.2011 20:43, schrieb Edward Hervey:

> Module: gst-editing-services
> Branch: master
> Commit: a6f3ae6dacfff0fe8cda4afbbd5ad86a8a31a7f7
> URL:    http://cgit.freedesktop.org/gstreamer/gst-editing-services/commit/?id=a6f3ae6dacfff0fe8cda4afbbd5ad86a8a31a7f7
>
> Author: Edward Hervey <[hidden email]>
> Date:   Fri May  6 19:38:26 2011 +0200
>
> ges: Doc fixes
>
> ---
>
>  ges/ges-timeline-object.c              |   15 ++++++++-------
>  ges/ges-timeline-parse-launch-effect.c |   11 ++++++-----
>  ges/ges-track-object.c                 |    8 ++++----
>  ges/ges-track-parse-launch-effect.c    |   27 ++++++++++++++-------------
>  4 files changed, 32 insertions(+), 29 deletions(-)
>
> diff --git a/ges/ges-timeline-object.c b/ges/ges-timeline-object.c
> index 08e3b5a..f40f78d 100644
> --- a/ges/ges-timeline-object.c
> +++ b/ges/ges-timeline-object.c
> @@ -744,10 +744,11 @@ ges_timeline_object_set_priority (GESTimelineObject * object, guint priority)
>   * Finds the #GESTrackObject controlled by @object that is used in @track. You
>   * may optionally specify a GType to further narrow search criteria.
>   *
> - * Note: The reference count of the returned #GESTrackObject will be increased,
> - * unref when done with it.
> + * Note: If many objects match, then the one with the highest priority will be
> + * returned.
>   *
>   * Returns: (transfer full): The #GESTrackObject used by @track, else #NULL.
> + * Unref after usage.

It should be %NULL instead of #NULL. % is for constants, # is for
objects/structs/types, @ is for parameters.

Stefan

>   */
>  
>  GESTrackObject *
> @@ -779,11 +780,11 @@ ges_timeline_object_find_track_object (GESTimelineObject * object,
>   * ges_timeline_object_get_layer:
>   * @object: a #GESTimelineObject
>   *
> - * Note: The reference count of the returned #GESTimelineLayer will be increased,
> - * The user is responsible for unreffing it.
> + * Get the #GESTimelineLayer to which this object belongs.
>   *
> - * Returns: (transfer full): The #GESTimelineLayer where this @object is being used, #NULL if
> - * it is not used on any layer.
> + * Returns: (transfer full): The #GESTimelineLayer where this @object is being
> + * used, or #NULL if it is not used on any layer. The caller should unref it
> + * usage.
>   */
>  GESTimelineLayer *
>  ges_timeline_object_get_layer (GESTimelineObject * object)
> @@ -902,7 +903,7 @@ ges_timeline_object_get_top_effect_position (GESTimelineObject * object,
>  *
>  * This is a convenience method that lets you set the priority of a top effect.
>  *
> -* Returns: %TRUE if @effect was successfuly moved, %FALSE otherwize.
> +* Returns: %TRUE if @effect was successfuly moved, %FALSE otherwise.
>  */
>  gboolean
>  ges_timeline_object_set_top_effect_priority (GESTimelineObject * object,
> diff --git a/ges/ges-timeline-parse-launch-effect.c b/ges/ges-timeline-parse-launch-effect.c
> index 5799e4b..18ef944 100644
> --- a/ges/ges-timeline-parse-launch-effect.c
> +++ b/ges/ges-timeline-parse-launch-effect.c
> @@ -108,11 +108,12 @@ ges_timeline_parse_launch_effect_class_init (GESTimelineParseLaunchEffectClass *
>    object_class->set_property = ges_timeline_parse_launch_effect_set_property;
>  
>    /**
> -   * GESTimelineParseLaunchEffect:video_bin_description:
> +   * GESTimelineParseLaunchEffect:video-bin-description:
>     *
>     * The description of the video track of the effect bin with a gst-launch-style
>     * pipeline description. This should be used for test purposes.
> -   * exemple: videobalance saturation=1.5 hue=+0.5
> +   *
> +   * Example: "videobalance saturation=1.5 hue=+0.5"
>     */
>    g_object_class_install_property (object_class, PROP_VIDEO_BIN_DESCRIPTION,
>        g_param_spec_string ("video-bin-description",
> @@ -121,11 +122,12 @@ ges_timeline_parse_launch_effect_class_init (GESTimelineParseLaunchEffectClass *
>            NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
>  
>    /**
> -   * GESTimelineParseLaunchEffect:audio_bin_description:
> +   * GESTimelineParseLaunchEffect:audio-bin-description:
>     *
>     * The description of the audio track of the effect bin with a gst-launch-style
>     * pipeline description. This should be used for test purposes.
> -   * exemple: videobalance saturation=1.5 hue=+0.5
> +   *
> +   * Example: "audiopanorama panorama=1.0"
>     */
>    g_object_class_install_property (object_class, PROP_AUDIO_BIN_DESCRIPTION,
>        g_param_spec_string ("audio-bin-description",
> @@ -154,7 +156,6 @@ ges_tl_parse_launch_effect_create_track_obj (GESTimelineObject * self,
>    GESTimelineParseLaunchEffect *effect =
>        GES_TIMELINE_PARSE_LAUNCH_EFFECT (self);
>  
> -
>    if (track->type == GES_TRACK_TYPE_VIDEO) {
>      if (effect->priv->video_bin_description != NULL) {
>        GST_DEBUG ("Creating a GESTrackEffect for the video track");
> diff --git a/ges/ges-track-object.c b/ges/ges-track-object.c
> index f8b324e..e85caa4 100644
> --- a/ges/ges-track-object.c
> +++ b/ges/ges-track-object.c
> @@ -286,7 +286,7 @@ ges_track_object_class_init (GESTrackObjectClass * klass)
>        G_TYPE_NONE, 2, GST_TYPE_ELEMENT, G_TYPE_PARAM);
>  
>    klass->create_gnl_object = ges_track_object_create_gnl_object_func;
> -  /*  There is no 'get_props_hastable' default implementation */
> +  /*  There is no 'get_props_hashtable' default implementation */
>    klass->get_props_hastable = NULL;
>    klass->list_children_properties = default_list_children_properties;
>  }
> @@ -991,11 +991,11 @@ ges_track_object_is_active (GESTrackObject * object)
>      return object->active;
>  }
>  
> -/*
> +/**
>   * ges_track_object_lookup_child:
>   * @object: object to lookup the property in
>   * @prop_name: name of the property to look up. You can specify the name of the
> - *     class as such: ClassName::property-name, to guarantee that you get the
> + *     class as such: "ClassName::property-name", to guarantee that you get the
>   *     proper GParamSpec in case various GstElement-s contain the same property
>   *     name. If you don't do so, you will get the first element found, having
>   *     this property and the and the corresponding GParamSpec.
> @@ -1250,7 +1250,7 @@ cant_copy:
>   * Gets an array of #GParamSpec* for all configurable properties of the
>   * children of @object.
>   *
> - * Returns: an array of #GParamSpec* which should be freed after use or %NULL
> + * Returns: (array): an array of #GParamSpec* which should be freed after use or %NULL
>   * if something went wrong
>   */
>  GParamSpec **
> diff --git a/ges/ges-track-parse-launch-effect.c b/ges/ges-track-parse-launch-effect.c
> index 6aea39b..6d12d9b 100644
> --- a/ges/ges-track-parse-launch-effect.c
> +++ b/ges/ges-track-parse-launch-effect.c
> @@ -93,11 +93,12 @@ ges_track_parse_launch_effect_class_init (GESTrackParseLaunchEffectClass *
>    obj_bg_class->create_element = ges_track_parse_launch_effect_create_element;
>  
>    /**
> -   * GESTrackParseLaunchEffect:bin_description:
> +   * GESTrackParseLaunchEffect:bin-description:
>     *
>     * The description of the effect bin with a gst-launch-style
>     * pipeline description.
> -   * exemple: videobalance saturation=1.5 hue=+0.5
> +   *
> +   * Example: "videobalance saturation=1.5 hue=+0.5"
>     */
>    g_object_class_install_property (object_class, PROP_BIN_DESCRIPTION,
>        g_param_spec_string ("bin-description",
> @@ -144,7 +145,7 @@ ges_track_parse_launch_effect_create_element (GESTrackObject * object)
>  
>    if (!track) {
>      GST_WARNING
> -        ("The object %p should be in a Track for the element to be created");
> +      ("The object %p should be in a Track for the element to be created", object);
>      return NULL;
>    }
>  
> @@ -163,25 +164,25 @@ ges_track_parse_launch_effect_create_element (GESTrackObject * object)
>    g_free (bin_desc);
>  
>    if (error != NULL) {
> -    GST_DEBUG ("%s accured while creating the GstElement", error->message);
> +    GST_DEBUG ("An error occured while creating the GstElement: %s", error->message);
>      g_error_free (error);
>      return NULL;
>    }
>  
> -  GST_DEBUG ("Created %p", effect);
> +  GST_DEBUG ("Created effect %p", effect);
>  
>    return effect;
>  }
>  
>  /**
> -* ges_track_parse_launch_effect_new:
> -* @bin_description: The gst-launch like bin description of the effect
> -*
> -* Creates a new #GESTrackParseLaunchEffect from the description of the bin.
> -*
> -* Returns: a newly created #GESTrackParseLaunchEffect, or %NULL if something went
> -* wrong.
> -*/
> + * ges_track_parse_launch_effect_new:
> + * @bin_description: The gst-launch like bin description of the effect
> + *
> + * Creates a new #GESTrackParseLaunchEffect from the description of the bin.
> + *
> + * Returns: a newly created #GESTrackParseLaunchEffect, or %NULL if something went
> + * wrong.
> + */
>  GESTrackParseLaunchEffect *
>  ges_track_parse_launch_effect_new (const gchar * bin_description)
>  {
>
> _______________________________________________
> gstreamer-commits mailing list
> [hidden email]
> http://lists.freedesktop.org/mailman/listinfo/gstreamer-commits

_______________________________________________
gstreamer-devel mailing list
[hidden email]
http://lists.freedesktop.org/mailman/listinfo/gstreamer-devel