From 476a34cfdb90bd008395c4e38b58670ffc7b83a5 Mon Sep 17 00:00:00 2001
From: naglis <341855-naglis@users.noreply.gitlab.freedesktop.org>
Date: Thu, 22 Feb 2024 09:41:00 +0200
Subject: [PATCH] gstplay: Fix typos in documentation

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/6177>
---
 girs/GstPlay-1.0.gir                               | 14 +++++++-------
 .../gst-plugins-bad/gst-libs/gst/play/gstplay.c    | 14 +++++++-------
 2 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/girs/GstPlay-1.0.gir b/girs/GstPlay-1.0.gir
index 3e779b0e54..d23dfd923e 100644
--- a/girs/GstPlay-1.0.gir
+++ b/girs/GstPlay-1.0.gir
@@ -435,8 +435,8 @@ This option is disabled by default.</doc>
         </parameters>
       </function>
       <function name="config_set_position_update_interval" c:identifier="gst_play_config_set_position_update_interval" version="1.20">
-        <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">set desired interval in milliseconds between two position-updated messages.
-pass 0 to stop updating the position.</doc>
+        <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">Set desired interval in milliseconds between two position-updated messages.
+Pass 0 to stop updating the position.</doc>
         <source-position filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.h"/>
         <return-value transfer-ownership="none">
           <type name="none" c:type="void"/>
@@ -547,7 +547,7 @@ matching #GstPlayVideoInfo.</doc>
       <function name="is_play_message" c:identifier="gst_play_is_play_message" version="1.20">
         <source-position filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.h"/>
         <return-value transfer-ownership="none">
-          <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">A #gboolean indicating wheter the passes message represents a #GstPlay message or not.</doc>
+          <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">A #gboolean indicating whether the passed message represents a #GstPlay message or not.</doc>
           <type name="gboolean" c:type="gboolean"/>
         </return-value>
         <parameters>
@@ -835,7 +835,7 @@ currently-playing stream.</doc>
         </parameters>
       </method>
       <method name="get_subtitle_uri" c:identifier="gst_play_get_subtitle_uri" version="1.20">
-        <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">current subtitle URI</doc>
+        <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">Current subtitle URI</doc>
         <source-position filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.h"/>
         <return-value transfer-ownership="full" nullable="1">
           <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">URI of the current external subtitle.
@@ -880,7 +880,7 @@ currently-playing stream. g_free() after usage.</doc>
       </method>
       <method name="get_video_snapshot" c:identifier="gst_play_get_video_snapshot" version="1.20">
         <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">Get a snapshot of the currently selected video stream, if any. The format can be
-selected with @format and optional configuration is possible with @config
+selected with @format and optional configuration is possible with @config.
 Currently supported settings are:
 - width, height of type G_TYPE_INT
 - pixel-aspect-ratio of type GST_TYPE_FRACTION
@@ -1055,7 +1055,7 @@ value.</doc>
       </method>
       <method name="set_config" c:identifier="gst_play_set_config" version="1.20">
         <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">Set the configuration of the play. If the play is already configured, and
-the configuration haven't change, this function will return %TRUE. If the
+the configuration hasn't changed, this function will return %TRUE. If the
 play is not in the GST_PLAY_STATE_STOPPED, this method will return %FALSE
 and active configuration will remain.
 
@@ -1277,7 +1277,7 @@ Sets the video track @stream_index.</doc>
       <method name="set_visualization" c:identifier="gst_play_set_visualization" version="1.20">
         <source-position filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.h"/>
         <return-value transfer-ownership="none">
-          <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">%TRUE if the visualizations was set correctly. Otherwise,
+          <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">%TRUE if the visualization was set correctly. Otherwise,
 %FALSE.</doc>
           <type name="gboolean" c:type="gboolean"/>
         </return-value>
diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c b/subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c
index cc8ac28db5..a88e4c302e 100644
--- a/subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c
@@ -3250,7 +3250,7 @@ gst_play_set_subtitle_uri (GstPlay * self, const gchar * suburi)
  * gst_play_get_subtitle_uri:
  * @play: #GstPlay instance
  *
- * current subtitle URI
+ * Current subtitle URI
  *
  * Returns: (transfer full) (nullable): URI of the current external subtitle.
  *   g_free() after usage.
@@ -3752,7 +3752,7 @@ gst_play_set_subtitle_track_enabled (GstPlay * self, gboolean enabled)
  * @name: (nullable): visualization element obtained from
  * #gst_play_visualizations_get()
  *
- * Returns: %TRUE if the visualizations was set correctly. Otherwise,
+ * Returns: %TRUE if the visualization was set correctly. Otherwise,
  * %FALSE.
  * Since: 1.20
  */
@@ -4332,7 +4332,7 @@ gst_play_error_get_name (GstPlayError error)
  * @config: (transfer full): a #GstStructure
  *
  * Set the configuration of the play. If the play is already configured, and
- * the configuration haven't change, this function will return %TRUE. If the
+ * the configuration hasn't changed, this function will return %TRUE. If the
  * play is not in the GST_PLAY_STATE_STOPPED, this method will return %FALSE
  * and active configuration will remain.
  *
@@ -4443,8 +4443,8 @@ gst_play_config_get_user_agent (const GstStructure * config)
  * @config: a #GstPlay configuration
  * @interval: interval in ms
  *
- * set desired interval in milliseconds between two position-updated messages.
- * pass 0 to stop updating the position.
+ * Set desired interval in milliseconds between two position-updated messages.
+ * Pass 0 to stop updating the position.
  * Since: 1.20
  */
 void
@@ -4578,7 +4578,7 @@ gst_play_config_get_pipeline_dump_in_error_details (const GstStructure * config)
  * @config: (allow-none): Additional configuration
  *
  * Get a snapshot of the currently selected video stream, if any. The format can be
- * selected with @format and optional configuration is possible with @config
+ * selected with @format and optional configuration is possible with @config.
  * Currently supported settings are:
  * - width, height of type G_TYPE_INT
  * - pixel-aspect-ratio of type GST_TYPE_FRACTION
@@ -4672,7 +4672,7 @@ gst_play_get_video_snapshot (GstPlay * self,
  * gst_play_is_play_message:
  * @msg: A #GstMessage
  *
- * Returns: A #gboolean indicating wheter the passes message represents a #GstPlay message or not.
+ * Returns: A #gboolean indicating whether the passed message represents a #GstPlay message or not.
  *
  * Since: 1.20
  */