docs: unify doc style

Use gtkdoc syntax and add short desc for the examples.
This commit is contained in:
Stefan Kost 2010-02-16 09:49:05 +02:00
parent cbbfba3152
commit d8fd8ea9e9
2 changed files with 6 additions and 6 deletions

View file

@ -36,9 +36,9 @@
*
* <refsect2>
* <title>Example launch line</title>
* <programlisting>
* |[
* gst-launch audiotestsrc wave=sine num-buffers=100 ! audioconvert ! faac ! matroskamux ! filesink location=sine.mkv
* </programlisting>
* ]| Encode a sine beep as aac and write to matroska container.
* </refsect2>
*/

View file

@ -26,12 +26,12 @@
*
* <refsect2>
* <title>Example launch lines</title>
* <programlisting>
* |[
* gst-launch filesrc location=example.mp4 ! qtdemux ! faad ! audioconvert ! audioresample ! autoaudiosink
* </programlisting>
* <programlisting>
* ]| Play aac from mp4 file.
* |[
* gst-launch filesrc location=example.adts ! faad ! audioconvert ! audioresample ! autoaudiosink
* </programlisting>
* ]| Play standalone aac bitstream.
* </refsect2>
*/