diff options
| author | Niels De Graef <niels.degraef@barco.com> | 2019-05-09 14:08:31 +0200 |
|---|---|---|
| committer | Tim-Philipp Müller <tim@centricular.com> | 2019-08-20 17:01:53 +0100 |
| commit | b1971de590539e41abf8b8ca0cdad0dceeecf452 (patch) | |
| tree | b16d08fc247f6de44a85397d2e340566efafc486 /ext | |
| parent | 92eaeb5fb6781b9a643b3bd418300ccbd263c1d7 (diff) | |
| download | gstreamer-plugins-bad-b1971de590539e41abf8b8ca0cdad0dceeecf452.tar.gz | |
webrtc: Fix signals documentation
Some GIR annotations were incorrect or even missing. The former isn't
good for bindings, while the latter is especially annoying for signal
handlers, as that means your arguments will get the wrong names in the
rendered documentation.
Diffstat (limited to 'ext')
| -rw-r--r-- | ext/webrtc/gstwebrtcbin.c | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/ext/webrtc/gstwebrtcbin.c b/ext/webrtc/gstwebrtcbin.c index cb3504cf7..a4a8909ee 100644 --- a/ext/webrtc/gstwebrtcbin.c +++ b/ext/webrtc/gstwebrtcbin.c @@ -5082,7 +5082,7 @@ gst_webrtc_bin_class_init (GstWebRTCBinClass * klass) * GstWebRTCBin::set-local-description: * @object: the #GstWebRtcBin * @desc: a #GstWebRTCSessionDescription description - * @promise (allow-none): a #GstPromise to be notified when it's set + * @promise: (nullable): a #GstPromise to be notified when it's set */ gst_webrtc_bin_signals[SET_LOCAL_DESCRIPTION_SIGNAL] = g_signal_new_class_handler ("set-local-description", @@ -5095,7 +5095,7 @@ gst_webrtc_bin_class_init (GstWebRTCBinClass * klass) * GstWebRTCBin::set-remote-description: * @object: the #GstWebRtcBin * @desc: a #GstWebRTCSessionDescription description - * @promise (allow-none): a #GstPromise to be notified when it's set + * @promise: (nullable): a #GstPromise to be notified when it's set */ gst_webrtc_bin_signals[SET_REMOTE_DESCRIPTION_SIGNAL] = g_signal_new_class_handler ("set-remote-description", @@ -5107,6 +5107,7 @@ gst_webrtc_bin_class_init (GstWebRTCBinClass * klass) /** * GstWebRTCBin::add-ice-candidate: * @object: the #GstWebRtcBin + * @mline_index: the index of the media description in the SDP * @ice-candidate: an ice candidate */ gst_webrtc_bin_signals[ADD_ICE_CANDIDATE_SIGNAL] = @@ -5118,6 +5119,7 @@ gst_webrtc_bin_class_init (GstWebRTCBinClass * klass) /** * GstWebRTCBin::get-stats: * @object: the #GstWebRtcBin + * @pad: (nullable): A #GstPad to get the stats for, or %NULL for all * @promise: a #GstPromise for the result * * The @promise will contain the result of retrieving the session statistics. @@ -5203,6 +5205,7 @@ gst_webrtc_bin_class_init (GstWebRTCBinClass * klass) /** * GstWebRTCBin::on-ice-candidate: * @object: the #GstWebRtcBin + * @mline_index: the index of the media description in the SDP * @candidate: the ICE candidate */ gst_webrtc_bin_signals[ON_ICE_CANDIDATE_SIGNAL] = @@ -5303,7 +5306,7 @@ gst_webrtc_bin_class_init (GstWebRTCBinClass * klass) * id G_TYPE_INT Override the default identifier selection of this channel * priority GST_TYPE_WEBRTC_PRIORITY_TYPE The priority to use for this channel * - * Returns: a new data channel object + * Returns: (transfer full): a new data channel object */ gst_webrtc_bin_signals[CREATE_DATA_CHANNEL_SIGNAL] = g_signal_new_class_handler ("create-data-channel", |