gstpromise: add since 1.14 markers
authorMatthew Waters <matthew@centricular.com>
Thu, 1 Feb 2018 13:24:20 +0000 (00:24 +1100)
committerMatthew Waters <matthew@centricular.com>
Fri, 2 Feb 2018 04:06:36 +0000 (15:06 +1100)
gst/gstpromise.c
gst/gstpromise.h

index fdde3ed65a69f288cf53e7ab4fca23f113e0fe80..3a9aba0fff1b12e12c4c261935ee685fb6ade9db 100644 (file)
@@ -104,6 +104,8 @@ typedef struct
  * immediately with the current result.
  *
  * Returns: the result of the promise
+ *
+ * Since: 1.14
  */
 GstPromiseResult
 gst_promise_wait (GstPromise * promise)
@@ -134,6 +136,8 @@ gst_promise_wait (GstPromise * promise)
  *
  * Set a reply on @promise.  This will wake up any waiters with
  * %GST_PROMISE_RESULT_REPLIED.
+ *
+ * Since: 1.14
  */
 void
 gst_promise_reply (GstPromise * promise, GstStructure * s)
@@ -196,6 +200,8 @@ gst_promise_reply (GstPromise * promise, GstStructure * s)
  * %GST_PROMISE_RESULT_REPLIED and is owned by @promise
  *
  * Returns: (transfer none): The reply set on @promise
+ *
+ * Since: 1.14
  */
 const GstStructure *
 gst_promise_get_reply (GstPromise * promise)
@@ -220,6 +226,8 @@ gst_promise_get_reply (GstPromise * promise)
  *
  * Interrupt waiting for a @promise.  This will wake up any waiters with
  * %GST_PROMISE_RESULT_INTERRUPTED
+ *
+ * Since: 1.14
  */
 void
 gst_promise_interrupt (GstPromise * promise)
@@ -258,6 +266,8 @@ gst_promise_interrupt (GstPromise * promise)
  *
  * Expire a @promise.  This will wake up any waiters with
  * %GST_PROMISE_RESULT_EXPIRED
+ *
+ * Since: 1.14
  */
 void
 gst_promise_expire (GstPromise * promise)
@@ -329,6 +339,8 @@ gst_promise_init (GstPromise * promise)
  * gst_promise_new:
  *
  * Returns: a new #GstPromise
+ *
+ * Since: 1.14
  */
 GstPromise *
 gst_promise_new (void)
@@ -352,6 +364,8 @@ gst_promise_new (void)
  * states.
  *
  * Returns: a new #GstPromise
+ *
+ * Since: 1.14
  */
 GstPromise *
 gst_promise_new_with_change_func (GstPromiseChangeFunc func, gpointer user_data,
index a48b97f242d6695d1507d34db142a08ddf96a8d5..4f662c8a51de7ca62b4008fe630a6075ec715a3d 100644 (file)
@@ -42,6 +42,8 @@ typedef struct _GstPromise GstPromise;
  *     lost all refs) and the promise will never be fulfilled.
  *
  * The result of a #GstPromise
+ *
+ * Since: 1.14
  */
 typedef enum
 {
@@ -55,12 +57,16 @@ typedef enum
  * GstPromiseChangeFunc:
  * @promise: a #GstPromise
  * @user_data: (closure): user data
+ *
+ * Since: 1.14
  */
 typedef void (*GstPromiseChangeFunc) (GstPromise * promise, gpointer user_data);
 
 /**
  * GstPromise:
  * @parent: parent #GstMiniObject
+ *
+ * Since: 1.14
  */
 struct _GstPromise
 {
@@ -94,6 +100,8 @@ const GstStructure *    gst_promise_get_reply               (GstPromise * promis
  * Increases the refcount of the given @promise by one.
  *
  * Returns: (transfer full): @promise
+ *
+ * Since: 1.14
  */
 static inline GstPromise *
 gst_promise_ref (GstPromise * promise)
@@ -107,6 +115,8 @@ gst_promise_ref (GstPromise * promise)
  *
  * Decreases the refcount of the promise. If the refcount reaches 0, the
  * promise will be freed.
+ *
+ * Since: 1.14
  */
 static inline void
 gst_promise_unref (GstPromise * promise)