From 4565bb1c01da2e378314a1d8e9e22c237191ca9f Mon Sep 17 00:00:00 2001
From: Stefan Sauer <ensonic@users.sf.net>
Date: Sun, 4 Mar 2012 21:54:08 +0100
Subject: [PATCH] shm: add minimal doc blobs

---
 sys/shm/gstshmsink.c | 14 ++++++++++++--
 sys/shm/gstshmsrc.c  | 16 +++++++++++++++-
 2 files changed, 27 insertions(+), 3 deletions(-)

diff --git a/sys/shm/gstshmsink.c b/sys/shm/gstshmsink.c
index fd7ffb4..ec2a4c3 100644
--- a/sys/shm/gstshmsink.c
+++ b/sys/shm/gstshmsink.c
@@ -18,8 +18,18 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
-
-
+/**
+ * SECTION:element-shmsink
+ *
+ * Send data over shared memory to the matching source.
+ *
+ * <refsect2>
+ * <title>Example launch lines</title>
+ * |[
+ * gst-launch -v videotestsrc !  shmsink socket-path=/tmp/blah shm-size=1000000
+ * ]| Send video to shm buffers.
+ * </refsect2>
+ */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/sys/shm/gstshmsrc.c b/sys/shm/gstshmsrc.c
index cff5d46..fe086b7 100644
--- a/sys/shm/gstshmsrc.c
+++ b/sys/shm/gstshmsrc.c
@@ -18,6 +18,20 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+/**
+ * SECTION:element-shmsrc
+ *
+ * Receive data from the shared memory sink.
+ *
+ * <refsect2>
+ * <title>Example launch lines</title>
+ * |[
+ * gst-launch shmsrc socket-path=/tmp/blah ! \
+ * "video/x-raw-yuv, format=(fourcc)YUY2, color-matrix=(string)sdtv, \
+ * chroma-site=(string)mpeg2, width=(int)320, height=(int)240, framerate=(fraction)30/1" ! autovideosink
+ * ]| Render video from shm buffers.
+ * </refsect2>
+ */
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"
@@ -90,7 +104,7 @@ gst_shm_src_base_init (gpointer g_class)
   gst_element_class_set_details_simple (element_class,
       "Shared Memory Source",
       "Source",
-      "Receive data from the sharem memory sink",
+      "Receive data from the shared memory sink",
       "Olivier Crete <olivier.crete@collabora.co.uk>");
 }
 
-- 
2.7.4