summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorgb <gb@5584edef-b1fe-4b99-b61b-dd2bab72e969>2010-03-23 14:19:21 +0000
committergb <gb@5584edef-b1fe-4b99-b61b-dd2bab72e969>2010-03-23 14:19:21 +0000
commit49689f8f1eecc99c49d726ffdc79b57d3a51566a (patch)
tree2ce401ffbf4f740c3d34ca48e312af35e150d60b /docs
parent123eb732ff4a4bf9d428adcd902dcb7d39bc518a (diff)
Add plugins documentation template.
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/Makefile.am2
-rw-r--r--docs/reference/plugins/Makefile.am105
-rw-r--r--docs/reference/plugins/plugins-docs.xml.in29
-rw-r--r--docs/reference/plugins/plugins-overrides.txt0
-rw-r--r--docs/reference/plugins/plugins-sections.txt28
-rw-r--r--docs/reference/plugins/plugins.types2
6 files changed, 165 insertions, 1 deletions
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index d29d4576..3eef00ec 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -1,4 +1,4 @@
-SUBDIRS = libs
+SUBDIRS = libs plugins
# Extra clean files so that maintainer-clean removes *everything*
MAINTAINERCLEANFILES = Makefile.in
diff --git a/docs/reference/plugins/Makefile.am b/docs/reference/plugins/Makefile.am
new file mode 100644
index 00000000..778dc967
--- /dev/null
+++ b/docs/reference/plugins/Makefile.am
@@ -0,0 +1,105 @@
+## Process this file with automake to produce Makefile.in
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# This is a blank Makefile.am for using gtk-doc.
+# Copy this to your project's API docs directory and modify the variables to
+# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
+# of using the various options.
+
+# The name of the module, e.g. 'glib'.
+DOC_MODULE = plugins
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml
+
+# The directory containing the source code. Relative to $(srcdir).
+# gtk-doc will search all .c & .h files beneath here for inline comments
+# documenting the functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk
+DOC_SOURCE_DIR = $(top_srcdir)/sys
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS = --type-init-func="gst_init(NULL, NULL)"
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS = --deprecated-guards="GST_VAAPI_DISABLE_DEPRECATED"
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS = --sgml-mode --output-format=xml --name-space=$(DOC_MODULE)
+
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+MKTMPL_OPTIONS =
+
+# Extra options to supply to gtkdoc-fixref. Not normally needed.
+# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
+FIXXREF_OPTIONS = \
+ --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \
+ --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \
+ --extra-dir=$(CAIRO_PREFIX)/share/gtk-doc/html/cairo \
+ --extra-dir=$(PANGO_PREFIX)/share/gtk-doc/html/pango
+
+# Used for dependencies. The docs will be rebuilt if any of these change.
+# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
+# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
+HFILE_GLOB = $(top_srcdir)/sys/*/*.h
+CFILE_GLOB = $(top_srcdir)/sys/*/*.c
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES = \
+ $(NULL)
+
+EXTRA_HFILES = \
+ $(NULL)
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+HTML_IMAGES = \
+ $(NULL)
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
+content_files = \
+ $(NULL)
+
+# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# These files must be listed here *and* in content_files
+# e.g. expand_content_files=running.sgml
+expand_content_files = \
+ $(NULL)
+
+# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
+# Only needed if you are using gtkdoc-scangobj to dynamically query widget
+# signals and properties.
+# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+
+INCLUDES = \
+ -I$(top_srcdir) \
+ -I$(top_srcdir)/gst-libs \
+ -I$(top_srcdir)/gst-libs/gst/vaapi \
+ $(GLIB_CFLAGS)
+
+GTKDOC_LIBS = \
+ $(top_builddir)/gst-libs/gst/vaapi/libgstvaapi-$(GST_MAJORMINOR).la \
+ $(top_builddir)/gst-libs/gst/vaapi/libgstvaapi-x11-$(GST_MAJORMINOR).la \
+ $(top_builddir)/sys/vaapiconvert/libgstvaapiconvert.la \
+ $(top_builddir)/sys/vaapisink/libgstvaapisink.la \
+ $(GLIB_LIBS)
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+# e.g. EXTRA_DIST += version.xml.in
+EXTRA_DIST += \
+ $(DOC_MODULE)-docs.xml.in \
+ $(NULL)
+
+# Extra clean files so that maintainer-clean removes *everything*
+MAINTAINERCLEANFILES = Makefile.in $(DOC_MODULE)-docs.xml
diff --git a/docs/reference/plugins/plugins-docs.xml.in b/docs/reference/plugins/plugins-docs.xml.in
new file mode 100644
index 00000000..fbc2cf5a
--- /dev/null
+++ b/docs/reference/plugins/plugins-docs.xml.in
@@ -0,0 +1,29 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+<book id="index">
+ <bookinfo>
+ <title>GStreamer VA-API Plugins @GST_MAJORMINOR@ Plugins Reference Manual</title>
+ </bookinfo>
+
+ <chapter>
+ <title>gst-plugins-vaapi Plugins</title>
+ <xi:include href="xml/gstvaapiconvert.xml"/>
+ <xi:include href="xml/gstvaapisink.xml"/>
+ </chapter>
+
+ <chapter id="object-tree">
+ <title>Object Hierarchy</title>
+ <xi:include href="xml/tree_index.sgml"/>
+ </chapter>
+
+ <index id="api-index-full">
+ <title>API Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+
+ <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>
diff --git a/docs/reference/plugins/plugins-overrides.txt b/docs/reference/plugins/plugins-overrides.txt
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/docs/reference/plugins/plugins-overrides.txt
diff --git a/docs/reference/plugins/plugins-sections.txt b/docs/reference/plugins/plugins-sections.txt
new file mode 100644
index 00000000..8853004e
--- /dev/null
+++ b/docs/reference/plugins/plugins-sections.txt
@@ -0,0 +1,28 @@
+<SECTION>
+<FILE>gstvaapisink</FILE>
+<TITLE>GstVaapiSink</TITLE>
+GstVaapiSink
+<SUBSECTION Standard>
+GST_VAAPISINK
+GST_IS_VAAPISINK
+GST_TYPE_VAAPISINK
+gst_vaapisink_get_type
+GST_VAAPISINK_CLASS
+GST_IS_VAAPISINK_CLASS
+GST_VAAPISINK_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gstvaapiconvert</FILE>
+<TITLE>GstVaapiConvert</TITLE>
+GstVaapiConvert
+<SUBSECTION Standard>
+GST_VAAPICONVERT
+GST_IS_VAAPICONVERT
+GST_TYPE_VAAPICONVERT
+gst_vaapiconvert_get_type
+GST_VAAPICONVERT_CLASS
+GST_IS_VAAPICONVERT_CLASS
+GST_VAAPICONVERT_GET_CLASS
+</SECTION>
+
diff --git a/docs/reference/plugins/plugins.types b/docs/reference/plugins/plugins.types
new file mode 100644
index 00000000..fab5f67f
--- /dev/null
+++ b/docs/reference/plugins/plugins.types
@@ -0,0 +1,2 @@
+gst_vaapisink_get_type
+gst_vaapiconvert_get_type