Integrate documentation build and some random cleanup everywhere

5 files changed, 210 insertions, 1 deletions

diff --git a/docs/Makefile.am b/docs/Makefile.am
index a111605..31b3682 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1 +1 @@
-SUBDIRS = #insanity random
+SUBDIRS = insanity-gst
diff --git a/docs/insanity-gst/Makefile.am b/docs/insanity-gst/Makefile.am
new file mode 100644
index 0000000..2bb3f6b
--- /dev/null
+++ b/docs/insanity-gst/Makefile.am
@@ -0,0 +1,104 @@
+## 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=insanity-gst
+
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+DOC_MODULE_VERSION=1
+
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# Directories containing the source code.
+# gtk-doc will search all .c and .h files beneath these paths
+# for inline comments documenting functions and macros.
+# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
+DOC_SOURCE_DIR=$(top_srcdir)/lib/insanity-gst
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS=
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
+MKDB_OPTIONS=--xml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+MKTMPL_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkhtml
+MKHTML_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
+
+# 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)/lib/insanity-gst/*.h
+CFILE_GLOB=$(top_srcdir)/lib/insanity-gst/*.c
+
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+EXTRA_HFILES=
+
+# Header files or dirs to ignore when scanning. Use base file/dir names
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
+IGNORE_HFILES=config.h insanitygstprivate.h
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+HTML_IMAGES=
+
+# 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=
+
+# 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=
+
+# 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. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+GTKDOC_CFLAGS=-I$(top_srcdir)/lib $(GST_CFLAGS) $(INSANITY_CFLAGS) $(GLIB_CFLAGS) $(GOBJECT_CFLAGS) $(GTHREAD_CFLAGS)
+GTKDOC_LIBS=$(GST_LIBS) $(INSANITY_LIBS) $(GLIB_LIBS) $(GOBJECT_LIBS) $(GTHREAD_LIBS) -L$(top_builddir)/lib/insanity-gst/.libs -linsanity-gst-@LIBINSANITY_GST_API_VERSION@
+
+# 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 += version.xml.in
+
+# Files not to distribute
+# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
+# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
+#DISTCLEANFILES +=
+
+# Comment this out if you want 'make check' to test you doc status
+# and run some sanity checks
+if ENABLE_GTK_DOC
+TESTS_ENVIRONMENT = cd $(srcdir) && \
+  DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
+  SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
+#TESTS = $(GTKDOC_CHECK)
+endif
+
diff --git a/docs/insanity-gst/insanity-gst-docs.sgml b/docs/insanity-gst/insanity-gst-docs.sgml
new file mode 100644
index 0000000..b91a745
--- /dev/null
+++ b/docs/insanity-gst/insanity-gst-docs.sgml
@@ -0,0 +1,50 @@
+<?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 version SYSTEM "version.xml">
+  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+<book id="index">
+  <bookinfo>
+    <title>InsanityGst Reference Manual</title>
+    <releaseinfo>
+      for InsanityGst (&version;)
+    </releaseinfo>
+  </bookinfo>
+
+  <chapter>
+    <para>
+InsanityGst is cross-platform and works on most UNIX-like platforms as well as
+Windows.  It is released under the GNU Library General Public License
+(GNU LGPL).
+    </para>
+    
+    <!-- TODO: General information about insanity-gst here -->
+  </chapter>
+
+  <chapter>
+    <title>InsanityGst library</title>
+    <para>
+      InsanityGst provides API to write GStreamer Insanity tests in C
+      and via GObject-Introspection in any other language.
+    </para>
+        <xi:include href="xml/insanitygsttest.xml"/>
+        <xi:include href="xml/insanitygstpipelinetest.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>
+  <index id="deprecated-api-index" role="deprecated">
+    <title>Index of deprecated API</title>
+    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+  </index>
+
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>
diff --git a/docs/insanity-gst/insanity-gst-sections.txt b/docs/insanity-gst/insanity-gst-sections.txt
new file mode 100644
index 0000000..5496e36
--- /dev/null
+++ b/docs/insanity-gst/insanity-gst-sections.txt
@@ -0,0 +1,54 @@
+<SECTION>
+<FILE>insanity-gst</FILE>
+
+</SECTION>
+
+<SECTION>
+<FILE>insanitygsttest</FILE>
+<TITLE>InsanityGstTest</TITLE>
+InsanityGstTest
+InsanityGstTestClass
+
+insanity_gst_test_new
+
+InsanityGstDataProbeFunction
+insanity_gst_test_add_data_probe
+insanity_gst_test_remove_data_probe
+<SUBSECTION Standard>
+INSANITY_GST_TEST
+INSANITY_GST_TEST_CLASS
+INSANITY_GST_TEST_GET_CLASS
+INSANITY_IS_GST_TEST
+INSANITY_IS_GST_TEST_CLASS
+INSANITY_TYPE_GST_TEST
+InsanityGstTestPrivateData
+insanity_gst_test_get_type
+</SECTION>
+
+<SECTION>
+<FILE>insanitygstpipelinetest</FILE>
+<TITLE>InsanityGstPipelineTest</TITLE>
+InsanityGstPipelineTest
+InsanityGstPipelineTestClass
+
+insanity_gst_pipeline_test_new
+
+InsanityGstCreatePipelineFunction
+insanity_gst_pipeline_test_set_create_pipeline_function
+
+insanity_gst_pipeline_test_enable_buffering
+insanity_gst_pipeline_test_set_initial_state
+insanity_gst_pipeline_test_set_live
+
+insanity_gst_pipeline_test_query_duration
+<SUBSECTION Standard>
+INSANITY_GST_PIPELINE_TEST
+INSANITY_GST_PIPELINE_TEST_CLASS
+INSANITY_GST_PIPELINE_TEST_GET_CLASS
+INSANITY_IS_GST_PIPELINE_TEST
+INSANITY_IS_GST_PIPELINE_TEST_CLASS
+INSANITY_TYPE_GST_PIPELINE_TEST
+insanity_gst_pipeline_test_get_type
+InsanityGstPipelineTestPrivateData
+</SECTION>
+
diff --git a/docs/insanity-gst/version.xml.in b/docs/insanity-gst/version.xml.in
new file mode 100644
index 0000000..d78bda9
--- /dev/null
+++ b/docs/insanity-gst/version.xml.in
@@ -0,0 +1 @@
+@VERSION@