docs: unify doc style
authorStefan Kost <ensonic@users.sf.net>
Tue, 16 Feb 2010 07:49:05 +0000 (09:49 +0200)
committerStefan Kost <ensonic@users.sf.net>
Tue, 16 Feb 2010 07:49:05 +0000 (09:49 +0200)
Use gtkdoc syntax and add short desc for the examples.

ext/faac/gstfaac.c
ext/faad/gstfaad.c

index 176c735..16c5fdc 100644 (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>
  */
 
index de9f32b..2ed9189 100644 (file)
  *
  * <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>
  */