mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-02 22:46:35 +00:00
Code Issues 1 Projects Releases Wiki Activity

gst: Fix up a bunch of GIR annotations

Browse source 
This is mostly on nullable return values, and some other minor ones that
I ran across.

https://bugzilla.gnome.org/show_bug.cgi?id=789319
This commit is contained in:
Arun Raghavan 2017-10-22 18:05:30 +05:30 committed by Tim-Philipp Müller
parent 41a59cddb6
commit b5028383ab
33 changed files with 153 additions and 138 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
gst/gst.c
View file

@ -237,7 +237,7 @@ DllMain (HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved)
* threading system as one of the very first things in your program * threading system as one of the very first things in your program
* (see the example at the beginning of this section). * (see the example at the beginning of this section).
* *
* Returns: (transfer full): a pointer to GStreamer's option group. * Returns: (transfer full) (nullable): a pointer to GStreamer's option group.
*/ */
GOptionGroup * GOptionGroup *
@ -375,7 +375,7 @@ find_executable_path (void)
* external process, the returned path will be the same as from the * external process, the returned path will be the same as from the
* parent process. * parent process.
* *
* Returns: (transfer none): The path of the executable that * Returns: (transfer none) (nullable): The path of the executable that
* initialized GStreamer, or %NULL if it could not be determined. * initialized GStreamer, or %NULL if it could not be determined.
* *
* Since: 1.14 * Since: 1.14

8
gst/gstallocator.c
View file

@ -159,13 +159,13 @@ gst_allocation_params_init (GstAllocationParams * params)
/** /**
* gst_allocation_params_copy: * gst_allocation_params_copy:
* @params: (transfer none): a #GstAllocationParams * @params: (transfer none) (nullable): a #GstAllocationParams
* *
* Create a copy of @params. * Create a copy of @params.
* *
* Free-function: gst_allocation_params_free * Free-function: gst_allocation_params_free
* *
* Returns: (transfer full): a new ##GstAllocationParams, free with * Returns: (transfer full) (nullable): a new ##GstAllocationParams, free with
* gst_allocation_params_free(). * gst_allocation_params_free().
*/ */
GstAllocationParams * GstAllocationParams *
@ -290,7 +290,7 @@ gst_allocator_set_default (GstAllocator * allocator)
* the amount of bytes to align to. For example, to align to 8 bytes, * the amount of bytes to align to. For example, to align to 8 bytes,
* use an alignment of 7. * use an alignment of 7.
* *
* Returns: (transfer full): a new #GstMemory. * Returns: (transfer full) (nullable): a new #GstMemory.
*/ */
GstMemory * GstMemory *
gst_allocator_alloc (GstAllocator * allocator, gsize size, gst_allocator_alloc (GstAllocator * allocator, gsize size,
@ -631,7 +631,7 @@ _priv_gst_allocator_cleanup (void)
* The prefix/padding must be filled with 0 if @flags contains * The prefix/padding must be filled with 0 if @flags contains
* #GST_MEMORY_FLAG_ZERO_PREFIXED and #GST_MEMORY_FLAG_ZERO_PADDED respectively. * #GST_MEMORY_FLAG_ZERO_PREFIXED and #GST_MEMORY_FLAG_ZERO_PADDED respectively.
* *
* Returns: (transfer full): a new #GstMemory. * Returns: (transfer full) (nullable): a new #GstMemory.
*/ */
GstMemory * GstMemory *
gst_memory_new_wrapped (GstMemoryFlags flags, gpointer data, gst_memory_new_wrapped (GstMemoryFlags flags, gpointer data,

3
gst/gstbin.c
View file

@ -4549,7 +4549,8 @@ compare_interface (const GValue * velement, GValue * interface)
* *
* MT safe. Caller owns returned reference. * MT safe. Caller owns returned reference.
* *
* Returns: (transfer full): A #GstElement inside the bin implementing the interface * Returns: (transfer full) (nullable): A #GstElement inside the bin
* implementing the interface
*/ */
GstElement * GstElement *
gst_bin_get_by_interface (GstBin * bin, GType iface) gst_bin_get_by_interface (GstBin * bin, GType iface)

16
gst/gstbuffer.c
View file

@ -1080,7 +1080,7 @@ _get_mapped (GstBuffer * buffer, guint idx, GstMapInfo * info,
* the memory block in @buffer is removed, replaced or merged, typically with * the memory block in @buffer is removed, replaced or merged, typically with
* any call that modifies the memory in @buffer. * any call that modifies the memory in @buffer.
* *
* Returns: (transfer none): the #GstMemory at @idx. * Returns: (transfer none) (nullable): the #GstMemory at @idx.
*/ */
GstMemory * GstMemory *
gst_buffer_peek_memory (GstBuffer * buffer, guint idx) gst_buffer_peek_memory (GstBuffer * buffer, guint idx)
@ -1101,7 +1101,7 @@ gst_buffer_peek_memory (GstBuffer * buffer, guint idx)
* *
* Get the memory block at index @idx in @buffer. * Get the memory block at index @idx in @buffer.
* *
* Returns: (transfer full): a #GstMemory that contains the data of the * Returns: (transfer full) (nullable): a #GstMemory that contains the data of the
* memory block at @idx. Use gst_memory_unref () after usage. * memory block at @idx. Use gst_memory_unref () after usage.
*/ */
GstMemory * GstMemory *
@ -1117,7 +1117,7 @@ gst_buffer_get_memory (GstBuffer * buffer, guint idx)
* Get all the memory block in @buffer. The memory blocks will be merged * Get all the memory block in @buffer. The memory blocks will be merged
* into one large #GstMemory. * into one large #GstMemory.
* *
* Returns: (transfer full): a #GstMemory that contains the merged memory. * Returns: (transfer full) (nullable): a #GstMemory that contains the merged memory.
* Use gst_memory_unref () after usage. * Use gst_memory_unref () after usage.
*/ */
GstMemory * GstMemory *
@ -1137,7 +1137,7 @@ gst_buffer_get_all_memory (GstBuffer * buffer)
* *
* If @length is -1, all memory starting from @idx is merged. * If @length is -1, all memory starting from @idx is merged.
* *
* Returns: (transfer full): a #GstMemory that contains the merged data of @length * Returns: (transfer full) (nullable): a #GstMemory that contains the merged data of @length
* blocks starting at @idx. Use gst_memory_unref () after usage. * blocks starting at @idx. Use gst_memory_unref () after usage.
*/ */
GstMemory * GstMemory *
@ -2147,7 +2147,7 @@ gst_buffer_get_meta (GstBuffer * buffer, GType api)
* *
* Add metadata for @info to @buffer using the parameters in @params. * Add metadata for @info to @buffer using the parameters in @params.
* *
* Returns: (transfer none): the metadata for the api in @info on @buffer. * Returns: (transfer none) (nullable): the metadata for the api in @info on @buffer.
*/ */
GstMeta * GstMeta *
gst_buffer_add_meta (GstBuffer * buffer, const GstMetaInfo * info, gst_buffer_add_meta (GstBuffer * buffer, const GstMetaInfo * info,
@ -2430,7 +2430,7 @@ GST_DEBUG_CATEGORY_STATIC (gst_parent_buffer_meta_debug);
* Add a #GstParentBufferMeta to @buffer that holds a reference on * Add a #GstParentBufferMeta to @buffer that holds a reference on
* @ref until the buffer is freed. * @ref until the buffer is freed.
* *
* Returns: (transfer none): The #GstParentBufferMeta that was added to the buffer * Returns: (transfer none) (nullable): The #GstParentBufferMeta that was added to the buffer
* *
* Since: 1.6 * Since: 1.6
*/ */
@ -2561,7 +2561,7 @@ GST_DEBUG_CATEGORY_STATIC (gst_reference_timestamp_meta_debug);
* optionally @duration based on a specific timestamp @reference. See the * optionally @duration based on a specific timestamp @reference. See the
* documentation of #GstReferenceTimestampMeta for details. * documentation of #GstReferenceTimestampMeta for details.
* *
* Returns: (transfer none): The #GstReferenceTimestampMeta that was added to the buffer * Returns: (transfer none) (nullable): The #GstReferenceTimestampMeta that was added to the buffer
* *
* Since: 1.14 * Since: 1.14
*/ */
@ -2599,7 +2599,7 @@ gst_buffer_add_reference_timestamp_meta (GstBuffer * buffer,
* *
* Buffers can contain multiple #GstReferenceTimestampMeta metadata items. * Buffers can contain multiple #GstReferenceTimestampMeta metadata items.
* *
* Returns: (transfer none): the #GstReferenceTimestampMeta or %NULL when there * Returns: (transfer none) (nullable): the #GstReferenceTimestampMeta or %NULL when there
* is no such metadata on @buffer. * is no such metadata on @buffer.
* *
* Since: 1.14 * Since: 1.14

2
gst/gstbus.c
View file

@ -888,7 +888,7 @@ static GSourceFuncs gst_bus_source_funcs = {
* a message is on the bus. After the GSource is dispatched, the * a message is on the bus. After the GSource is dispatched, the
* message is popped off the bus and unreffed. * message is popped off the bus and unreffed.
* *
* Returns: (transfer full): a #GSource that can be added to a mainloop. * Returns: (transfer full) (nullable): a #GSource that can be added to a mainloop.
*/ */
GSource * GSource *
gst_bus_create_watch (GstBus * bus) gst_bus_create_watch (GstBus * bus)

17
gst/gstcaps.c
View file

@ -395,9 +395,10 @@ G_DEFINE_POINTER_TYPE (GstStaticCaps, gst_static_caps);
* *
* Converts a #GstStaticCaps to a #GstCaps. * Converts a #GstStaticCaps to a #GstCaps.
* *
* Returns: (transfer full): a pointer to the #GstCaps. Unref after usage. * Returns: (transfer full) (nullable): a pointer to the #GstCaps. Unref
* Since the core holds an additional ref to the returned caps, * after usage. Since the core holds an additional ref to the
* use gst_caps_make_writable() on the returned caps to modify it. * returned caps, use gst_caps_make_writable() on the returned caps
* to modify it.
*/ */
GstCaps * GstCaps *
gst_static_caps_get (GstStaticCaps * static_caps) gst_static_caps_get (GstStaticCaps * static_caps)
@ -513,8 +514,8 @@ gst_caps_remove_and_get_structure (GstCaps * caps, guint idx)
* Retrieves the structure with the given index from the list of structures * Retrieves the structure with the given index from the list of structures
* contained in @caps. The caller becomes the owner of the returned structure. * contained in @caps. The caller becomes the owner of the returned structure.
* *
* Returns: (transfer full): a pointer to the #GstStructure corresponding * Returns: (transfer full) (nullable): a pointer to the #GstStructure
* to @index. * corresponding to @index.
*/ */
GstStructure * GstStructure *
gst_caps_steal_structure (GstCaps * caps, guint index) gst_caps_steal_structure (GstCaps * caps, guint index)
@ -856,8 +857,8 @@ gst_caps_get_structure (const GstCaps * caps, guint index)
* You do not need to free or unref the structure returned, it * You do not need to free or unref the structure returned, it
* belongs to the #GstCaps. * belongs to the #GstCaps.
* *
* Returns: (transfer none): a pointer to the #GstCapsFeatures corresponding * Returns: (transfer none) (nullable): a pointer to the #GstCapsFeatures
* to @index * corresponding to @index
* *
* Since: 1.2 * Since: 1.2
*/ */
@ -2361,7 +2362,7 @@ gst_caps_from_string_inplace (GstCaps * caps, const gchar * string)
* The current implementation of serialization will lead to unexpected results * The current implementation of serialization will lead to unexpected results
* when there are nested #GstCaps / #GstStructure deeper than one level. * when there are nested #GstCaps / #GstStructure deeper than one level.
* *
* Returns: (transfer full): a newly allocated #GstCaps * Returns: (transfer full) (nullable): a newly allocated #GstCaps
*/ */
GstCaps * GstCaps *
gst_caps_from_string (const gchar * string) gst_caps_from_string (const gchar * string)

2
gst/gstcapsfeatures.c
View file

@ -593,7 +593,7 @@ gst_caps_features_get_size (const GstCapsFeatures * features)
* *
* Returns the @i-th feature of @features. * Returns the @i-th feature of @features.
* *
* Returns: The @i-th feature of @features. * Returns: (nullable): The @i-th feature of @features.
* *
* Since: 1.2 * Since: 1.2
*/ */

4
gst/gstdatetime.c
View file

@ -498,7 +498,7 @@ gst_date_time_check_fields (gint * year, gint * month, gint * day,
* *
* Free-function: gst_date_time_unref * Free-function: gst_date_time_unref
* *
* Return value: (transfer full): the newly created #GstDateTime * Return value: (transfer full) (nullable): the newly created #GstDateTime
*/ */
GstDateTime * GstDateTime *
gst_date_time_new_local_time (gint year, gint month, gint day, gint hour, gst_date_time_new_local_time (gint year, gint month, gint day, gint hour,
@ -607,7 +607,7 @@ __gst_date_time_compare (const GstDateTime * dt1, const GstDateTime * dt2)
* *
* Free-function: gst_date_time_unref * Free-function: gst_date_time_unref
* *
* Return value: (transfer full): the newly created #GstDateTime * Return value: (transfer full) (nullable): the newly created #GstDateTime
*/ */
GstDateTime * GstDateTime *
gst_date_time_new (gfloat tzoffset, gint year, gint month, gint day, gint hour, gst_date_time_new (gfloat tzoffset, gint year, gint month, gint day, gint hour,

7
gst/gstdevice.c
View file

@ -199,7 +199,8 @@ gst_device_set_property (GObject * object, guint prop_id,
* Creates the element with all of the required parameters set to use * Creates the element with all of the required parameters set to use
* this device. * this device.
* *
* Returns: (transfer full): a new #GstElement configured to use this device * Returns: (transfer full) (nullable): a new #GstElement configured to use
* this device
* *
* Since: 1.4 * Since: 1.4
*/ */
@ -222,7 +223,7 @@ gst_device_create_element (GstDevice * device, const gchar * name)
* *
* Getter for the #GstCaps that this device supports. * Getter for the #GstCaps that this device supports.
* *
* Returns: The #GstCaps supported by this device. Unref with * Returns: (nullable): The #GstCaps supported by this device. Unref with
* gst_caps_unref() when done. * gst_caps_unref() when done.
* *
* Since: 1.4 * Since: 1.4
@ -286,7 +287,7 @@ gst_device_get_device_class (GstDevice * device)
* *
* Gets the extra properties of a device. * Gets the extra properties of a device.
* *
* Returns: The extra properties or %NULL when there are none. * Returns: (nullable): The extra properties or %NULL when there are none.
* Free with gst_structure_free() after use. * Free with gst_structure_free() after use.
* *
* Since: 1.6 * Since: 1.6

2
gst/gstdevicemonitor.c
View file

@ -342,7 +342,7 @@ gst_device_monitor_dispose (GObject * object)
* Gets a list of devices from all of the relevant monitors. This may actually * Gets a list of devices from all of the relevant monitors. This may actually
* probe the hardware if the monitor is not currently started. * probe the hardware if the monitor is not currently started.
* *
* Returns: (transfer full) (element-type GstDevice): a #GList of * Returns: (transfer full) (element-type GstDevice) (nullable): a #GList of
* #GstDevice * #GstDevice
* *
* Since: 1.4 * Since: 1.4

2
gst/gstdeviceprovider.c
View file

@ -337,7 +337,7 @@ gst_device_provider_class_set_static_metadata (GstDeviceProviderClass * klass,
* *
* Get metadata with @key in @klass. * Get metadata with @key in @klass.
* *
* Returns: the metadata for @key. * Returns: (nullable): the metadata for @key.
* *
* Since: 1.4 * Since: 1.4
*/ */

7
gst/gstelement.c
View file

@ -444,7 +444,7 @@ gst_element_set_clock (GstElement * element, GstClock * clock)
* Elements in a pipeline will only have their clock set when the * Elements in a pipeline will only have their clock set when the
* pipeline is in the PLAYING state. * pipeline is in the PLAYING state.
* *
* Returns: (transfer full): the #GstClock of the element. unref after usage. * Returns: (transfer full) (nullable): the #GstClock of the element. unref after usage.
* *
* MT safe. * MT safe.
*/ */
@ -3381,7 +3381,8 @@ gst_element_set_bus (GstElement * element, GstBus * bus)
* Returns the bus of the element. Note that only a #GstPipeline will provide a * Returns the bus of the element. Note that only a #GstPipeline will provide a
* bus for the application. * bus for the application.
* *
* Returns: (transfer full): the element's #GstBus. unref after usage. * Returns: (transfer full) (nullable): the element's #GstBus. unref after
* usage.
* *
* MT safe. * MT safe.
*/ */
@ -3505,7 +3506,7 @@ _match_context_type (GstContext * c1, const gchar * context_type)
* *
* Gets the context with @context_type set on the element or NULL. * Gets the context with @context_type set on the element or NULL.
* *
* Returns: (transfer full): A #GstContext or NULL * Returns: (transfer full) (nullable): A #GstContext or NULL
* *
* Since: 1.8 * Since: 1.8
*/ */

12
gst/gstevent.c
View file

@ -293,7 +293,7 @@ gst_event_init (GstEventImpl * event, GstEventType type)
* New custom events can also be created by subclassing the event type if * New custom events can also be created by subclassing the event type if
* needed. * needed.
* *
* Returns: (transfer full): the new custom event. * Returns: (transfer full) (nullable): the new custom event.
*/ */
GstEvent * GstEvent *
gst_event_new_custom (GstEventType type, GstStructure * structure) gst_event_new_custom (GstEventType type, GstStructure * structure)
@ -801,7 +801,7 @@ gst_event_parse_gap (GstEvent * event, GstClockTime * timestamp,
* synchronized with the buffer flow and contains the format of the buffers * synchronized with the buffer flow and contains the format of the buffers
* that will follow after the event. * that will follow after the event.
* *
* Returns: (transfer full): the new CAPS event. * Returns: (transfer full) (nullable): the new CAPS event.
*/ */
GstEvent * GstEvent *
gst_event_new_caps (GstCaps * caps) gst_event_new_caps (GstCaps * caps)
@ -879,7 +879,7 @@ gst_event_parse_caps (GstEvent * event, GstCaps ** caps)
* *
* time + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate) * time + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
* *
* Returns: (transfer full): the new SEGMENT event. * Returns: (transfer full) (nullable): the new SEGMENT event.
*/ */
GstEvent * GstEvent *
gst_event_new_segment (const GstSegment * segment) gst_event_new_segment (const GstSegment * segment)
@ -1128,7 +1128,7 @@ gst_event_parse_buffer_size (GstEvent * event, GstFormat * format,
* The application can use general event probes to intercept the QoS * The application can use general event probes to intercept the QoS
* event and implement custom application specific QoS handling. * event and implement custom application specific QoS handling.
* *
* Returns: (transfer full): a new QOS event. * Returns: (transfer full) (nullable): a new QOS event.
*/ */
GstEvent * GstEvent *
gst_event_new_qos (GstQOSType type, gdouble proportion, gst_event_new_qos (GstQOSType type, gdouble proportion,
@ -1254,7 +1254,7 @@ gst_event_parse_qos (GstEvent * event, GstQOSType * type,
* #GST_QUERY_POSITION and update the playback segment current position with a * #GST_QUERY_POSITION and update the playback segment current position with a
* #GST_SEEK_TYPE_SET to the desired position. * #GST_SEEK_TYPE_SET to the desired position.
* *
* Returns: (transfer full): a new seek event. * Returns: (transfer full) (nullable): a new seek event.
*/ */
GstEvent * GstEvent *
gst_event_new_seek (gdouble rate, GstFormat format, GstSeekFlags flags, gst_event_new_seek (gdouble rate, GstFormat format, GstSeekFlags flags,
@ -1435,7 +1435,7 @@ gst_event_parse_latency (GstEvent * event, GstClockTime * latency)
* The @intermediate flag instructs the pipeline that this step operation is * The @intermediate flag instructs the pipeline that this step operation is
* part of a larger step operation. * part of a larger step operation.
* *
* Returns: (transfer full): a new #GstEvent * Returns: (transfer full) (nullable): a new #GstEvent
*/ */
GstEvent * GstEvent *
gst_event_new_step (GstFormat format, guint64 amount, gdouble rate, gst_event_new_step (GstFormat format, guint64 amount, gdouble rate,

10
gst/gstinfo.c
View file

@ -574,7 +574,7 @@ gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
* Gets the string representation of a #GstDebugMessage. This function is used * Gets the string representation of a #GstDebugMessage. This function is used
* in debug handlers to extract the message. * in debug handlers to extract the message.
* *
* Returns: the string representation of a #GstDebugMessage. * Returns: (nullable): the string representation of a #GstDebugMessage.
*/ */
const gchar * const gchar *
gst_debug_message_get (GstDebugMessage * message) gst_debug_message_get (GstDebugMessage * message)
@ -2439,7 +2439,7 @@ gst_info_vasprintf (gchar ** result, const gchar * format, va_list args)
* *
* Free with g_free(). * Free with g_free().
* *
* Returns: a newly allocated null terminated string or %NULL on any error * Returns: (nullable): a newly allocated null terminated string or %NULL on any error
* *
* Since: 1.8 * Since: 1.8
*/ */
@ -2466,7 +2466,7 @@ gst_info_strdup_vprintf (const gchar * format, va_list args)
* *
* Free with g_free(). * Free with g_free().
* *
* Returns: a newly allocated null terminated string or %NULL on any error * Returns: (nullable): a newly allocated null terminated string or %NULL on any error
* *
* Since: 1.8 * Since: 1.8
*/ */
@ -2771,8 +2771,8 @@ generate_backtrace_trace (void)
* @flags: A set of #GstStackTraceFlags to determine how the stack * @flags: A set of #GstStackTraceFlags to determine how the stack
* trace should look like. Pass 0 to retrieve a minimal backtrace. * trace should look like. Pass 0 to retrieve a minimal backtrace.
* *
* If libunwind or glibc backtrace are present, a stack trace * Returns: (nullable): a stack trace, if libunwind or glibc backtrace are
* is returned. * present, else %NULL.
* *
* Since: 1.12 * Since: 1.12
*/ */

25
gst/gstmessage.c
View file

@ -284,7 +284,7 @@ gst_message_init (GstMessageImpl * message, GstMessageType type,
* handled by other message-specific functions to pass a message to the * handled by other message-specific functions to pass a message to the
* app. The structure field can be %NULL. * app. The structure field can be %NULL.
* *
* Returns: (transfer full): The new message. * Returns: (transfer full) (nullable): The new message.
* *
* MT safe. * MT safe.
*/ */
@ -405,7 +405,7 @@ gst_message_new_eos (GstObject * src)
* occurred. The pipeline will probably (partially) stop. The application * occurred. The pipeline will probably (partially) stop. The application
* receiving this message should stop the pipeline. * receiving this message should stop the pipeline.
* *
* Returns: (transfer full): the new error message. * Returns: (transfer full) (nullable): the new error message.
* *
* Since: 1.10 * Since: 1.10
*/ */
@ -497,7 +497,7 @@ gst_message_parse_error_details (GstMessage * message,
* Create a new warning message. The message will make copies of @error and * Create a new warning message. The message will make copies of @error and
* @debug. * @debug.
* *
* Returns: (transfer full): the new warning message. * Returns: (transfer full) (nullable): the new warning message.
* *
* Since: 1.10 * Since: 1.10
*/ */
@ -587,7 +587,7 @@ gst_message_parse_warning_details (GstMessage * message,
* Create a new info message. The message will make copies of @error and * Create a new info message. The message will make copies of @error and
* @debug. * @debug.
* *
* Returns: (transfer full): the new warning message. * Returns: (transfer full) (nullable): the new warning message.
* *
* Since: 1.10 * Since: 1.10
*/ */
@ -714,7 +714,7 @@ gst_message_new_tag (GstObject * src, GstTagList * tag_list)
* *
* MT safe. * MT safe.
* *
* Returns: (transfer full): The new buffering message. * Returns: (transfer full) (nullable): The new buffering message.
*/ */
GstMessage * GstMessage *
gst_message_new_buffering (GstObject * src, gint percent) gst_message_new_buffering (GstObject * src, gint percent)
@ -984,7 +984,7 @@ gst_message_new_segment_done (GstObject * src, GstFormat format,
* Create a new application-typed message. GStreamer will never create these * Create a new application-typed message. GStreamer will never create these
* messages; they are a gift from us to you. Enjoy. * messages; they are a gift from us to you. Enjoy.
* *
* Returns: (transfer full): The new application message. * Returns: (transfer full) (nullable): The new application message.
* *
* MT safe. * MT safe.
*/ */
@ -1007,7 +1007,7 @@ gst_message_new_application (GstObject * src, GstStructure * structure)
* "the firewire cable was unplugged". The format of the message should be * "the firewire cable was unplugged". The format of the message should be
* documented in the element's documentation. The structure field can be %NULL. * documented in the element's documentation. The structure field can be %NULL.
* *
* Returns: (transfer full): The new element message. * Returns: (transfer full) (nullable): The new element message.
* *
* MT safe. * MT safe.
*/ */
@ -1815,9 +1815,10 @@ gst_message_set_stream_status_object (GstMessage * message,
* *
* Extracts the object managing the streaming thread from @message. * Extracts the object managing the streaming thread from @message.
* *
* Returns: a GValue containing the object that manages the streaming thread. * Returns: (nullable): a GValue containing the object that manages the
* This object is usually of type GstTask but other types can be added in the * streaming thread. This object is usually of type GstTask but other types can
* future. The object remains valid as long as @message is valid. * be added in the future. The object remains valid as long as @message is
* valid.
*/ */
const GValue * const GValue *
gst_message_get_stream_status_object (GstMessage * message) gst_message_get_stream_status_object (GstMessage * message)
@ -2226,7 +2227,7 @@ gst_message_parse_qos_stats (GstMessage * message, GstFormat * format,
* @code contains a well defined string describing the action. * @code contains a well defined string describing the action.
* @text should contain a user visible string detailing the current action. * @text should contain a user visible string detailing the current action.
* *
* Returns: (transfer full): The new qos message. * Returns: (transfer full) (nullable): The new qos message.
*/ */
GstMessage * GstMessage *
gst_message_new_progress (GstObject * src, GstProgressType type, gst_message_new_progress (GstObject * src, GstProgressType type,
@ -2911,7 +2912,7 @@ gst_message_streams_selected_add (GstMessage * msg, GstStream * stream)
* *
* Retrieves the #GstStream with index @index from the @message. * Retrieves the #GstStream with index @index from the @message.
* *
* Returns: (transfer full): A #GstStream * Returns: (transfer full) (nullable): A #GstStream
* *
* Since: 1.10 * Since: 1.10
*/ */

3
gst/gstmeta.c
View file

@ -158,7 +158,8 @@ gst_meta_api_type_get_tags (GType api)
* The same @info can be retrieved later with gst_meta_get_info() by using * The same @info can be retrieved later with gst_meta_get_info() by using
* @impl as the key. * @impl as the key.
* *
* Returns: (transfer none): a #GstMetaInfo that can be used to access metadata. * Returns: (transfer none) (nullable): a #GstMetaInfo that can be used to
* access metadata.
*/ */
const GstMetaInfo * const GstMetaInfo *

5
gst/gstminiobject.c
View file

@ -132,7 +132,8 @@ gst_mini_object_init (GstMiniObject * mini_object, guint flags, GType type,
* *
* MT safe * MT safe
* *
* Returns: (transfer full): the new mini-object. * Returns: (transfer full) (nullable): the new mini-object if copying is
* possible, %NULL otherwise.
*/ */
GstMiniObject * GstMiniObject *
gst_mini_object_copy (const GstMiniObject * mini_object) gst_mini_object_copy (const GstMiniObject * mini_object)
@ -521,7 +522,7 @@ gst_mini_object_replace (GstMiniObject ** olddata, GstMiniObject * newdata)
* Replace the current #GstMiniObject pointer to by @olddata with %NULL and * Replace the current #GstMiniObject pointer to by @olddata with %NULL and
* return the old value. * return the old value.
* *
* Returns: the #GstMiniObject at @oldata * Returns: (nullable): the #GstMiniObject at @oldata
*/ */
GstMiniObject * GstMiniObject *
gst_mini_object_steal (GstMiniObject ** olddata) gst_mini_object_steal (GstMiniObject ** olddata)

12
gst/gstpad.c
View file

@ -2759,7 +2759,7 @@ gst_pad_get_pad_template_caps (GstPad * pad)
* Gets the peer of @pad. This function refs the peer pad so * Gets the peer of @pad. This function refs the peer pad so
* you need to unref it after use. * you need to unref it after use.
* *
* Returns: (transfer full): the peer #GstPad. Unref after usage. * Returns: (transfer full) (nullable): the peer #GstPad. Unref after usage.
* *
* MT safe. * MT safe.
*/ */
@ -5905,7 +5905,7 @@ gst_pad_set_element_private (GstPad * pad, gpointer priv)
* Gets the private data of a pad. * Gets the private data of a pad.
* No locking is performed in this function. * No locking is performed in this function.
* *
* Returns: (transfer none): a #gpointer to the private data. * Returns: (transfer none) (nullable): a #gpointer to the private data.
*/ */
gpointer gpointer
gst_pad_get_element_private (GstPad * pad) gst_pad_get_element_private (GstPad * pad)
@ -6271,7 +6271,7 @@ join_failed:
* gst_pad_probe_info_get_event: * gst_pad_probe_info_get_event:
* @info: a #GstPadProbeInfo * @info: a #GstPadProbeInfo
* *
* Returns: (transfer none): The #GstEvent from the probe * Returns: (transfer none) (nullable): The #GstEvent from the probe
*/ */
GstEvent * GstEvent *
@ -6288,7 +6288,7 @@ gst_pad_probe_info_get_event (GstPadProbeInfo * info)
* gst_pad_probe_info_get_query: * gst_pad_probe_info_get_query:
* @info: a #GstPadProbeInfo * @info: a #GstPadProbeInfo
* *
* Returns: (transfer none): The #GstQuery from the probe * Returns: (transfer none) (nullable): The #GstQuery from the probe
*/ */
GstQuery * GstQuery *
@ -6304,7 +6304,7 @@ gst_pad_probe_info_get_query (GstPadProbeInfo * info)
* gst_pad_probe_info_get_buffer: * gst_pad_probe_info_get_buffer:
* @info: a #GstPadProbeInfo * @info: a #GstPadProbeInfo
* *
* Returns: (transfer none): The #GstBuffer from the probe * Returns: (transfer none) (nullable): The #GstBuffer from the probe
*/ */
GstBuffer * GstBuffer *
@ -6319,7 +6319,7 @@ gst_pad_probe_info_get_buffer (GstPadProbeInfo * info)
* gst_pad_probe_info_get_buffer_list: * gst_pad_probe_info_get_buffer_list:
* @info: a #GstPadProbeInfo * @info: a #GstPadProbeInfo
* *
* Returns: (transfer none): The #GstBufferList from the probe * Returns: (transfer none) (nullable): The #GstBufferList from the probe
*/ */
GstBufferList * GstBufferList *

4
gst/gstpadtemplate.c
View file

@ -299,7 +299,7 @@ G_DEFINE_POINTER_TYPE (GstStaticPadTemplate, gst_static_pad_template);
* *
* Converts a #GstStaticPadTemplate into a #GstPadTemplate. * Converts a #GstStaticPadTemplate into a #GstPadTemplate.
* *
* Returns: (transfer floating): a new #GstPadTemplate. * Returns: (transfer floating) (nullable): a new #GstPadTemplate.
*/ */
/* FIXME0.11: rename to gst_pad_template_new_from_static_pad_template() */ /* FIXME0.11: rename to gst_pad_template_new_from_static_pad_template() */
GstPadTemplate * GstPadTemplate *
@ -369,7 +369,7 @@ gst_pad_template_new_from_static_pad_template_with_gtype (GstStaticPadTemplate *
* Creates a new pad template with a name according to the given template * Creates a new pad template with a name according to the given template
* and with the given arguments. * and with the given arguments.
* *
* Returns: (transfer floating): a new #GstPadTemplate. * Returns: (transfer floating) (nullable): a new #GstPadTemplate.
*/ */
GstPadTemplate * GstPadTemplate *
gst_pad_template_new (const gchar * name_template, gst_pad_template_new (const gchar * name_template,

2
gst/gstparamspecs.c
View file

@ -164,7 +164,7 @@ gst_param_spec_fraction_get_type (void)
* used in connection with g_object_class_install_property() in a GObjects's * used in connection with g_object_class_install_property() in a GObjects's
* instance_init function. * instance_init function.
* *
* Returns: (transfer full): a newly created parameter specification * Returns: (transfer full) (nullable): a newly created parameter specification
*/ */
GParamSpec * GParamSpec *
gst_param_spec_fraction (const gchar * name, const gchar * nick, gst_param_spec_fraction (const gchar * name, const gchar * nick,

37
gst/gstparse.c
View file

@ -75,8 +75,8 @@ gst_parse_error_quark (void)
* *
* Free-function: gst_parse_context_free * Free-function: gst_parse_context_free
* *
* Returns: (transfer full): a newly-allocated parse context. Free with * Returns: (transfer full) (nullable): a newly-allocated parse context. Free
* gst_parse_context_free() when no longer needed. * with gst_parse_context_free() when no longer needed.
*/ */
GstParseContext * GstParseContext *
gst_parse_context_new (void) gst_parse_context_new (void)
@ -99,7 +99,7 @@ gst_parse_context_new (void)
* *
* Copies the @context. * Copies the @context.
* *
* Returns: (transfer full): A copied #GstParseContext * Returns: (transfer full) (nullable): A copied #GstParseContext
*/ */
GstParseContext * GstParseContext *
gst_parse_context_copy (const GstParseContext * context) gst_parse_context_copy (const GstParseContext * context)
@ -147,7 +147,7 @@ gst_parse_context_free (GstParseContext * context)
* or gst_parse_launchv_full(). Will only return results if an error code * or gst_parse_launchv_full(). Will only return results if an error code
* of %GST_PARSE_ERROR_NO_SUCH_ELEMENT was returned. * of %GST_PARSE_ERROR_NO_SUCH_ELEMENT was returned.
* *
* Returns: (transfer full) (array zero-terminated=1) (element-type gchar*): a * Returns: (transfer full) (array zero-terminated=1) (element-type gchar*) (nullable): a
* %NULL-terminated array of element factory name strings of missing * %NULL-terminated array of element factory name strings of missing
* elements. Free with g_strfreev() when no longer needed. * elements. Free with g_strfreev() when no longer needed.
*/ */
@ -216,7 +216,8 @@ _gst_parse_escape (const gchar * str)
* @error will contain an error message if an erroneous pipeline is specified. * @error will contain an error message if an erroneous pipeline is specified.
* An error does not mean that the pipeline could not be constructed. * An error does not mean that the pipeline could not be constructed.
* *
* Returns: (transfer floating): a new element on success and %NULL on failure. * Returns: (transfer floating) (nullable): a new element on success and %NULL
* on failure.
*/ */
GstElement * GstElement *
gst_parse_launchv (const gchar ** argv, GError ** error) gst_parse_launchv (const gchar ** argv, GError ** error)
@ -236,10 +237,11 @@ gst_parse_launchv (const gchar ** argv, GError ** error)
* @error will contain an error message if an erroneous pipeline is specified. * @error will contain an error message if an erroneous pipeline is specified.
* An error does not mean that the pipeline could not be constructed. * An error does not mean that the pipeline could not be constructed.
* *
* Returns: (transfer floating): a new element on success; on failure, either %NULL * Returns: (transfer floating) (nullable): a new element on success; on
* or a partially-constructed bin or element will be returned and @error will * failure, either %NULL or a partially-constructed bin or element will be
* be set (unless you passed #GST_PARSE_FLAG_FATAL_ERRORS in @flags, then * returned and @error will be set (unless you passed
* %NULL will always be returned on failure) * #GST_PARSE_FLAG_FATAL_ERRORS in @flags, then %NULL will always be returned
* on failure)
*/ */
GstElement * GstElement *
gst_parse_launchv_full (const gchar ** argv, GstParseContext * context, gst_parse_launchv_full (const gchar ** argv, GstParseContext * context,
@ -289,9 +291,10 @@ gst_parse_launchv_full (const gchar ** argv, GstParseContext * context,
* the @error is set. In this case there was a recoverable parsing error and you * the @error is set. In this case there was a recoverable parsing error and you
* can try to play the pipeline. * can try to play the pipeline.
* *
* Returns: (transfer floating): a new element on success, %NULL on failure. If * Returns: (transfer floating) (nullable): a new element on success, %NULL on
* more than one toplevel element is specified by the @pipeline_description, * failure. If more than one toplevel element is specified by the
* all elements are put into a #GstPipeline, which than is returned. * @pipeline_description, all elements are put into a #GstPipeline, which
* than is returned.
*/ */
GstElement * GstElement *
gst_parse_launch (const gchar * pipeline_description, GError ** error) gst_parse_launch (const gchar * pipeline_description, GError ** error)
@ -313,11 +316,11 @@ gst_parse_launch (const gchar * pipeline_description, GError ** error)
* the @error is set. In this case there was a recoverable parsing error and you * the @error is set. In this case there was a recoverable parsing error and you
* can try to play the pipeline. * can try to play the pipeline.
* *
* Returns: (transfer floating): a new element on success, %NULL on failure. If * Returns: (transfer floating) (nullable): a new element on success, %NULL on
* more than one toplevel element is specified by the @pipeline_description, * failure. If more than one toplevel element is specified by the
* all elements are put into a #GstPipeline, which then is returned (unless * @pipeline_description, all elements are put into a #GstPipeline, which
* the GST_PARSE_FLAG_PLACE_IN_BIN flag is set, in which case they are put * then is returned (unless the GST_PARSE_FLAG_PLACE_IN_BIN flag is set, in
* in a #GstBin instead). * which case they are put in a #GstBin instead).
*/ */
GstElement * GstElement *
gst_parse_launch_full (const gchar * pipeline_description, gst_parse_launch_full (const gchar * pipeline_description,

6
gst/gstplugin.c
View file

@ -1309,7 +1309,8 @@ gst_plugin_find_feature_by_name (GstPlugin * plugin, const gchar * name)
* *
* Load the named plugin. Refs the plugin. * Load the named plugin. Refs the plugin.
* *
* Returns: (transfer full): a reference to a loaded plugin, or %NULL on error. * Returns: (transfer full) (nullable): a reference to a loaded plugin, or
* %NULL on error.
*/ */
GstPlugin * GstPlugin *
gst_plugin_load_by_name (const gchar * name) gst_plugin_load_by_name (const gchar * name)
@ -1352,7 +1353,8 @@ gst_plugin_load_by_name (const gchar * name)
* plugin = loaded_plugin; * plugin = loaded_plugin;
* ]| * ]|
* *
* Returns: (transfer full): a reference to a loaded plugin, or %NULL on error. * Returns: (transfer full) (nullable): a reference to a loaded plugin, or
* %NULL on error.
*/ */
GstPlugin * GstPlugin *
gst_plugin_load (GstPlugin * plugin) gst_plugin_load (GstPlugin * plugin)

13
gst/gstprotection.c
View file

@ -166,9 +166,10 @@ gst_buffer_add_protection_meta (GstBuffer * buffer, GstStructure * info)
* an element that supports one of the supplied UUIDs. If more than one * an element that supports one of the supplied UUIDs. If more than one
* element matches, the system ID of the highest ranked element is selected. * element matches, the system ID of the highest ranked element is selected.
* *
* Returns: (transfer none): One of the strings from @system_identifiers that * Returns: (transfer none) (nullable): One of the strings from
* indicates the highest ranked element that implements the protection system * @system_identifiers that indicates the highest ranked element that
* indicated by that system ID, or %NULL if no element has been found. * implements the protection system indicated by that system ID, or %NULL if no
* element has been found.
* *
* Since: 1.6 * Since: 1.6
*/ */
@ -202,9 +203,9 @@ gst_protection_select_system (const gchar ** system_identifiers)
* Iterates the supplied list of UUIDs and checks the GstRegistry for * Iterates the supplied list of UUIDs and checks the GstRegistry for
* all the decryptors supporting one of the supplied UUIDs. * all the decryptors supporting one of the supplied UUIDs.
* *
* Returns: (transfer full): A null terminated array containing all the * Returns: (transfer full) (nullable): A null terminated array containing all
* @system_identifiers supported by the set of available decryptors, or %NULL * the @system_identifiers supported by the set of available decryptors, or
* if no matches were found. * %NULL if no matches were found.
* *
* Since: 1.14 * Since: 1.14
*/ */

2
gst/gstquery.c
View file

@ -663,7 +663,7 @@ gst_query_parse_segment (GstQuery * query, gdouble * rate, GstFormat * format,
* *
* Free-function: gst_query_unref() * Free-function: gst_query_unref()
* *
* Returns: (transfer full): a new #GstQuery * Returns: (transfer full) (nullable): a new #GstQuery
*/ */
GstQuery * GstQuery *
gst_query_new_custom (GstQueryType type, GstStructure * structure) gst_query_new_custom (GstQueryType type, GstStructure * structure)

2
gst/gstsample.c
View file

@ -207,7 +207,7 @@ gst_sample_get_segment (GstSample * sample)
* *
* Get extra information associated with @sample. * Get extra information associated with @sample.
* *
* Returns: (transfer none): the extra info of @sample. * Returns: (transfer none) (nullable): the extra info of @sample.
* The info remains valid as long as @sample is valid. * The info remains valid as long as @sample is valid.
*/ */
const GstStructure * const GstStructure *

2
gst/gststreamcollection.c
View file

@ -342,7 +342,7 @@ gst_stream_collection_get_size (GstStreamCollection * collection)
* *
* The caller should not modify the returned #GstStream * The caller should not modify the returned #GstStream
* *
* Returns: (transfer none): A #GstStream * Returns: (transfer none) (nullable): A #GstStream
* *
* Since: 1.10 * Since: 1.10
*/ */

2
gst/gststreams.c
View file

@ -525,7 +525,7 @@ gst_stream_get_property (GObject * object, guint prop_id,
* *
* Get a descriptive string for a given #GstStreamType * Get a descriptive string for a given #GstStreamType
* *
* Returns: A string describing the stream type * Returns: (nullable): A string describing the stream type
* *
* Since: 1.10 * Since: 1.10
*/ */

9
gst/gststructure.c
View file

@ -879,7 +879,8 @@ gst_structure_get_field (const GstStructure * structure,
* *
* Get the value of the field with name @fieldname. * Get the value of the field with name @fieldname.
* *
* Returns: the #GValue corresponding to the field with the given name. * Returns: (nullable): the #GValue corresponding to the field with the given
* name.
*/ */
const GValue * const GValue *
gst_structure_get_value (const GstStructure * structure, gst_structure_get_value (const GstStructure * structure,
@ -904,8 +905,8 @@ gst_structure_get_value (const GstStructure * structure,
* *
* Get the value of the field with GQuark @field. * Get the value of the field with GQuark @field.
* *
* Returns: the #GValue corresponding to the field with the given name * Returns: (nullable): the #GValue corresponding to the field with the given
* identifier. * name identifier.
*/ */
const GValue * const GValue *
gst_structure_id_get_value (const GstStructure * structure, GQuark field) gst_structure_id_get_value (const GstStructure * structure, GQuark field)
@ -2848,7 +2849,7 @@ gst_structure_intersect_field2 (GQuark id, const GValue * val1, gpointer data)
* *
* Intersects @struct1 and @struct2 and returns the intersection. * Intersects @struct1 and @struct2 and returns the intersection.
* *
* Returns: Intersection of @struct1 and @struct2 * Returns: (nullable): Intersection of @struct1 and @struct2
*/ */
GstStructure * GstStructure *
gst_structure_intersect (const GstStructure * struct1, gst_structure_intersect (const GstStructure * struct1,

4
gst/gsttaglist.c
View file

@ -604,7 +604,7 @@ gst_tag_get_type (const gchar * tag)
* Returns the human-readable name of this tag, You must not change or free * Returns the human-readable name of this tag, You must not change or free
* this string. * this string.
* *
* Returns: the human-readable name of this tag * Returns: (nullable): the human-readable name of this tag
*/ */
const gchar * const gchar *
gst_tag_get_nick (const gchar * tag) gst_tag_get_nick (const gchar * tag)
@ -629,7 +629,7 @@ gst_tag_get_nick (const gchar * tag)
* Returns the human-readable description of this tag, You must not change or * Returns the human-readable description of this tag, You must not change or
* free this string. * free this string.
* *
* Returns: the human-readable description of this tag * Returns: (nullable): the human-readable description of this tag
*/ */
const gchar * const gchar *
gst_tag_get_description (const gchar * tag) gst_tag_get_description (const gchar * tag)

2
gst/gsttoc.c
View file

@ -777,7 +777,7 @@ gst_toc_entry_get_toc (GstTocEntry * entry)
* *
* Gets the parent #GstTocEntry of @entry. * Gets the parent #GstTocEntry of @entry.
* *
* Returns: (transfer none): The parent #GstTocEntry of @entry * Returns: (transfer none) (nullable): The parent #GstTocEntry of @entry
*/ */
GstTocEntry * GstTocEntry *
gst_toc_entry_get_parent (GstTocEntry * entry) gst_toc_entry_get_parent (GstTocEntry * entry)

45
gst/gsturi.c
View file

@ -397,7 +397,7 @@ gst_uri_is_valid (const gchar * uri)
* Extracts the protocol out of a given valid URI. The returned string must be * Extracts the protocol out of a given valid URI. The returned string must be
* freed using g_free(). * freed using g_free().
* *
* Returns: The protocol for this URI. * Returns: (nullable): The protocol for this URI.
*/ */
gchar * gchar *
gst_uri_get_protocol (const gchar * uri) gst_uri_get_protocol (const gchar * uri)
@ -449,9 +449,9 @@ gst_uri_has_protocol (const gchar * uri, const gchar * protocol)
* *
* Free-function: g_free * Free-function: g_free
* *
* Returns: (transfer full): the location for this URI. Returns %NULL if the * Returns: (transfer full) (nullable): the location for this URI. Returns
* URI isn't valid. If the URI does not contain a location, an empty * %NULL if the URI isn't valid. If the URI does not contain a location, an
* string is returned. * empty string is returned.
*/ */
gchar * gchar *
gst_uri_get_location (const gchar * uri) gst_uri_get_location (const gchar * uri)
@ -616,7 +616,8 @@ gst_uri_protocol_is_supported (const GstURIType type, const gchar * protocol)
* *
* Creates an element for handling the given URI. * Creates an element for handling the given URI.
* *
* Returns: (transfer floating): a new element or %NULL if none could be created * Returns: (transfer floating) (nullable): a new element or %NULL if none
* could be created
*/ */
GstElement * GstElement *
gst_element_make_from_uri (const GstURIType type, const gchar * uri, gst_element_make_from_uri (const GstURIType type, const gchar * uri,
@ -1767,8 +1768,8 @@ gst_uri_equal (const GstUri * first, const GstUri * second)
* If either URI is %NULL then the other URI will be returned with the ref count * If either URI is %NULL then the other URI will be returned with the ref count
* increased. * increased.
* *
* Returns: (transfer full): A #GstUri which represents the base with the * Returns: (transfer full) (nullable): A #GstUri which represents the base
* reference URI joined on. * with the reference URI joined on.
* *
* Since: 1.6 * Since: 1.6
*/ */
@ -2076,7 +2077,7 @@ gst_uri_normalize (GstUri * uri)
* Get the scheme name from the URI or %NULL if it doesn't exist. * Get the scheme name from the URI or %NULL if it doesn't exist.
* If @uri is %NULL then returns %NULL. * If @uri is %NULL then returns %NULL.
* *
* Returns: The scheme from the #GstUri object or %NULL. * Returns: (nullable): The scheme from the #GstUri object or %NULL.
*/ */
const gchar * const gchar *
gst_uri_get_scheme (const GstUri * uri) gst_uri_get_scheme (const GstUri * uri)
@ -2116,7 +2117,7 @@ gst_uri_set_scheme (GstUri * uri, const gchar * scheme)
* Get the userinfo (usually in the form "username:password") from the URI * Get the userinfo (usually in the form "username:password") from the URI
* or %NULL if it doesn't exist. If @uri is %NULL then returns %NULL. * or %NULL if it doesn't exist. If @uri is %NULL then returns %NULL.
* *
* Returns: The userinfo from the #GstUri object or %NULL. * Returns: (nullable): The userinfo from the #GstUri object or %NULL.
* *
* Since: 1.6 * Since: 1.6
*/ */
@ -2158,7 +2159,7 @@ gst_uri_set_userinfo (GstUri * uri, const gchar * userinfo)
* Get the host name from the URI or %NULL if it doesn't exist. * Get the host name from the URI or %NULL if it doesn't exist.
* If @uri is %NULL then returns %NULL. * If @uri is %NULL then returns %NULL.
* *
* Returns: The host name from the #GstUri object or %NULL. * Returns: (nullable): The host name from the #GstUri object or %NULL.
* *
* Since: 1.6 * Since: 1.6
*/ */
@ -2240,8 +2241,8 @@ gst_uri_set_port (GstUri * uri, guint port)
* *
* Extract the path string from the URI object. * Extract the path string from the URI object.
* *
* Returns: (transfer full): The path from the URI. Once finished with the * Returns: (transfer full): (nullable): The path from the URI. Once finished
* string should be g_free()'d. * with the string should be g_free()'d.
* *
* Since: 1.6 * Since: 1.6
*/ */
@ -2303,8 +2304,8 @@ gst_uri_set_path (GstUri * uri, const gchar * path)
* *
* Extract the path string from the URI object as a percent encoded URI path. * Extract the path string from the URI object as a percent encoded URI path.
* *
* Returns: (transfer full): The path from the URI. Once finished with the * Returns: (transfer full) (nullable): The path from the URI. Once finished
* string should be g_free()'d. * with the string should be g_free()'d.
* *
* Since: 1.6 * Since: 1.6
*/ */
@ -2490,8 +2491,8 @@ gst_uri_append_path_segment (GstUri * uri, const gchar * path_segment)
* *
* Get a percent encoded URI query string from the @uri. * Get a percent encoded URI query string from the @uri.
* *
* Returns: (transfer full): A percent encoded query string. Use g_free() when * Returns: (transfer full) (nullable): A percent encoded query string. Use
* no longer needed. * g_free() when no longer needed.
* *
* Since: 1.6 * Since: 1.6
*/ */
@ -2566,8 +2567,8 @@ gst_uri_set_query_string (GstUri * uri, const gchar * query)
* no longer required. Modifying this hash table will modify the query in the * no longer required. Modifying this hash table will modify the query in the
* URI. * URI.
* *
* Returns: (transfer full)(element-type gchar* gchar*): The query hash table * Returns: (transfer full) (element-type gchar* gchar*) (nullable): The query
* from the URI. * hash table from the URI.
* *
* Since: 1.6 * Since: 1.6
*/ */
@ -2714,7 +2715,7 @@ gst_uri_query_has_key (const GstUri * uri, const gchar * query_key)
* use gst_uri_query_has_key() to determine if a key is present in the URI * use gst_uri_query_has_key() to determine if a key is present in the URI
* query. * query.
* *
* Returns: The value for the given key, or %NULL if not found. * Returns: (nullable): The value for the given key, or %NULL if not found.
* *
* Since: 1.6 * Since: 1.6
*/ */
@ -2760,7 +2761,7 @@ gst_uri_get_query_keys (const GstUri * uri)
* Get the fragment name from the URI or %NULL if it doesn't exist. * Get the fragment name from the URI or %NULL if it doesn't exist.
* If @uri is %NULL then returns %NULL. * If @uri is %NULL then returns %NULL.
* *
* Returns: The host name from the #GstUri object or %NULL. * Returns: (nullable): The host name from the #GstUri object or %NULL.
* *
* Since: 1.6 * Since: 1.6
*/ */
@ -2811,8 +2812,8 @@ gst_uri_set_fragment (GstUri * uri, const gchar * fragment)
* *
* See more about Media Fragments URI 1.0 (W3C) at https://www.w3.org/TR/media-frags/ * See more about Media Fragments URI 1.0 (W3C) at https://www.w3.org/TR/media-frags/
* *
* Returns: (transfer full)(element-type gchar* gchar*): The fragment hash table * Returns: (transfer full) (element-type gchar* gchar*) (nullable): The
* from the URI. * fragment hash table from the URI.
* *
* Since: 1.12 * Since: 1.12
*/ */

2
gst/gstutils.c
View file

@ -3375,7 +3375,7 @@ gst_parse_bin_from_description (const gchar * bin_description,
* and want them all ghosted, you will have to create the ghost pads * and want them all ghosted, you will have to create the ghost pads
* yourself). * yourself).
* *
* Returns: (transfer floating) (type Gst.Element): a newly-created * Returns: (transfer floating) (type Gst.Element) (nullable): a newly-created
* element, which is guaranteed to be a bin unless * element, which is guaranteed to be a bin unless
* GST_FLAG_NO_SINGLE_ELEMENT_BINS was passed, or %NULL if an error * GST_FLAG_NO_SINGLE_ELEMENT_BINS was passed, or %NULL if an error
* occurred. * occurred.

4
gst/gstvalue.c
View file

@ -1939,7 +1939,7 @@ gst_value_set_fraction_range_full (GValue * value,
* *
* Gets the minimum of the range specified by @value. * Gets the minimum of the range specified by @value.
* *
* Returns: the minimum of the range * Returns: (nullable): the minimum of the range
*/ */
const GValue * const GValue *
gst_value_get_fraction_range_min (const GValue * value) gst_value_get_fraction_range_min (const GValue * value)
@ -1962,7 +1962,7 @@ gst_value_get_fraction_range_min (const GValue * value)
* *
* Gets the maximum of the range specified by @value. * Gets the maximum of the range specified by @value.
* *
* Returns: the maximum of the range * Returns: (nullable): the maximum of the range
*/ */
const GValue * const GValue *
gst_value_get_fraction_range_max (const GValue * value) gst_value_get_fraction_range_max (const GValue * value)