mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-10-05 18:22:23 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: Fix docstrings

Browse source
This commit is contained in:
Thibault Saunier 2019-04-24 16:24:05 +00:00
parent 7161b21334
commit 85282e53ca
5 changed files with 8 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/gst-validate-transcoding.md
View file

@ -32,7 +32,7 @@ This is the serialization format of a [GstEncodingProfile](GstEncodingProfile).
Internally the transcoding application uses [GstEncodeBin](encodebin). Internally the transcoding application uses [GstEncodeBin](encodebin).
`gst-validate-transcoding-GST_API_VERSION` uses its own serialization `gst-validate-transcoding-GST_API_VERSION` uses its own serialization
format to describe the [`GstEncodeBin.profile`](GstEncodeBin--profile) property of the format to describe the [`GstEncodeBin.profile`](encodebin:profile) property of the
encodebin. encodebin.
The simplest serialized profile looks like: The simplest serialized profile looks like:
@ -59,7 +59,7 @@ This field allows you to specify how many times maximum a
[GstEncodingProfile](GstEncodingProfile) can be used inside an encodebin. [GstEncodingProfile](GstEncodingProfile) can be used inside an encodebin.
You can also use the `restriction_caps->encoded_format_caps` syntax to You can also use the `restriction_caps->encoded_format_caps` syntax to
specify the [restriction caps](GstEncodingProfile::restriction-caps) specify the [restriction caps](GstEncodingProfile:restriction-caps)
to be set on a [GstEncodingProfile](GstEncodingProfile). It to be set on a [GstEncodingProfile](GstEncodingProfile). It
corresponds to the restriction [GstCaps](GstCaps) to apply before the encoder corresponds to the restriction [GstCaps](GstCaps) to apply before the encoder
that will be used in the profile. The fields present in restriction caps that will be used in the profile. The fields present in restriction caps

7
docs/index.md
View file

@ -18,10 +18,9 @@ elements. The generated reports are ordered by level of importance from
"issue" to "critical". "issue" to "critical".
Some tools have been implemented to help developers validate and test Some tools have been implemented to help developers validate and test
their GstElement, you can have a look at the [command line tools their GstElement, see [gst-validate](gst-validate.md) for example.
section](command-line-tools.md) to find more information.
On top of that, the notion of a [validation scenario] has been On top of that, the notion of a [validation scenario](gst-validate-scenarios.md)
implemented so that developers can easily execute a set of actions on has been implemented so that developers can easily execute a set of actions on
pipelines to test real world interactive cases and reproduce existing pipelines to test real world interactive cases and reproduce existing
issues in a convenient way. issues in a convenient way.

2
validate/gst/validate/gst-validate-runner.c
View file

@ -785,7 +785,7 @@ _do_report_synthesis (GstValidateRunner * runner)
* @runner: The #GstValidateRunner to print all the reports for * @runner: The #GstValidateRunner to print all the reports for
* *
* Prints all the reports on the terminal or on wherever is set * Prints all the reports on the terminal or on wherever is set
* in the #GST_VALIDATE_FILE env variable. * in the `GST_VALIDATE_FILE` env variable.
* *
* Returns: 0 if no critical error has been found and 18 if a critical * Returns: 0 if no critical error has been found and 18 if a critical
* error has been detected. That return value is usually to be used as * error has been detected. That return value is usually to be used as

2
validate/gst/validate/gst-validate-scenario.c
View file

@ -31,7 +31,7 @@
* It is basically an ordered list of #GstValidateAction that will be executed during the * It is basically an ordered list of #GstValidateAction that will be executed during the
* execution of the pipeline. * execution of the pipeline.
* *
* Possible configurations (see #GST_VALIDATE_CONFIG): * Possible configurations (see [GST_VALIDATE_CONFIG](gst-validate-environment-variables.md)):
* * scenario-action-execution-interval: Sets the interval in * * scenario-action-execution-interval: Sets the interval in
* milliseconds (1/1000ths of a second), between which actions * milliseconds (1/1000ths of a second), between which actions
* will be executed, setting it to 0 means "execute in idle". * will be executed, setting it to 0 means "execute in idle".

2
validate/gst/validate/validate.c
View file

@ -172,7 +172,7 @@ create_config (const gchar * config, const gchar * suffix)
/** /**
* gst_validate_plugin_get_config: * gst_validate_plugin_get_config:
* @plugin, a #GstPlugin, or #NULL * @plugin: a #GstPlugin, or #NULL
* *
* Return the configuration specific to @plugin, or the "core" one if @plugin * Return the configuration specific to @plugin, or the "core" one if @plugin
* is #NULL * is #NULL