play: Add/fix various annotations
authorSebastian Dröge <sebastian@centricular.com>
Mon, 17 Oct 2022 16:36:13 +0000 (19:36 +0300)
committerSebastian Dröge <sebastian@centricular.com>
Tue, 18 Oct 2022 10:51:17 +0000 (13:51 +0300)
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3194>

subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay-signal-adapter.c

index 55cccbd..fe02e03 100644 (file)
@@ -420,6 +420,14 @@ gst_play_signal_adapter_class_init (GstPlaySignalAdapterClass * klass)
       G_SIGNAL_RUN_LAST | G_SIGNAL_NO_RECURSE | G_SIGNAL_NO_HOOKS, 0, NULL,
       NULL, NULL, G_TYPE_NONE, 0, G_TYPE_INVALID);
 
+  /**
+   * GstPlaySignalAdapter::error:
+   * @adapter: The #GstPlaySignalAdapter
+   * @error: The error
+   * @details: (nullable): Additional error details
+   *
+   * Emitted on errors.
+   */
   signals[SIGNAL_ERROR] =
       g_signal_new ("error", G_TYPE_FROM_CLASS (klass),
       G_SIGNAL_RUN_LAST | G_SIGNAL_NO_RECURSE | G_SIGNAL_NO_HOOKS, 0, NULL,
@@ -445,6 +453,14 @@ gst_play_signal_adapter_class_init (GstPlaySignalAdapterClass * klass)
       G_SIGNAL_RUN_LAST | G_SIGNAL_NO_RECURSE | G_SIGNAL_NO_HOOKS, 0, NULL,
       NULL, NULL, G_TYPE_NONE, 1, G_TYPE_BOOLEAN);
 
+  /**
+   * GstPlaySignalAdapter::warning:
+   * @adapter: The #GstPlaySignalAdapter
+   * @error: The warning
+   * @details: (nullable): Additional warning details
+   *
+   * Emitted on warnings.
+   */
   signals[SIGNAL_WARNING] =
       g_signal_new ("warning", G_TYPE_FROM_CLASS (klass),
       G_SIGNAL_RUN_LAST | G_SIGNAL_NO_RECURSE | G_SIGNAL_NO_HOOKS, 0, NULL,