check: Add/fix various annotations

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3194>

diff --git a/subprojects/gstreamer/libs/gst/check/gstharness.c b/subprojects/gstreamer/libs/gst/check/gstharness.c
index 1d0f297..295b66f 100644 (file)
--- a/subprojects/gstreamer/libs/gst/check/gstharness.c
+++ b/subprojects/gstreamer/libs/gst/check/gstharness.c
@@ -668,7 +668,7 @@ gst_pad_is_request_pad (GstPad * pad)
  *
  * MT safe.
  *
- * Returns: (transfer full): a #GstHarness, or %NULL if the harness could
+ * Returns: (transfer full) (nullable): a #GstHarness, or %NULL if the harness could
  * not be created
  *
  * Since: 1.8
@@ -723,15 +723,15 @@ gst_harness_new_empty (void)
  * gst_harness_add_element_full: (skip)
  * @h: a #GstHarness
  * @element: a #GstElement to add to the harness (transfer none)
- * @hsrc: (allow-none): a #GstStaticPadTemplate describing the harness srcpad.
+ * @hsrc: (nullable): a #GstStaticPadTemplate describing the harness srcpad.
  * %NULL will not create a harness srcpad.
- * @element_sinkpad_name: (allow-none): a #gchar with the name of the element
+ * @element_sinkpad_name: (nullable): a #gchar with the name of the element
  * sinkpad that is then linked to the harness srcpad. Can be a static or request
  * or a sometimes pad that has been added. %NULL will not get/request a sinkpad
  * from the element. (Like if the element is a src.)
- * @hsink: (allow-none): a #GstStaticPadTemplate describing the harness sinkpad.
+ * @hsink: (nullable): a #GstStaticPadTemplate describing the harness sinkpad.
  * %NULL will not create a harness sinkpad.
- * @element_srcpad_name: (allow-none): a #gchar with the name of the element
+ * @element_srcpad_name: (nullable): a #gchar with the name of the element
  * srcpad that is then linked to the harness sinkpad, similar to the
  * @element_sinkpad_name.
  *
@@ -804,15 +804,15 @@ gst_harness_add_element_full (GstHarness * h, GstElement * element,
 /**
  * gst_harness_new_full: (skip)
  * @element: a #GstElement to attach the harness to (transfer none)
- * @hsrc: (allow-none): a #GstStaticPadTemplate describing the harness srcpad.
+ * @hsrc: (nullable): a #GstStaticPadTemplate describing the harness srcpad.
  * %NULL will not create a harness srcpad.
- * @element_sinkpad_name: (allow-none): a #gchar with the name of the element
+ * @element_sinkpad_name: (nullable): a #gchar with the name of the element
  * sinkpad that is then linked to the harness srcpad. Can be a static or request
  * or a sometimes pad that has been added. %NULL will not get/request a sinkpad
  * from the element. (Like if the element is a src.)
- * @hsink: (allow-none): a #GstStaticPadTemplate describing the harness sinkpad.
+ * @hsink: (nullable): a #GstStaticPadTemplate describing the harness sinkpad.
  * %NULL will not create a harness sinkpad.
- * @element_srcpad_name: (allow-none): a #gchar with the name of the element
+ * @element_srcpad_name: (nullable): a #gchar with the name of the element
  * srcpad that is then linked to the harness sinkpad, similar to the
  * @element_sinkpad_name.
  *
@@ -820,7 +820,7 @@ gst_harness_add_element_full (GstHarness * h, GstElement * element,
  *
  * MT safe.
  *
- * Returns: (transfer full): a #GstHarness, or %NULL if the harness could
+ * Returns: (transfer full) (nullable): a #GstHarness, or %NULL if the harness could
  * not be created
  *
  * Since: 1.6
@@ -840,10 +840,10 @@ gst_harness_new_full (GstElement * element,
 /**
  * gst_harness_new_with_element: (skip)
  * @element: a #GstElement to attach the harness to (transfer none)
- * @element_sinkpad_name: (allow-none): a #gchar with the name of the element
+ * @element_sinkpad_name: (nullable): a #gchar with the name of the element
  * sinkpad that is then linked to the harness srcpad. %NULL does not attach a
  * sinkpad
- * @element_srcpad_name: (allow-none): a #gchar with the name of the element
+ * @element_srcpad_name: (nullable): a #gchar with the name of the element
  * srcpad that is then linked to the harness sinkpad. %NULL does not attach a
  * srcpad
  *
@@ -853,7 +853,7 @@ gst_harness_new_full (GstElement * element,
  *
  * MT safe.
  *
- * Returns: (transfer full): a #GstHarness, or %NULL if the harness could
+ * Returns: (transfer full) (nullable): a #GstHarness, or %NULL if the harness could
  * not be created
  *
  * Since: 1.6
@@ -869,10 +869,10 @@ gst_harness_new_with_element (GstElement * element,
 /**
  * gst_harness_new_with_padnames: (skip)
  * @element_name: a #gchar describing the #GstElement name
- * @element_sinkpad_name: (allow-none): a #gchar with the name of the element
+ * @element_sinkpad_name: (nullable): a #gchar with the name of the element
  * sinkpad that is then linked to the harness srcpad. %NULL does not attach a
  * sinkpad
- * @element_srcpad_name: (allow-none): a #gchar with the name of the element
+ * @element_srcpad_name: (nullable): a #gchar with the name of the element
  * srcpad that is then linked to the harness sinkpad. %NULL does not attach a
  * srcpad
  *
@@ -881,7 +881,7 @@ gst_harness_new_with_element (GstElement * element,
  *
  * MT safe.
  *
- * Returns: (transfer full): a #GstHarness, or %NULL if the harness could
+ * Returns: (transfer full) (nullable): a #GstHarness, or %NULL if the harness could
  * not be created
  *
  * Since: 1.6
@@ -903,9 +903,9 @@ gst_harness_new_with_padnames (const gchar * element_name,
 /**
  * gst_harness_new_with_templates: (skip)
  * @element_name: a #gchar describing the #GstElement name
- * @hsrc: (allow-none): a #GstStaticPadTemplate describing the harness srcpad.
+ * @hsrc: (nullable): a #GstStaticPadTemplate describing the harness srcpad.
  * %NULL will not create a harness srcpad.
- * @hsink: (allow-none): a #GstStaticPadTemplate describing the harness sinkpad.
+ * @hsink: (nullable): a #GstStaticPadTemplate describing the harness sinkpad.
  * %NULL will not create a harness sinkpad.
  *
  * Creates a new harness, like gst_harness_new_full(), except it
@@ -913,7 +913,7 @@ gst_harness_new_with_padnames (const gchar * element_name,
  *
  * MT safe.
  *
- * Returns: (transfer full): a #GstHarness, or %NULL if the harness could
+ * Returns: (transfer full) (nullable): a #GstHarness, or %NULL if the harness could
  * not be created
  *
  * Since: 1.6
@@ -940,7 +940,7 @@ gst_harness_new_with_templates (const gchar * element_name,
  *
  * MT safe.
  *
- * Returns: (transfer full): a #GstHarness, or %NULL if the harness could
+ * Returns: (transfer full) (nullable): a #GstHarness, or %NULL if the harness could
  * not be created
  *
  * Since: 1.6
@@ -1033,7 +1033,7 @@ gst_harness_add_parse (GstHarness * h, const gchar * launchline)
  *
  * MT safe.
  *
- * Returns: (transfer full): a #GstHarness, or %NULL if the harness could
+ * Returns: (transfer full) (nullable): a #GstHarness, or %NULL if the harness could
  * not be created
  *
  * Since: 1.6
@@ -1390,7 +1390,7 @@ gst_harness_use_testclock (GstHarness * h)
  *
  * MT safe.
  *
- * Returns: (transfer full): a #GstTestClock, or %NULL if the testclock is not
+ * Returns: (transfer full) (nullable): a #GstTestClock, or %NULL if the testclock is not
  * present.
  *
  * Since: 1.6
@@ -1676,7 +1676,7 @@ gst_harness_push (GstHarness * h, GstBuffer * buffer)
  *
  * MT safe.
  *
- * Returns: (transfer full): a #GstBuffer or %NULL if timed out.
+ * Returns: (transfer full) (nullable): a #GstBuffer or %NULL if timed out.
  *
  * Since: 1.6
  */
@@ -1699,7 +1699,7 @@ gst_harness_pull (GstHarness * h)
 /**
  * gst_harness_pull_until_eos:
  * @h: a #GstHarness
- * @buf: (out) (transfer full): A #GstBuffer, or %NULL if EOS or timeout occures
+ * @buf: (out) (nullable) (transfer full): A #GstBuffer, or %NULL if EOS or timeout occures
  *   first.
  *
  * Pulls a #GstBuffer from the #GAsyncQueue on the #GstHarness sinkpad. The pull
@@ -1740,7 +1740,7 @@ gst_harness_pull_until_eos (GstHarness * h, GstBuffer ** buf)
  *
  * MT safe.
  *
- * Returns: (transfer full): a #GstBuffer or %NULL if no buffers are present in the #GAsyncQueue
+ * Returns: (transfer full) (nullable): a #GstBuffer or %NULL if no buffers are present in the #GAsyncQueue
  *
  * Since: 1.6
  */
@@ -1770,7 +1770,7 @@ gst_harness_try_pull (GstHarness * h)
  *
  * MT safe.
  *
- * Returns: (transfer full): a #GstBuffer or %NULL if timed out.
+ * Returns: (transfer full) (nullable): a #GstBuffer or %NULL if timed out.
  *
  * Since: 1.6
  */
@@ -1984,7 +1984,7 @@ gst_harness_get_last_pushed_timestamp (GstHarness * h)
 /**
  * gst_harness_push_event:
  * @h: a #GstHarness
- * @event: a #GstEvent to push
+ * @event: (transfer full): a #GstEvent to push
  *
  * Pushes an #GstEvent on the #GstHarness srcpad.
  *
@@ -2009,7 +2009,7 @@ gst_harness_push_event (GstHarness * h, GstEvent * event)
  *
  * MT safe.
  *
- * Returns: a #GstEvent or %NULL if timed out.
+ * Returns: (transfer full) (nullable): a #GstEvent or %NULL if timed out.
  *
  * Since: 1.6
  */
@@ -2030,7 +2030,7 @@ gst_harness_pull_event (GstHarness * h)
  *
  * MT safe.
  *
- * Returns: a #GstEvent or %NULL if no buffers are present in the #GAsyncQueue
+ * Returns: (transfer full) (nullable): a #GstEvent or %NULL if no buffers are present in the #GAsyncQueue
  *
  * Since: 1.6
  */
@@ -2084,7 +2084,7 @@ gst_harness_events_in_queue (GstHarness * h)
 /**
  * gst_harness_push_upstream_event:
  * @h: a #GstHarness
- * @event: a #GstEvent to push
+ * @event: (transfer full): a #GstEvent to push
  *
  * Pushes an #GstEvent on the #GstHarness sinkpad.
  *
@@ -2112,7 +2112,7 @@ gst_harness_push_upstream_event (GstHarness * h, GstEvent * event)
  *
  * MT safe.
  *
- * Returns: a #GstEvent or %NULL if timed out.
+ * Returns: (transfer full) (nullable): a #GstEvent or %NULL if timed out.
  *
  * Since: 1.6
  */
@@ -2133,7 +2133,7 @@ gst_harness_pull_upstream_event (GstHarness * h)
  *
  * MT safe.
  *
- * Returns: a #GstEvent or %NULL if no buffers are present in the #GAsyncQueue
+ * Returns: (transfer full) (nullable): a #GstEvent or %NULL if no buffers are present in the #GAsyncQueue
  *
  * Since: 1.6
  */
@@ -2251,8 +2251,8 @@ gst_harness_set_live (GstHarness * h, gboolean is_live)
 /**
  * gst_harness_get_allocator:
  * @h: a #GstHarness
- * @allocator: (out) (allow-none) (transfer none): the #GstAllocator used
- * @params: (out) (allow-none) (transfer full): the #GstAllocationParams of
+ * @allocator: (out) (optional) (nullable) (transfer none): the #GstAllocator used
+ * @params: (out) (optional): the #GstAllocationParams of
  *   @allocator
  *
  * Gets the @allocator and its @params that has been decided to use after an
@@ -2277,8 +2277,8 @@ gst_harness_get_allocator (GstHarness * h, GstAllocator ** allocator,
 /**
  * gst_harness_set_propose_allocator:
  * @h: a #GstHarness
- * @allocator: (allow-none) (transfer full): a #GstAllocator
- * @params: (allow-none) (transfer none): a #GstAllocationParams
+ * @allocator: (nullable) (transfer full): a #GstAllocator
+ * @params: (nullable) (transfer none): a #GstAllocationParams
  *
  * Sets the @allocator and @params to propose when receiving an allocation
  * query.
@@ -2302,7 +2302,7 @@ gst_harness_set_propose_allocator (GstHarness * h, GstAllocator * allocator,
  * gst_harness_add_propose_allocation_meta:
  * @h: a #GstHarness
  * @api: a metadata API
- * @params: (allow-none) (transfer none): API specific parameters
+ * @params: (nullable) (transfer none): API specific parameters
  *
  * Add api with params as one of the supported metadata API to propose when
  * receiving an allocation query.
@@ -2680,7 +2680,7 @@ gst_harness_sink_push_many (GstHarness * h, gint pushes)
  *
  * MT safe.
  *
- * Returns: (transfer full) (allow-none): a #GstElement or %NULL if not found
+ * Returns: (transfer full) (nullable): a #GstElement or %NULL if not found
  *
  * Since: 1.6
  */
@@ -3190,7 +3190,7 @@ gst_harness_stress_thread_stop (GstHarnessThread * t)
 /**
  * gst_harness_stress_custom_start: (skip)
  * @h: a #GstHarness
- * @init: (allow-none): a #GFunc that is called initially and only once
+ * @init: (nullable): a #GFunc that is called initially and only once
  * @callback: a #GFunc that is called as often as possible
  * @data: a #gpointer with custom data to pass to the @callback function
  * @sleep: a #gulong specifying how long to sleep in (microseconds) for