doc: Minor fixes

This commit is contained in:
Thibault Saunier 2018-10-22 11:38:24 +02:00
parent 22e179cbc1
commit 040b71a3d9
7 changed files with 12 additions and 1 deletions

View file

@ -22,6 +22,11 @@
#ifndef __GST_VALIDATE_ENUMS_H__ #ifndef __GST_VALIDATE_ENUMS_H__
#define __GST_VALIDATE_ENUMS_H__ #define __GST_VALIDATE_ENUMS_H__
/**
* SECTION: gst-validate-enums.h
* @title: GstValidate enums
*/
/** /**
* GstValidateReportingDetails: * GstValidateReportingDetails:
* @GST_VALIDATE_SHOW_NONE: No debugging level specified or desired. Used to deactivate * @GST_VALIDATE_SHOW_NONE: No debugging level specified or desired. Used to deactivate

View file

@ -23,6 +23,7 @@
/** /**
* SECTION:gst-validate-monitor-factory * SECTION:gst-validate-monitor-factory
* @title: GstValidateMonitorFactory
* @short_description: Lets you start monitoring a #GstObject with GstValidate * @short_description: Lets you start monitoring a #GstObject with GstValidate
* *
* To start monitoring and thus run GstValidate tests on a #GstPipeline, the only thing to * To start monitoring and thus run GstValidate tests on a #GstPipeline, the only thing to

View file

@ -39,6 +39,7 @@ static gboolean output_is_tty = TRUE;
/** /**
* SECTION:gst-validate-pipeline-monitor * SECTION:gst-validate-pipeline-monitor
* @title: GstValidatePipelineMonitor
* @short_description: Class that wraps a #GstPipeline for Validate checks * @short_description: Class that wraps a #GstPipeline for Validate checks
* *
* TODO * TODO

View file

@ -21,6 +21,7 @@
*/ */
/** /**
* SECTION:gst-validate-reporter * SECTION:gst-validate-reporter
* @title: GstValidateReporter
* @short_description: A #GInterface that allows #GObject to be used as originator of * @short_description: A #GInterface that allows #GObject to be used as originator of
* issues in the GstValidate reporting system * issues in the GstValidate reporting system
*/ */

View file

@ -53,6 +53,7 @@ static GstValidateRunner *first_runner = NULL;
/** /**
* SECTION:gst-validate-runner * SECTION:gst-validate-runner
* @title: GstValidateRunner
* @short_description: Class that runs Gst Validate tests for a pipeline * @short_description: Class that runs Gst Validate tests for a pipeline
* *
* Allows you to test a pipeline within GstValidate. It is the object where * Allows you to test a pipeline within GstValidate. It is the object where
@ -74,6 +75,7 @@ static GstValidateRunner *first_runner = NULL;
* gst_object_unref (runner); * gst_object_unref (runner);
* gst_object_unref (monitor); * gst_object_unref (monitor);
* ]| * ]|
*
*/ */
struct _GstValidateRunnerPrivate struct _GstValidateRunnerPrivate

View file

@ -24,6 +24,7 @@
*/ */
/** /**
* SECTION:gst-validate-scenario * SECTION:gst-validate-scenario
* @title: GstValidateScenario
* @short_description: A GstValidateScenario represents a set of actions to be executed on a pipeline. * @short_description: A GstValidateScenario represents a set of actions to be executed on a pipeline.
* *
* A #GstValidateScenario represents the scenario that will be executed on a #GstPipeline. * A #GstValidateScenario represents the scenario that will be executed on a #GstPipeline.
@ -605,7 +606,6 @@ _check_scenario_is_done (GstValidateScenario * scenario)
* @name: The name of the parameter for which to retrieve a time * @name: The name of the parameter for which to retrieve a time
* @retval: (out): The return value for the wanted time * @retval: (out): The return value for the wanted time
* *
*
* Get a time value for the @name parameter of an action. This * Get a time value for the @name parameter of an action. This
* method should be called to retrieve and compute a timed value of a given * method should be called to retrieve and compute a timed value of a given
* action. It will first try to retrieve the value as a double, * action. It will first try to retrieve the value as a double,

View file

@ -22,6 +22,7 @@
*/ */
/** /**
* SECTION:validate * SECTION:validate
* @title: Initialization
* @short_description: Initialize GstValidate * @short_description: Initialize GstValidate
*/ */