aggregator: Assert if the sink/src pad type that is to be used is not a GstAggregator...
[platform/upstream/gstreamer.git] / libs / gst / base / gstbitreader.c
index 271424a..9df36d1 100644 (file)
@@ -14,8 +14,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.
  */
 
 #ifdef HAVE_CONFIG_H
@@ -29,6 +29,7 @@
 
 /**
  * SECTION:gstbitreader
+ * @title: GstBitReader
  * @short_description: Reads any number of bits from a memory buffer
  *
  * #GstBitReader provides a bit reader that can read any number of bits
@@ -37,8 +38,9 @@
  */
 
 /**
- * gst_bit_reader_new:
- * @data: Data from which the #GstBitReader should read
+ * gst_bit_reader_new: (skip)
+ * @data: (array length=size): Data from which the #GstBitReader
+ *   should read
  * @size: Size of @data in bytes
  *
  * Create a new #GstBitReader instance, which will read from @data.
@@ -46,8 +48,6 @@
  * Free-function: gst_bit_reader_free
  *
  * Returns: (transfer full): a new #GstBitReader instance
- *
- * Since: 0.10.22
  */
 GstBitReader *
 gst_bit_reader_new (const guint8 * data, guint size)
@@ -66,8 +66,6 @@ gst_bit_reader_new (const guint8 * data, guint size)
  *
  * Frees a #GstBitReader instance, which was previously allocated by
  * gst_bit_reader_new().
- * 
- * Since: 0.10.22
  */
 void
 gst_bit_reader_free (GstBitReader * reader)
@@ -85,8 +83,6 @@ gst_bit_reader_free (GstBitReader * reader)
  *
  * Initializes a #GstBitReader instance to read from @data. This function
  * can be called on already initialized instances.
- * 
- * Since: 0.10.22
  */
 void
 gst_bit_reader_init (GstBitReader * reader, const guint8 * data, guint size)
@@ -107,8 +103,6 @@ gst_bit_reader_init (GstBitReader * reader, const guint8 * data, guint size)
  *
  * Returns: %TRUE if the position could be set successfully, %FALSE
  * otherwise.
- * 
- * Since: 0.10.22
  */
 gboolean
 gst_bit_reader_set_pos (GstBitReader * reader, guint pos)
@@ -131,8 +125,6 @@ gst_bit_reader_set_pos (GstBitReader * reader, guint pos)
  * Returns the current position of a #GstBitReader instance in bits.
  *
  * Returns: The current position of @reader in bits.
- * 
- * Since: 0.10.22
  */
 guint
 gst_bit_reader_get_pos (const GstBitReader * reader)
@@ -147,8 +139,6 @@ gst_bit_reader_get_pos (const GstBitReader * reader)
  * Returns the remaining number of bits of a #GstBitReader instance.
  *
  * Returns: The remaining number of bits of @reader instance.
- * 
- * Since: 0.10.22
  */
 guint
 gst_bit_reader_get_remaining (const GstBitReader * reader)
@@ -163,8 +153,6 @@ gst_bit_reader_get_remaining (const GstBitReader * reader)
  * Returns the total number of bits of a #GstBitReader instance.
  *
  * Returns: The total number of bits of @reader instance.
- * 
- * Since: 0.10.26
  */
 guint
 gst_bit_reader_get_size (const GstBitReader * reader)
@@ -180,8 +168,6 @@ gst_bit_reader_get_size (const GstBitReader * reader)
  * Skips @nbits bits of the #GstBitReader instance.
  *
  * Returns: %TRUE if @nbits bits could be skipped, %FALSE otherwise.
- * 
- * Since: 0.10.22
  */
 gboolean
 gst_bit_reader_skip (GstBitReader * reader, guint nbits)
@@ -196,8 +182,6 @@ gst_bit_reader_skip (GstBitReader * reader, guint nbits)
  * Skips until the next byte.
  *
  * Returns: %TRUE if successful, %FALSE otherwise.
- * 
- * Since: 0.10.22
  */
 gboolean
 gst_bit_reader_skip_to_byte (GstBitReader * reader)
@@ -214,8 +198,6 @@ gst_bit_reader_skip_to_byte (GstBitReader * reader)
  * Read @nbits bits into @val and update the current position.
  *
  * Returns: %TRUE if successful, %FALSE otherwise.
- * 
- * Since: 0.10.22
  */
 
 /**
@@ -227,8 +209,6 @@ gst_bit_reader_skip_to_byte (GstBitReader * reader)
  * Read @nbits bits into @val and update the current position.
  *
  * Returns: %TRUE if successful, %FALSE otherwise.
- * 
- * Since: 0.10.22
  */
 
 /**
@@ -240,8 +220,6 @@ gst_bit_reader_skip_to_byte (GstBitReader * reader)
  * Read @nbits bits into @val and update the current position.
  *
  * Returns: %TRUE if successful, %FALSE otherwise.
- * 
- * Since: 0.10.22
  */
 
 /**
@@ -253,8 +231,6 @@ gst_bit_reader_skip_to_byte (GstBitReader * reader)
  * Read @nbits bits into @val and update the current position.
  *
  * Returns: %TRUE if successful, %FALSE otherwise.
- * 
- * Since: 0.10.22
  */
 
 /**
@@ -266,8 +242,6 @@ gst_bit_reader_skip_to_byte (GstBitReader * reader)
  * Read @nbits bits into @val but keep the current position.
  *
  * Returns: %TRUE if successful, %FALSE otherwise.
- * 
- * Since: 0.10.22
  */
 
 /**
@@ -279,8 +253,6 @@ gst_bit_reader_skip_to_byte (GstBitReader * reader)
  * Read @nbits bits into @val but keep the current position.
  *
  * Returns: %TRUE if successful, %FALSE otherwise.
- * 
- * Since: 0.10.22
  */
 
 /**
@@ -292,8 +264,6 @@ gst_bit_reader_skip_to_byte (GstBitReader * reader)
  * Read @nbits bits into @val but keep the current position.
  *
  * Returns: %TRUE if successful, %FALSE otherwise.
- * 
- * Since: 0.10.22
  */
 
 /**
@@ -305,8 +275,6 @@ gst_bit_reader_skip_to_byte (GstBitReader * reader)
  * Read @nbits bits into @val but keep the current position.
  *
  * Returns: %TRUE if successful, %FALSE otherwise.
- * 
- * Since: 0.10.22
  */
 
 #define GST_BIT_READER_READ_BITS(bits) \