validate: Introspection annotation cleanups

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

diff --git a/subprojects/gst-devtools/validate/gst/validate/gst-validate-bin-monitor.c b/subprojects/gst-devtools/validate/gst/validate/gst-validate-bin-monitor.c
index ab2c82c..69239a2 100644 (file)
--- a/subprojects/gst-devtools/validate/gst/validate/gst-validate-bin-monitor.c
+++ b/subprojects/gst-devtools/validate/gst/validate/gst-validate-bin-monitor.c
@@ -191,6 +191,10 @@ gst_validate_bin_monitor_init (GstValidateBinMonitor * bin_monitor)
 /**
  * gst_validate_bin_monitor_new:
  * @bin: (transfer none): a #GstBin to run Validate on
+ * @runner: (transfer none): a #GstValidateRunner
+ * @parent: (nullable): The parent of the new monitor
+ *
+ * Returns: (transfer full): A #GstValidateBinMonitor or NULL
  */
 GstValidateBinMonitor *
 gst_validate_bin_monitor_new (GstBin * bin, GstValidateRunner * runner,

diff --git a/subprojects/gst-devtools/validate/gst/validate/gst-validate-element-monitor.c b/subprojects/gst-devtools/validate/gst/validate/gst-validate-element-monitor.c
index 2966b14..bb8e812 100644 (file)
--- a/subprojects/gst-devtools/validate/gst/validate/gst-validate-element-monitor.c
+++ b/subprojects/gst-devtools/validate/gst/validate/gst-validate-element-monitor.c
@@ -152,6 +152,10 @@ gst_validate_element_monitor_init (GstValidateElementMonitor * element_monitor)
 /**
  * gst_validate_element_monitor_new:
  * @element: (transfer none): a #GstElement to run Validate on
+ * @runner: (transfer none): a #GstValidateRunner
+ * @parent: (nullable): The parent of the new monitor
+ *
+ * Returns: (transfer full): A #GstValidateElementMonitor or NULL
  */
 GstValidateElementMonitor *
 gst_validate_element_monitor_new (GstElement * element,

diff --git a/subprojects/gst-devtools/validate/gst/validate/gst-validate-monitor.c b/subprojects/gst-devtools/validate/gst/validate/gst-validate-monitor.c
index b6b75f6..54dcb09 100644 (file)
--- a/subprojects/gst-devtools/validate/gst/validate/gst-validate-monitor.c
+++ b/subprojects/gst-devtools/validate/gst/validate/gst-validate-monitor.c
@@ -77,7 +77,7 @@ _get_reporting_level (GstValidateReporter * monitor)
  * gst_validate_monitor_get_pipeline:
  * @monitor: The monitor to get the pipeline from
  *
- * Returns: (transfer full): The pipeline in which @monitor
+ * Returns: (transfer full)(nullable): The pipeline in which @monitor
  * target is in.
  */
 GstPipeline *
@@ -90,7 +90,7 @@ gst_validate_monitor_get_pipeline (GstValidateMonitor * monitor)
  * gst_validate_monitor_get_target:
  * @monitor: The monitor to get the target from
  *
- * Returns: (transfer full): The target object
+ * Returns: (transfer full)(nullable): The target object
  */
 GstObject *
 gst_validate_monitor_get_target (GstValidateMonitor * monitor)

diff --git a/subprojects/gst-devtools/validate/gst/validate/gst-validate-pad-monitor.c b/subprojects/gst-devtools/validate/gst/validate/gst-validate-pad-monitor.c
index 7cf92fc..1171a29 100644 (file)
--- a/subprojects/gst-devtools/validate/gst/validate/gst-validate-pad-monitor.c
+++ b/subprojects/gst-devtools/validate/gst/validate/gst-validate-pad-monitor.c
@@ -1038,6 +1038,10 @@ gst_validate_pad_monitor_init (GstValidatePadMonitor * pad_monitor)
 /**
  * gst_validate_pad_monitor_new:
  * @pad: (transfer none): a #GstPad to run Validate on
+ * @runner: (transfer none): a #GstValidateRunner
+ * @parent: (nullable): The parent of the new monitor
+ *
+ * Returns: (transfer full): A #GstValidatePadMonitor or NULL
  */
 GstValidatePadMonitor *
 gst_validate_pad_monitor_new (GstPad * pad, GstValidateRunner * runner,

diff --git a/subprojects/gst-devtools/validate/gst/validate/gst-validate-pad-monitor.h b/subprojects/gst-devtools/validate/gst/validate/gst-validate-pad-monitor.h
index 22c3479..597d6ad 100644 (file)
--- a/subprojects/gst-devtools/validate/gst/validate/gst-validate-pad-monitor.h
+++ b/subprojects/gst-devtools/validate/gst/validate/gst-validate-pad-monitor.h
@@ -148,7 +148,7 @@ GST_VALIDATE_API
 GType          gst_validate_pad_monitor_get_type               (void);
 
 GST_VALIDATE_API
-GstValidatePadMonitor *   gst_validate_pad_monitor_new      (GstPad * pad, GstValidateRunner * runner, GstValidateElementMonitor *element_monitor);
+GstValidatePadMonitor *   gst_validate_pad_monitor_new      (GstPad * pad, GstValidateRunner * runner, GstValidateElementMonitor * parent);
 
 G_END_DECLS
 

diff --git a/subprojects/gst-devtools/validate/gst/validate/gst-validate-pipeline-monitor.c b/subprojects/gst-devtools/validate/gst/validate/gst-validate-pipeline-monitor.c
index 5e22720..6776465 100644 (file)
--- a/subprojects/gst-devtools/validate/gst/validate/gst-validate-pipeline-monitor.c
+++ b/subprojects/gst-devtools/validate/gst/validate/gst-validate-pipeline-monitor.c
@@ -825,6 +825,10 @@ done:
 /**
  * gst_validate_pipeline_monitor_new:
  * @pipeline: (transfer none): a #GstPipeline to run Validate on
+ * @runner: (transfer none): a #GstValidateRunner
+ * @parent: (nullable): The parent of the new monitor
+ *
+ * Returns: (transfer full): A #GstValidatePipelineMonitor or NULL
  */
 GstValidatePipelineMonitor *
 gst_validate_pipeline_monitor_new (GstPipeline * pipeline,

diff --git a/subprojects/gst-devtools/validate/gst/validate/gst-validate-report.c b/subprojects/gst-devtools/validate/gst/validate/gst-validate-report.c
index 0dcff9e..0a455d4 100644 (file)
--- a/subprojects/gst-devtools/validate/gst/validate/gst-validate-report.c
+++ b/subprojects/gst-devtools/validate/gst/validate/gst-validate-report.c
@@ -25,6 +25,13 @@
 #  include "config.h"
 #endif
 
+/**
+ * SECTION:gstvalidatereport
+ * @title: GstValidateReport
+ * @short_description: A Validate report
+ * @see_also: #GstValidateRunner
+ *
+ */
 
 #include <stdlib.h>             /* exit */
 #include <stdio.h>              /* fprintf */

diff --git a/subprojects/gst-devtools/validate/gst/validate/gst-validate-reporter.c b/subprojects/gst-devtools/validate/gst/validate/gst-validate-reporter.c
index 960cfd4..2fa7fe3 100644 (file)
--- a/subprojects/gst-devtools/validate/gst/validate/gst-validate-reporter.c
+++ b/subprojects/gst-devtools/validate/gst/validate/gst-validate-reporter.c
@@ -139,7 +139,7 @@ gst_validate_reporter_get_reporting_level (GstValidateReporter * reporter)
  * gst_validate_reporter_get_pipeline:
  * @reporter: The reporter to get the pipeline from
  *
- * Returns: (transfer full) (allow-none): The #GstPipeline
+ * Returns: (transfer full)(nullable): The #GstPipeline
  */
 GstPipeline *
 gst_validate_reporter_get_pipeline (GstValidateReporter * reporter)
@@ -436,7 +436,7 @@ gst_validate_reporter_get_name (GstValidateReporter * reporter)
  * gst_validate_reporter_get_runner:
  * @reporter: The reporter to get the runner from
  *
- * Returns: (transfer full): The runner
+ * Returns: (transfer full)(nullable): The runner
  */
 GstValidateRunner *
 gst_validate_reporter_get_runner (GstValidateReporter * reporter)

diff --git a/subprojects/gst-devtools/validate/gst/validate/gst-validate-runner.c b/subprojects/gst-devtools/validate/gst/validate/gst-validate-runner.c
index cb6b8bf..f1f2f27 100644 (file)
--- a/subprojects/gst-devtools/validate/gst/validate/gst-validate-runner.c
+++ b/subprojects/gst-devtools/validate/gst/validate/gst-validate-runner.c
@@ -750,7 +750,7 @@ gst_validate_runner_add_report (GstValidateRunner * runner,
 
 /**
  * gst_validate_runner_get_reports_count:
- * @runner: The $GstValidateRunner to get the number of reports from
+ * @runner: The #GstValidateRunner to get the number of reports from
  *
  * Get the number of reports present in the runner:
  *
@@ -780,7 +780,7 @@ gst_validate_runner_get_reports_count (GstValidateRunner * runner)
  * gst_validate_runner_get_reports:
  * @runner: The #GstValidateRunner
  *
- * Returns: (element-type GstValidateReport) (transfer full): all the reports
+ * Returns: (element-type GstValidateReport) (transfer full): All the reports in a #GList of #GstValidateReportg
  */
 GList *
 gst_validate_runner_get_reports (GstValidateRunner * runner)

diff --git a/subprojects/gst-devtools/validate/gst/validate/media-descriptor.h b/subprojects/gst-devtools/validate/gst/validate/media-descriptor.h
index e7521e9..fffbae2 100644 (file)
--- a/subprojects/gst-devtools/validate/gst/validate/media-descriptor.h
+++ b/subprojects/gst-devtools/validate/gst/validate/media-descriptor.h
@@ -29,9 +29,9 @@
 
 G_BEGIN_DECLS
 
-#define GST_VALIDATE_UNKNOWN_UINT64 -1
+#define GST_VALIDATE_UNKNOWN_UINT64 - 1
 
-#define GST_VALIDATE_UNKNOWN_BOOL -1
+#define GST_VALIDATE_UNKNOWN_BOOL - 1
 
 typedef struct
 {