introspection: add some missing allow-none annotations to in params

https://bugzilla.gnome.org/show_bug.cgi?id=730957
This commit is contained in:
Evan Nemerson 2014-06-11 16:19:01 -07:00 committed by Sebastian Dröge
parent 5d80cf12ba
commit 4088363aea
10 changed files with 48 additions and 47 deletions

View file

@ -823,8 +823,8 @@ gst_buffer_pool_config_set_params (GstStructure * config, GstCaps * caps,
/** /**
* gst_buffer_pool_config_set_allocator: * gst_buffer_pool_config_set_allocator:
* @config: a #GstBufferPool configuration * @config: a #GstBufferPool configuration
* @allocator: a #GstAllocator * @allocator: (allow-none): a #GstAllocator
* @params: #GstAllocationParams * @params: (allow-none): #GstAllocationParams
* *
* Set the @allocator and @params on @config. * Set the @allocator and @params on @config.
* *

View file

@ -1731,7 +1731,7 @@ gst_element_post_message (GstElement * element, GstMessage * message)
/** /**
* _gst_element_error_printf: * _gst_element_error_printf:
* @format: the printf-like format to use, or %NULL * @format: (allow-none): the printf-like format to use, or %NULL
* *
* This function is only used internally by the gst_element_error() macro. * This function is only used internally by the gst_element_error() macro.
* *

View file

@ -197,7 +197,7 @@ struct _GstDebugCategory {
/** /**
* GST_STR_NULL: * GST_STR_NULL:
* @str: The string to check. * @str: (allow-none): The string to check.
* *
* Macro to use when a string must not be %NULL, but may be %NULL. If the string * Macro to use when a string must not be %NULL, but may be %NULL. If the string
* is %NULL, "(NULL)" is printed instead. * is %NULL, "(NULL)" is printed instead.

View file

@ -256,8 +256,8 @@ gst_message_init (GstMessageImpl * message, GstMessageType type,
* gst_message_new_custom: * gst_message_new_custom:
* @type: The #GstMessageType to distinguish messages * @type: The #GstMessageType to distinguish messages
* @src: The object originating the message. * @src: The object originating the message.
* @structure: (transfer full): the structure for the message. The message * @structure: (transfer full) (allow-none): the structure for the
* will take ownership of the structure. * message. The message will take ownership of the structure.
* *
* Create a new custom-typed message. This can be used for anything not * Create a new custom-typed message. This can be used for anything not
* handled by other message-specific functions to pass a message to the * handled by other message-specific functions to pass a message to the
@ -785,8 +785,8 @@ gst_message_new_application (GstObject * src, GstStructure * structure)
/** /**
* gst_message_new_element: * gst_message_new_element:
* @src: (transfer none): The object originating the message. * @src: (transfer none): The object originating the message.
* @structure: (transfer full): The structure for the message. The message * @structure: (transfer full): The structure for the
* will take ownership of the structure. * message. The message will take ownership of the structure.
* *
* Create a new element-specific message. This is meant as a generic way of * Create a new element-specific message. This is meant as a generic way of
* allowing one-way communication from an element to an application, for example * allowing one-way communication from an element to an application, for example

View file

@ -312,7 +312,7 @@ gst_object_ref_sink (gpointer object)
* gst_object_replace: * gst_object_replace:
* @oldobj: (inout) (transfer full) (nullable): pointer to a place of * @oldobj: (inout) (transfer full) (nullable): pointer to a place of
* a #GstObject to replace * a #GstObject to replace
* @newobj: (transfer none): a new #GstObject * @newobj: (transfer none) (allow-none): a new #GstObject
* *
* Atomically modifies a pointer to point to a new object. * Atomically modifies a pointer to point to a new object.
* The reference count of @oldobj is decreased and the reference count of * The reference count of @oldobj is decreased and the reference count of
@ -588,7 +588,7 @@ had_parent:
/** /**
* gst_object_set_name: * gst_object_set_name:
* @object: a #GstObject * @object: a #GstObject
* @name: new name of object * @name: (allow-none): new name of object
* *
* Sets the name of @object, or gives @object a guaranteed unique * Sets the name of @object, or gives @object a guaranteed unique
* name (if @name is %NULL). * name (if @name is %NULL).

View file

@ -766,7 +766,7 @@ gst_pad_get_property (GObject * object, guint prop_id,
/** /**
* gst_pad_new: * gst_pad_new:
* @name: the name of the new pad. * @name: (allow-none): the name of the new pad.
* @direction: the #GstPadDirection of the pad. * @direction: the #GstPadDirection of the pad.
* *
* Creates a new pad with the given name in the given direction. * Creates a new pad with the given name in the given direction.
@ -789,7 +789,7 @@ gst_pad_new (const gchar * name, GstPadDirection direction)
/** /**
* gst_pad_new_from_template: * gst_pad_new_from_template:
* @templ: the pad template to use * @templ: the pad template to use
* @name: the name of the element * @name: (allow-none): the name of the element
* *
* Creates a new pad with the given name from the given template. * Creates a new pad with the given name from the given template.
* If name is %NULL, a guaranteed unique name (across all pads) * If name is %NULL, a guaranteed unique name (across all pads)

View file

@ -251,9 +251,9 @@ typedef gboolean (*GstPadActivateModeFunction) (GstPad *pad, GstObject *parent,
/** /**
* GstPadChainFunction: * GstPadChainFunction:
* @pad: the sink #GstPad that performed the chain. * @pad: the sink #GstPad that performed the chain.
* @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set, * @parent: (allow-none): the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
* @parent is guaranteed to be not-%NULL and remain valid during the * flag is set, @parent is guaranteed to be not-%NULL and remain valid
* execution of this function. * during the execution of this function.
* @buffer: the #GstBuffer that is chained, not %NULL. * @buffer: the #GstBuffer that is chained, not %NULL.
* *
* A function that will be called on sinkpads when chaining buffers. * A function that will be called on sinkpads when chaining buffers.
@ -274,9 +274,9 @@ typedef GstFlowReturn (*GstPadChainFunction) (GstPad *pad, GstObject *parent,
/** /**
* GstPadChainListFunction: * GstPadChainListFunction:
* @pad: the sink #GstPad that performed the chain. * @pad: the sink #GstPad that performed the chain.
* @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set, * @parent: (allow-none): the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
* @parent is guaranteed to be not-%NULL and remain valid during the * flag is set, @parent is guaranteed to be not-%NULL and remain valid
* execution of this function. * during the execution of this function.
* @list: the #GstBufferList that is chained, not %NULL. * @list: the #GstBufferList that is chained, not %NULL.
* *
* A function that will be called on sinkpads when chaining buffer lists. * A function that will be called on sinkpads when chaining buffer lists.
@ -297,9 +297,9 @@ typedef GstFlowReturn (*GstPadChainListFunction) (GstPad *pad, GstObject *paren
/** /**
* GstPadGetRangeFunction: * GstPadGetRangeFunction:
* @pad: the src #GstPad to perform the getrange on. * @pad: the src #GstPad to perform the getrange on.
* @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set, * @parent: (allow-none): the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
* @parent is guaranteed to be not-%NULL and remain valid during the * flag is set, @parent is guaranteed to be not-%NULL and remain valid
* execution of this function. * during the execution of this function.
* @offset: the offset of the range * @offset: the offset of the range
* @length: the length of the range * @length: the length of the range
* @buffer: a memory location to hold the result buffer, cannot be %NULL. * @buffer: a memory location to hold the result buffer, cannot be %NULL.
@ -348,9 +348,9 @@ typedef GstFlowReturn (*GstPadGetRangeFunction) (GstPad *pad, GstObject *parent
/** /**
* GstPadEventFunction: * GstPadEventFunction:
* @pad: the #GstPad to handle the event. * @pad: the #GstPad to handle the event.
* @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set, * @parent: (allow-none): the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
* @parent is guaranteed to be not-%NULL and remain valid during the * flag is set, @parent is guaranteed to be not-%NULL and remain valid
* execution of this function. * during the execution of this function.
* @event: the #GstEvent to handle. * @event: the #GstEvent to handle.
* *
* Function signature to handle an event for the pad. * Function signature to handle an event for the pad.
@ -365,9 +365,9 @@ typedef gboolean (*GstPadEventFunction) (GstPad *pad, GstObject *parent,
/** /**
* GstPadIterIntLinkFunction: * GstPadIterIntLinkFunction:
* @pad: The #GstPad to query. * @pad: The #GstPad to query.
* @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set, * @parent: (allow-none): the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
* @parent is guaranteed to be not-%NULL and remain valid during the * flag is set, @parent is guaranteed to be not-%NULL and remain valid
* execution of this function. * during the execution of this function.
* *
* The signature of the internal pad link iterator function. * The signature of the internal pad link iterator function.
* *
@ -382,9 +382,9 @@ typedef GstIterator* (*GstPadIterIntLinkFunction) (GstPad *pad, Gst
/** /**
* GstPadQueryFunction: * GstPadQueryFunction:
* @pad: the #GstPad to query. * @pad: the #GstPad to query.
* @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set, * @parent: (allow-none): the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
* @parent is guaranteed to be not-%NULL and remain valid during the * flag is set, @parent is guaranteed to be not-%NULL and remain valid
* execution of this function. * during the execution of this function.
* @query: the #GstQuery object to execute * @query: the #GstQuery object to execute
* *
* The signature of the query function. * The signature of the query function.
@ -399,9 +399,9 @@ typedef gboolean (*GstPadQueryFunction) (GstPad *pad, GstObject *parent,
/** /**
* GstPadLinkFunction: * GstPadLinkFunction:
* @pad: the #GstPad that is linked. * @pad: the #GstPad that is linked.
* @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set, * @parent: (allow-none): the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
* @parent is guaranteed to be not-%NULL and remain valid during the * flag is set, @parent is guaranteed to be not-%NULL and remain valid
* execution of this function. * during the execution of this function.
* @peer: the peer #GstPad of the link * @peer: the peer #GstPad of the link
* *
* Function signature to handle a new link on the pad. * Function signature to handle a new link on the pad.
@ -412,9 +412,9 @@ typedef GstPadLinkReturn (*GstPadLinkFunction) (GstPad *pad, GstObject *parent,
/** /**
* GstPadUnlinkFunction: * GstPadUnlinkFunction:
* @pad: the #GstPad that is linked. * @pad: the #GstPad that is linked.
* @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set, * @parent: (allow-none): the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
* @parent is guaranteed to be not-%NULL and remain valid during the * flag is set, @parent is guaranteed to be not-%NULL and remain valid
* execution of this function. * during the execution of this function.
* *
* Function signature to handle a unlinking the pad prom its peer. * Function signature to handle a unlinking the pad prom its peer.
*/ */
@ -524,8 +524,8 @@ typedef enum
* GstPadProbeInfo: * GstPadProbeInfo:
* @type: the current probe type * @type: the current probe type
* @id: the id of the probe * @id: the id of the probe
* @data: type specific data, check the @type field to know the datatype. * @data: (allow-none): type specific data, check the @type field to know the
* This field can be %NULL. * datatype. This field can be %NULL.
* @offset: offset of pull probe, this field is valid when @type contains * @offset: offset of pull probe, this field is valid when @type contains
* #GST_PAD_PROBE_TYPE_PULL * #GST_PAD_PROBE_TYPE_PULL
* @size: size of pull probe, this field is valid when @type contains * @size: size of pull probe, this field is valid when @type contains
@ -581,7 +581,7 @@ typedef GstPadProbeReturn (*GstPadProbeCallback) (GstPad *pad, GstPadProbeIn
/** /**
* GstPadStickyEventsForeachFunction: * GstPadStickyEventsForeachFunction:
* @pad: the #GstPad. * @pad: the #GstPad.
* @event: a sticky #GstEvent. * @event: (allow-none): a sticky #GstEvent.
* @user_data: the #gpointer to optional user data. * @user_data: the #gpointer to optional user data.
* *
* Callback used by gst_pad_sticky_events_foreach(). * Callback used by gst_pad_sticky_events_foreach().

View file

@ -145,11 +145,12 @@ typedef gboolean (*GstPluginInitFullFunc) (GstPlugin *plugin, gpointer user_data
* @source: source module plugin belongs to * @source: source module plugin belongs to
* @package: shipped package plugin belongs to * @package: shipped package plugin belongs to
* @origin: URL to provider of plugin * @origin: URL to provider of plugin
* @release_datetime: date time string in ISO 8601 format (or rather, a * @release_datetime: (allow-none): date time string in ISO 8601
* subset thereof), or %NULL. Allowed are the following formats: * format (or rather, a subset thereof), or %NULL. Allowed are the
* "YYYY-MM-DD" and "YYY-MM-DDTHH:MMZ" (with 'T' a separator and 'Z' * following formats: "YYYY-MM-DD" and "YYY-MM-DDTHH:MMZ" (with
* indicating UTC/Zulu time). This field should be set via the * 'T' a separator and 'Z' indicating UTC/Zulu time). This field
* GST_PACKAGE_RELEASE_DATETIME preprocessor macro. * should be set via the %GST_PACKAGE_RELEASE_DATETIME
* preprocessor macro.
* *
* A plugin should export a variable of this type called plugin_desc. The plugin * A plugin should export a variable of this type called plugin_desc. The plugin
* loader will use the data provided there to initialize the plugin. * loader will use the data provided there to initialize the plugin.

View file

@ -1069,7 +1069,7 @@ gst_preset_delete_preset (GstPreset * preset, const gchar * name)
* @preset: a #GObject that implements #GstPreset * @preset: a #GObject that implements #GstPreset
* @name: preset name * @name: preset name
* @tag: meta data item name * @tag: meta data item name
* @value: new value * @value: (allow-none): new value
* *
* Sets a new @value for an existing meta data item or adds a new item. Meta * Sets a new @value for an existing meta data item or adds a new item. Meta
* data @tag names can be something like e.g. "comment". Supplying %NULL for the * data @tag names can be something like e.g. "comment". Supplying %NULL for the

View file

@ -1133,8 +1133,8 @@ gst_tag_list_insert (GstTagList * into, const GstTagList * from,
/** /**
* gst_tag_list_merge: * gst_tag_list_merge:
* @list1: first list to merge * @list1: (allow-none): first list to merge
* @list2: second list to merge * @list2: (allow-none): second list to merge
* @mode: the mode to use * @mode: the mode to use
* *
* Merges the two given lists into a new list. If one of the lists is %NULL, a * Merges the two given lists into a new list. If one of the lists is %NULL, a