docs: add some gtk-doc Since: markers

Add some gtk-doc Since: markers, fix one Since: marker,
fix typo.
This commit is contained in:
Tim-Philipp Müller 2010-10-16 16:53:49 +01:00
parent 349899e735
commit 5b25761f29
4 changed files with 14 additions and 4 deletions

View file

@ -29,7 +29,7 @@
* These function allow to create a pipeline based on the syntax used in the
* gst-launch utility (see man-page for syntax documentation).
*
* Please note that these functions take serveral meassures to create even
* Please note that these functions take several measures to create
* somewhat dynamic pipelines. Due to that such pipelines are not always
* reuseable (set the state to NULL and back to PLAYING).
*/

View file

@ -963,6 +963,8 @@ gst_value_lcopy_int64_range (const GValue * value, guint n_collect_values,
* @end: the end of the range
*
* Sets @value to the range specified by @start and @end.
*
* Since: 0.10.31
*/
void
gst_value_set_int64_range (GValue * value, gint64 start, gint64 end)
@ -981,6 +983,8 @@ gst_value_set_int64_range (GValue * value, gint64 start, gint64 end)
* Gets the minimum of the range specified by @value.
*
* Returns: the minimum of the range
*
* Since: 0.10.31
*/
gint64
gst_value_get_int64_range_min (const GValue * value)
@ -997,6 +1001,8 @@ gst_value_get_int64_range_min (const GValue * value)
* Gets the maximum of the range specified by @value.
*
* Returns: the maxumum of the range
*
* Since: 0.10.31
*/
gint64
gst_value_get_int64_range_max (const GValue * value)

View file

@ -106,6 +106,8 @@ G_BEGIN_DECLS
* @x: the #GValue to check
*
* Checks if the given #GValue contains a #GST_TYPE_INT64_RANGE value.
*
* Since: 0.10.31
*/
#define GST_VALUE_HOLDS_INT64_RANGE(x) (G_VALUE_HOLDS((x), gst_int64_range_get_type ()))
@ -217,6 +219,8 @@ G_BEGIN_DECLS
* a #GValue type that represents an #gint64 range
*
* Returns: the #GType of GstInt64Range
*
* Since: 0.10.31
*/
#define GST_TYPE_INT64_RANGE gst_int64_range_get_type ()

View file

@ -722,10 +722,10 @@ done:
* Caller owns returned list and contained buffers. gst_buffer_unref() each
* buffer in the list before freeng the list after usage.
*
* Since: 0.10.24
*
* Returns: a #GSList of buffers containing the first @nbytes of the adapter,
* Returns: a #GSList of buffers containing the first @nbytes of the adapter,
* or #NULL if @nbytes bytes are not available
*
* Since: 0.10.31
*/
GList *
gst_adapter_take_list (GstAdapter * adapter, guint nbytes)