mpegts: Add GIR generation array anotations
authorRussel Winder <russel@winder.org.uk>
Fri, 18 May 2018 17:42:43 +0000 (18:42 +0100)
committerEdward Hervey <bilboed@bilboed.com>
Sat, 19 May 2018 09:06:14 +0000 (11:06 +0200)
For function parameters that are known to be arrays.

https://bugzilla.gnome.org/show_bug.cgi?id=796221

gst-libs/gst/mpegts/gst-dvb-descriptor.c
gst-libs/gst/mpegts/gstmpegtsdescriptor.c
gst-libs/gst/mpegts/gstmpegtssection.c

index ea33a1d..8410a89 100644 (file)
@@ -1,7 +1,7 @@
 /*
- * gstmpegtsdescriptor.c - 
+ * gstmpegtsdescriptor.c -
  * Copyright (C) 2013 Edward Hervey
- * 
+ *
  * Authors:
  *   Edward Hervey <edward@collabora.com>
  *
@@ -40,7 +40,7 @@
  *
  * * Add common validation code for data presence and minimum/maximum expected
  *   size.
- * * Add parsing methods for the following descriptors that were previously 
+ * * Add parsing methods for the following descriptors that were previously
  *   handled in mpegtsbase:
  *   * GST_MTS_DESC_DVB_DATA_BROADCAST_ID
  *   * GST_MTS_DESC_DVB_CAROUSEL_IDENTIFIER
@@ -1743,7 +1743,7 @@ static void
  * gst_mpegts_descriptor_parse_dvb_multilingual_component:
  * @descriptor: a %GST_MTS_DESC_DVB_MULTILINGUAL_COMPONENT
  * #GstMpegtsDescriptor
- * @component_tag: the component tag
+ * @component_tag: (out): the component tag
  * @component_description_items: (out) (transfer full) (element-type GstMpegtsDvbMultilingualComponentItem):
  * a #GstMpegtsDvbMultilingualComponentItem
  *
@@ -1796,7 +1796,7 @@ gst_mpegts_descriptor_parse_dvb_multilingual_component (const
  * @descriptor: a %GST_MTS_DESC_DVB_PRIVATE_DATA_SPECIFIER #GstMpegtsDescriptor
  * @private_data_specifier: (out): the private data specifier id
  * registered by http://www.dvbservices.com/
- * @private_data: (out) (transfer full)(allow-none): additional data or NULL
+ * @private_data: (out) (transfer full) (allow-none) (array length=length): additional data or NULL
  * @length: (out) (allow-none): length of %private_data
  *
  * Parses out the private data specifier from the @descriptor.
@@ -2003,7 +2003,7 @@ gst_mpegts_descriptor_parse_dvb_scrambling (const GstMpegtsDescriptor *
  * gst_mpegts_descriptor_parse_dvb_data_broadcast_id:
  * @descriptor: a %GST_MTS_DESC_DVB_DATA_BROADCAST_ID #GstMpegtsDescriptor
  * @data_broadcast_id: (out): the data broadcast id
- * @id_selector_bytes: (out) (transfer full): the selector bytes, if present
+ * @id_selector_bytes: (out) (transfer full) (array length=len): the selector bytes, if present
  * @len: (out): the length of #id_selector_bytes
  *
  * Parses out the data broadcast id from the @descriptor.
index 079716e..5884132 100644 (file)
@@ -1,7 +1,7 @@
 /*
- * gstmpegtsdescriptor.c - 
+ * gstmpegtsdescriptor.c -
  * Copyright (C) 2013 Edward Hervey
- * 
+ *
  * Authors:
  *   Edward Hervey <edward@collabora.com>
  *
@@ -29,7 +29,7 @@
 /**
  * SECTION:gstmpegtsdescriptor
  * @title: Base MPEG-TS descriptors
- * @short_description: Descriptors for ITU H.222.0 | ISO/IEC 13818-1 
+ * @short_description: Descriptors for ITU H.222.0 | ISO/IEC 13818-1
  * @include: gst/mpegts/mpegts.h
  *
  * These are the base descriptor types and methods.
@@ -61,7 +61,7 @@
  *
  * * Add common validation code for data presence and minimum/maximum expected
  *   size.
- * * Add parsing methods for the following descriptors that were previously 
+ * * Add parsing methods for the following descriptors that were previously
  *   handled in mpegtsbase:
  *   * GST_MTS_DESC_DVB_DATA_BROADCAST_ID
  *   * GST_MTS_DESC_DVB_CAROUSEL_IDENTIFIER
@@ -841,7 +841,7 @@ gst_mpegts_find_descriptor (GPtrArray * descriptors, guint8 tag)
 /**
  * gst_mpegts_descriptor_from_registration:
  * @format_identifier: (transfer none): a 4 character format identifier string
- * @additional_info: (transfer none) (allow-none): pointer to optional additional info
+ * @additional_info: (transfer none) (allow-none) (array length=additional_info_length): pointer to optional additional info
  * @additional_info_length: length of the optional @additional_info
  *
  * Creates a %GST_MTS_DESC_REGISTRATION #GstMpegtsDescriptor
@@ -874,7 +874,7 @@ gst_mpegts_descriptor_from_registration (const gchar * format_identifier,
  * @descriptor: a %GST_MTS_DESC_CA #GstMpegtsDescriptor
  * @ca_system_id: (out): the type of CA system used
  * @ca_pid: (out): The PID containing ECM or EMM data
- * @private_data: (out) (allow-none): The private data
+ * @private_data: (out) (allow-none) (array length=private_data_size): The private data
  * @private_data_size: (out) (allow-none): The size of @private_data in bytes
  *
  * Extracts the Conditional Access information from @descriptor.
@@ -1104,7 +1104,7 @@ gst_mpegts_descriptor_parse_logical_channel (const GstMpegtsDescriptor *
 /**
  * gst_mpegts_descriptor_from_custom:
  * @tag: descriptor tag
- * @data: (transfer none): descriptor data (after tag and length field)
+ * @data: (transfer none) (array length=length): descriptor data (after tag and length field)
  * @length: length of @data
  *
  * Creates a #GstMpegtsDescriptor with custom @tag and @data
@@ -1131,7 +1131,7 @@ gst_mpegts_descriptor_from_custom (guint8 tag, const guint8 * data,
  * gst_mpegts_descriptor_from_custom_with_extension:
  * @tag: descriptor tag
  * @tag_extension: descriptor tag extension
- * @data: (transfer none): descriptor data (after tag and length field)
+ * @data: (transfer none) (array length=length): descriptor data (after tag and length field)
  * @length: length of @data
  *
  * Creates a #GstMpegtsDescriptor with custom @tag, @tag_extension and @data
index 01fc2a2..62657da 100644 (file)
@@ -45,7 +45,7 @@
 /**
  * SECTION:gstmpegtssection
  * @title: Base MPEG-TS sections
- * @short_description: Sections for ITU H.222.0 | ISO/IEC 13818-1 
+ * @short_description: Sections for ITU H.222.0 | ISO/IEC 13818-1
  * @include: gst/mpegts/mpegts.h
  *
  * For more details, refer to the ITU H.222.0 or ISO/IEC 13818-1 specifications
@@ -55,7 +55,7 @@
 /*
  * TODO
  *
- * * Check minimum size for section parsing in the various 
+ * * Check minimum size for section parsing in the various
  *   gst_mpegts_section_get_<tabld>() methods
  *
  * * Implement parsing code for
@@ -1161,7 +1161,7 @@ _packetize_common_section (GstMpegtsSection * section, gsize length)
 /**
  * gst_mpegts_section_new:
  * @pid: the PID to which this section belongs
- * @data: (transfer full): a pointer to the beginning of the section (i.e. the first byte
+ * @data: (transfer full) (array length=data_size): a pointer to the beginning of the section (i.e. the first byte
  * should contain the table_id field).
  * @data_size: size of the @data argument.
  *