diff options
| author | Stefan Kost <ensonic@users.sf.net> | 2009-01-28 17:46:06 +0200 |
|---|---|---|
| committer | Stefan Kost <ensonic@users.sf.net> | 2009-01-28 18:05:09 +0200 |
| commit | 9cf73bdd8f18505269fa4b6d1d80127945e735b1 (patch) | |
| tree | 799b0f7efa6d37844173fbd636bc58254cbccd78 /ext/cairo | |
| parent | 1f32369451bd5ddf7a59defef7900d508ee144da (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/cairo')
| -rw-r--r-- | ext/cairo/gsttextoverlay.c | 12 | ||||
| -rw-r--r-- | ext/cairo/gsttimeoverlay.c | 13 |
2 files changed, 17 insertions, 8 deletions
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> */ |