summaryrefslogtreecommitdiffstats
path: root/ext/annodex
diff options
context:
space:
mode:
authorStefan Kost <ensonic@users.sf.net>2009-01-28 17:46:06 +0200
committerStefan Kost <ensonic@users.sf.net>2009-01-28 18:05:09 +0200
commit9cf73bdd8f18505269fa4b6d1d80127945e735b1 (patch)
tree799b0f7efa6d37844173fbd636bc58254cbccd78 /ext/annodex
parent1f32369451bd5ddf7a59defef7900d508ee144da (diff)
Update and add documentation for plugins with deps (ext).
Link to properties. Correct titles for examples. Document a few trivial cases. Keep lists in section file and docs/plugins/Makefile.am alphabetically ordered. Fix warnings that gtk-doc points out.
Diffstat (limited to 'ext/annodex')
-rw-r--r--ext/annodex/gstcmmldec.c9
-rw-r--r--ext/annodex/gstcmmlenc.c10
2 files changed, 9 insertions, 10 deletions
diff --git a/ext/annodex/gstcmmldec.c b/ext/annodex/gstcmmldec.c
index 75038c61..765a0a12 100644
--- a/ext/annodex/gstcmmldec.c
+++ b/ext/annodex/gstcmmldec.c
@@ -25,17 +25,16 @@
* SECTION:element-cmmldec
* @see_also: cmmlenc, oggdemux
*
- * <refsect2>
- * <para>
* Cmmldec extracts a CMML document from a CMML bitstream.<ulink
* url="http://www.annodex.net/TR/draft-pfeiffer-cmml-02.html">CMML</ulink> is
* an XML markup language for time-continuous data maintained by the <ulink
* url="http:/www.annodex.org/">Annodex Foundation</ulink>.
- * </para>
+ *
+ * <refsect2>
* <title>Example pipeline</title>
- * <programlisting>
+ * |[
* gst-launch -v filesrc location=annotated.ogg ! oggdemux ! cmmldec ! filesink location=annotations.cmml
- * </programlisting>
+ * ]|
* </refsect2>
*/
diff --git a/ext/annodex/gstcmmlenc.c b/ext/annodex/gstcmmlenc.c
index 9b2c03c6..f3b65e55 100644
--- a/ext/annodex/gstcmmlenc.c
+++ b/ext/annodex/gstcmmlenc.c
@@ -25,16 +25,16 @@
* SECTION:element-cmmlenc
* @see_also: cmmldec, oggmux
*
- * <refsect2>
- * <para> Cmmlenc encodes a CMML document into a CMML stream. <ulink
+ * Cmmlenc encodes a CMML document into a CMML stream. <ulink
* url="http://www.annodex.net/TR/draft-pfeiffer-cmml-02.html">CMML</ulink> is
* an XML markup language for time-continuous data maintained by the <ulink
* url="http:/www.annodex.org/">Annodex Foundation</ulink>.
- * </para>
+ *
+ * <refsect2>
* <title>Example pipeline</title>
- * <programlisting>
+ * |[
* gst-launch -v filesrc location=annotations.cmml ! cmmlenc ! oggmux name=mux ! filesink location=annotated.ogg
- * </programlisting>
+ * ]|
* </refsect2>
*/