gst-editing-services: design: add a description of the ges_timeline_object_get_top_effect_postion method

[Stefan Kost]

Am 06.05.2011 20:43, schrieb Edward Hervey:
> Module: gst-editing-services
> Branch: master
> Commit: e49e58b045ef0e8f23c8a1df2443d435440116df
> URL:    http://cgit.freedesktop.org/gstreamer/gst-editing-services/commit/?id=e49e58b045ef0e8f23c8a1df2443d435440116df
> 
> Author: Thibault Saunier <thibault.saunier at collabora.co.uk>
> Date:   Mon Jan 31 11:05:10 2011 +0100
> 
> design: add a description of the ges_timeline_object_get_top_effect_postion method
> 
> ---
> 
>  docs/design/effects.txt |   14 ++++++++++++++
>  1 files changed, 14 insertions(+), 0 deletions(-)
> 
> diff --git a/docs/design/effects.txt b/docs/design/effects.txt
> index 7be99b9..f4c989a 100644
> --- a/docs/design/effects.txt
> +++ b/docs/design/effects.txt
> @@ -231,6 +231,20 @@ C. Keyframes
>        ges_timeline_object_set_top_effect_position (GESTimelineObject *object,
>              GESTrackEffect *effect, guint newposition);
>  
> +      /**
> +      * ges_timeline_object_get_top_effect_position:
> +      *
> +      * @object: The origin #GESTimelineObject
> +      * @effect: The #GESTrackEffect we want to get the top position from
> +      *

There should be no newline between the symbol-name and the parameters (@-lines).

Stefan

> +      * Gets the top position of an effect.
> +      *
> +      * Returns: The top position of the effect, -1 if something went wrong.
> +      */
> +      gint 
> +      ges_timeline_object_get_top_effect_position (GESTimelineObject *object,
> +            GESTrackEffect *effect);
> +
>    C - The GESTrackEffect API:
>  
>        /**
> 
> _______________________________________________
> gstreamer-commits mailing list
> gstreamer-commits at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/gstreamer-commits