From c206569a648c6452e96481e3b1f3bcc61e138d9a Mon Sep 17 00:00:00 2001 From: Thibault Saunier Date: Mon, 8 Jun 2015 17:11:51 +0200 Subject: [PATCH] validate: Generate documentation for Validate plugins Summary: Depends on D215 Reviewers: Mathieu_Du Differential Revision: http://phabricator.freedesktop.org/D216 --- validate/configure.ac | 1 + validate/docs/Makefile.am | 4 +- validate/docs/plugins/Makefile.am | 63 +++++++++++++++++++ .../plugins/gst-validate-plugins-docs.sgml | 28 +++++++++ .../plugins/gst-validate-plugins-sections.txt | 9 +++ .../docs/plugins/gst-validate-plugins.sgml | 24 +++++++ .../docs/plugins/gst-validate-plugins.types | 1 + validate/docs/version.entities | 1 - validate/docs/version.entities.in | 1 + validate/plugins/Makefile.am | 4 ++ 10 files changed, 133 insertions(+), 3 deletions(-) create mode 100644 validate/docs/plugins/Makefile.am create mode 100644 validate/docs/plugins/gst-validate-plugins-docs.sgml create mode 100644 validate/docs/plugins/gst-validate-plugins-sections.txt create mode 100644 validate/docs/plugins/gst-validate-plugins.sgml create mode 100644 validate/docs/plugins/gst-validate-plugins.types delete mode 100644 validate/docs/version.entities diff --git a/validate/configure.ac b/validate/configure.ac index cfa3d9d9c3..122a88949d 100644 --- a/validate/configure.ac +++ b/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 diff --git a/validate/docs/Makefile.am b/validate/docs/Makefile.am index 80353a3fe8..6e692066cb 100644 --- a/validate/docs/Makefile.am +++ b/validate/docs/Makefile.am @@ -1,5 +1,5 @@ -SUBDIRS = validate -DIST_SUBDIRS = validate launcher +SUBDIRS = validate plugins +DIST_SUBDIRS = validate launcher plugins if HAVE_SPHINHX SUBDIRS += launcher diff --git a/validate/docs/plugins/Makefile.am b/validate/docs/plugins/Makefile.am new file mode 100644 index 0000000000..9a2f47ebff --- /dev/null +++ b/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 + diff --git a/validate/docs/plugins/gst-validate-plugins-docs.sgml b/validate/docs/plugins/gst-validate-plugins-docs.sgml new file mode 100644 index 0000000000..42dddd4fa4 --- /dev/null +++ b/validate/docs/plugins/gst-validate-plugins-docs.sgml @@ -0,0 +1,28 @@ + + +%version-entities; +]> + + + + GStreamer Validate Plugins &GST_API_VERSION; Plugins Reference Manual + + 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 + + http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-validate-plugins/html/ + . + + + + + GstValidate plugins + + + + + diff --git a/validate/docs/plugins/gst-validate-plugins-sections.txt b/validate/docs/plugins/gst-validate-plugins-sections.txt new file mode 100644 index 0000000000..242e4eb87a --- /dev/null +++ b/validate/docs/plugins/gst-validate-plugins-sections.txt @@ -0,0 +1,9 @@ +
+validate-ssim +Validate SSim plugin +VALIDATE_TYPE_S_SIM_OVERRIDE +ValidateSSimOverrideClass +validate_s_sim_override_new +ValidateSSimOverride +
+ diff --git a/validate/docs/plugins/gst-validate-plugins.sgml b/validate/docs/plugins/gst-validate-plugins.sgml new file mode 100644 index 0000000000..38736dd529 --- /dev/null +++ b/validate/docs/plugins/gst-validate-plugins.sgml @@ -0,0 +1,24 @@ + + +%version-entities; +]> + + + + 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 + http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-validate/html/. + + + + + gst-validate plugins + + + + + diff --git a/validate/docs/plugins/gst-validate-plugins.types b/validate/docs/plugins/gst-validate-plugins.types new file mode 100644 index 0000000000..9f4950e70d --- /dev/null +++ b/validate/docs/plugins/gst-validate-plugins.types @@ -0,0 +1 @@ +#include diff --git a/validate/docs/version.entities b/validate/docs/version.entities deleted file mode 100644 index 5d99c99cb7..0000000000 --- a/validate/docs/version.entities +++ /dev/null @@ -1 +0,0 @@ - diff --git a/validate/docs/version.entities.in b/validate/docs/version.entities.in index b66183d6ec..286989f56e 100644 --- a/validate/docs/version.entities.in +++ b/validate/docs/version.entities.in @@ -1 +1,2 @@ + diff --git a/validate/plugins/Makefile.am b/validate/plugins/Makefile.am index 3329fcc8be..97d117f2e6 100644 --- a/validate/plugins/Makefile.am +++ b/validate/plugins/Makefile.am @@ -3,3 +3,7 @@ SUBDIRS = fault_injection gapplication if HAVE_GTK SUBDIRS += gtk endif + +if HAVE_CAIRO +SUBDIRS += ssim +endif