From 438c1c116ddd23a642c8c6737dd6ac40a69fd2bb Mon Sep 17 00:00:00 2001 From: Edward Hervey Date: Mon, 21 May 2018 11:36:42 +0200 Subject: [PATCH] sample: Update documentation --- docs/gst/gstreamer-sections.txt | 4 ++-- gst/gstsample.c | 8 ++++++++ gst/gstsample.h | 3 ++- 3 files changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index 2da2fc6..a627fce 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -569,8 +569,8 @@ gst_sample_new gst_sample_ref gst_sample_unref gst_sample_copy -gst_buffer_is_writable -gst_buffer_make_writable +gst_sample_is_writable +gst_sample_make_writable GST_IS_SAMPLE GST_SAMPLE diff --git a/gst/gstsample.c b/gst/gstsample.c index 143215f..016ac5e 100644 --- a/gst/gstsample.c +++ b/gst/gstsample.c @@ -266,6 +266,8 @@ gst_sample_set_buffer_list (GstSample * sample, GstBufferList * buffer_list) /** * gst_sample_set_buffer: + * @sample: A #GstSample + * @buffer: (transfer none): A #GstBuffer * * Set the buffer associated with @sample. @sample must be writable. * @@ -282,6 +284,8 @@ gst_sample_set_buffer (GstSample * sample, GstBuffer * buffer) /** * gst_sample_set_caps: + * @sample: A #GstSample + * @caps: (transfer none): A #GstCaps * * Set the caps associated with @sample. @sample must be writable. * @@ -298,6 +302,8 @@ gst_sample_set_caps (GstSample * sample, GstCaps * caps) /** * gst_sample_set_segment: + * @sample: A #GstSample + * @segment: (transfer none): A #GstSegment * * Set the segment associated with @sample. @sample must be writable. * @@ -318,6 +324,8 @@ gst_sample_set_segment (GstSample * sample, const GstSegment * segment) /** * gst_sample_set_info: + * @sample: A #GstSample + * @info: (transfer full): A #GstStructure * * Set the info structure associated with @sample. @sample must be writable, * and @info must not have a parent set already. diff --git a/gst/gstsample.h b/gst/gstsample.h index 7cbf072..268119c 100644 --- a/gst/gstsample.h +++ b/gst/gstsample.h @@ -118,6 +118,7 @@ gst_sample_unref (GstSample * sample) /** * gst_sample_is_writable: + * @sample: A #GstSample * * Tests if you can safely set the buffer and / or buffer list of @sample. * @@ -127,7 +128,7 @@ gst_sample_unref (GstSample * sample) /** * gst_sample_make_writable: - * @sample: (transfer full): + * @sample: (transfer full): A #GstSample * * Returns a writable copy of @sample. If the source sample is * already writable, this will simply return the same sample. -- 2.7.4