validate: Generate documentation for Validate plugins

Summary: Depends on D215

Reviewers: Mathieu_Du

Differential Revision: http://phabricator.freedesktop.org/D216

validate/configure.ac

@@ -331,6 +331,7 @@ launcher/apps/Makefile
 docs/Makefile
 docs/version.entities
 docs/validate/Makefile
+docs/plugins/Makefile
 docs/launcher/Makefile
 ])
 AC_OUTPUT

validate/docs/Makefile.am

@@ -1,5 +1,5 @@
-SUBDIRS = validate
+SUBDIRS = validate plugins
-DIST_SUBDIRS = validate launcher
+DIST_SUBDIRS = validate launcher plugins
 
 if HAVE_SPHINHX
 SUBDIRS += launcher

validate/docs/plugins/Makefile.am

@@ -0,0 +1,63 @@
+GST_DOC_SCANOBJ = $(top_srcdir)/common/gstdoc-scangobj
+
+# The name of the module, e.g. 'glib'.
+MODULE=gst-validate
+DOC_MODULE=$(MODULE)-plugins
+
+# for upload-doc.mak
+DOC=$(MODULE)-plugins
+FORMATS=html
+html: html-build.stamp
+include $(top_srcdir)/common/upload-doc.mak
+
+# The top-level SGML file. Change it if you want.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# The directory containing the source code.
+# gtk-doc will search all .c & .h files beneath here for inline comments
+# documenting functions and macros.
+DOC_SOURCE_DIR = $(top_srcdir)/plugins/
+
+# Extra options to supply to gtkdoc-scan.
+SCAN_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkdb.
+MKDB_OPTIONS=--sgml-mode
+
+# Extra options to supply to gtkdoc-fixref.
+FIXXREF_OPTIONS=--extra-dir=$(top_builddir)/docs/gst/html \
+	--extra-dir=$(top_builddir)/docs/libs/html \
+	--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
+	--extra-dir=$(datadir)/gtk-doc/html
+
+# Used for dependencies.
+CFILE_GLOB=$(top_srcdir)/plugins/*/*.c
+
+# Header files to ignore when scanning.
+IGNORE_HFILES =
+IGNORE_CFILES =
+
+# Images to copy into HTML directory.
+HTML_IMAGES =
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+content_files =
+
+# Other files to distribute.
+extra_files =
+
+# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
+# contains GtkObjects/GObjects and you want to document signals and properties.
+GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) $(GST_OBJ_CFLAGS) -I$(top_builddir) -I$(top_builddir)/gst-libs
+GTKDOC_LIBS = $(GST_BASE_LIBS)
+
+GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
+GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC)
+
+# If you need to override some of the declarations, place them in this file
+# and uncomment this line.
+#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
+DOC_OVERRIDES =
+
+include $(top_srcdir)/common/gtk-doc.mak
+

validate/docs/plugins/gst-validate-plugins-docs.sgml

@@ -0,0 +1,28 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!ENTITY % version-entities SYSTEM "version.entities">
+%version-entities;
+]>
+
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+  <bookinfo>
+    <title>GStreamer Validate Plugins &GST_API_VERSION; Plugins Reference Manual</title>
+    <releaseinfo>
+      GStreamer Validate Plugins &GST_API_VERSION; Plugins Reference Manual
+      for GStreamer Validate &GST_API_VERSION; (&GST_VERSION;)
+      The latest version of this documentation can be found on-line at
+      <ulink role="online-location"
+        url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-validate-plugins/html/">
+        http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-validate-plugins/html/
+      </ulink>.
+    </releaseinfo>
+  </bookinfo>
+
+  <chapter>
+    <title>GstValidate plugins</title>
+    <xi:include href="xml/validate-ssim.xml"/>
+  </chapter>
+</book>
+
+

validate/docs/plugins/gst-validate-plugins-sections.txt

@@ -0,0 +1,9 @@
+<SECTION>
+<FILE>validate-ssim</FILE>
+<TITLE>Validate SSim plugin</TITLE>
+VALIDATE_TYPE_S_SIM_OVERRIDE
+ValidateSSimOverrideClass
+validate_s_sim_override_new
+ValidateSSimOverride
+</SECTION>
+

validate/docs/plugins/gst-validate-plugins.sgml

@@ -0,0 +1,24 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!ENTITY % version-entities SYSTEM "version.entities">
+%version-entities;
+]>
+
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+  <bookinfo>
+    <title>GStreamer Validate Plugins &GST_API_VERSION; Plugins Reference Manual</title>
+    <releaseinfo>
+      for GStreamer Validate &GST_API_VERSION; (&GST_VERSION;)
+      The latest version of this documentation can be found on-line at
+      <ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-validate/html/</ulink>.
+    </releaseinfo>
+  </bookinfo>
+
+  <chapter>
+    <title>gst-validate plugins</title>
+    <xi:include href="xml/ssim.xml" />
+  </chapter>
+</book>
+
+

validate/docs/plugins/gst-validate-plugins.types

@@ -0,0 +1 @@
+#include <gst/gst.h>

validate/docs/version.entities

@@ -1 +0,0 @@
-<!ENTITY GST_API_VERSION "1.0">

validate/docs/version.entities.in

@@ -1 +1,2 @@
 <!ENTITY GST_API_VERSION "@GST_API_VERSION@">
+<!ENTITY GST_VERSION "@VERSION@">

validate/plugins/Makefile.am

@@ -3,3 +3,7 @@ SUBDIRS = fault_injection gapplication
 if HAVE_GTK
 SUBDIRS += gtk
 endif
+
+if HAVE_CAIRO
+SUBDIRS += ssim
+endif