From 9194e259d92081a68e7cd597dbd34f624e4f71f3 Mon Sep 17 00:00:00 2001
From: Nirbheek Chauhan <nirbheek@centricular.com>
Date: Tue, 1 Apr 2025 16:10:52 +0530
Subject: [PATCH] docs: Fix GstWebRTCICE* class documentation

IceStream is not an actual object, it's GstWebRTCICEStream

Some `Returns:` annotations were improperly formatted and not taking
effect.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/8755>
---
 subprojects/gst-plugins-bad/gst-libs/gst/webrtc/ice.c       | 6 +++++-
 subprojects/gst-plugins-bad/gst-libs/gst/webrtc/icestream.c | 6 +++---
 2 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/webrtc/ice.c b/subprojects/gst-plugins-bad/gst-libs/gst/webrtc/ice.c
index 82a685940a..f35652a27f 100644
--- a/subprojects/gst-plugins-bad/gst-libs/gst/webrtc/ice.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/webrtc/ice.c
@@ -182,6 +182,7 @@ gst_webrtc_ice_set_local_credentials (GstWebRTCICE * ice,
  * gst_webrtc_ice_gather_candidates:
  * @ice: The #GstWebRTCICE
  * @stream: The #GstWebRTCICEStream
+ *
  * Returns: FALSE on error, TRUE otherwise
  *
  * Since: 1.22
@@ -215,6 +216,7 @@ gst_webrtc_ice_set_is_controller (GstWebRTCICE * ice, gboolean controller)
 /**
  * gst_webrtc_ice_get_is_controller:
  * @ice: The #GstWebRTCICE
+ *
  * Returns: TRUE if set as controller, FALSE otherwise
  *
  * Since: 1.22
@@ -267,7 +269,8 @@ gst_webrtc_ice_set_tos (GstWebRTCICE * ice, GstWebRTCICEStream * stream,
  * gst_webrtc_ice_get_local_candidates:
  * @ice: The #GstWebRTCICE
  * @stream: The #GstWebRTCICEStream
- * Returns: (transfer full)(array zero-terminated=1): List of local candidates
+ *
+ * Returns: (transfer full) (array zero-terminated=1): List of local candidates
  *
  * Since: 1.22
  */
@@ -286,6 +289,7 @@ gst_webrtc_ice_get_local_candidates (GstWebRTCICE * ice,
  * gst_webrtc_ice_get_remote_candidates:
  * @ice: The #GstWebRTCICE
  * @stream: The #GstWebRTCICEStream
+ *
  * Returns: (transfer full) (array zero-terminated=1): List of remote candidates
  *
  * Since: 1.22
diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/webrtc/icestream.c b/subprojects/gst-plugins-bad/gst-libs/gst/webrtc/icestream.c
index 4d0055f520..eb248af0ad 100644
--- a/subprojects/gst-plugins-bad/gst-libs/gst/webrtc/icestream.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/webrtc/icestream.c
@@ -17,9 +17,9 @@
  * Boston, MA 02110-1301, USA.
  */
 /**
- * SECTION: icestream
- * @short_description: IceStream object
- * @title: GstIceStream
+ * SECTION: GstWebRTCICEStream
+ * @short_description: GstWebRTCICEStream object
+ * @title: GstWebRTCICEStream
  * @symbols:
  * - GstWebRTCICEStream
  */