effectv: Add basic documentation for the effectv elements

[platform/upstream/gstreamer.git] / gst / effectv / gstshagadelic.c

diff --git a/gst/effectv/gstshagadelic.c b/gst/effectv/gstshagadelic.c
index 1eea4df..769eb23 100644 (file)
--- a/gst/effectv/gstshagadelic.c
+++ b/gst/effectv/gstshagadelic.c
@@ -22,6 +22,19 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-shagadelictv
+ *
+ * Oh behave, ShagedelicTV makes images shagadelic!
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch -v videotestsrc ! shagadelictv ! ffmpegcolorspace ! autovideosink
+ * ]| This pipeline shows the effect of shagadelictv on a test stream.
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif