webrtc: Re-add WebRTC object docs to the public headers
authorSebastian Dröge <sebastian@centricular.com>
Mon, 28 Jun 2021 14:41:38 +0000 (17:41 +0300)
committerGStreamer Marge Bot <gitlab-merge-bot@gstreamer-foundation.org>
Mon, 28 Jun 2021 14:45:37 +0000 (14:45 +0000)
So they end up in the generated documentation and the Since markers
appear in the .gir files too.

Also remove wrong "Since: 1.16" markers for some objects that were
available since 1.14.0 already.

Fixes https://gitlab.freedesktop.org/gstreamer/gst-plugins-bad/-/issues/1609

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-bad/-/merge_requests/2366>

gst-libs/gst/webrtc/webrtc-priv.h
gst-libs/gst/webrtc/webrtc_fwd.h

index 203f852..cf8a081 100644 (file)
@@ -49,8 +49,6 @@ G_BEGIN_DECLS
  * @kind: Type of media (Since: 1.20)
  *
  * Mostly matches the WebRTC RTCRtpTransceiver interface.
- *
- * Since: 1.16
  */
 /**
  * GstWebRTCRTPTransceiver.kind:
@@ -95,8 +93,6 @@ struct _GstWebRTCRTPTransceiverClass
  * An object to track the sending aspect of the stream
  *
  * Mostly matches the WebRTC RTCRtpSender interface.
- *
- * Since: 1.16
  */
 /**
  * GstWebRTCRTPSender.priority:
@@ -135,8 +131,6 @@ GstWebRTCRTPSender *        gst_webrtc_rtp_sender_new                   (void);
  * An object to track the receiving aspect of the stream
  *
  * Mostly matches the WebRTC RTCRtpReceiver interface.
- *
- * Since: 1.16
  */
 struct _GstWebRTCRTPReceiver
 {
index 87d5f98..f3f9aeb 100644 (file)
 
 #include <gst/webrtc/webrtc-enumtypes.h>
 
+/**
+ * GstWebRTCDTLSTransport:
+ */
 typedef struct _GstWebRTCDTLSTransport GstWebRTCDTLSTransport;
 typedef struct _GstWebRTCDTLSTransportClass GstWebRTCDTLSTransportClass;
 
+/**
+ * GstWebRTCICETransport:
+ */
 typedef struct _GstWebRTCICETransport GstWebRTCICETransport;
 typedef struct _GstWebRTCICETransportClass GstWebRTCICETransportClass;
 
+/**
+ * GstWebRTCRTPReceiver:
+ *
+ * An object to track the receiving aspect of the stream
+ *
+ * Mostly matches the WebRTC RTCRtpReceiver interface.
+ */
 typedef struct _GstWebRTCRTPReceiver GstWebRTCRTPReceiver;
 typedef struct _GstWebRTCRTPReceiverClass GstWebRTCRTPReceiverClass;
 
+/**
+ * GstWebRTCRTPSender:
+ *
+ * An object to track the sending aspect of the stream
+ *
+ * Mostly matches the WebRTC RTCRtpSender interface.
+ */
 typedef struct _GstWebRTCRTPSender GstWebRTCRTPSender;
 typedef struct _GstWebRTCRTPSenderClass GstWebRTCRTPSenderClass;
 
 typedef struct _GstWebRTCSessionDescription GstWebRTCSessionDescription;
 
+/**
+ * GstWebRTCRTPTransceiver:
+ *
+ * Mostly matches the WebRTC RTCRtpTransceiver interface.
+ */
 typedef struct _GstWebRTCRTPTransceiver GstWebRTCRTPTransceiver;
 typedef struct _GstWebRTCRTPTransceiverClass GstWebRTCRTPTransceiverClass;
 
+/**
+ * GstWebRTCDataChannel:
+ *
+ * Since: 1.18
+ */
 typedef struct _GstWebRTCDataChannel GstWebRTCDataChannel;
 typedef struct _GstWebRTCDataChannelClass GstWebRTCDataChannelClass;