Add gtkdoc support

Documentation is not complete yet.

6 files changed, 158 insertions, 0 deletions

diff --git a/Makefile.am b/Makefile.am
index 7b8aa4d..9db41d9 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,6 +1,7 @@
 DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc
 
 SUBDIRS = 			\
+	docs			\
 	gst-libs 		\
 	ext			\
 	gst		 	\
@@ -9,6 +10,7 @@ SUBDIRS = 			\
 	pkgconfig
 
 DIST_SUBDIRS = 			\
+	docs			\
 	gst-libs		\
 	ext			\
 	gst			\
diff --git a/configure.ac b/configure.ac
index 87c6916..d38e882 100644
--- a/configure.ac
+++ b/configure.ac
@@ -285,6 +285,9 @@ dnl *** output files ***
 
 AC_CONFIG_FILES(
 Makefile
+docs/Makefile
+docs/libs/Makefile
+docs/version.entities
 ext/Makefile
 ext/pango/Makefile
 ext/xlib/Makefile
diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644
index 0000000..2ca6b96
--- /dev/null
+++ b/docs/Makefile.am
@@ -0,0 +1,8 @@
+SUBDIRS = libs
+
+EXTRA_DIST = \
+        version.entities.in
+
+upload:
+	@if test "x$(SUBDIRS)" != x; then for a in $(SUBDIRS); do cd $$a; make upload; cd ..; done; fi
+
diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am
new file mode 100644
index 0000000..4d8ec42
--- /dev/null
+++ b/docs/libs/Makefile.am
@@ -0,0 +1,99 @@
+## Process this file with automake to produce Makefile.in
+
+# The name of the module, e.g. 'glib'.
+#DOC_MODULE=gst-plugins-libs-@GST_MAJORMINOR@
+DOC_MODULE=gst-plugins-cairo-libs
+
+# for upload-doc.mak
+DOC=gst-plugins-cairo-libs
+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)/gst-libs/gst
+DOC_BUILD_DIR=$(top_builddir)/gst-libs/gst
+
+# Extra options to supply to gtkdoc-scan.
+SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED"
+
+# 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  --output-format=xml
+
+# Extra options to supply to gtkdoc-fixref.
+FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
+	--extra-dir=$(GST_PREFIX)/share/gtk-doc/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 = \
+	$(top_builddir)/gst-libs/gst/cairo/libgstcairo-@GST_MAJORMINOR@.la
+
+# Header files to ignore when scanning.
+IGNORE_HFILES = \
+	gstcairobuffer-private.h \
+	gstcairoformat-private.h \
+	gstcairoxbuffer.h \
+	gstcairoxdisplay.h \
+	gstcairocaps2format.h \
+	gstcairocapsany.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 = -I$(top_srcdir)/gst-libs $(GST_CAIRO_CFLAGS) $(GST_BASE_CFLAGS) $(CAIRO_CFLAGS)
+GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_BASE_LIBS) $(CAIRO_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/docs/libs/gst-plugins-cairo-libs-sections.txt b/docs/libs/gst-plugins-cairo-libs-sections.txt
new file mode 100644
index 0000000..321d056
--- /dev/null
+++ b/docs/libs/gst-plugins-cairo-libs-sections.txt
@@ -0,0 +1,42 @@
+<SECTION>
+<FILE>gstcairobuffer</FILE>
+<TITLE>GstCairoBuffer</TITLE>
+gst_cairo_buffer_new
+gst_cairo_buffer_new_similar
+gst_cairo_buffer_is_fixed
+gst_cairo_buffer_set_format
+gst_cairo_create_surface
+gst_cairo_create_similar_surface
+</SECTION>
+
+<SECTION>
+<FILE>gstcairopad</FILE>
+gst_cairo_pad_template_new
+GstCairoRestrictCapsFunction
+gst_cairo_pad_alloc_buffer
+gst_cairo_pad_alloc_buffer_full
+</SECTION>
+
+<SECTION>
+<FILE>gstcairoformat</FILE>
+GstCairoFormatOption
+GstCairoFormat
+gst_cairo_format_new
+gst_cairo_format_copy
+gst_cairo_format_free
+gst_cairo_format_to_caps
+gst_cairo_format_is_native
+gst_cairo_format_get_width
+gst_cairo_format_get_height
+gst_cairo_format_get_buffer_size
+gst_cairo_format_get_framerate
+gst_cairo_format_get_pixel_aspect_ratio
+gst_cairo_format_equal
+</SECTION>
+
+<SECTION>
+<FILE>gstcairocaps</FILE>
+gst_cairo_caps_any
+gst_cairo_caps_expand
+</SECTION>
+
diff --git a/docs/libs/gst-plugins-cairo-libs.types b/docs/libs/gst-plugins-cairo-libs.types
new file mode 100644
index 0000000..c79fc2d
--- /dev/null
+++ b/docs/libs/gst-plugins-cairo-libs.types
@@ -0,0 +1,4 @@
+#include <gst/gst.h>
+#include <gst/cairo/gstcairo.h>
+
+