validate: Introspection annotation cleanups

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1810>
This commit is contained in:
Philippe Normand 2022-03-02 13:11:43 +00:00
parent d07f2323fe
commit a9e3b05055
10 changed files with 32 additions and 9 deletions

View file

@ -191,6 +191,10 @@ gst_validate_bin_monitor_init (GstValidateBinMonitor * bin_monitor)
/** /**
* gst_validate_bin_monitor_new: * gst_validate_bin_monitor_new:
* @bin: (transfer none): a #GstBin to run Validate on * @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 * GstValidateBinMonitor *
gst_validate_bin_monitor_new (GstBin * bin, GstValidateRunner * runner, gst_validate_bin_monitor_new (GstBin * bin, GstValidateRunner * runner,

View file

@ -152,6 +152,10 @@ gst_validate_element_monitor_init (GstValidateElementMonitor * element_monitor)
/** /**
* gst_validate_element_monitor_new: * gst_validate_element_monitor_new:
* @element: (transfer none): a #GstElement to run Validate on * @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 * GstValidateElementMonitor *
gst_validate_element_monitor_new (GstElement * element, gst_validate_element_monitor_new (GstElement * element,

View file

@ -77,7 +77,7 @@ _get_reporting_level (GstValidateReporter * monitor)
* gst_validate_monitor_get_pipeline: * gst_validate_monitor_get_pipeline:
* @monitor: The monitor to get the pipeline from * @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. * target is in.
*/ */
GstPipeline * GstPipeline *
@ -90,7 +90,7 @@ gst_validate_monitor_get_pipeline (GstValidateMonitor * monitor)
* gst_validate_monitor_get_target: * gst_validate_monitor_get_target:
* @monitor: The monitor to get the target from * @monitor: The monitor to get the target from
* *
* Returns: (transfer full): The target object * Returns: (transfer full)(nullable): The target object
*/ */
GstObject * GstObject *
gst_validate_monitor_get_target (GstValidateMonitor * monitor) gst_validate_monitor_get_target (GstValidateMonitor * monitor)

View file

@ -1038,6 +1038,10 @@ gst_validate_pad_monitor_init (GstValidatePadMonitor * pad_monitor)
/** /**
* gst_validate_pad_monitor_new: * gst_validate_pad_monitor_new:
* @pad: (transfer none): a #GstPad to run Validate on * @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 * GstValidatePadMonitor *
gst_validate_pad_monitor_new (GstPad * pad, GstValidateRunner * runner, gst_validate_pad_monitor_new (GstPad * pad, GstValidateRunner * runner,

View file

@ -148,7 +148,7 @@ GST_VALIDATE_API
GType gst_validate_pad_monitor_get_type (void); GType gst_validate_pad_monitor_get_type (void);
GST_VALIDATE_API 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 G_END_DECLS

View file

@ -825,6 +825,10 @@ done:
/** /**
* gst_validate_pipeline_monitor_new: * gst_validate_pipeline_monitor_new:
* @pipeline: (transfer none): a #GstPipeline to run Validate on * @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 * GstValidatePipelineMonitor *
gst_validate_pipeline_monitor_new (GstPipeline * pipeline, gst_validate_pipeline_monitor_new (GstPipeline * pipeline,

View file

@ -25,6 +25,13 @@
# include "config.h" # include "config.h"
#endif #endif
/**
* SECTION:gstvalidatereport
* @title: GstValidateReport
* @short_description: A Validate report
* @see_also: #GstValidateRunner
*
*/
#include <stdlib.h> /* exit */ #include <stdlib.h> /* exit */
#include <stdio.h> /* fprintf */ #include <stdio.h> /* fprintf */

View file

@ -139,7 +139,7 @@ gst_validate_reporter_get_reporting_level (GstValidateReporter * reporter)
* gst_validate_reporter_get_pipeline: * gst_validate_reporter_get_pipeline:
* @reporter: The reporter to get the pipeline from * @reporter: The reporter to get the pipeline from
* *
* Returns: (transfer full) (allow-none): The #GstPipeline * Returns: (transfer full)(nullable): The #GstPipeline
*/ */
GstPipeline * GstPipeline *
gst_validate_reporter_get_pipeline (GstValidateReporter * reporter) gst_validate_reporter_get_pipeline (GstValidateReporter * reporter)
@ -436,7 +436,7 @@ gst_validate_reporter_get_name (GstValidateReporter * reporter)
* gst_validate_reporter_get_runner: * gst_validate_reporter_get_runner:
* @reporter: The reporter to get the runner from * @reporter: The reporter to get the runner from
* *
* Returns: (transfer full): The runner * Returns: (transfer full)(nullable): The runner
*/ */
GstValidateRunner * GstValidateRunner *
gst_validate_reporter_get_runner (GstValidateReporter * reporter) gst_validate_reporter_get_runner (GstValidateReporter * reporter)

View file

@ -750,7 +750,7 @@ gst_validate_runner_add_report (GstValidateRunner * runner,
/** /**
* gst_validate_runner_get_reports_count: * 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: * 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: * gst_validate_runner_get_reports:
* @runner: The #GstValidateRunner * @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 * GList *
gst_validate_runner_get_reports (GstValidateRunner * runner) gst_validate_runner_get_reports (GstValidateRunner * runner)

View file

@ -29,9 +29,9 @@
G_BEGIN_DECLS 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 typedef struct
{ {