mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-10-02 16:52:42 +00:00
Code Issues 1 Projects Releases Wiki Activity

sparsefile: add some Since markers to docs

Browse source
This commit is contained in:
Tim-Philipp Müller 2014-05-08 16:30:55 +01:00
parent 4a6ab37591
commit 250f89a7e9
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
libs/gst/base/gstsparsefile.c
View file

@ -137,6 +137,8 @@ get_read_range (GstSparseFile * file, gsize offset, gsize count)
* Make a new #GstSparseFile backed by the file represented with @fd. * Make a new #GstSparseFile backed by the file represented with @fd.
* *
* Returns: a new #GstSparseFile, gst_sparse_file_free() after usage. * Returns: a new #GstSparseFile, gst_sparse_file_free() after usage.
*
* Since: 1.4
*/ */
GstSparseFile * GstSparseFile *
gst_sparse_file_new (void) gst_sparse_file_new (void)
@ -159,6 +161,8 @@ gst_sparse_file_new (void)
* Store the data for @file in the file represented with @fd. * Store the data for @file in the file represented with @fd.
* *
* Returns: %TRUE when @fd could be set * Returns: %TRUE when @fd could be set
*
* Since: 1.4
*/ */
gboolean gboolean
gst_sparse_file_set_fd (GstSparseFile * file, gint fd) gst_sparse_file_set_fd (GstSparseFile * file, gint fd)
@ -198,6 +202,8 @@ gst_sparse_file_clear (GstSparseFile * file)
* @file: a #GstSparseFile * @file: a #GstSparseFile
* *
* Free the memory used by @file. * Free the memory used by @file.
*
* Since: 1.4
*/ */
void void
gst_sparse_file_free (GstSparseFile * file) gst_sparse_file_free (GstSparseFile * file)
@ -227,6 +233,8 @@ gst_sparse_file_free (GstSparseFile * file)
* data already available after the last written byte. * data already available after the last written byte.
* *
* Returns: The number of bytes written of 0 on error. * Returns: The number of bytes written of 0 on error.
*
* Since: 1.4
*/ */
gsize gsize
gst_sparse_file_write (GstSparseFile * file, gsize offset, gconstpointer data, gst_sparse_file_write (GstSparseFile * file, gsize offset, gconstpointer data,
@ -306,6 +314,8 @@ error:
* range. * range.
* *
* Returns: The number of bytes read of 0 on error. * Returns: The number of bytes read of 0 on error.
*
* Since: 1.4
*/ */
gsize gsize
gst_sparse_file_read (GstSparseFile * file, gsize offset, gpointer data, gst_sparse_file_read (GstSparseFile * file, gsize offset, gpointer data,
@ -366,6 +376,8 @@ error:
* Get the number of ranges that are written in @file. * Get the number of ranges that are written in @file.
* *
* Returns: the number of written ranges. * Returns: the number of written ranges.
*
* Since: 1.4
*/ */
guint guint
gst_sparse_file_n_ranges (GstSparseFile * file) gst_sparse_file_n_ranges (GstSparseFile * file)
@ -386,6 +398,8 @@ gst_sparse_file_n_ranges (GstSparseFile * file)
* including @offset. * including @offset.
* *
* Returns: %TRUE if the range with data before @offset exists. * Returns: %TRUE if the range with data before @offset exists.
*
* Since: 1.4
*/ */
gboolean gboolean
gst_sparse_file_get_range_before (GstSparseFile * file, gsize offset, gst_sparse_file_get_range_before (GstSparseFile * file, gsize offset,
@ -425,6 +439,8 @@ gst_sparse_file_get_range_before (GstSparseFile * file, gsize offset,
* including @offset. * including @offset.
* *
* Returns: %TRUE if the range with data after @offset exists. * Returns: %TRUE if the range with data after @offset exists.
*
* Since: 1.4
*/ */
gboolean gboolean
gst_sparse_file_get_range_after (GstSparseFile * file, gsize offset, gst_sparse_file_get_range_after (GstSparseFile * file, gsize offset,