diff options
Diffstat (limited to 'libs/gst/base/gstbytewriter.c')
| -rw-r--r-- | libs/gst/base/gstbytewriter.c | 54 |
1 files changed, 37 insertions, 17 deletions
diff --git a/libs/gst/base/gstbytewriter.c b/libs/gst/base/gstbytewriter.c index 6aa940ac8..25564f7d9 100644 --- a/libs/gst/base/gstbytewriter.c +++ b/libs/gst/base/gstbytewriter.c @@ -43,7 +43,9 @@ * * Creates a new, empty #GstByteWriter instance * - * Returns: a new, empty #GstByteWriter instance + * Free-function: gst_byte_writer_free + * + * Returns: (transfer full): a new, empty #GstByteWriter instance * * Since: 0.10.26 */ @@ -64,7 +66,9 @@ gst_byte_writer_new (void) * Creates a new #GstByteWriter instance with the given * initial data size. * - * Returns: a new #GstByteWriter instance + * Free-function: gst_byte_writer_free + * + * Returns: (transfer full): a new #GstByteWriter instance * * Since: 0.10.26 */ @@ -91,7 +95,9 @@ gst_byte_writer_new_with_size (guint size, gboolean fixed) * memory area. If @initialized is %TRUE it is possible to * read @size bytes from the #GstByteWriter from the beginning. * - * Returns: a new #GstByteWriter instance + * Free-function: gst_byte_writer_free + * + * Returns: (transfer full): a new #GstByteWriter instance * * Since: 0.10.26 */ @@ -120,7 +126,9 @@ gst_byte_writer_new_with_data (guint8 * data, guint size, gboolean initialized) * * <note>@buffer must be writable</note> * - * Returns: a new #GstByteWriter instance + * Free-function: gst_byte_writer_free + * + * Returns: (transfer full): a new #GstByteWriter instance * * Since: 0.10.26 */ @@ -179,7 +187,8 @@ gst_byte_writer_init_with_size (GstByteWriter * writer, guint size, /** * gst_byte_writer_init_with_data: * @writer: #GstByteWriter instance - * @data: Memory area for writing + * @data: (in callee-allocated) (array length=size) (transfer none): Memory + * area for writing * @size: Size of @data in bytes * @initialized: If %TRUE the complete data can be read from the beginning * @@ -207,7 +216,7 @@ gst_byte_writer_init_with_data (GstByteWriter * writer, guint8 * data, /** * gst_byte_writer_init_with_buffer: * @writer: #GstByteWriter instance - * @buffer: Buffer used for writing + * @buffer: (transfer none): Buffer used for writing * @initialized: If %TRUE the complete data can be read from the beginning * * Initializes @writer with the given @@ -253,7 +262,9 @@ gst_byte_writer_reset (GstByteWriter * writer) * * Resets @writer and returns the current data. * - * Returns: the current data. g_free() after usage. + * Free-function: g_free + * + * Returns: (transfer full): the current data. g_free() after usage. * * Since: 0.10.26 */ @@ -279,7 +290,10 @@ gst_byte_writer_reset_and_get_data (GstByteWriter * writer) * * Resets @writer and returns the current data as buffer. * - * Returns: the current data as buffer. gst_buffer_unref() after usage. + * Free-function: gst_buffer_unref + * + * Returns: (transfer full): the current data as buffer. gst_buffer_unref() + * after usage. * * Since: 0.10.26 */ @@ -300,7 +314,7 @@ gst_byte_writer_reset_and_get_buffer (GstByteWriter * writer) /** * gst_byte_writer_free: - * @writer: #GstByteWriter instance + * @writer: (in) (transfer full): #GstByteWriter instance * * Frees @writer and all memory allocated by it. * @@ -317,12 +331,14 @@ gst_byte_writer_free (GstByteWriter * writer) /** * gst_byte_writer_free_and_get_data: - * @writer: #GstByteWriter instance + * @writer: (in) (transfer full): #GstByteWriter instance * * Frees @writer and all memory allocated by it except * the current data, which is returned. * - * Returns: the current data. g_free() after usage. + * Free-function: g_free + * + * Returns: (transfer full): the current data. g_free() after usage. * * Since: 0.10.26 */ @@ -341,12 +357,15 @@ gst_byte_writer_free_and_get_data (GstByteWriter * writer) /** * gst_byte_writer_free_and_get_buffer: - * @writer: #GstByteWriter instance + * @writer: (in) (transfer full): #GstByteWriter instance * * Frees @writer and all memory allocated by it except * the current data, which is returned as #GstBuffer. * - * Returns: the current data as buffer. gst_buffer_unref() after usage. + * Free-function: gst_buffer_unref + * + * Returns: (transfer full): the current data as buffer. gst_buffer_unref() + * after usage. * * Since: 0.10.26 */ @@ -721,7 +740,8 @@ CREATE_WRITE_STRING_FUNC (32, guint32); /** * gst_byte_writer_put_string_utf8: * @writer: #GstByteWriter instance - * @data: UTF8 string to write + * @data: (transfer none) (array zero-terminated=1) (type utf8): UTF8 string to + * write * * Writes a NUL-terminated UTF8 string to @writer (including the terminator). * @@ -732,7 +752,7 @@ CREATE_WRITE_STRING_FUNC (32, guint32); /** * gst_byte_writer_put_string_utf16: * @writer: #GstByteWriter instance - * @data: UTF16 string to write + * @data: (transfer none) (array zero-terminated=1): UTF16 string to write * * Writes a NUL-terminated UTF16 string to @writer (including the terminator). * @@ -743,7 +763,7 @@ CREATE_WRITE_STRING_FUNC (32, guint32); /** * gst_byte_writer_put_string_utf32: * @writer: #GstByteWriter instance - * @data: UTF32 string to write + * @data: (transfer none) (array zero-terminated=1): UTF32 string to write * * Writes a NUL-terminated UTF32 string to @writer (including the terminator). * @@ -754,7 +774,7 @@ CREATE_WRITE_STRING_FUNC (32, guint32); /** * gst_byte_writer_put_data: * @writer: #GstByteWriter instance - * @data: Data to write + * @data: (transfer none) (array length=size): Data to write * @size: Size of @data in bytes * * Writes @size bytes of @data to @writer. |