tag: fix some GIR annotations

Mostly related to out and array parameters.
This commit is contained in:
Mark Nauwelaerts 2018-04-13 20:18:56 +02:00 committed by Sebastian Dröge
parent d202097dd6
commit 9a1f62923e
4 changed files with 22 additions and 19 deletions

View file

@ -252,7 +252,7 @@ gst_tag_extract_id3v1_string (GstTagList * list, const gchar * tag,
/** /**
* gst_tag_list_new_from_id3v1: * gst_tag_list_new_from_id3v1:
* @data: 128 bytes of data containing the ID3v1 tag * @data: (array fixed-size=128): 128 bytes of data containing the ID3v1 tag
* *
* Parses the data containing an ID3v1 tag and returns a #GstTagList from the * Parses the data containing an ID3v1 tag and returns a #GstTagList from the
* parsed data. * parsed data.
@ -337,7 +337,7 @@ gst_tag_id3_genre_get (const guint id)
/** /**
* gst_tag_list_add_id3_image: * gst_tag_list_add_id3_image:
* @tag_list: a tag list * @tag_list: a tag list
* @image_data: the (encoded) image * @image_data: (array length=image_data_len): the (encoded) image
* @image_data_len: the length of the encoded image data at @image_data * @image_data_len: the length of the encoded image data at @image_data
* @id3_picture_type: picture type as per the ID3 (v2.4.0) specification for * @id3_picture_type: picture type as per the ID3 (v2.4.0) specification for
* the APIC frame (0 = unknown/other) * the APIC frame (0 = unknown/other)

View file

@ -403,12 +403,12 @@ decode_failed:
/** /**
* gst_tag_list_from_vorbiscomment: * gst_tag_list_from_vorbiscomment:
* @data: data to convert * @data: (array length=size): data to convert
* @size: size of @data * @size: size of @data
* @id_data: identification data at start of stream * @id_data: (array length=id_data_length): identification data at start of stream
* @id_data_length: length of identification data * @id_data_length: length of identification data
* @vendor_string: pointer to a string that should take the vendor string * @vendor_string: (out) (optional): pointer to a string that should take the
* of this vorbis comment or NULL if you don't need it. * vendor string of this vorbis comment or NULL if you don't need it.
* *
* Creates a new tag list that contains the information parsed out of a * Creates a new tag list that contains the information parsed out of a
* vorbiscomment packet. * vorbiscomment packet.
@ -501,10 +501,10 @@ error:
/** /**
* gst_tag_list_from_vorbiscomment_buffer: * gst_tag_list_from_vorbiscomment_buffer:
* @buffer: buffer to convert * @buffer: buffer to convert
* @id_data: identification data at start of stream * @id_data: (array length=id_data_length): identification data at start of stream
* @id_data_length: length of identification data * @id_data_length: length of identification data
* @vendor_string: pointer to a string that should take the vendor string * @vendor_string: (out) (optional): pointer to a string that should take the
* of this vorbis comment or NULL if you don't need it. * vendor string of this vorbis comment or NULL if you don't need it.
* *
* Creates a new tag list that contains the information parsed out of a * Creates a new tag list that contains the information parsed out of a
* vorbiscomment packet. * vorbiscomment packet.
@ -777,9 +777,9 @@ write_one_tag (const GstTagList * list, const gchar * tag, gpointer user_data)
/** /**
* gst_tag_list_to_vorbiscomment_buffer: * gst_tag_list_to_vorbiscomment_buffer:
* @list: tag list to convert * @list: tag list to convert
* @id_data: identification data at start of stream * @id_data: (array length=id_data_length): identification data at start of stream
* @id_data_length: length of identification data, may be 0 if @id_data is NULL * @id_data_length: length of identification data, may be 0 if @id_data is NULL
* @vendor_string: string that describes the vendor string or NULL * @vendor_string: (nullable): string that describes the vendor string or NULL
* *
* Creates a new vorbiscomment buffer from a tag list. * Creates a new vorbiscomment buffer from a tag list.
* *

View file

@ -1698,7 +1698,8 @@ write_one_tag (const GstTagList * list, XmpTag * xmp_tag, gpointer user_data)
* gst_tag_list_to_xmp_buffer: * gst_tag_list_to_xmp_buffer:
* @list: tags * @list: tags
* @read_only: does the container forbid inplace editing * @read_only: does the container forbid inplace editing
* @schemas: %NULL terminated array of schemas to be used on serialization * @schemas: (array zero-terminated):
* %NULL terminated array of schemas to be used on serialization
* *
* Formats a taglist as a xmp packet using only the selected * Formats a taglist as a xmp packet using only the selected
* schemas. An empty list (%NULL) means that all schemas should * schemas. An empty list (%NULL) means that all schemas should

View file

@ -242,9 +242,11 @@ gst_tag_image_type_is_valid (GstTagImageType type)
/** /**
* gst_tag_parse_extended_comment: * gst_tag_parse_extended_comment:
* @ext_comment: an extended comment string, see #GST_TAG_EXTENDED_COMMENT * @ext_comment: an extended comment string, see #GST_TAG_EXTENDED_COMMENT
* @key: return location for the comment description key, or NULL * @key: (out) (nullable):
* @lang: return location for the comment ISO-639 language code, or NULL * return location for the comment description key, or NULL
* @value: return location for the actual comment string, or NULL * @lang: (out) (nullable):
* return location for the comment ISO-639 language code, or NULL
* @value: (out): return location for the actual comment string, or NULL
* @fail_if_no_key: whether to fail if strings are not in key=value form * @fail_if_no_key: whether to fail if strings are not in key=value form
* *
* Convenience function to parse a GST_TAG_EXTENDED_COMMENT string and * Convenience function to parse a GST_TAG_EXTENDED_COMMENT string and
@ -303,10 +305,10 @@ gst_tag_parse_extended_comment (const gchar * ext_comment, gchar ** key,
/** /**
* gst_tag_freeform_string_to_utf8: * gst_tag_freeform_string_to_utf8:
* @data: string data * @data: (array length=size) (element-type gchar): string data
* @size: length of string data, or -1 if the string is NUL-terminated * @size: length of string data, or -1 if the string is NUL-terminated
* @env_vars: a NULL-terminated string array of environment variable names, * @env_vars: (array zero-terminated=1)
* or NULL * a NULL-terminated string array of environment variable names, or NULL
* *
* Convenience function to read a string with unknown character encoding. If * Convenience function to read a string with unknown character encoding. If
* the string is already in UTF-8 encoding, it will be returned right away. * the string is already in UTF-8 encoding, it will be returned right away.
@ -474,7 +476,7 @@ beach:
/** /**
* gst_tag_image_data_to_image_sample: * gst_tag_image_data_to_image_sample:
* @image_data: the (encoded) image * @image_data: (array length=image_data_len): the (encoded) image
* @image_data_len: the length of the encoded image data at @image_data * @image_data_len: the length of the encoded image data at @image_data
* @image_type: type of the image, or #GST_TAG_IMAGE_TYPE_UNDEFINED. Pass * @image_type: type of the image, or #GST_TAG_IMAGE_TYPE_UNDEFINED. Pass
* #GST_TAG_IMAGE_TYPE_NONE if no image type should be set at all (e.g. * #GST_TAG_IMAGE_TYPE_NONE if no image type should be set at all (e.g.