introspection: Assorted minor introspection and documentation fixes

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

diff --git a/gst/gstbufferpool.c b/gst/gstbufferpool.c
index 92f6648..6509225 100644 (file)
--- a/gst/gstbufferpool.c
+++ b/gst/gstbufferpool.c
@@ -1294,7 +1294,7 @@ gst_buffer_pool_release_buffer (GstBufferPool * pool, GstBuffer * buffer)
  * @pool: a #GstBufferPool
  * @flushing: whether to start or stop flushing
  *
- * Enabled or disable the flushing state of a @pool without freeing or
+ * Enable or disable the flushing state of a @pool without freeing or
  * allocating buffers.
  *
  * Since: 1.4

diff --git a/gst/gstdevice.c b/gst/gstdevice.c
index 08404bb..1237dca 100644 (file)
--- a/gst/gstdevice.c
+++ b/gst/gstdevice.c
@@ -295,7 +295,7 @@ gst_device_reconfigure_element (GstDevice * device, GstElement * element)
 /**
  * gst_device_has_classesv:
  * @device: a #GstDevice
- * @classes: (array zero-terminated=1): a %NULL terminated array of klasses to match, only match if all
+ * @classes: (array zero-terminated=1): a %NULL terminated array of classes to match, only match if all
  *   classes are matched
  *
  * Check if @factory matches all of the given classes

diff --git a/gst/gstdevicemonitor.c b/gst/gstdevicemonitor.c
index d6b7f25..458c43b 100644 (file)
--- a/gst/gstdevicemonitor.c
+++ b/gst/gstdevicemonitor.c
@@ -422,7 +422,7 @@ gst_device_monitor_stop (GstDeviceMonitor * monitor)
 /**
  * gst_device_monitor_add_filter:
  * @monitor: a device monitor
- * @classes: device classes to use as filter or %NULL for any class
+ * @classes: (allow-none): device classes to use as filter or %NULL for any class
  * @caps: (allow-none): the #GstCaps to filter or %NULL for ANY
  *
  * Adds a filter for which #GstDevice will be monitored, any device that matches

diff --git a/gst/gstdeviceprovider.c b/gst/gstdeviceprovider.c
index ea91200..963a683 100644 (file)
--- a/gst/gstdeviceprovider.c
+++ b/gst/gstdeviceprovider.c
@@ -181,6 +181,8 @@ gst_device_provider_finalize (GObject * object)
  * @value: the value to set
  *
  * Set @key with @value as metadata in @klass.
+ *
+ * Since: 1.4
  */
 void
 gst_device_provider_class_add_metadata (GstDeviceProviderClass * klass,
@@ -198,7 +200,7 @@ gst_device_provider_class_add_metadata (GstDeviceProviderClass * klass,
  * gst_device_provider_class_add_static_metadata:
  * @klass: class to set metadata for
  * @key: the key to set
- * @value: the value to set
+ * @value: (transfer full): the value to set
  *
  * Set @key with @value as metadata in @klass.
  *
@@ -263,14 +265,15 @@ gst_device_provider_class_set_metadata (GstDeviceProviderClass * klass,
 /**
  * gst_device_provider_class_set_static_metadata:
  * @klass: class to set metadata for
- * @longname: The long English name of the element. E.g. "File Sink"
- * @classification: String describing the type of element, as an unordered list
- * separated with slashes ('/'). See draft-klass.txt of the design docs
- * for more details and common types. E.g: "Sink/File"
- * @description: Sentence describing the purpose of the element.
- * E.g: "Write stream to a file"
- * @author: Name and contact details of the author(s). Use \n to separate
- * multiple author metadata. E.g: "Joe Bloggs <joe.blogs at foo.com>"
+ * @longname: (transfer full): The long English name of the element. E.g. "File Sink"
+ * @classification: (transfer full): String describing the type of element, as
+ * an unordered list separated with slashes ('/'). See draft-klass.txt of the
+ * design docs for more details and common types. E.g: "Sink/File"
+ * @description: (transfer full): Sentence describing the purpose of the
+ * element.  E.g: "Write stream to a file"
+ * @author: (transfer full): Name and contact details of the author(s). Use \n
+ * to separate multiple author metadata. E.g: "Joe Bloggs <joe.blogs at
+ * foo.com>"
  *
  * Sets the detailed information for a #GstDeviceProviderClass.
  * <note>This function is for use in _class_init functions only.</note>

diff --git a/gst/gstdeviceproviderfactory.c b/gst/gstdeviceproviderfactory.c
index 3ea0703..3f38f06 100644 (file)
--- a/gst/gstdeviceproviderfactory.c
+++ b/gst/gstdeviceproviderfactory.c
@@ -388,8 +388,7 @@ create_failed:
  * only be retrieved if the device provider factory is loaded, which can be
  * assured with gst_plugin_feature_load().
  *
- * Returns: the #GType for device providers managed by this factory or 0 if
- * the factory is not loaded.
+ * Returns: the #GType for device providers managed by this factory.
  *
  * Since: 1.4
  */
@@ -397,7 +396,8 @@ GType
 gst_device_provider_factory_get_device_provider_type (GstDeviceProviderFactory *
     factory)
 {
-  g_return_val_if_fail (GST_IS_DEVICE_PROVIDER_FACTORY (factory), 0);
+  g_return_val_if_fail (GST_IS_DEVICE_PROVIDER_FACTORY (factory),
+      G_TYPE_INVALID);
 
   return factory->type;
 }
@@ -463,7 +463,7 @@ gst_device_provider_factory_get_metadata_keys (GstDeviceProviderFactory *
  * gst_device_provider_factory_has_classesv:
  * @factory: a #GstDeviceProviderFactory
  * @classes: (array zero-terminated=1) (allow-none): a %NULL terminated array
- *   of klasses to match, only match if all classes are matched
+ *   of classes to match, only match if all classes are matched
  *
  * Check if @factory matches all of the given classes
  *
@@ -513,7 +513,7 @@ gst_device_provider_factory_has_classesv (GstDeviceProviderFactory * factory,
 /**
  * gst_device_provider_factory_has_classes:
  * @factory: a #GstDeviceProviderFactory
- * @classes: (allow-none): a "/" separate list of klasses to match, only match
+ * @classes: (allow-none): a "/" separate list of classes to match, only match
  *     if all classes are matched
  *
  * Check if @factory matches all of the given @classes

diff --git a/gst/gstmessage.c b/gst/gstmessage.c
index f4b3ded..63950eb 100644 (file)
--- a/gst/gstmessage.c
+++ b/gst/gstmessage.c
@@ -2340,7 +2340,7 @@ gst_message_parse_have_context (GstMessage * message, GstContext ** context)
  * @device: (transfer none): The new #GstDevice
  *
  * Creates a new device-added message. The device-added message is produced by
- * #GstDeviceProvider or a #GstlDeviceMonitor. They announce the appearance
+ * #GstDeviceProvider or a #GstDeviceMonitor. They announce the appearance
  * of monitored devices.
  *
  * Returns: a newly allocated #GstMessage

diff --git a/gst/gstquery.c b/gst/gstquery.c
index 78a04fa..c35df63 100644 (file)
--- a/gst/gstquery.c
+++ b/gst/gstquery.c
@@ -1463,7 +1463,7 @@ gst_query_parse_uri_redirection (GstQuery * query, gchar ** uri)
 
 /**
  * gst_query_set_uri_redirection_permanent:
- * @query: a #GstQuery with query type GST_QUERY_URI
+ * @query: a #GstQuery with query type %GST_QUERY_URI
  * @permanent: whether the redirect is permanent or not
  *
  * Answer a URI query by setting the requested URI redirection

diff --git a/gst/gststructure.c b/gst/gststructure.c
index 91f3ab3..876862e 100644 (file)
--- a/gst/gststructure.c
+++ b/gst/gststructure.c
@@ -1368,14 +1368,14 @@ gst_structure_get_uint (const GstStructure * structure,
  * gst_structure_get_int64:
  * @structure: a #GstStructure
  * @fieldname: the name of a field
- * @value: (out): a pointer to an int64 to set
+ * @value: (out): a pointer to a #gint64 to set
  *
- * Sets the int64 pointed to by @value corresponding to the value of the
+ * Sets the #gint64 pointed to by @value corresponding to the value of the
  * given field. Caller is responsible for making sure the field exists
  * and has the correct type.
  *
  * Returns: %TRUE if the value could be set correctly. If there was no field
- * with @fieldname or the existing field did not contain an int64, this function
+ * with @fieldname or the existing field did not contain a #gint64, this function
  * returns %FALSE.
  *
  * Since: 1.4
@@ -1404,14 +1404,14 @@ gst_structure_get_int64 (const GstStructure * structure,
  * gst_structure_get_uint64:
  * @structure: a #GstStructure
  * @fieldname: the name of a field
- * @value: (out): a pointer to a uint64 to set
+ * @value: (out): a pointer to a #guint64 to set
  *
- * Sets the uint64 pointed to by @value corresponding to the value of the
+ * Sets the #guint64 pointed to by @value corresponding to the value of the
  * given field. Caller is responsible for making sure the field exists
  * and has the correct type.
  *
  * Returns: %TRUE if the value could be set correctly. If there was no field
- * with @fieldname or the existing field did not contain a uint64, this function
+ * with @fieldname or the existing field did not contain a #guint64, this function
  * returns %FALSE.
  *
  * Since: 1.4

diff --git a/gst/gstsystemclock.c b/gst/gstsystemclock.c
index 01beee7..dabce1d 100644 (file)
--- a/gst/gstsystemclock.c
+++ b/gst/gstsystemclock.c
@@ -284,7 +284,7 @@ gst_system_clock_get_property (GObject * object, guint prop_id, GValue * value,
  * @new_clock: a #GstClock
  *
  * Sets the default system clock that can be obtained with
- * gst_system_clock_obtain.
+ * gst_system_clock_obtain().
  *
  * This is mostly used for testing and debugging purposes when you
  * want to have control over the time reported by the default system

diff --git a/libs/gst/base/gstbasesrc.c b/libs/gst/base/gstbasesrc.c
index eb861a3..9c8a0c6 100644 (file)
--- a/libs/gst/base/gstbasesrc.c
+++ b/libs/gst/base/gstbasesrc.c
@@ -629,7 +629,7 @@ gst_base_src_set_dynamic_size (GstBaseSrc * src, gboolean dynamic)
  * @src: base source instance
  * @automatic_eos: automatic eos
  *
- * If @automatic_eos is %TRUE, basesrc will automatically go EOS if a buffer
+ * If @automatic_eos is %TRUE, @src will automatically go EOS if a buffer
  * after the total size is returned. By default this is %TRUE but sources
  * that can't return an authoritative size and only know that they're EOS
  * when trying to read more should set this to %FALSE.

diff --git a/libs/gst/base/gstcollectpads.c b/libs/gst/base/gstcollectpads.c
index bebaf12..992446b 100644 (file)
--- a/libs/gst/base/gstcollectpads.c
+++ b/libs/gst/base/gstcollectpads.c
@@ -1889,13 +1889,13 @@ forward_event_to_all_sinkpads (GstPad * srcpad, GstEvent * event)
 
 /**
  * gst_collect_pads_src_event_default:
- * @pads: the collectpads to use
+ * @pads: the #GstCollectPads to use
  * @pad: src #GstPad that received the event
  * @event: event being processed
  *
  * Default #GstCollectPads event handling for the src pad of elements.
  * Elements can chain up to this to let flushing seek event handling
- * be done by GstCollectPads.
+ * be done by #GstCollectPads.
  *
  * Since: 1.4
  */

diff --git a/libs/gst/check/gstcheck.c b/libs/gst/check/gstcheck.c
index 454ebb2..7589ce1 100644 (file)
--- a/libs/gst/check/gstcheck.c
+++ b/libs/gst/check/gstcheck.c
@@ -280,6 +280,8 @@ gst_check_setup_src_pad_by_name (GstElement * element,
  * @tmpl: pad template
  *
  * Returns: (transfer full): a new pad
+ *
+ * Since: 1.4
  */
 GstPad *
 gst_check_setup_src_pad_from_template (GstElement * element,
@@ -295,6 +297,8 @@ gst_check_setup_src_pad_from_template (GstElement * element,
  * @name: name
  *
  * Returns: (transfer full): a new pad
+ *
+ * Since: 1.4
  */
 GstPad *
 gst_check_setup_src_pad_by_name_from_template (GstElement * element,
@@ -403,6 +407,8 @@ gst_check_setup_sink_pad_by_name (GstElement * element,
  * @tmpl: pad template
  *
  * Returns: (transfer full): a new pad
+ *
+ * Since: 1.4
  */
 GstPad *
 gst_check_setup_sink_pad_from_template (GstElement * element,
@@ -418,6 +424,8 @@ gst_check_setup_sink_pad_from_template (GstElement * element,
  * @name: name
  *
  * Returns: (transfer full): a new pad
+ *
+ * Since: 1.4
  */
 GstPad *
 gst_check_setup_sink_pad_by_name_from_template (GstElement * element,

diff --git a/libs/gst/check/gsttestclock.c b/libs/gst/check/gsttestclock.c
index a609766..0981b0b 100644 (file)
--- a/libs/gst/check/gsttestclock.c
+++ b/libs/gst/check/gsttestclock.c
@@ -985,7 +985,7 @@ gst_test_clock_get_next_entry_time (GstTestClock * test_clock)
  * @count: the number of pending clock notifications to wait for
  * @pending_list: (out) (element-type Gst.ClockID) (transfer full) (allow-none): Address
  *     of a #GList pointer variable to store the list of pending #GstClockIDs
- *     that expired, or NULL
+ *     that expired, or %NULL
  *
  * Blocks until at least @count clock notifications have been requested from
  * @test_clock. There is no timeout for this wait, see the main description of