From 6335307b9739beb568f986bfc8a4c1e1fb2b8e31 Mon Sep 17 00:00:00 2001
From: Stefan Kost <ensonic@users.sf.net>
Date: Thu, 29 Jan 2009 10:10:08 +0200
Subject: Update and add documentation for platform specific plugins (sys).

Link to properties. Correct titles for examples. Fix examples.
---
 sys/osxvideo/osxvideosink.m | 24 ++++++++++--------------
 1 file changed, 10 insertions(+), 14 deletions(-)

(limited to 'sys/osxvideo')

diff --git a/sys/osxvideo/osxvideosink.m b/sys/osxvideo/osxvideosink.m
index a72171ee..3022197d 100644
--- a/sys/osxvideo/osxvideosink.m
+++ b/sys/osxvideo/osxvideosink.m
@@ -26,23 +26,19 @@
 /**
  * SECTION:element-osxvideosink
  *
- * <refsect2>
- * <para>
  * The OSXVideoSink renders video frames to a MacOSX window. The video output
  * can be directed to a window embedded in an existing NSApp. This can be done
- * by setting the "embed" property to #TRUE. When the NSView to be embedded is
- * created an element #GstMessage with a name of 'have-ns-view' will be created
- * and posted on the bus. The pointer to the NSView to embed will be in the
- * 'nsview' field of that message. If no embedding is requested, the plugin will
- * create a standalone window.
- * </para>
+ * by setting the #GstOSXVideoSink:embed property to %TRUE. When the NSView to
+ * be embedded is created an element #GstMessage with a name of 'have-ns-view'
+ * will be created and posted on the bus. The pointer to the NSView to embed
+ * will be in the 'nsview' field of that message. If no embedding is requested,
+ * the plugin will create a standalone window.
+ *
+ * <refsect2>
  * <title>Examples</title>
- * <para>
- * Simple timeline to test the sink :
- * <programlisting>
- * gst-launch-0.10 -v videotestsrc ! osxvideosink
- * </programlisting>
- * </para>
+ * |[
+ * gst-launch-0.10 videotestsrc ! osxvideosink
+ * ]| test the sink
  * </refsect2>
  */
 
-- 
cgit