docs: fix misc. gtk-doc warnings in libs

(for gtk-doc 1.15)

12 files changed, 31 insertions, 59 deletions

diff --git a/libs/gst/base/gstadapter.h b/libs/gst/base/gstadapter.h
index a4b65e3e6a..ae8b7813b8 100644
--- a/libs/gst/base/gstadapter.h
+++ b/libs/gst/base/gstadapter.h
@@ -44,7 +44,6 @@ typedef struct _GstAdapterPrivate GstAdapterPrivate;
 
 /**
  * GstAdapter:
- * @object: the parent object.
  *
  * The opaque #GstAdapter data structure.
  */
diff --git a/libs/gst/base/gstbasesink.h b/libs/gst/base/gstbasesink.h
index 60f94854c3..e91cb2cfe7 100644
--- a/libs/gst/base/gstbasesink.h
+++ b/libs/gst/base/gstbasesink.h
@@ -50,7 +50,6 @@ typedef struct _GstBaseSinkPrivate GstBaseSinkPrivate;
 
 /**
  * GstBaseSink:
- * @element: the parent element.
  *
  * The opaque #GstBaseSink data structure.
  */
@@ -218,7 +217,7 @@ GstClockTimeDiff gst_base_sink_get_ts_offset    (GstBaseSink *sink);
 
 /* last buffer */
 GstBuffer *     gst_base_sink_get_last_buffer   (GstBaseSink *sink);
-void            gst_base_sink_set_last_buffer_enabled (GstBaseSink *sink, gboolean enable);
+void            gst_base_sink_set_last_buffer_enabled (GstBaseSink *sink, gboolean enabled);
 gboolean        gst_base_sink_is_last_buffer_enabled (GstBaseSink *sink);
 
 /* latency */
diff --git a/libs/gst/base/gstbasesrc.h b/libs/gst/base/gstbasesrc.h
index 854cf6b9b5..9715972052 100644
--- a/libs/gst/base/gstbasesrc.h
+++ b/libs/gst/base/gstbasesrc.h
@@ -64,7 +64,6 @@ typedef struct _GstBaseSrcPrivate GstBaseSrcPrivate;
 
 /**
  * GstBaseSrc:
- * @element: the parent element.
  *
  * The opaque #GstBaseSrc data structure.
  */
diff --git a/libs/gst/base/gstbasetransform.h b/libs/gst/base/gstbasetransform.h
index bdfbe04265..33f971baa6 100644
--- a/libs/gst/base/gstbasetransform.h
+++ b/libs/gst/base/gstbasetransform.h
@@ -103,7 +103,6 @@ typedef struct _GstBaseTransformPrivate GstBaseTransformPrivate;
 
 /**
  * GstBaseTransform:
- * @element: the parent element.
  *
  * The opaque #GstBaseTransform data structure.
  */
diff --git a/libs/gst/base/gstbitreader-docs.h b/libs/gst/base/gstbitreader-docs.h
index 47a7b72b6c..ee1a04fd54 100644
--- a/libs/gst/base/gstbitreader-docs.h
+++ b/libs/gst/base/gstbitreader-docs.h
@@ -32,8 +32,6 @@
  * Skips @nbits bits of the #GstBitReader instance without checking if there
  * are enough bits available in the bit reader.
  *
- * Returns: %TRUE if @nbits bits could be skipped, %FALSE otherwise.
- * 
  * Since: 0.10.31
  */
 void gst_bit_reader_skip_unchecked (GstBitReader * reader, guint nbits);
@@ -44,8 +42,6 @@ void gst_bit_reader_skip_unchecked (GstBitReader * reader, guint nbits);
  *
  * Skips until the next byte without checking if there are enough bits
  * available in the bit reader.
- *
- * Returns: %TRUE if successful, %FALSE otherwise.
  * 
  * Since: 0.10.31
  */
diff --git a/libs/gst/base/gstbytereader-docs.h b/libs/gst/base/gstbytereader-docs.h
index 6bee12ba4d..91747601e4 100644
--- a/libs/gst/base/gstbytereader-docs.h
+++ b/libs/gst/base/gstbytereader-docs.h
@@ -628,7 +628,7 @@ const guint8 * gst_byte_reader_peek_data_unchecked (GstByteReader * reader);
  */
 const guint8 * gst_byte_reader_get_data_unchecked (GstByteReader * reader, guint size);
 /**
- * gst_byte_reader_dup_data:
+ * gst_byte_reader_dup_data_unchecked:
  * @reader: a #GstByteReader instance
  * @size: Size in bytes
  *
diff --git a/libs/gst/base/gstbytewriter-docs.h b/libs/gst/base/gstbytewriter-docs.h
index 55d606ef09..e7a3d70cc3 100644
--- a/libs/gst/base/gstbytewriter-docs.h
+++ b/libs/gst/base/gstbytewriter-docs.h
@@ -44,8 +44,6 @@ void gst_byte_writer_put_uint8_unchecked (GstByteWriter *writer, guint8 val);
  * Writes a unsigned big endian 16 bit integer to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_uint16_be_unchecked (GstByteWriter *writer, guint16 val);
@@ -58,8 +56,6 @@ void gst_byte_writer_put_uint16_be_unchecked (GstByteWriter *writer, guint16 val
  * Writes a unsigned big endian 24 bit integer to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_uint24_be_unchecked (GstByteWriter *writer, guint32 val);
@@ -72,8 +68,6 @@ void gst_byte_writer_put_uint24_be_unchecked (GstByteWriter *writer, guint32 val
  * Writes a unsigned big endian 32 bit integer to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_uint32_be_unchecked (GstByteWriter *writer, guint32 val);
@@ -86,8 +80,6 @@ void gst_byte_writer_put_uint32_be_unchecked (GstByteWriter *writer, guint32 val
  * Writes a unsigned big endian 64 bit integer to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_uint64_be_unchecked (GstByteWriter *writer, guint64 val);
@@ -100,8 +92,6 @@ void gst_byte_writer_put_uint64_be_unchecked (GstByteWriter *writer, guint64 val
  * Writes a unsigned little endian 16 bit integer to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_uint16_le_unchecked (GstByteWriter *writer, guint16 val);
@@ -114,8 +104,6 @@ void gst_byte_writer_put_uint16_le_unchecked (GstByteWriter *writer, guint16 val
  * Writes a unsigned little endian 24 bit integer to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_uint24_le_unchecked (GstByteWriter *writer, guint32 val);
@@ -128,8 +116,6 @@ void gst_byte_writer_put_uint24_le_unchecked (GstByteWriter *writer, guint32 val
  * Writes a unsigned little endian 32 bit integer to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_uint32_le_unchecked (GstByteWriter *writer, guint32 val);
@@ -142,8 +128,6 @@ void gst_byte_writer_put_uint32_le_unchecked (GstByteWriter *writer, guint32 val
  * Writes a unsigned little endian 64 bit integer to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_uint64_le_unchecked (GstByteWriter *writer, guint64 val);
@@ -156,8 +140,6 @@ void gst_byte_writer_put_uint64_le_unchecked (GstByteWriter *writer, guint64 val
  * Writes a signed 8 bit integer to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_int8_unchecked (GstByteWriter *writer, gint8 val);
@@ -170,8 +152,6 @@ void gst_byte_writer_put_int8_unchecked (GstByteWriter *writer, gint8 val);
  * Writes a signed big endian 16 bit integer to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_int16_be_unchecked (GstByteWriter *writer, gint16 val);
@@ -184,8 +164,6 @@ void gst_byte_writer_put_int16_be_unchecked (GstByteWriter *writer, gint16 val);
  * Writes a signed big endian 24 bit integer to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_int24_be_unchecked (GstByteWriter *writer, gint32 val);
@@ -198,8 +176,6 @@ void gst_byte_writer_put_int24_be_unchecked (GstByteWriter *writer, gint32 val);
  * Writes a signed big endian 32 bit integer to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_int32_be_unchecked (GstByteWriter *writer, gint32 val);
@@ -212,8 +188,6 @@ void gst_byte_writer_put_int32_be_unchecked (GstByteWriter *writer, gint32 val);
  * Writes a signed big endian 64 bit integer to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_int64_be_unchecked (GstByteWriter *writer, gint64 val);
@@ -226,8 +200,6 @@ void gst_byte_writer_put_int64_be_unchecked (GstByteWriter *writer, gint64 val);
  * Writes a signed little endian 16 bit integer to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_int16_le_unchecked (GstByteWriter *writer, gint16 val);
@@ -240,8 +212,6 @@ void gst_byte_writer_put_int16_le_unchecked (GstByteWriter *writer, gint16 val);
  * Writes a signed little endian 24 bit integer to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_int24_le_unchecked (GstByteWriter *writer, gint32 val);
@@ -254,8 +224,6 @@ void gst_byte_writer_put_int24_le_unchecked (GstByteWriter *writer, gint32 val);
  * Writes a signed little endian 32 bit integer to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_int32_le_unchecked (GstByteWriter *writer, gint32 val);
@@ -268,8 +236,6 @@ void gst_byte_writer_put_int32_le_unchecked (GstByteWriter *writer, gint32 val);
  * Writes a signed little endian 64 bit integer to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_int64_le_unchecked (GstByteWriter *writer, gint64 val);
@@ -282,8 +248,6 @@ void gst_byte_writer_put_int64_le_unchecked (GstByteWriter *writer, gint64 val);
  * Writes a big endian 32 bit float to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_float32_be_unchecked (GstByteWriter *writer, gfloat val);
@@ -296,8 +260,6 @@ void gst_byte_writer_put_float32_be_unchecked (GstByteWriter *writer, gfloat val
  * Writes a big endian 64 bit float to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_float64_be_unchecked (GstByteWriter *writer, gdouble val);
@@ -310,8 +272,6 @@ void gst_byte_writer_put_float64_be_unchecked (GstByteWriter *writer, gdouble va
  * Writes a little endian 32 bit float to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_float32_le_unchecked (GstByteWriter *writer, gfloat val);
@@ -324,8 +284,6 @@ void gst_byte_writer_put_float32_le_unchecked (GstByteWriter *writer, gfloat val
  * Writes a little endian 64 bit float to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_float64_le_unchecked (GstByteWriter *writer, gdouble val);
@@ -339,8 +297,6 @@ void gst_byte_writer_put_float64_le_unchecked (GstByteWriter *writer, gdouble va
  * Writes @size bytes of @data to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_put_data_unchecked (GstByteWriter *writer, const guint8 *data, guint size);
@@ -354,8 +310,6 @@ void gst_byte_writer_put_data_unchecked (GstByteWriter *writer, const guint8 *da
  * Writes @size bytes containing @value to @writer without
  * checking if there is enough free space available in the byte writer.
  *
- * Returns: %TRUE if the value could be written
- *
  * Since: 0.10.31
  */
 void gst_byte_writer_fill_unchecked (GstByteWriter *writer, guint8 value, guint size);
diff --git a/libs/gst/base/gstdataqueue.c b/libs/gst/base/gstdataqueue.c
index a90ab73f31..37412914ec 100644
--- a/libs/gst/base/gstdataqueue.c
+++ b/libs/gst/base/gstdataqueue.c
@@ -26,6 +26,8 @@
  * #GstDataQueue is an object that handles threadsafe queueing of objects. It
  * also provides size-related functionality. This object should be used for
  * any #GstElement that wishes to provide some sort of queueing functionality.
+ *
+ * Since: 0.10.11
  */
 
 #include <gst/gst.h>
@@ -298,6 +300,8 @@ gst_data_queue_locked_is_full (GstDataQueue * queue)
  * Flushes all the contents of the @queue. Any call to #gst_data_queue_push and
  * #gst_data_queue_pop will be released.
  * MT safe.
+ *
+ * Since: 0.10.11
  */
 void
 gst_data_queue_flush (GstDataQueue * queue)
@@ -316,6 +320,8 @@ gst_data_queue_flush (GstDataQueue * queue)
  * MT safe.
  *
  * Returns: #TRUE if @queue is empty.
+ *
+ * Since: 0.10.11
  */
 gboolean
 gst_data_queue_is_empty (GstDataQueue * queue)
@@ -338,6 +344,8 @@ gst_data_queue_is_empty (GstDataQueue * queue)
  * MT safe.
  *
  * Returns: #TRUE if @queue is full.
+ *
+ * Since: 0.10.11
  */
 gboolean
 gst_data_queue_is_full (GstDataQueue * queue)
@@ -363,6 +371,8 @@ gst_data_queue_is_full (GstDataQueue * queue)
  * all calls to those two functions will return #FALSE.
  *
  * MT Safe.
+ *
+ * Since: 0.10.11
  */
 void
 gst_data_queue_set_flushing (GstDataQueue * queue, gboolean flushing)
@@ -395,6 +405,8 @@ gst_data_queue_set_flushing (GstDataQueue * queue, gboolean flushing)
  * is returned, the caller is responsible for freeing @item and its contents.
  *
  * Returns: #TRUE if the @item was successfully pushed on the @queue.
+ *
+ * Since: 0.10.11
  */
 gboolean
 gst_data_queue_push (GstDataQueue * queue, GstDataQueueItem * item)
@@ -457,6 +469,8 @@ flushing:
  * MT safe.
  *
  * Returns: #TRUE if an @item was successfully retrieved from the @queue.
+ *
+ * Since: 0.10.11
  */
 gboolean
 gst_data_queue_pop (GstDataQueue * queue, GstDataQueueItem ** item)
@@ -516,6 +530,8 @@ flushing:
  * Pop and unref the head-most #GstMiniObject with the given #GType.
  *
  * Returns: TRUE if an element was removed.
+ *
+ * Since: 0.10.11
  */
 gboolean
 gst_data_queue_drop_head (GstDataQueue * queue, GType type)
@@ -566,6 +582,8 @@ done:
  *
  * Inform the queue that the limits for the fullness check have changed and that
  * any blocking gst_data_queue_push() should be unblocked to recheck the limts.
+ *
+ * Since: 0.10.11
  */
 void
 gst_data_queue_limits_changed (GstDataQueue * queue)
@@ -584,6 +602,8 @@ gst_data_queue_limits_changed (GstDataQueue * queue)
  * @level: the location to store the result
  *
  * Get the current level of the queue.
+ *
+ * Since: 0.10.11
  */
 void
 gst_data_queue_get_level (GstDataQueue * queue, GstDataQueueSize * level)
diff --git a/libs/gst/base/gstdataqueue.h b/libs/gst/base/gstdataqueue.h
index a58a7493a0..d07dfa83d8 100644
--- a/libs/gst/base/gstdataqueue.h
+++ b/libs/gst/base/gstdataqueue.h
@@ -54,6 +54,8 @@ typedef struct _GstDataQueueItem GstDataQueueItem;
  *
  * Structure used by #GstDataQueue. You can supply a different structure, as
  * long as the top of the structure is identical to this structure.
+ *
+ * Since: 0.10.11
  */
 
 struct _GstDataQueueItem
@@ -74,6 +76,8 @@ struct _GstDataQueueItem
  * @time: amount of time
  *
  * Structure describing the size of a queue.
+ *
+ * Since: 0.10.11
  */
 struct _GstDataQueueSize
 {
@@ -94,6 +98,8 @@ struct _GstDataQueueSize
  * considered as full.
  *
  * Returns: #TRUE if the queue should be considered full.
+ *
+ * Since: 0.10.11
  */
 typedef gboolean (*GstDataQueueCheckFullFunction) (GstDataQueue * queue,
     guint visible, guint bytes, guint64 time, gpointer checkdata);
@@ -103,8 +109,11 @@ typedef void (*GstDataQueueEmptyCallback) (GstDataQueue * queue, gpointer checkd
 
 /**
  * GstDataQueue:
+ * @object: the parent structure
  *
  * Opaque #GstDataQueue structure.
+ *
+ * Since: 0.10.11
  */
 struct _GstDataQueue
 {
diff --git a/libs/gst/base/gstpushsrc.h b/libs/gst/base/gstpushsrc.h
index e018da4203..49786d57e0 100644
--- a/libs/gst/base/gstpushsrc.h
+++ b/libs/gst/base/gstpushsrc.h
@@ -41,7 +41,6 @@ typedef struct _GstPushSrcClass GstPushSrcClass;
 
 /**
  * GstPushSrc:
- * @parent: the parent base source object.
  *
  * The opaque #GstPushSrc data structure.
  */
diff --git a/libs/gst/net/gstnetclientclock.h b/libs/gst/net/gstnetclientclock.h
index 52d36cfae3..44b2e2edda 100644
--- a/libs/gst/net/gstnetclientclock.h
+++ b/libs/gst/net/gstnetclientclock.h
@@ -63,7 +63,6 @@ typedef struct _GstNetClientClockPrivate GstNetClientClockPrivate;
 
 /**
  * GstNetClientClock:
- * @clock: the parent clock structure.
  *
  * Opaque #GstNetClientClock structure.
  */
diff --git a/libs/gst/net/gstnettimeprovider.h b/libs/gst/net/gstnettimeprovider.h
index 2486cbb6ff..204d781e8c 100644
--- a/libs/gst/net/gstnettimeprovider.h
+++ b/libs/gst/net/gstnettimeprovider.h
@@ -62,7 +62,6 @@ typedef struct _GstNetTimeProviderPrivate GstNetTimeProviderPrivate;
 
 /**
  * GstNetTimeProvider:
- * @parent: the parent object structure.
  *
  * Opaque #GstNetTimeProvider structure.
  */