aggregator: Assert if the sink/src pad type that is to be used is not a GstAggregator...
[platform/upstream/gstreamer.git] / libs / gst / base / gstbytereader-docs.h
index e4b6e35..b582c3f 100644 (file)
@@ -13,8 +13,8 @@
  *
  * You should have received a copy of the GNU Library General Public
  * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
  */
 
 /* This header is not installed, it just contains stuff for gtk-doc to parse,
@@ -31,8 +31,6 @@
  *
  * Skips @nbytes bytes of the #GstByteReader instance without checking if
  * there are enough bytes available in the byte reader.
- *
- * Since: 0.10.25
  */
 void gst_byte_reader_skip_unchecked (GstByteReader * reader, guint nbytes);
 
@@ -44,8 +42,6 @@ void gst_byte_reader_skip_unchecked (GstByteReader * reader, guint nbytes);
  * available in the byte reader and update the current position.
  *
  * Returns: unsigned 8 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_uint8_unchecked:
@@ -55,8 +51,6 @@ void gst_byte_reader_skip_unchecked (GstByteReader * reader, guint nbytes);
  * available in the byte reader, but do not advance the current read position.
  *
  * Returns: unsigned 8 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_get_int8_unchecked:
@@ -66,8 +60,6 @@ void gst_byte_reader_skip_unchecked (GstByteReader * reader, guint nbytes);
  * available in the byte reader and update the current position.
  *
  * Returns: signed 8 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_int8_unchecked:
@@ -77,8 +69,6 @@ void gst_byte_reader_skip_unchecked (GstByteReader * reader, guint nbytes);
  * available in the byte reader, but do not advance the current read position.
  *
  * Returns: signed 8 bit integer.
- *
- * Since: 0.10.25
  */
 guint8  gst_byte_reader_get_uint8_unchecked     (GstByteReader * reader);
 guint8  gst_byte_reader_peek_uint8_unchecked    (GstByteReader * reader);
@@ -94,8 +84,6 @@ gint8   gst_byte_reader_peek_int8_unchecked     (GstByteReader * reader);
  * current position.
  *
  * Returns: unsigned 16 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_uint16_le_unchecked:
@@ -106,8 +94,6 @@ gint8   gst_byte_reader_peek_int8_unchecked     (GstByteReader * reader);
  * the current position.
  *
  * Returns: unsigned 16 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_get_uint16_be_unchecked:
@@ -118,8 +104,6 @@ gint8   gst_byte_reader_peek_int8_unchecked     (GstByteReader * reader);
  * current position.
  *
  * Returns: unsigned 16 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_uint16_be_unchecked:
@@ -130,8 +114,6 @@ gint8   gst_byte_reader_peek_int8_unchecked     (GstByteReader * reader);
  * the current position.
  *
  * Returns: unsigned 16 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_get_int16_le_unchecked:
@@ -142,8 +124,6 @@ gint8   gst_byte_reader_peek_int8_unchecked     (GstByteReader * reader);
  * current position.
  *
  * Returns: signed 16 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_int16_le_unchecked:
@@ -154,8 +134,6 @@ gint8   gst_byte_reader_peek_int8_unchecked     (GstByteReader * reader);
  * the current position.
  *
  * Returns: signed 16 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_get_int16_be_unchecked:
@@ -166,8 +144,6 @@ gint8   gst_byte_reader_peek_int8_unchecked     (GstByteReader * reader);
  * current position.
  *
  * Returns: signed 16 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_int16_be_unchecked:
@@ -178,8 +154,6 @@ gint8   gst_byte_reader_peek_int8_unchecked     (GstByteReader * reader);
  * the current position.
  *
  * Returns: signed 16 bit integer.
- *
- * Since: 0.10.25
  */
 guint16 gst_byte_reader_get_uint16_le_unchecked  (GstByteReader * reader);
 guint16 gst_byte_reader_get_uint16_be_unchecked  (GstByteReader * reader);
@@ -199,8 +173,6 @@ gint16  gst_byte_reader_peek_int16_be_unchecked  (GstByteReader * reader);
  * current position.
  *
  * Returns: unsigned 24 bit integer (as guint32)
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_uint24_le_unchecked:
@@ -211,8 +183,6 @@ gint16  gst_byte_reader_peek_int16_be_unchecked  (GstByteReader * reader);
  * the current position.
  *
  * Returns: unsigned 24 bit integer (as guint32)
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_get_uint24_be_unchecked:
@@ -223,8 +193,6 @@ gint16  gst_byte_reader_peek_int16_be_unchecked  (GstByteReader * reader);
  * current position.
  *
  * Returns: unsigned 24 bit integer (as guint32)
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_uint24_be_unchecked:
@@ -235,8 +203,6 @@ gint16  gst_byte_reader_peek_int16_be_unchecked  (GstByteReader * reader);
  * the current position.
  *
  * Returns: unsigned 24 bit integer (as guint32)
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_get_int24_le_unchecked:
@@ -247,8 +213,6 @@ gint16  gst_byte_reader_peek_int16_be_unchecked  (GstByteReader * reader);
  * current position.
  *
  * Returns: signed 24 bit integer (as gint32)
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_int24_le_unchecked:
@@ -259,8 +223,6 @@ gint16  gst_byte_reader_peek_int16_be_unchecked  (GstByteReader * reader);
  * the current position.
  *
  * Returns: signed 24 bit integer (as gint32)
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_get_int24_be_unchecked:
@@ -271,8 +233,6 @@ gint16  gst_byte_reader_peek_int16_be_unchecked  (GstByteReader * reader);
  * current position.
  *
  * Returns: signed 24 bit integer (as gint32)
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_int24_be_unchecked:
@@ -283,8 +243,6 @@ gint16  gst_byte_reader_peek_int16_be_unchecked  (GstByteReader * reader);
  * the current position.
  *
  * Returns: signed 24 bit integer (as gint32)
- *
- * Since: 0.10.25
  */
 guint32 gst_byte_reader_get_uint24_le_unchecked  (GstByteReader * reader);
 guint32 gst_byte_reader_get_uint24_be_unchecked  (GstByteReader * reader);
@@ -304,8 +262,6 @@ gint32  gst_byte_reader_peek_int24_be_unchecked  (GstByteReader * reader);
  * current position.
  *
  * Returns: unsigned 32 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_uint32_le_unchecked:
@@ -316,8 +272,6 @@ gint32  gst_byte_reader_peek_int24_be_unchecked  (GstByteReader * reader);
  * the current position.
  *
  * Returns: unsigned 32 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_get_uint32_be_unchecked:
@@ -328,8 +282,6 @@ gint32  gst_byte_reader_peek_int24_be_unchecked  (GstByteReader * reader);
  * current position.
  *
  * Returns: unsigned 32 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_uint32_be_unchecked:
@@ -340,8 +292,6 @@ gint32  gst_byte_reader_peek_int24_be_unchecked  (GstByteReader * reader);
  * the current position.
  *
  * Returns: unsigned 32 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_get_int32_le_unchecked:
@@ -352,8 +302,6 @@ gint32  gst_byte_reader_peek_int24_be_unchecked  (GstByteReader * reader);
  * current position.
  *
  * Returns: signed 32 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_int32_le_unchecked:
@@ -364,8 +312,6 @@ gint32  gst_byte_reader_peek_int24_be_unchecked  (GstByteReader * reader);
  * the current position.
  *
  * Returns: signed 32 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_get_int32_be_unchecked:
@@ -376,8 +322,6 @@ gint32  gst_byte_reader_peek_int24_be_unchecked  (GstByteReader * reader);
  * current position.
  *
  * Returns: signed 32 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_int32_be_unchecked:
@@ -388,8 +332,6 @@ gint32  gst_byte_reader_peek_int24_be_unchecked  (GstByteReader * reader);
  * the current position.
  *
  * Returns: signed 32 bit integer.
- *
- * Since: 0.10.25
  */
 guint32 gst_byte_reader_get_uint32_le_unchecked  (GstByteReader * reader);
 guint32 gst_byte_reader_get_uint32_be_unchecked  (GstByteReader * reader);
@@ -409,8 +351,6 @@ gint32  gst_byte_reader_peek_int32_be_unchecked  (GstByteReader * reader);
  * current position.
  *
  * Returns: unsigned 64 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_uint64_le_unchecked:
@@ -421,8 +361,6 @@ gint32  gst_byte_reader_peek_int32_be_unchecked  (GstByteReader * reader);
  * the current position.
  *
  * Returns: unsigned 64 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_get_uint64_be_unchecked:
@@ -433,8 +371,6 @@ gint32  gst_byte_reader_peek_int32_be_unchecked  (GstByteReader * reader);
  * current position.
  *
  * Returns: unsigned 64 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_uint64_be_unchecked:
@@ -445,8 +381,6 @@ gint32  gst_byte_reader_peek_int32_be_unchecked  (GstByteReader * reader);
  * the current position.
  *
  * Returns: unsigned 64 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_get_int64_le_unchecked:
@@ -457,8 +391,6 @@ gint32  gst_byte_reader_peek_int32_be_unchecked  (GstByteReader * reader);
  * current position.
  *
  * Returns: signed 64 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_int64_le_unchecked:
@@ -469,8 +401,6 @@ gint32  gst_byte_reader_peek_int32_be_unchecked  (GstByteReader * reader);
  * the current position.
  *
  * Returns: signed 64 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_get_int64_be_unchecked:
@@ -481,8 +411,6 @@ gint32  gst_byte_reader_peek_int32_be_unchecked  (GstByteReader * reader);
  * current position.
  *
  * Returns: signed 64 bit integer.
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_int64_be_unchecked:
@@ -493,8 +421,6 @@ gint32  gst_byte_reader_peek_int32_be_unchecked  (GstByteReader * reader);
  * the current position.
  *
  * Returns: signed 64 bit integer.
- *
- * Since: 0.10.25
  */
 guint64 gst_byte_reader_get_uint64_le_unchecked  (GstByteReader * reader);
 guint64 gst_byte_reader_get_uint64_be_unchecked  (GstByteReader * reader);
@@ -513,8 +439,6 @@ gint64  gst_byte_reader_peek_int64_be_unchecked  (GstByteReader * reader);
  * data available and update the current position.
  *
  * Returns: floating point value read
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_float32_le_unchecked:
@@ -524,8 +448,6 @@ gint64  gst_byte_reader_peek_int64_be_unchecked  (GstByteReader * reader);
  * data available, but keep the current position.
  *
  * Returns: floating point value read
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_get_float32_be_unchecked:
@@ -535,8 +457,6 @@ gint64  gst_byte_reader_peek_int64_be_unchecked  (GstByteReader * reader);
  * data available and update the current position.
  *
  * Returns: floating point value read
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_float32_be_unchecked:
@@ -546,8 +466,6 @@ gint64  gst_byte_reader_peek_int64_be_unchecked  (GstByteReader * reader);
  * data available, but keep the current position.
  *
  * Returns: floating point value read
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_get_float64_le_unchecked:
@@ -557,8 +475,6 @@ gint64  gst_byte_reader_peek_int64_be_unchecked  (GstByteReader * reader);
  * data available and update the current position.
  *
  * Returns: double precision floating point value read
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_float64_le_unchecked:
@@ -568,8 +484,6 @@ gint64  gst_byte_reader_peek_int64_be_unchecked  (GstByteReader * reader);
  * data available, but keep the current position.
  *
  * Returns: double precision floating point value read
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_get_float64_be_unchecked:
@@ -579,8 +493,6 @@ gint64  gst_byte_reader_peek_int64_be_unchecked  (GstByteReader * reader);
  * data available and update the current position.
  *
  * Returns: double precision floating point value read
- *
- * Since: 0.10.25
  */
 /**
  * gst_byte_reader_peek_float64_be_unchecked:
@@ -590,8 +502,6 @@ gint64  gst_byte_reader_peek_int64_be_unchecked  (GstByteReader * reader);
  * data available, but keep the current position.
  *
  * Returns: double precision floating point value read
- *
- * Since: 0.10.25
  */
 
 gfloat  gst_byte_reader_get_float32_le_unchecked  (GstByteReader * reader);
@@ -609,10 +519,8 @@ gdouble gst_byte_reader_peek_float64_be_unchecked (GstByteReader * reader);
  * @reader: a #GstByteReader instance
  *
  * Returns: (transfer none): a constant pointer to the current data position
- *
- * Since: 0.10.25
  */
-const guint8 * gst_byte_reader_peek_data_unchecked (GstByteReader * reader);
+const guint8 * gst_byte_reader_peek_data_unchecked (const GstByteReader * reader);
 /**
  * gst_byte_reader_get_data_unchecked:
  * @reader: a #GstByteReader instance
@@ -624,8 +532,6 @@ const guint8 * gst_byte_reader_peek_data_unchecked (GstByteReader * reader);
  *
  * Returns: (transfer none) (array length=size): a constant pointer to the
  *     current data position.
- *
- * Since: 0.10.25
  */
 const guint8 * gst_byte_reader_get_data_unchecked (GstByteReader * reader, guint size);
 /**
@@ -641,8 +547,6 @@ const guint8 * gst_byte_reader_get_data_unchecked (GstByteReader * reader, guint
  *
  * Returns: (transfer full) (array length=size): a newly-allocated copy of the
  *     data @size bytes in size. Free with g_free() when no longer needed.
- *
- * Since: 0.10.25
  */
 guint8 * gst_byte_reader_dup_data_unchecked (GstByteReader * reader, guint size);