From 9cf73bdd8f18505269fa4b6d1d80127945e735b1 Mon Sep 17 00:00:00 2001
From: Stefan Kost <ensonic@users.sf.net>
Date: Wed, 28 Jan 2009 17:46:06 +0200
Subject: 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.
---
 ext/cairo/gsttextoverlay.c | 12 ++++++++++++
 ext/cairo/gsttimeoverlay.c | 13 +++++--------
 2 files changed, 17 insertions(+), 8 deletions(-)

(limited to 'ext/cairo')

diff --git a/ext/cairo/gsttextoverlay.c b/ext/cairo/gsttextoverlay.c
index 6ac993f1..6bdd6fd9 100644
--- a/ext/cairo/gsttextoverlay.c
+++ b/ext/cairo/gsttextoverlay.c
@@ -17,6 +17,18 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+/**
+ * SECTION:element-cairotextoverlay
+ *
+ * cairotextoverlay renders the text on top of the video frames.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch videotestsrc ! cairotextoverlay text="hello" ! autovideosink
+ * ]|
+ * </refsect2>
+ */
 
 #ifdef HAVE_CONFIG_H
 #include <config.h>
diff --git a/ext/cairo/gsttimeoverlay.c b/ext/cairo/gsttimeoverlay.c
index 8f1d03d1..5a2f016f 100644
--- a/ext/cairo/gsttimeoverlay.c
+++ b/ext/cairo/gsttimeoverlay.c
@@ -21,17 +21,14 @@
 /**
  * SECTION:element-cairotimeoverlay
  *
- * <refsect2>
- * <para>
  * cairotimeoverlay renders the buffer timestamp for each frame on top of
  * the frame.
- * </para>
+ *
+ * <refsect2>
  * <title>Example launch line</title>
- * <para>
- * <programlisting>
- * gst-launch -v -m videotestsrc ! cairotimeoverlay ! autovideosink
- * </programlisting>
- * </para>
+ * |[
+ * gst-launch videotestsrc ! cairotimeoverlay ! autovideosink
+ * ]|
  * </refsect2>
  */
 
-- 
cgit