[Bug 732534] New: Introspection and documentation issues for new 1.4 symbols

[GStreamer (bugzilla.gnome.org)]

https://bugzilla.gnome.org/show_bug.cgi?id=732534
  GStreamer | gstreamer (core) | unspecified

           Summary: Introspection and documentation issues for new 1.4
                    symbols
    Classification: Platform
           Product: GStreamer
           Version: unspecified
        OS/Version: Linux
            Status: UNCONFIRMED
          Severity: normal
          Priority: Normal
         Component: gstreamer (core)
        AssignedTo: gstreamer-bugs at lists.freedesktop.org
        ReportedBy: evan at coeus-group.com
         QAContact: gstreamer-bugs at lists.freedesktop.org
     GNOME version: ---


Created an attachment (id=279645)
 View: https://bugzilla.gnome.org/attachment.cgi?id=279645
 Review: https://bugzilla.gnome.org/review?bug=732534&attachment=279645

Assorted minor introspection and documentation fixes.

I'm going to go through the new API added for 1.4, mainly looking for issues
which could present issues for languages other than C, especially the
annotations and documentation.



gst_device_provider_factory_get_device_provider_type:

Documents the return value of g_return_val_if_fail, which "should be considered
to have undefined behaviour (a programmer error). The only correct solution to
such an error is to change the module that is calling the current function, so
that it avoids this incorrect call."
(https://developer.gnome.org/glib/stable/glib-Warnings-and-Assertions.html#g-return-val-if-fail).

Furthermore, the value in question is 0, instead of G_TYPE_INVALID (could
present issues for non-C langauges for which GType is not treated as an integer
type).  If factory->type could be invalid then this should be changed to
G_TYPE_INVALID (actually, I think it should be changed regardless).  Otherwise,
the mention of the return value possibly being 0 should be removed from the
documentation.

For this patch, I assumed factory->type will never be G_TYPE_INVALID.



gst_device_provider_factory_has_classesv,
gst_device_provider_factory_has_classes,
gst_device_has_classesv:

s/klasses/classes/ in the documentation of the classes argument.



gst_message_new_device_added:

s/GstlDeviceManager/GstDeviceManager/ (note the "l" between "Gst" and
"DeviceManager").



gst_structure_get_{int64,uint64}:

It would probably be better to use the right type name in the description
("#gint64" instead of "int64", "#guint64" instead of "int64").



gst_buffer_pool_set_flushing:

s/Enabled/Enable/



gst_device_provider_class_add_metadata:

Missing Since: 1.4



gst_device_provider_class_add_static_metadata:

@value should be (transfer full)



gst_device_provider_class_set_static_metadata:

@longname, @classification, @description, and @author should be (transfer full)



gst_device_monitor_add_filter:

@classes should be (allow-none)



gst_query_set_uri_redirection_permanent:

s/GST_QUERY_URI/%GST_QUERY_URI/ in @query



gst_system_clock_set_default:

s/gst_system_clock_obtain/gst_system_clock_obtain()/



gst_base_src_set_automatic_eos:

s/basesrc/@src/



gst_collect_pads_src_event_default:

s/collectpads/#GstCollectPads/, s/GstCollectPads/#GstCollectPads/



gst_test_clock_wait_for_multiple_pending_ids:

s/NULL/%NULL/



gst_check_setup_src_pad_from_template,
gst_check_setup_src_pad_by_name_from_template,
gst_check_setup_sink_pad_from_template,
gst_check_setup_sink_pad_by_name_from_template:

Missing "Since: 1.4"






Not addressed by this patch:


gst_collect_pads_set_flush_function:

No destroy notify.  If the callback is invoked exactly once it should be marked
as (scope async).  Otherwise, it needs a GDestroyNotify, or it's not
introspectable.

-- 
Configure bugmail: https://bugzilla.gnome.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the QA contact for the bug.
You are the assignee for the bug.