From 56b3efb077bba2189f5e128782683b75055360d5 Mon Sep 17 00:00:00 2001
From: Thijs Vermeir <thijsvermeir@gmail.com>
Date: Fri, 23 Jan 2009 21:46:13 +0100
Subject: Add documentation for aspectratiocrop

---
 gst/videocrop/gstaspectratiocrop.c | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

(limited to 'gst/videocrop/gstaspectratiocrop.c')

diff --git a/gst/videocrop/gstaspectratiocrop.c b/gst/videocrop/gstaspectratiocrop.c
index 2c0407b8..2cdd51ca 100644
--- a/gst/videocrop/gstaspectratiocrop.c
+++ b/gst/videocrop/gstaspectratiocrop.c
@@ -17,6 +17,21 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-aspectratiocrop
+ * @see_also: #GstVideoCrop
+ *
+ * This element crops video frames to a specified aspect-ratio.
+ *
+ * If the aspect-ratio is already correct, the element will operate in pass-through mode.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[gst-launch -v videotestsrc ! video/x-raw-rgb,height=640,width=480 ! aspectratiocrop aspect-ratio=16/9 ! ximagesink]|
+ * This pipeline generates a videostream in 4/3 and crops it to 16/9.
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
-- 
cgit