docs: Fix docstrings

diff --git a/docs/gst-validate-transcoding.md b/docs/gst-validate-transcoding.md
index 6d1f7c0..419dca1 100644 (file)
--- a/docs/gst-validate-transcoding.md
+++ b/docs/gst-validate-transcoding.md
@@ -32,7 +32,7 @@ This is the serialization format of a [GstEncodingProfile](GstEncodingProfile).
 
 Internally the transcoding application uses [GstEncodeBin](encodebin).
 `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.
 
 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.
 
 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
 corresponds to the restriction [GstCaps](GstCaps) to apply before the encoder
 that will be used in the profile. The fields present in restriction caps

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

diff --git a/validate/gst/validate/gst-validate-runner.c b/validate/gst/validate/gst-validate-runner.c
index 199273e..5d928e3 100644 (file)
--- a/validate/gst/validate/gst-validate-runner.c
+++ b/validate/gst/validate/gst-validate-runner.c
@@ -785,7 +785,7 @@ _do_report_synthesis (GstValidateRunner * runner)
  * @runner: The #GstValidateRunner to print all the reports for
  *
  * 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
  * error has been detected. That return value is usually to be used as

diff --git a/validate/gst/validate/gst-validate-scenario.c b/validate/gst/validate/gst-validate-scenario.c
index 42dec01..fff4a1e 100644 (file)
--- a/validate/gst/validate/gst-validate-scenario.c
+++ b/validate/gst/validate/gst-validate-scenario.c
@@ -31,7 +31,7 @@
  * It is basically an ordered list of #GstValidateAction that will be executed during the
  * 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
  *    milliseconds (1/1000ths of a second), between which actions
  *    will be executed, setting it to 0 means "execute in idle".

diff --git a/validate/gst/validate/validate.c b/validate/gst/validate/validate.c
index b541edc..f69cef4 100644 (file)
--- a/validate/gst/validate/validate.c
+++ b/validate/gst/validate/validate.c
@@ -172,7 +172,7 @@ create_config (const gchar * config, const gchar * suffix)
 
 /**
  * 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
  * is #NULL