Skip to content

Commit 9194e25

Browse files
nirbheekGStreamer Marge Bot
authored andcommitted
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>
1 parent 0b611ce commit 9194e25

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

subprojects/gst-plugins-bad/gst-libs/gst/webrtc/ice.c

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,7 @@ gst_webrtc_ice_set_local_credentials (GstWebRTCICE * ice,
182182
* gst_webrtc_ice_gather_candidates:
183183
* @ice: The #GstWebRTCICE
184184
* @stream: The #GstWebRTCICEStream
185+
*
185186
* Returns: FALSE on error, TRUE otherwise
186187
*
187188
* Since: 1.22
@@ -215,6 +216,7 @@ gst_webrtc_ice_set_is_controller (GstWebRTCICE * ice, gboolean controller)
215216
/**
216217
* gst_webrtc_ice_get_is_controller:
217218
* @ice: The #GstWebRTCICE
219+
*
218220
* Returns: TRUE if set as controller, FALSE otherwise
219221
*
220222
* Since: 1.22
@@ -267,7 +269,8 @@ gst_webrtc_ice_set_tos (GstWebRTCICE * ice, GstWebRTCICEStream * stream,
267269
* gst_webrtc_ice_get_local_candidates:
268270
* @ice: The #GstWebRTCICE
269271
* @stream: The #GstWebRTCICEStream
270-
* Returns: (transfer full)(array zero-terminated=1): List of local candidates
272+
*
273+
* Returns: (transfer full) (array zero-terminated=1): List of local candidates
271274
*
272275
* Since: 1.22
273276
*/
@@ -286,6 +289,7 @@ gst_webrtc_ice_get_local_candidates (GstWebRTCICE * ice,
286289
* gst_webrtc_ice_get_remote_candidates:
287290
* @ice: The #GstWebRTCICE
288291
* @stream: The #GstWebRTCICEStream
292+
*
289293
* Returns: (transfer full) (array zero-terminated=1): List of remote candidates
290294
*
291295
* Since: 1.22

subprojects/gst-plugins-bad/gst-libs/gst/webrtc/icestream.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@
1717
* Boston, MA 02110-1301, USA.
1818
*/
1919
/**
20-
* SECTION: icestream
21-
* @short_description: IceStream object
22-
* @title: GstIceStream
20+
* SECTION: GstWebRTCICEStream
21+
* @short_description: GstWebRTCICEStream object
22+
* @title: GstWebRTCICEStream
2323
* @symbols:
2424
* - GstWebRTCICEStream
2525
*/

0 commit comments

Comments
 (0)