Add plugins documentation template.

This commit is contained in:
gb 2010-03-23 14:19:21 +00:00
parent 123eb732ff
commit 49689f8f1e
7 changed files with 167 additions and 1 deletions

View file

@ -206,6 +206,8 @@ debian/libgstvaapi-x11.install.in
docs/reference/Makefile
docs/reference/libs/Makefile
docs/reference/libs/libs-docs.xml
docs/reference/plugins/Makefile
docs/reference/plugins/plugins-docs.xml
gst-libs/Makefile
gst-libs/gst/Makefile
gst-libs/gst/vaapi/Makefile

View file

@ -1,4 +1,4 @@
SUBDIRS = libs
SUBDIRS = libs plugins
# Extra clean files so that maintainer-clean removes *everything*
MAINTAINERCLEANFILES = Makefile.in

View file

@ -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

View file

@ -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>

View file

@ -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>

View file

@ -0,0 +1,2 @@
gst_vaapisink_get_type
gst_vaapiconvert_get_type