Enable documentation.

Original commit message from CVS:
2005-11-06  Julien MOUTTE  <julien@moutte.net>

* Makefile.am:
* autogen.sh:
* configure.ac:
* docs/Makefile.am:
* docs/plugins/.cvsignore:
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-bad-plugins-decl-list.txt:
* docs/plugins/gst-plugins-bad-plugins-decl.txt:
* docs/plugins/gst-plugins-bad-plugins-docs.sgml:
* docs/plugins/gst-plugins-bad-plugins-sections.txt:
* docs/plugins/gst-plugins-bad-plugins-undocumented.txt:
* docs/plugins/gst-plugins-bad-plugins.args:
* docs/plugins/gst-plugins-bad-plugins.hierarchy:
* docs/plugins/gst-plugins-bad-plugins.interfaces:
* docs/plugins/gst-plugins-bad-plugins.prerequisites:
* docs/plugins/gst-plugins-bad-plugins.signals:
* docs/plugins/gst-plugins-bad-plugins.types:
* docs/plugins/inspect/plugin-dfbvideosink.xml:
* docs/version.entities.in: Enable documentation.
* examples/Makefile.am:
* examples/directfb/Makefile.am:
* examples/directfb/decker.ttf:
* examples/directfb/dfblogo.png:
* examples/directfb/gstdfb.c: (myclock), (dynamic_link),
(size_changed), (setup_dynamic_link), (main): Add an example
application for DirectFB.

17 files changed, 378 insertions, 0 deletions

diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644
index 000000000..2b9075b79
--- /dev/null
+++ b/docs/Makefile.am
@@ -0,0 +1,12 @@
+if ENABLE_GTK_DOC
+GTK_DOC_DIRS = plugins
+else
+GTK_DOC_DIRS =
+endif
+
+SUBDIRS = $(GTK_DOC_DIRS)
+DIST_SUBDIRS = plugins
+
+EXTRA_DIST = \
+        random/ChangeLog-0.8 \
+        version.entities.in
diff --git a/docs/plugins/.gitignore b/docs/plugins/.gitignore
new file mode 100644
index 000000000..2ef1402d1
--- /dev/null
+++ b/docs/plugins/.gitignore
@@ -0,0 +1,18 @@
+Makefile
+Makefile.in
+
+*-decl.txt
+*-decl-list.txt
+*-undocumented.txt
+*-unused.txt
+
+*.args
+*.hierarchy
+*.interfaces
+*.prerequisites
+*.signals
+
+html
+sgml
+xml
+*.stamp
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
new file mode 100644
index 000000000..3ac322d59
--- /dev/null
+++ b/docs/plugins/Makefile.am
@@ -0,0 +1,113 @@
+GST_DOC_SCANOBJ = $(top_srcdir)/common/gstdoc-scangobj
+
+## Process this file with automake to produce Makefile.in
+
+# The name of the module, e.g. 'glib'.
+#DOC_MODULE=gst-plugins-libs-@GST_MAJORMINOR@
+MODULE=gst-plugins-bad
+DOC_MODULE=$(MODULE)-plugins
+
+# for upload.mak
+DOC=$(MODULE)-plugins
+FORMATS=html
+html: html-build.stamp
+include $(top_srcdir)/common/upload-doc.mak
+
+# generated basefiles
+#basefiles = \
+##		$(DOC_MODULE).types \
+#		$(DOC_MODULE)-sections.txt \
+#		$(DOC_MODULE)-docs.sgml
+
+# ugly hack to make -unused.sgml work
+#unused-build.stamp:
+#	BUILDDIR=`pwd` && \
+#	cd $(srcdir)/tmpl && \
+#	ln -sf gstreamer-libs-unused.sgml \
+#		$$BUILDDIR/tmpl/gstreamer-libs-@GST_MAJORMINOR@-unused.sgml
+#	touch unused-build.stamp
+
+# these rules are added to create parallel docs using GST_MAJORMINOR
+#$(basefiles): gstreamer-libs-@GST_MAJORMINOR@%: gstreamer-libs%
+#	cp $< $@
+
+#CLEANFILES = $(basefiles)
+
+# The top-level SGML file. Change it if you want.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# The directory containing the source code. Relative to $(top_srcdir).
+# gtk-doc will search all .c & .h files beneath here for inline comments
+# documenting functions and macros.
+DOC_SOURCE_DIR = $(top_srcdir)
+
+# Extra options to supply to gtkdoc-scan.
+SCAN_OPTIONS=
+
+# FIXME :
+# there's something wrong with gstreamer-sections.txt not being in the dist
+# maybe it doesn't resolve; we're adding it below for now
+#EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt gstreamer-sections.txt $(DOC_MAIN_SGML_FILE)
+
+# Extra options to supply to gtkdoc-mkdb.
+MKDB_OPTIONS=--sgml-mode
+
+# Extra options to supply to gtkdoc-fixref.
+# FIXME get the location of the installed gstreamer docs
+#FIXXREF_OPTIONS=--extra-dir=../gst/html
+
+# Used for dependencies.
+HFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.h
+CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.c
+
+# this is a wingo addition
+# thomasvs: another nice wingo addition would be an explanation on why
+# this is useful ;)
+
+SCANOBJ_DEPS =
+
+# Header files to ignore when scanning.
+IGNORE_HFILES = 
+IGNORE_CFILES =
+
+# we add all .h files of elements that have signals/args we want
+# sadly this also pulls in the private methods - maybe we should
+# move those around in the source ?
+# also, we should add some stuff here conditionally based on whether
+# or not the plugin will actually build
+# but I'm not sure about that - it might be this Just Works given that
+# the registry won't have the element
+
+# FIXME: not ported yet
+#	$(top_srcdir)/ext/gnomevfs/gstgnomevfssink.c 
+
+# example code that needs to be converted to xml and placed in xml/
+EXAMPLE_CFILES = \
+        $(top_srcdir)/ext/directfb/dfb-example.c
+
+EXTRA_HFILES = \
+	$(top_srcdir)/ext/directfb/dfbvideosink.h
+
+# 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) -I$(top_builddir)
+GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_BASE_LIBS)
+
+GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
+GTKDOC_LD=$(LIBTOOL) --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-plugins.mak
diff --git a/docs/plugins/gst-plugins-bad-plugins-decl-list.txt b/docs/plugins/gst-plugins-bad-plugins-decl-list.txt
new file mode 100644
index 000000000..ad63ed4bd
--- /dev/null
+++ b/docs/plugins/gst-plugins-bad-plugins-decl-list.txt
@@ -0,0 +1,18 @@
+<SECTION>
+<FILE>dfbvideosink</FILE>
+GST_TYPE_DFBSURFACE
+GST_IS_DFBSURFACE
+GST_DFBSURFACE
+GstDfbSurface
+GstDfbVMode
+<TITLE>GstDfbVideoSink</TITLE>
+gst_dfbsurface_get_type
+<SUBSECTION Standard>
+GST_DFBVIDEOSINK
+GST_IS_DFBVIDEOSINK
+GST_TYPE_DFBVIDEOSINK
+gst_dfbvideosink_get_type
+GST_DFBVIDEOSINK_CLASS
+GST_IS_DFBVIDEOSINK_CLASS
+</SECTION>
+
diff --git a/docs/plugins/gst-plugins-bad-plugins-decl.txt b/docs/plugins/gst-plugins-bad-plugins-decl.txt
new file mode 100644
index 000000000..4e7cf514c
--- /dev/null
+++ b/docs/plugins/gst-plugins-bad-plugins-decl.txt
@@ -0,0 +1,119 @@
+<MACRO>
+<NAME>GST_TYPE_DFBVIDEOSINK</NAME>
+#define GST_TYPE_DFBVIDEOSINK              (gst_dfbvideosink_get_type())
+</MACRO>
+<MACRO>
+<NAME>GST_DFBVIDEOSINK</NAME>
+#define GST_DFBVIDEOSINK(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_DFBVIDEOSINK, GstDfbVideoSink))
+</MACRO>
+<MACRO>
+<NAME>GST_DFBVIDEOSINK_CLASS</NAME>
+#define GST_DFBVIDEOSINK_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_DFBVIDEOSINK, GstDfbVideoSink))
+</MACRO>
+<MACRO>
+<NAME>GST_IS_DFBVIDEOSINK</NAME>
+#define GST_IS_DFBVIDEOSINK(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_DFBVIDEOSINK))
+</MACRO>
+<MACRO>
+<NAME>GST_IS_DFBVIDEOSINK_CLASS</NAME>
+#define GST_IS_DFBVIDEOSINK_CLASS(obj)     (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_DFBVIDEOSINK))
+</MACRO>
+<STRUCT>
+<NAME>GstDfbVideoSink</NAME>
+</STRUCT>
+<STRUCT>
+<NAME>GstDfbVideoSinkClass</NAME>
+</STRUCT>
+<MACRO>
+<NAME>GST_TYPE_DFBSURFACE</NAME>
+#define GST_TYPE_DFBSURFACE (gst_dfbsurface_get_type())
+</MACRO>
+<MACRO>
+<NAME>GST_IS_DFBSURFACE</NAME>
+#define GST_IS_DFBSURFACE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_DFBSURFACE))
+</MACRO>
+<MACRO>
+<NAME>GST_DFBSURFACE</NAME>
+#define GST_DFBSURFACE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_DFBSURFACE, GstDfbSurface))
+</MACRO>
+<STRUCT>
+<NAME>GstDfbSurface</NAME>
+</STRUCT>
+<STRUCT>
+<NAME>GstDfbSurface</NAME>
+struct _GstDfbSurface {
+  GstBuffer buffer; /* We extend GstBuffer */
+  
+  IDirectFBSurface *surface;
+  
+  gint width;
+  gint height;
+  
+  gboolean locked;
+  
+  DFBSurfacePixelFormat pixel_format;
+  
+  GstDfbVideoSink *dfbvideosink;
+};
+</STRUCT>
+<STRUCT>
+<NAME>GstDfbVMode</NAME>
+</STRUCT>
+<STRUCT>
+<NAME>GstDfbVMode</NAME>
+struct _GstDfbVMode {
+  gint width;
+  gint height;
+  gint bpp;
+};
+</STRUCT>
+<STRUCT>
+<NAME>GstDfbVideoSink</NAME>
+struct _GstDfbVideoSink {
+  /* Our element stuff */
+  GstVideoSink videosink;
+  
+  GSList *buffer_pool;
+  
+  gdouble framerate;
+  gint video_width, video_height; /* size of incoming video */
+  gint out_width, out_height;
+  
+  /* Standalone */
+  IDirectFB *dfb;
+  
+  GSList *vmodes; /* Video modes */
+  
+  gint layer_id;
+  IDirectFBDisplayLayer *layer;
+  IDirectFBSurface *primary;
+  IDirectFBEventBuffer *event_buffer;
+  GThread *event_thread;
+  
+  /* Embedded */
+  IDirectFBSurface *ext_surface;
+  
+  DFBSurfacePixelFormat pixel_format;
+  
+  gboolean hw_scaling;
+  gboolean backbuffer;
+  gboolean setup;
+  gboolean running;
+};
+</STRUCT>
+<STRUCT>
+<NAME>GstDfbVideoSinkClass</NAME>
+struct _GstDfbVideoSinkClass {
+  GstVideoSinkClass parent_class;
+};
+</STRUCT>
+<FUNCTION>
+<NAME>gst_dfbvideosink_get_type</NAME>
+<RETURNS>GType </RETURNS>
+void
+</FUNCTION>
+<FUNCTION>
+<NAME>gst_dfbsurface_get_type</NAME>
+<RETURNS>GType </RETURNS>
+void
+</FUNCTION>
diff --git a/docs/plugins/gst-plugins-bad-plugins-docs.sgml b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
new file mode 100644
index 000000000..44c115fab
--- /dev/null
+++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
@@ -0,0 +1,25 @@
+<?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 Bad Plugins &GST_MAJORMINOR; Plugins Reference Manual</title>
+  </bookinfo>
+
+  <chapter>
+    <title>gst-plugins-bad Elements</title>
+
+    <xi:include href="xml/element-dfbvideosink.xml" />
+  </chapter>
+
+  <chapter>
+    <title>gst-plugins-bad Plugins</title>
+
+    <xi:include href="xml/plugin-dfbvideosink.xml" />
+
+  </chapter>
+</book>
diff --git a/docs/plugins/gst-plugins-bad-plugins-overrides.txt b/docs/plugins/gst-plugins-bad-plugins-overrides.txt
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/docs/plugins/gst-plugins-bad-plugins-overrides.txt
diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt
new file mode 100644
index 000000000..da82aa0cb
--- /dev/null
+++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt
@@ -0,0 +1,8 @@
+<SECTION>
+<FILE>element-dfbvideosink</FILE>
+GstDfbVideoSink
+<TITLE>dfbvideosink</TITLE>
+<SUBSECTION Standard>
+GstDfbVideoSinkClass
+</SECTION>
+
diff --git a/docs/plugins/gst-plugins-bad-plugins-undocumented.txt b/docs/plugins/gst-plugins-bad-plugins-undocumented.txt
new file mode 100644
index 000000000..298053bef
--- /dev/null
+++ b/docs/plugins/gst-plugins-bad-plugins-undocumented.txt
@@ -0,0 +1,9 @@
+75% symbol docs coverage.
+3 symbols documented.
+0 symbols incomplete.
+1 not documented.
+
+
+GstDfbVideoSink
+
+
diff --git a/docs/plugins/gst-plugins-bad-plugins.args b/docs/plugins/gst-plugins-bad-plugins.args
new file mode 100644
index 000000000..91294e2a1
--- /dev/null
+++ b/docs/plugins/gst-plugins-bad-plugins.args
@@ -0,0 +1,9 @@
+<ARG>
+<NAME>GstDfbVideoSink::surface</NAME>
+<TYPE>gpointer</TYPE>
+<RANGE></RANGE>
+<FLAGS>w</FLAGS>
+<NICK>Destination surface</NICK>
+<BLURB>Render video frames to this surface. The pointer you pass here has to point to an IDirectFBSurface * interface</BLURB>
+<DEFAULT>NULL</DEFAULT>
+</ARG>
diff --git a/docs/plugins/gst-plugins-bad-plugins.hierarchy b/docs/plugins/gst-plugins-bad-plugins.hierarchy
new file mode 100644
index 000000000..5f18922a3
--- /dev/null
+++ b/docs/plugins/gst-plugins-bad-plugins.hierarchy
@@ -0,0 +1,20 @@
+GObject
+  GstObject
+    GstPad
+    GstPluginFeature
+      GstElementFactory
+      GstTypeFindFactory
+      GstIndexFactory
+    GstElement
+      GstBin
+        GstPipeline
+      GstQueue
+      GstBaseSink
+        GstVideoSink
+          GstDfbVideoSink
+    GstPlugin
+    GstRegistry
+    GstPadTemplate
+  GstSignalObject
+GInterface
+  GstChildProxy
diff --git a/docs/plugins/gst-plugins-bad-plugins.interfaces b/docs/plugins/gst-plugins-bad-plugins.interfaces
new file mode 100644
index 000000000..fc9ba12c3
--- /dev/null
+++ b/docs/plugins/gst-plugins-bad-plugins.interfaces
@@ -0,0 +1,2 @@
+GstBin GstChildProxy
+GstPipeline GstChildProxy
diff --git a/docs/plugins/gst-plugins-bad-plugins.prerequisites b/docs/plugins/gst-plugins-bad-plugins.prerequisites
new file mode 100644
index 000000000..f526a9f60
--- /dev/null
+++ b/docs/plugins/gst-plugins-bad-plugins.prerequisites
@@ -0,0 +1 @@
+GstChildProxy GstObject
diff --git a/docs/plugins/gst-plugins-bad-plugins.signals b/docs/plugins/gst-plugins-bad-plugins.signals
new file mode 100644
index 000000000..8b1378917
--- /dev/null
+++ b/docs/plugins/gst-plugins-bad-plugins.signals
@@ -0,0 +1 @@
+
diff --git a/docs/plugins/gst-plugins-bad-plugins.types b/docs/plugins/gst-plugins-bad-plugins.types
new file mode 100644
index 000000000..9f4950e70
--- /dev/null
+++ b/docs/plugins/gst-plugins-bad-plugins.types
@@ -0,0 +1 @@
+#include <gst/gst.h>
diff --git a/docs/plugins/inspect/plugin-dfbvideosink.xml b/docs/plugins/inspect/plugin-dfbvideosink.xml
new file mode 100644
index 000000000..83f5fb4e8
--- /dev/null
+++ b/docs/plugins/inspect/plugin-dfbvideosink.xml
@@ -0,0 +1,20 @@
+<plugin>
+  <name>dfbvideosink</name>
+  <description>DirectFB video sink</description>
+  <filename>../../ext/directfb/.libs/libgstdfbvideosink.so</filename>
+  <basename>libgstdfbvideosink.so</basename>
+  <version>0.9.4</version>
+  <license>LGPL</license>
+  <source>gst-plugins-bad</source>
+  <package>GStreamer source release</package>
+  <origin>http://gstreamer.freedesktop.org/</origin>
+  <elements>
+    <element>
+      <name>dfbvideosink</name>
+      <longname>DirectFB video sink</longname>
+      <class>Sink/Video</class>
+      <description>DirectFB video sink</description>
+      <author>Julien Moutte &lt;julien@moutte.net&gt;</author>
+    </element>
+  </elements>
+</plugin>
diff --git a/docs/version.entities.in b/docs/version.entities.in
new file mode 100644
index 000000000..79a68981d
--- /dev/null
+++ b/docs/version.entities.in
@@ -0,0 +1,2 @@
+<!ENTITY GST_MAJORMINOR "@GST_MAJORMINOR@">
+<!ENTITY GST_VERSION "@VERSION@">