docs: Fix documentation typos and inconsistencies

 * GstGlobalDeviceMonitor was renamed to GstDeviceMonitor
 * Expand GST_MESSAGE_DEVICE to the full enum value names
 * Correct the incorrect references to the GstDeviceProvider interfaces
 * Describe caps arguments for gstcheck interface
 * Add missing docs for GstNetAddressMeta and its add function
 * Add docs for toc helper macros
 * Avoid refering to GstValueList type as done elsewhere

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

diff --git a/docs/libs/gstreamer-libs-docs.sgml b/docs/libs/gstreamer-libs-docs.sgml
index ce87695..0070771 100644 (file)
--- a/docs/libs/gstreamer-libs-docs.sgml
+++ b/docs/libs/gstreamer-libs-docs.sgml
@@ -72,6 +72,7 @@
         libgstnet-&GST_API_VERSION;.so provides network elements and objects.
       </para>
 
+      <xi:include href="xml/gstnetaddressmeta.xml" />
       <xi:include href="xml/gstnetclientclock.xml" />
       <xi:include href="xml/gstnettimepacket.xml" />
       <xi:include href="xml/gstnettimeprovider.xml" />

diff --git a/docs/libs/gstreamer-libs-sections.txt b/docs/libs/gstreamer-libs-sections.txt
index 2fb0701..83b19db 100644 (file)
--- a/docs/libs/gstreamer-libs-sections.txt
+++ b/docs/libs/gstreamer-libs-sections.txt
@@ -978,6 +978,10 @@ gst_check_element_push_buffer
 gst_check_run_suite
 gst_check_setup_events
 gst_check_setup_events_with_stream_id
+gst_check_setup_sink_pad_by_name_from_template
+gst_check_setup_sink_pad_from_template
+gst_check_setup_src_pad_by_name_from_template
+gst_check_setup_src_pad_from_template
 
 <SUBSECTION Private>
 MAIN_INIT

diff --git a/gst/gstcaps.h b/gst/gstcaps.h
index 2acf84c..4b09b8e 100644 (file)
--- a/gst/gstcaps.h
+++ b/gst/gstcaps.h
@@ -291,14 +291,14 @@ gst_caps_copy (const GstCaps * caps)
  * @old_caps: (inout) (transfer full) (nullable): pointer to a pointer
  *     to a #GstCaps to be replaced.
  * @new_caps: (transfer none) (allow-none): pointer to a #GstCaps that will
- *     replace the caps pointed to by @ocaps.
+ *     replace the caps pointed to by @old_caps.
  *
  * Modifies a pointer to a #GstCaps to point to a different #GstCaps. The
  * modification is done atomically (so this is useful for ensuring thread safety
  * in some cases), and the reference counts are updated appropriately (the old
  * caps is unreffed, the new is reffed).
  *
- * Either @ncaps or the #GstCaps pointed to by @ocaps may be %NULL.
+ * Either @new_caps or the #GstCaps pointed to by @old_caps may be %NULL.
  *
  * Returns: %TRUE if @new_caps was different from @old_caps
  */
@@ -317,7 +317,7 @@ gst_caps_replace (GstCaps **old_caps, GstCaps *new_caps)
  * @old_caps: (inout) (transfer full): pointer to a pointer to a #GstCaps to be
  *     replaced.
  * @new_caps: (transfer full) (allow-none): pointer to a #GstCaps that will
- *     replace the caps pointed to by @ocaps.
+ *     replace the caps pointed to by @old_caps.
  *
  * Modifies a pointer to a #GstCaps to point to a different #GstCaps. This
  * function is similar to gst_caps_replace() except that it takes ownership

diff --git a/gst/gstdevice.c b/gst/gstdevice.c
index 1237dca..6274c93 100644 (file)
--- a/gst/gstdevice.c
+++ b/gst/gstdevice.c
@@ -29,7 +29,7 @@
  * representing the media types it can produce or handle.
  *
  * #GstDevice are created by #GstDeviceProvider objects which can be
- * aggregated by #GstGlobalDeviceMonitor objects.
+ * aggregated by #GstDeviceMonitor objects.
  *
  * Since: 1.4
  */

diff --git a/gst/gstdeviceprovider.c b/gst/gstdeviceprovider.c
index 963a683..8ad737c 100644 (file)
--- a/gst/gstdeviceprovider.c
+++ b/gst/gstdeviceprovider.c
@@ -380,9 +380,9 @@ gst_device_provider_get_devices (GstDeviceProvider * provider)
  * gst_device_provider_start:
  * @provider: A #GstDeviceProvider
  *
- * Starts providering the devices. This will cause #GST_MESSAGE_DEVICE messages
- * to be posted on the provider's bus when devices are added or removed from
- * the system.
+ * Starts providering the devices. This will cause #GST_MESSAGE_DEVICE_ADDED
+ * and #GST_MESSAGE_DEVICE_REMOVED messages to be posted on the provider's bus
+ * when devices are added or removed from the system.
  *
  * Since the #GstDeviceProvider is a singleton,
  * gst_device_provider_start() may already have been called by another

diff --git a/gst/gstdeviceproviderfactory.c b/gst/gstdeviceproviderfactory.c
index 3f38f06..a28a0bd 100644 (file)
--- a/gst/gstdeviceproviderfactory.c
+++ b/gst/gstdeviceproviderfactory.c
@@ -31,8 +31,8 @@
  * #GstPluginFeature.
  *
  * Use the gst_device_provider_factory_find() and
- * gst_device_provider_factory_create() functions to create device
- * provider instances or use gst_device_provider_factory_make() as a
+ * gst_device_provider_factory_get() functions to create device
+ * provider instances or use gst_device_provider_factory_get_by_name() as a
  * convenient shortcut.
  *
  * Since: 1.4

diff --git a/gst/gsttoc.h b/gst/gsttoc.h
index 39469c1..cb77862 100644 (file)
--- a/gst/gsttoc.h
+++ b/gst/gsttoc.h
@@ -81,7 +81,20 @@ typedef enum {
   GST_TOC_ENTRY_TYPE_CHAPTER     = 3,
 } GstTocEntryType;
 
+/**
+ * GST_TOC_ENTRY_TYPE_IS_ALTERNATIVE:
+ * @entry_type: The #GstTocEntryType from a #GstTocEntry
+ *
+ * Checks if @entry_type indicates that its #GstTocEntry is an alternative.
+ */
 #define GST_TOC_ENTRY_TYPE_IS_ALTERNATIVE(entry_type)  (entry_type < 0)
+
+/**
+ * GST_TOC_ENTRY_TYPE_IS_SEQUENCE:
+ * @entry_type: The #GstTocEntryType from a #GstTocEntry
+ *
+ * Checks if @entry_type indicates that its #GstTocEntry is a sequence.
+ */
 #define GST_TOC_ENTRY_TYPE_IS_SEQUENCE(entry_type)     (entry_type > 0)
 
 /**

diff --git a/gst/gstvalue.c b/gst/gstvalue.c
index 77e6fa1..964431c 100644 (file)
--- a/gst/gstvalue.c
+++ b/gst/gstvalue.c
@@ -4637,7 +4637,7 @@ gst_value_compare_with_func (const GValue * value1, const GValue * value2,
  *
  * Determines if @value1 and @value2 can be non-trivially unioned.
  * Any two values can be trivially unioned by adding both of them
- * to a #GstValueList.  However, certain types have the possibility
+ * to a GstValueList.  However, certain types have the possibility
  * to be unioned in a simpler way.  For example, an integer range
  * and an integer can be unioned if the integer is a subset of the
  * integer range.  If there is the possibility that two values can

diff --git a/libs/gst/check/gstcheck.c b/libs/gst/check/gstcheck.c
index 7589ce1..e92f4c8 100644 (file)
--- a/libs/gst/check/gstcheck.c
+++ b/libs/gst/check/gstcheck.c
@@ -547,14 +547,16 @@ buffer_event_function (GstPad * pad, GstObject * noparent, GstEvent * event)
  * @element_name: name of the element that needs to be created
  * @buffer_in: (element-type GstBuffer) (transfer full): a list of buffers that needs to be
  *  pushed to the element
+ * @caps_in: the #GstCaps expected of the sinkpad of the element
  * @buffer_out: (element-type GstBuffer) (transfer full): a list of buffers that we expect from
  * the element
+ * @caps_out: the #GstCaps expected of the srcpad of the element
  * @last_flow_return: the last buffer push needs to give this GstFlowReturn
  *
- * Create an @element with the factory with the name and push the buffers in
- * @buffer_in to this element. The element should create the buffers equal to
- * the buffers in @buffer_out. We only check the caps, size and the data of the
- * buffers. This function unrefs the buffers in the two lists.
+ * Create an element using the factory providing the @element_name and push the
+ * buffers in @buffer_in to this element. The element should create the buffers
+ * equal to the buffers in @buffer_out. We only check the size and the data of
+ * the buffers. This function unrefs the buffers in the two lists.
  * The last_flow_return parameter indicates the expected flow return value from
  * pushing the final buffer in the list.
  * This can be used to set up a test which pushes some buffers and then an
@@ -694,10 +696,12 @@ gst_check_element_push_buffer_list (const gchar * element_name,
  * gst_check_element_push_buffer:
  * @element_name: name of the element that needs to be created
  * @buffer_in: push this buffer to the element
+ * @caps_in: the #GstCaps expected of the sinkpad of the element
  * @buffer_out: compare the result with this buffer
+ * @caps_out: the #GstCaps expected of the srcpad of the element
  *
- * Create an @element with the factory with the name and push the
- * @buffer_in to this element. The element should create one buffer
+ * Create an element using the factory providing the @element_name and
+ * push the @buffer_in to this element. The element should create one buffer
  * and this will be compared with @buffer_out. We only check the caps
  * and the data of the buffers. This function unrefs the buffers.
  */

diff --git a/libs/gst/net/gstnetaddressmeta.c b/libs/gst/net/gstnetaddressmeta.c
index 164ce4f..2c413e2 100644 (file)
--- a/libs/gst/net/gstnetaddressmeta.c
+++ b/libs/gst/net/gstnetaddressmeta.c
@@ -91,6 +91,15 @@ gst_net_address_meta_get_info (void)
   return meta_info;
 }
 
+/**
+ * gst_buffer_add_net_address_meta:
+ * @buffer: a #GstBuffer
+ * @addr: a @GSocketAddress to connect to @buffer
+ *
+ * Attaches @addr as metadata in a #GstNetAddressMeta to @buffer.
+ *
+ * Returns: (transfer none): a #GstNetAddressMeta connected to @buffer
+ */
 GstNetAddressMeta *
 gst_buffer_add_net_address_meta (GstBuffer * buffer, GSocketAddress * addr)
 {

diff --git a/libs/gst/net/gstnetaddressmeta.h b/libs/gst/net/gstnetaddressmeta.h
index feb64d8..ff8b523 100644 (file)
--- a/libs/gst/net/gstnetaddressmeta.h
+++ b/libs/gst/net/gstnetaddressmeta.h
@@ -29,6 +29,8 @@ typedef struct _GstNetAddressMeta GstNetAddressMeta;
 
 /**
  * GstNetAddressMeta:
+ * @meta: the parent type
+ * @addr: a #GSocketAddress stored as metadata
  *
  * Buffer metadata for network addresses.
  */