sample: Update documentation
authorEdward Hervey <edward@centricular.com>
Mon, 21 May 2018 09:36:42 +0000 (11:36 +0200)
committerEdward Hervey <bilboed@bilboed.com>
Mon, 21 May 2018 09:36:42 +0000 (11:36 +0200)
docs/gst/gstreamer-sections.txt
gst/gstsample.c
gst/gstsample.h

index 2da2fc6..a627fce 100644 (file)
@@ -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
 <SUBSECTION Standard>
 GST_IS_SAMPLE
 GST_SAMPLE
index 143215f..016ac5e 100644 (file)
@@ -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.
index 7cbf072..268119c 100644 (file)
@@ -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.