diff options
| author | Thibault Saunier <thibault.saunier@osg.samsung.com> | 2017-01-23 16:36:11 -0300 |
|---|---|---|
| committer | Thibault Saunier <thibault.saunier@osg.samsung.com> | 2017-03-10 18:19:17 -0300 |
| commit | 099ac9faf2c6e6fcf55fe4bee812c9f90aeb8602 (patch) | |
| tree | e1c72b6424115e95c69fad3f9e39bff6979e0b20 /gst/audiotestsrc | |
| parent | a122135194c693edaeb14a1ecddf946d76523d2f (diff) | |
| download | gstreamer-plugins-base-099ac9faf2c6e6fcf55fe4bee812c9f90aeb8602.tar.gz | |
docs: Convert gtkdoc comments to markdown
Modernizing the documentation, making it simpler to read an
modify and allowing us to possibly switch to hotdoc in the
future.
Diffstat (limited to 'gst/audiotestsrc')
| -rw-r--r-- | gst/audiotestsrc/gstaudiotestsrc.c | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/gst/audiotestsrc/gstaudiotestsrc.c b/gst/audiotestsrc/gstaudiotestsrc.c index 51b25907d..bd1f88c5e 100644 --- a/gst/audiotestsrc/gstaudiotestsrc.c +++ b/gst/audiotestsrc/gstaudiotestsrc.c @@ -18,22 +18,24 @@ */ /** * SECTION:element-audiotestsrc + * @title: audiotestsrc * * AudioTestSrc can be used to generate basic audio signals. It support several * different waveforms and allows to set the base frequency and volume. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 audiotestsrc ! audioconvert ! autoaudiosink - * ]| This pipeline produces a sine with default frequency, 440 Hz, and the + * ]| + * This pipeline produces a sine with default frequency, 440 Hz, and the * default volume, 0.8 (relative to a maximum 1.0). * |[ * gst-launch-1.0 audiotestsrc wave=2 freq=200 ! tee name=t ! queue ! audioconvert ! autoaudiosink t. ! queue ! audioconvert ! libvisual_lv_scope ! videoconvert ! autovideosink - * ]| In this example a saw wave is generated. The wave is shown using a + * ]| + * In this example a saw wave is generated. The wave is shown using a * scope visualizer from libvisual, allowing you to visually verify that * the saw wave is correct. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H |