ges: More "Since: 0.10.2" doc markers

This commit is contained in:
Edward Hervey 2011-05-20 16:02:58 +02:00
parent b552352922
commit 3bc2d8854c
7 changed files with 36 additions and 7 deletions

View file

@ -28,7 +28,7 @@
* you use another type of #GESTimelineLayer, you will have to handle it * you use another type of #GESTimelineLayer, you will have to handle it
* yourself. * yourself.
* *
* Since: 0.10.2 * @Since: 0.10.2
*/ */
#include <ges/ges.h> #include <ges/ges.h>

View file

@ -182,9 +182,9 @@ struct _GESTimelineObject {
* @fill_track_object: method to fill an associated #GESTrackObject. * @fill_track_object: method to fill an associated #GESTrackObject.
* @need_fill_track: Set to TRUE if @fill_track_object needs to be called. * @need_fill_track: Set to TRUE if @fill_track_object needs to be called.
* @track_object_added: Should be overridden by subclasses if they need to perform an * @track_object_added: Should be overridden by subclasses if they need to perform an
* operation when a #GESTrackObject is added. * operation when a #GESTrackObject is added. Since: 0.10.2
* @track_object_released: Should be overridden by subclassed if they need to perform * @track_object_released: Should be overridden by subclassed if they need to perform
* action when a #GESTrackObject is released. * action when a #GESTrackObject is released. Since: 0.10.2
* *
* Subclasses can override the @create_track_object and @fill_track_object methods. * Subclasses can override the @create_track_object and @fill_track_object methods.
*/ */

View file

@ -31,7 +31,7 @@
* you use another type of #GESTimelineLayer, you will have to handle it * you use another type of #GESTimelineLayer, you will have to handle it
* yourself. * yourself.
* *
* Since: 0.10.2 * @Since: 0.10.2
*/ */
#include <ges/ges.h> #include <ges/ges.h>
@ -205,6 +205,8 @@ ges_tl_parse_launch_effect_create_track_obj (GESTimelineObject * self,
* *
* Returns: (transfer full): a newly created #GESTimelineParseLaunchEffect, or * Returns: (transfer full): a newly created #GESTimelineParseLaunchEffect, or
* %NULL if something went wrong. * %NULL if something went wrong.
*
* Since: 0.10.2
*/ */
GESTimelineParseLaunchEffect * GESTimelineParseLaunchEffect *
ges_timeline_parse_launch_effect_new (const gchar * video_bin_description, ges_timeline_parse_launch_effect_new (const gchar * video_bin_description,

View file

@ -22,7 +22,7 @@
* @short_description: adds an effect to a stream in a #GESTimelineSource or a * @short_description: adds an effect to a stream in a #GESTimelineSource or a
* #GESTimelineLayer * #GESTimelineLayer
* *
* Since: 0.10.2 * @Since: 0.10.2
*/ */
#include <glib/gprintf.h> #include <glib/gprintf.h>

View file

@ -43,7 +43,6 @@ typedef struct _GESTrackEffectPrivate GESTrackEffectPrivate;
/** /**
* GESTrackEffect: * GESTrackEffect:
*
*/ */
struct _GESTrackEffect struct _GESTrackEffect
{ {

View file

@ -911,6 +911,8 @@ ges_track_object_is_locked (GESTrackObject * object)
* Get the position of the object in the container #GESTrack. * Get the position of the object in the container #GESTrack.
* *
* Returns: the start position (in #GstClockTime) * Returns: the start position (in #GstClockTime)
*
* Since: 0.10.2
*/ */
guint64 guint64
ges_track_object_get_start (GESTrackObject * object) ges_track_object_get_start (GESTrackObject * object)
@ -928,6 +930,8 @@ ges_track_object_get_start (GESTrackObject * object)
* Get the offset within the contents of this #GESTrackObject * Get the offset within the contents of this #GESTrackObject
* *
* Returns: the in-point (in #GstClockTime) * Returns: the in-point (in #GstClockTime)
*
* Since: 0.10.2
*/ */
guint64 guint64
ges_track_object_get_inpoint (GESTrackObject * object) ges_track_object_get_inpoint (GESTrackObject * object)
@ -946,6 +950,8 @@ ges_track_object_get_inpoint (GESTrackObject * object)
* starting from the 'in-point' * starting from the 'in-point'
* *
* Returns: the duration (in #GstClockTime) * Returns: the duration (in #GstClockTime)
*
* Since: 0.10.2
*/ */
guint64 guint64
ges_track_object_get_duration (GESTrackObject * object) ges_track_object_get_duration (GESTrackObject * object)
@ -963,6 +969,8 @@ ges_track_object_get_duration (GESTrackObject * object)
* Get the priority of the object withing the containing #GESTrack. * Get the priority of the object withing the containing #GESTrack.
* *
* Returns: the priority of @object * Returns: the priority of @object
*
* Since: 0.10.2
*/ */
guint32 guint32
ges_track_object_get_priority (GESTrackObject * object) ges_track_object_get_priority (GESTrackObject * object)
@ -981,6 +989,8 @@ ges_track_object_get_priority (GESTrackObject * object)
* or not. * or not.
* *
* Returns: %TRUE if @object is active, %FALSE otherwize * Returns: %TRUE if @object is active, %FALSE otherwize
*
* Since: 0.10.2
*/ */
gboolean gboolean
ges_track_object_is_active (GESTrackObject * object) ges_track_object_is_active (GESTrackObject * object)
@ -1011,6 +1021,8 @@ ges_track_object_is_active (GESTrackObject * object)
* Returns: TRUE if @element and @pspec could be found. FALSE otherwise. In that * Returns: TRUE if @element and @pspec could be found. FALSE otherwise. In that
* case the values for @pspec and @element are not modified. Unref @element after * case the values for @pspec and @element are not modified. Unref @element after
* usage. * usage.
*
* Since: 0.10.2
*/ */
gboolean gboolean
ges_track_object_lookup_child (GESTrackObject * object, const gchar * prop_name, ges_track_object_lookup_child (GESTrackObject * object, const gchar * prop_name,
@ -1060,6 +1072,8 @@ ges_track_object_lookup_child (GESTrackObject * object, const gchar * prop_name,
* @value: the value * @value: the value
* *
* Sets a property of a child of @object. * Sets a property of a child of @object.
*
* Since: 0.10.2
*/ */
void void
ges_track_object_set_child_property_by_pspec (GESTrackObject * object, ges_track_object_set_child_property_by_pspec (GESTrackObject * object,
@ -1103,6 +1117,8 @@ prop_hash_not_set:
* that have the same property name, you can distinguish them using the following * that have the same property name, you can distinguish them using the following
* synthaxe: 'ClasseName::property_name' as property name. If you don't, the * synthaxe: 'ClasseName::property_name' as property name. If you don't, the
* corresponding property of the first element found will be set. * corresponding property of the first element found will be set.
*
* Since: 0.10.2
*/ */
void void
ges_track_object_set_child_property_valist (GESTrackObject * object, ges_track_object_set_child_property_valist (GESTrackObject * object,
@ -1172,6 +1188,8 @@ cant_copy:
* that have the same property name, you can distinguish them using the following * that have the same property name, you can distinguish them using the following
* synthaxe: 'ClasseName::property_name' as property name. If you don't, the * synthaxe: 'ClasseName::property_name' as property name. If you don't, the
* corresponding property of the first element found will be set. * corresponding property of the first element found will be set.
*
* Since: 0.10.2
*/ */
void void
ges_track_object_set_child_property (GESTrackObject * object, ges_track_object_set_child_property (GESTrackObject * object,
@ -1196,6 +1214,8 @@ ges_track_object_set_child_property (GESTrackObject * object,
* that have the same property name, you can distinguish them using the following * that have the same property name, you can distinguish them using the following
* synthaxe: 'ClasseName::property_name' as property name. If you don't, the * synthaxe: 'ClasseName::property_name' as property name. If you don't, the
* corresponding property of the first element found will be set. * corresponding property of the first element found will be set.
*
* Since: 0.10.2
*/ */
void void
ges_track_object_get_child_property_valist (GESTrackObject * object, ges_track_object_get_child_property_valist (GESTrackObject * object,
@ -1252,6 +1272,8 @@ cant_copy:
* *
* Returns: (transfer full) (array): an array of #GParamSpec* which should be freed after use or * Returns: (transfer full) (array): an array of #GParamSpec* which should be freed after use or
* %NULL if something went wrong * %NULL if something went wrong
*
* Since: 0.10.2
*/ */
GParamSpec ** GParamSpec **
ges_track_object_list_children_properties (GESTrackObject * object, ges_track_object_list_children_properties (GESTrackObject * object,
@ -1274,6 +1296,8 @@ ges_track_object_list_children_properties (GESTrackObject * object,
* name/return location pairs, followed by NULL * name/return location pairs, followed by NULL
* *
* Gets properties of a child of @object. * Gets properties of a child of @object.
*
* Since: 0.10.2
*/ */
void void
ges_track_object_get_child_property (GESTrackObject * object, ges_track_object_get_child_property (GESTrackObject * object,
@ -1294,6 +1318,8 @@ ges_track_object_get_child_property (GESTrackObject * object,
* @value: return location for the value * @value: return location for the value
* *
* Gets a property of a child of @object. * Gets a property of a child of @object.
*
* Since: 0.10.2
*/ */
void void
ges_track_object_get_child_property_by_pspec (GESTrackObject * object, ges_track_object_get_child_property_by_pspec (GESTrackObject * object,

View file

@ -22,7 +22,7 @@
* @short_description: adds an effect build from a parse-launch style * @short_description: adds an effect build from a parse-launch style
* bin description to a stream in a #GESTimelineSource or a #GESTimelineLayer * bin description to a stream in a #GESTimelineSource or a #GESTimelineLayer
* *
* Since: 0.10.2 * @Since: 0.10.2
*/ */
#include "ges-internal.h" #include "ges-internal.h"
@ -188,6 +188,8 @@ ges_track_parse_launch_effect_create_element (GESTrackObject * object)
* *
* Returns: a newly created #GESTrackParseLaunchEffect, or %NULL if something went * Returns: a newly created #GESTrackParseLaunchEffect, or %NULL if something went
* wrong. * wrong.
*
* Since: 0.10.2
*/ */
GESTrackParseLaunchEffect * GESTrackParseLaunchEffect *
ges_track_parse_launch_effect_new (const gchar * bin_description) ges_track_parse_launch_effect_new (const gchar * bin_description)