FaSTTUBe/GST-Tensordecoder-ov_ep
37
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: Fix GstWebRTCICE* class documentation

Browse Source 
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>
This commit is contained in:
Nirbheek Chauhan 2025-04-01 16:10:52 +05:30 committed by GStreamer Marge Bot
parent 0b611ce703
commit 9194e259d9
2 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
subprojects/gst-plugins-bad/gst-libs/gst/webrtc/ice.c
View File

@ -182,6 +182,7 @@ gst_webrtc_ice_set_local_credentials (GstWebRTCICE * ice,
* gst_webrtc_ice_gather_candidates: * gst_webrtc_ice_gather_candidates:
* @ice: The #GstWebRTCICE * @ice: The #GstWebRTCICE
* @stream: The #GstWebRTCICEStream * @stream: The #GstWebRTCICEStream
*
* Returns: FALSE on error, TRUE otherwise * Returns: FALSE on error, TRUE otherwise
* *
* Since: 1.22 * Since: 1.22
@ -215,6 +216,7 @@ gst_webrtc_ice_set_is_controller (GstWebRTCICE * ice, gboolean controller)
/** /**
* gst_webrtc_ice_get_is_controller: * gst_webrtc_ice_get_is_controller:
* @ice: The #GstWebRTCICE * @ice: The #GstWebRTCICE
*
* Returns: TRUE if set as controller, FALSE otherwise * Returns: TRUE if set as controller, FALSE otherwise
* *
* Since: 1.22 * Since: 1.22
@ -267,7 +269,8 @@ gst_webrtc_ice_set_tos (GstWebRTCICE * ice, GstWebRTCICEStream * stream,
* gst_webrtc_ice_get_local_candidates: * gst_webrtc_ice_get_local_candidates:
* @ice: The #GstWebRTCICE * @ice: The #GstWebRTCICE
* @stream: The #GstWebRTCICEStream * @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 * Since: 1.22
*/ */
@ -286,6 +289,7 @@ gst_webrtc_ice_get_local_candidates (GstWebRTCICE * ice,
* gst_webrtc_ice_get_remote_candidates: * gst_webrtc_ice_get_remote_candidates:
* @ice: The #GstWebRTCICE * @ice: The #GstWebRTCICE
* @stream: The #GstWebRTCICEStream * @stream: The #GstWebRTCICEStream
*
* Returns: (transfer full) (array zero-terminated=1): List of remote candidates * Returns: (transfer full) (array zero-terminated=1): List of remote candidates
* *
* Since: 1.22 * Since: 1.22

6
subprojects/gst-plugins-bad/gst-libs/gst/webrtc/icestream.c
View File

@ -17,9 +17,9 @@
* Boston, MA 02110-1301, USA. * Boston, MA 02110-1301, USA.
*/ */
/** /**
* SECTION: icestream * SECTION: GstWebRTCICEStream
* @short_description: IceStream object * @short_description: GstWebRTCICEStream object
* @title: GstIceStream * @title: GstWebRTCICEStream
* @symbols: * @symbols:
* - GstWebRTCICEStream * - GstWebRTCICEStream
*/ */