From aac0f505007749d75858bb0ff676f4ba7a0341d1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?V=C3=ADctor=20Manuel=20J=C3=A1quez=20Leal?=
 <victorx.jaquez@intel.com>
Date: Tue, 29 Mar 2016 13:50:00 +0200
Subject: [PATCH] docs: generate vaapijpegdec documentation

https://bugzilla.gnome.org/show_bug.cgi?id=764314
---
 .../gstreamer-vaapi-plugins-docs.xml.in       |  1 +
 .../gstreamer-vaapi-plugins-sections.txt      | 15 +++++------
 gst/vaapi/gstvaapidecode.c                    | 25 +++++++++++++++++++
 3 files changed, 34 insertions(+), 7 deletions(-)

diff --git a/docs/plugins/gstreamer-vaapi-plugins-docs.xml.in b/docs/plugins/gstreamer-vaapi-plugins-docs.xml.in
index 6626e0e443..c9cb5fc1f4 100644
--- a/docs/plugins/gstreamer-vaapi-plugins-docs.xml.in
+++ b/docs/plugins/gstreamer-vaapi-plugins-docs.xml.in
@@ -12,6 +12,7 @@
   <chapter>
     <title>gstreamer-vaapi Elements</title>
     <xi:include href="xml/element-vaapidecode.xml"/>
+    <xi:include href="xml/element-vaapijpegdec.xml"/>
     <xi:include href="xml/element-vaapidecodebin.xml"/>
     <xi:include href="xml/element-vaapipostproc.xml"/>
     <xi:include href="xml/element-vaapisink.xml"/>
diff --git a/docs/plugins/gstreamer-vaapi-plugins-sections.txt b/docs/plugins/gstreamer-vaapi-plugins-sections.txt
index bdd34f2c91..e3bc8e4031 100644
--- a/docs/plugins/gstreamer-vaapi-plugins-sections.txt
+++ b/docs/plugins/gstreamer-vaapi-plugins-sections.txt
@@ -2,15 +2,16 @@
 <FILE>element-vaapidecode</FILE>
 <TITLE>vaapidecode</TITLE>
 <SUBSECTION Standard>
-GST_IS_VAAPIDECODE
-GST_IS_VAAPIDECODE_CLASS
-GST_TYPE_VAAPIDECODE
-GST_VAAPIDECODE
-GST_VAAPIDECODE_CLASS
-GST_VAAPIDECODE_GET_CLASS
 GstVaapiDecode
 GstVaapiDecodeClass
-gst_vaapidecode_get_type
+</SECTION>
+
+<SECTION>
+<FILE>element-vaapijpegdec</FILE>
+<TITLE>vaapijpegdec</TITLE>
+<SUBSECTION Standard>
+GstVaapiDecode_jpeg
+GstVaapiDecode_jpegClass
 </SECTION>
 
 <SECTION>
diff --git a/gst/vaapi/gstvaapidecode.c b/gst/vaapi/gstvaapidecode.c
index 7dac9b6268..0f7f3ea830 100644
--- a/gst/vaapi/gstvaapidecode.c
+++ b/gst/vaapi/gstvaapidecode.c
@@ -47,6 +47,31 @@
  * </refsect2>
  */
 
+/**
+ * SECTION:element-vaapijpegdec
+ * @short_description: A VA-API based JPEG image decoder
+ *
+ * vaapijpegdec decodes a JPEG image to surfaces suitable for the
+ * vaapisink or vaapipostproc elements using the installed <ulink
+ * url="https://wiki.freedesktop.org/www/Software/vaapi/">VA-API</ulink>
+ * back-end.
+ *
+ * In the case of OpenGL based elements, the buffers have the
+ * #GstVideoGLTextureUploadMeta meta, which efficiently copies the
+ * content of the VA-API surface into a GL texture.
+ *
+ * Also it can deliver normal video buffers that can be rendered or
+ * processed by other elements, but the performance would be rather
+ * bad.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 filesrc location=~/image.jpeg ! jpegparse ! vaapijpegdec ! imagefreeze ! vaapisink
+ * ]|
+ * </refsect2>
+ */
+
 #include "gstcompat.h"
 #include <gst/vaapi/gstvaapidisplay.h>