mpegts: add missing Since comments after SCTE 35 work

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/913>

diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/mpegts/gst-scte-section.c b/subprojects/gst-plugins-bad/gst-libs/gst/mpegts/gst-scte-section.c
index 4721b72..2b9488b 100644 (file)
--- a/subprojects/gst-plugins-bad/gst-libs/gst/mpegts/gst-scte-section.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/mpegts/gst-scte-section.c
@@ -619,7 +619,7 @@ gst_mpegts_scte_splice_event_new (void)
 
 /**
  * gst_mpegts_scte_splice_component_new:
- * tag: the elementary PID stream identifier
+ * @tag: the elementary PID stream identifier
  *
  * Allocates and initializes a #GstMpegtsSCTESpliceComponent.
  *

diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/mpegts/gst-scte-section.h b/subprojects/gst-plugins-bad/gst-libs/gst/mpegts/gst-scte-section.h
index af10bec..bc7f9d4 100644 (file)
--- a/subprojects/gst-plugins-bad/gst-libs/gst/mpegts/gst-scte-section.h
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/mpegts/gst-scte-section.h
@@ -103,9 +103,20 @@ typedef enum {
 
 } GstMpegtsSectionSCTETableID;
 
-#define GST_TYPE_MPEGTS_SCTE_SPLICE_COMPONENT (gst_mpegts_scte_splice_component_get_type())
+#define GST_MPEGTS_TYPE_SCTE_SPLICE_COMPONENT (gst_mpegts_scte_splice_component_get_type())
 typedef struct _GstMpegtsSCTESpliceComponent GstMpegtsSCTESpliceComponent;
 
+/**
+ * GstMpegtsSCTESpliceComponent:
+ * @tag: the elementary PID stream containing the Splice Point
+ * @splice_time_specified: Whether @splice_time was specified
+ * @splice_time: the presentation time of the signaled splice event
+ * @utc_splice_time: The UTC time of the signaled splice event
+ *
+ * Per-PID splice information.
+ *
+ * Since: 1.20
+ */
 struct _GstMpegtsSCTESpliceComponent {
   guint8 tag;
 
@@ -136,8 +147,22 @@ struct _GstMpegtsSCTESpliceEvent {
   gboolean program_splice_time_specified; /* Only valid for insert_event && program_splice */
   guint64 program_splice_time; /* Only valid for insert_event && program_splice */
 
+  /**
+   * GstMpegtsSCTESpliceEvent.utc_splice_time:
+   *
+   * The UTC time of the signaled splice event
+   *
+   * Since: 1.20
+   */
   guint32 utc_splice_time; /* Only valid for !insert_event (schedule) && program_splice */
 
+  /**
+   * GstMpegtsSCTESpliceEvent.components:
+   *
+   * Per-PID splice time information
+   *
+   * Since: 1.20
+   */
   GPtrArray *components; /* Only valid for !program_splice */
 
   gboolean break_duration_auto_return;
@@ -195,11 +220,24 @@ struct _GstMpegtsSCTESIT
 
   GPtrArray *descriptors;
 
-  /* When encrypted, or when encountering an unknown command type,
-   * we may still want to pass the sit through */
+  /**
+   * GstMpegtsSCTESIT.fully_parsed:
+   *
+   * When encrypted, or when encountering an unknown command type,
+   * we may still want to pass the sit through.
+   *
+   * Since: 1.20
+   */
   gboolean fully_parsed;
-  /* When the SIT was constructed by the application, splice times
-   * are in running_time and must be translated before packetizing */
+
+  /**
+   * GstMpegtsSCTESIT.is_running_time:
+   *
+   * When the SIT was constructed by the application, splice times
+   * are in running_time and must be translated before packetizing.
+   *
+   * Since: 1.20
+   */
   gboolean is_running_time;
 };
 

diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/mpegts/gstmpegtssection.c b/subprojects/gst-plugins-bad/gst-libs/gst/mpegts/gstmpegtssection.c
index 6bc691c..3ab178e 100644 (file)
--- a/subprojects/gst-plugins-bad/gst-libs/gst/mpegts/gstmpegtssection.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/mpegts/gstmpegtssection.c
@@ -357,6 +357,15 @@ gst_message_new_mpegts_section (GstObject * parent, GstMpegtsSection * section)
   return msg;
 }
 
+/**
+ * gst_event_new_mpegts_section:
+ * @section: (transfer none): The #GstMpegtsSection to put in a message
+ *
+ * Creates a new #GstEvent for a #GstMpegtsSection.
+ *
+ * Returns: (transfer full): The new custom #GstEvent.
+ * Since: 1.20
+ */
 GstEvent *
 gst_event_new_mpegts_section (GstMpegtsSection * section)
 {

diff --git a/subprojects/gst-plugins-bad/gst/mpegtsdemux/tsdemux.c b/subprojects/gst-plugins-bad/gst/mpegtsdemux/tsdemux.c
index e788350..07d93a7 100644 (file)
--- a/subprojects/gst-plugins-bad/gst/mpegtsdemux/tsdemux.c
+++ b/subprojects/gst-plugins-bad/gst/mpegtsdemux/tsdemux.c
@@ -398,7 +398,7 @@ gst_ts_demux_class_init (GstTSDemuxClass * klass)
           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 
   /**
-   * mpegtsdemux:send-scte35-events:
+   * tsdemux:send-scte35-events:
    *
    * Whether SCTE 35 sections should be forwarded as events.
    *