docs/libs/tmpl/: Added sgml file templates for documentation

Original commit message from CVS:
* docs/libs/tmpl/gnl.sgml:
* docs/libs/tmpl/gnlcomposition.sgml:
* docs/libs/tmpl/gnlgroup.sgml:
* docs/libs/tmpl/gnlobject.sgml:
* docs/libs/tmpl/gnloperation.sgml:
* docs/libs/tmpl/gnlsource.sgml:
* docs/libs/tmpl/gnltimeline.sgml:
Added sgml file templates for documentation
* docs/libs/gnonlin.types:
* docs/libs/gnonlin-sections.txt:
* docs/libs/gnonlin-docs.sgml:
Added files for better hierarchy of documentation
* configure.ac:
* docs/Makefile.am:
* docs/version.entities.in:
* docs/libs/Makefile.am:
Added version.entities for documentation
* docs/libs/Makefile.am: (GTKDOC_LIBS): added libgnl.la dependency
* gnl/gnlsource.c: (source_getfunction): typo mistake
* gnonlin.pc.in: more corrections from Wouter Paesen for correct
dependency checks
* configure.ac: (GST_PLUGIN_LDFLAGS), (GST_REQ):
sanity corrections from Wouter Paesen

13 files changed, 824 insertions, 3 deletions

diff --git a/docs/Makefile.am b/docs/Makefile.am
index a65b32a..098ec8d 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -8,4 +8,4 @@ SUBDIRS = $(SUBDIRS_DOCS)
 DIST_SUBDIRS = libs
 
 EXTRA_DIST = \
-	upload.mak
+	upload.mak version.entities.in
diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am
index f9ea888..b27a192 100644
--- a/docs/libs/Makefile.am
+++ b/docs/libs/Makefile.am
@@ -208,11 +208,11 @@ html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
 	mkdir html
 	cp $(srcdir)/$(DOC_MAIN_SGML_FILE) html
 	cp -pr xml html
-#cp ../version.entities html
+	cp ../version.entities html
 	cd html && gtkdoc-mkhtml $(DOC_MODULE) $(DOC_MAIN_SGML_FILE)
 	rm -f html/$(DOC_MAIN_SGML_FILE)
 	rm -rf html/xml
-#rm -f html/version.entities
+	rm -f html/version.entities
 	test "x$(HTML_IMAGES)" = "x" || for i in "" $(HTML_IMAGES) ; do \
 	    if test "$$i" != ""; then cp $(srcdir)/$$i html ; fi; done
 	@echo '-- Fixing Crossreferences' 
diff --git a/docs/libs/gnonlin-docs.sgml b/docs/libs/gnonlin-docs.sgml
new file mode 100644
index 0000000..49dc1c2
--- /dev/null
+++ b/docs/libs/gnonlin-docs.sgml
@@ -0,0 +1,39 @@
+<?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;
+<!ENTITY Gnl SYSTEM "xml/gnl.xml">
+<!ENTITY GnlObject SYSTEM "xml/gnlobject.xml">
+<!ENTITY GnlSource SYSTEM "xml/gnlsource.xml">
+<!ENTITY GnlOperation SYSTEM "xml/gnloperation.xml">
+<!ENTITY GnlComposition SYSTEM "xml/gnlcomposition.xml">
+<!ENTITY GnlGroup SYSTEM "xml/gnlgroup.xml">
+<!ENTITY GnlTimeline SYSTEM "xml/gnltimeline.xml">
+
+<!ENTITY gnonlin-tree-index SYSTEM "xml/tree_index.sgml">
+
+]>
+<book id="index">
+  <bookinfo>
+    <title>GNonLin v&GNL_VERSION; Reference Manual</title>
+    <releaseinfo>For use with GStreamer Core v&GST_MAJORMINOR;</releaseinfo>
+  </bookinfo>
+
+  <chapter>
+    <title>GNonLin</title>
+
+    &Gnl;
+    &GnlObject;
+    &GnlSource;
+    &GnlOperation;
+    &GnlComposition;
+    &GnlGroup;
+    &GnlTimeline;
+  </chapter>
+  <chapter>
+    <title>Object Hierarchy</title>
+    &gnonlin-tree-index;
+  </chapter>
+</book>
diff --git a/docs/libs/gnonlin-sections.txt b/docs/libs/gnonlin-sections.txt
new file mode 100644
index 0000000..755773f
--- /dev/null
+++ b/docs/libs/gnonlin-sections.txt
@@ -0,0 +1,144 @@
+<SECTION>
+<FILE>gnlsource</FILE>
+<TITLE>GnlSource</TITLE>
+GnlSource
+GnlSourceClass
+gnl_source_new
+gnl_source_set_element
+gnl_source_get_element
+gnl_source_get_pad_for_stream
+<SUBSECTION Standard>
+GNL_SOURCE
+GNL_IS_SOURCE
+GNL_TYPE_SOURCE
+gnl_source_get_type
+GNL_SOURCE_CLASS
+GNL_IS_SOURCE_CLASS
+<SUBSECTION Private>
+gnl_source_details
+GnlSourcePrivate
+</SECTION>
+
+<SECTION>
+<FILE>gnlcomposition</FILE>
+GnlComposition
+GnlCompositionClass
+GnlFindMethod
+<TITLE>GnlComposition</TITLE>
+gnl_composition_new
+gnl_composition_add_object
+gnl_composition_remove_object
+gnl_composition_set_default_source
+gnl_composition_find_object
+<SUBSECTION Standard>
+GNL_COMPOSITION
+GNL_IS_COMPOSITION
+GNL_TYPE_COMPOSITION
+GNL_COMPOSITION_CLASS
+GNL_IS_COMPOSITION_CLASS
+<SUBSECTION Private>
+GnlCompositionEntry
+gnl_composition_get_type
+gnl_composition_details
+</SECTION>
+
+<SECTION>
+<FILE>gnlobject</FILE>
+GnlObject
+GnlObjectClass
+GnlObjectRateControl
+GnlCoverType
+GnlDirection
+<TITLE>GnlObject</TITLE>
+gnl_object_set_media_start_stop
+gnl_object_get_media_start_stop
+gnl_object_set_start_stop
+gnl_object_get_start_stop
+gnl_object_set_priority
+gnl_object_get_priority
+gnl_object_get_rate_control
+gnl_object_set_rate_control
+gnl_object_is_active
+gnl_object_set_active
+gnl_object_covers
+gnl_object_nearest_change
+gnl_object_to_media_time
+gnl_media_to_object_time
+<SUBSECTION Standard>
+GNL_OBJECT
+GNL_IS_OBJECT
+GNL_TYPE_OBJECT
+GNL_OBJECT_CLASS
+GNL_IS_OBJECT_CLASS
+<SUBSECTION Private>
+gnl_object_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gnltimeline</FILE>
+<TITLE>GnlTimeline</TITLE>
+GnlTimeline
+GnlTimelineClass
+gnl_timeline_new
+gnl_timeline_add_group
+gnl_timeline_get_pad_for_group
+<SUBSECTION Standard>
+GNL_TIMELINE
+GNL_IS_TIMELINE
+GNL_TYPE_TIMELINE
+gnl_timeline_get_type
+GNL_TIMELINE_CLASS
+GNL_IS_TIMELINE_CLASS
+<SUBSECTION Private>
+gnl_timeline_details
+GnlTimelineTimer
+</SECTION>
+
+<SECTION>
+<FILE>gnloperation</FILE>
+<TITLE>GnlOperation</TITLE>
+GnlOperation
+GnlOperationClass
+gnl_operation_new
+gnl_operation_get_num_sinks
+<SUBSECTION Standard>
+GNL_OPERATION
+GNL_IS_OPERATION
+GNL_TYPE_OPERATION
+gnl_operation_get_type
+GNL_OPERATION_CLASS
+GNL_IS_OPERATION_CLASS
+<SUBSECTION Private>
+gnl_operation_details
+</SECTION>
+
+<SECTION>
+<FILE>gnlgroup</FILE>
+<TITLE>GnlGroup</TITLE>
+GnlGroup
+GnlGroupClass
+gnl_group_new
+gnl_group_append_layer
+<SUBSECTION Standard>
+GNL_GROUP
+GNL_IS_GROUP
+GNL_TYPE_GROUP
+gnl_group_get_type
+GNL_GROUP_CLASS
+GNL_IS_GROUP_CLASS
+<SUBSECTION Private>
+gnl_group_details
+</SECTION>
+
+<SECTION>
+<FILE>gnl</FILE>
+GNL_VERSION_MAJOR
+GNL_VERSION_MINOR
+GNL_VERSION_MICRO
+gnl_init
+gnl_main
+gnl_main_quit
+<SUBSECTION Private>
+GST_CAT_DEFAULT
+gnl_marshal_OBJECT__STRING
+</SECTION>
diff --git a/docs/libs/gnonlin.types b/docs/libs/gnonlin.types
new file mode 100644
index 0000000..981177a
--- /dev/null
+++ b/docs/libs/gnonlin.types
@@ -0,0 +1,9 @@
+#include <gst/gst.h>
+#include <gnl/gnl.h>
+
+gnl_composition_get_type
+gnl_group_get_type
+gnl_object_get_type
+gnl_operation_get_type
+gnl_source_get_type
+gnl_timeline_get_type
\ No newline at end of file
diff --git a/docs/libs/tmpl/gnl.sgml b/docs/libs/tmpl/gnl.sgml
new file mode 100644
index 0000000..c0a88db
--- /dev/null
+++ b/docs/libs/tmpl/gnl.sgml
@@ -0,0 +1,62 @@
+<!-- ##### SECTION Title ##### -->
+Gnonlin
+
+<!-- ##### SECTION Short_Description ##### -->
+Non-linear editing library based on the GStreamer multimedia framework
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+GNonLin is a non-linear editing library built on top of the GStreamer multimedia
+framework to ease construction of non-linear editors (audio, video, ...).
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+The <ulink url="http://gstreamer.freedesktop.org/">GStreamer website</ulink> for
+further details.
+</para>
+
+<!-- ##### MACRO GNL_VERSION_MAJOR ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GNL_VERSION_MINOR ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GNL_VERSION_MICRO ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION gnl_init ##### -->
+<para>
+
+</para>
+
+@argc: 
+@argv: 
+
+
+<!-- ##### FUNCTION gnl_main ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION gnl_main_quit ##### -->
+<para>
+
+</para>
+
+
+
diff --git a/docs/libs/tmpl/gnlcomposition.sgml b/docs/libs/tmpl/gnlcomposition.sgml
new file mode 100644
index 0000000..20b59f3
--- /dev/null
+++ b/docs/libs/tmpl/gnlcomposition.sgml
@@ -0,0 +1,94 @@
+<!-- ##### SECTION Title ##### -->
+GnlComposition
+
+<!-- ##### SECTION Short_Description ##### -->
+Container to assemble and order #GnlObject
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+#GnlComposition are the base class for assembling #GnlObject through time. The
+main objects that can be assembled are #GnlSource and #GnlOperation , but it
+can receive any type of #GnlObject (#GnlComposition, #GnlTimeline, ...) that has
+ONE single output.
+</para>
+
+<para>
+The main idea behind #GnlComposition is to arrange ONE type of media (audio, or
+video, or ...) and then those #GnlComposition are combined in a #GnlTimeline.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT GnlComposition ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT GnlCompositionClass ##### -->
+<para>
+
+</para>
+
+@parent_class: 
+@nearest_cover: 
+
+<!-- ##### ENUM GnlFindMethod ##### -->
+<para>
+
+</para>
+
+@GNL_FIND_AT: 
+@GNL_FIND_AFTER: 
+@GNL_FIND_START: 
+
+<!-- ##### FUNCTION gnl_composition_new ##### -->
+<para>
+
+</para>
+
+@name: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gnl_composition_add_object ##### -->
+<para>
+
+</para>
+
+@comp: 
+@object: 
+
+
+<!-- ##### FUNCTION gnl_composition_remove_object ##### -->
+<para>
+
+</para>
+
+@comp: 
+@object: 
+
+
+<!-- ##### FUNCTION gnl_composition_set_default_source ##### -->
+<para>
+
+</para>
+
+@comp: 
+@source: 
+
+
+<!-- ##### FUNCTION gnl_composition_find_object ##### -->
+<para>
+
+</para>
+
+@comp: 
+@time: 
+@method: 
+@Returns: 
+
+
diff --git a/docs/libs/tmpl/gnlgroup.sgml b/docs/libs/tmpl/gnlgroup.sgml
new file mode 100644
index 0000000..da6ff0a
--- /dev/null
+++ b/docs/libs/tmpl/gnlgroup.sgml
@@ -0,0 +1,47 @@
+<!-- ##### SECTION Title ##### -->
+GnlGroup
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT GnlGroup ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT GnlGroupClass ##### -->
+<para>
+
+</para>
+
+@parent_class: 
+
+<!-- ##### FUNCTION gnl_group_new ##### -->
+<para>
+
+</para>
+
+@name: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gnl_group_append_layer ##### -->
+<para>
+
+</para>
+
+@group: 
+@layer: 
+
+
diff --git a/docs/libs/tmpl/gnlobject.sgml b/docs/libs/tmpl/gnlobject.sgml
new file mode 100644
index 0000000..5edfa4e
--- /dev/null
+++ b/docs/libs/tmpl/gnlobject.sgml
@@ -0,0 +1,233 @@
+<!-- ##### SECTION Title ##### -->
+GnlObject
+
+<!-- ##### SECTION Short_Description ##### -->
+Base class for GNonLin objects
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT GnlObject ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG GnlObject:active ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GnlObject:media-start ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GnlObject:media-stop ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GnlObject:priority ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GnlObject:rate-control ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GnlObject:start ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GnlObject:stop ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT GnlObjectClass ##### -->
+<para>
+
+</para>
+
+@parent_class: 
+@prepare: 
+@covers: 
+@nearest_change: 
+
+<!-- ##### ENUM GnlObjectRateControl ##### -->
+<para>
+
+</para>
+
+@GNL_OBJECT_INVALID_RATE_CONTROL: 
+@GNL_OBJECT_FIX_MEDIA_STOP: 
+@GNL_OBJECT_USE_MEDIA_STOP: 
+
+<!-- ##### ENUM GnlCoverType ##### -->
+<para>
+
+</para>
+
+@GNL_COVER_ALL: 
+@GNL_COVER_SOME: 
+@GNL_COVER_START: 
+@GNL_COVER_STOP: 
+
+<!-- ##### ENUM GnlDirection ##### -->
+<para>
+
+</para>
+
+@GNL_DIRECTION_FORWARD: 
+@GNL_DIRECTION_BACKWARD: 
+
+<!-- ##### FUNCTION gnl_object_set_media_start_stop ##### -->
+<para>
+
+</para>
+
+@object: 
+@start: 
+@stop: 
+
+
+<!-- ##### FUNCTION gnl_object_get_media_start_stop ##### -->
+<para>
+
+</para>
+
+@object: 
+@start: 
+@stop: 
+
+
+<!-- ##### FUNCTION gnl_object_set_start_stop ##### -->
+<para>
+
+</para>
+
+@object: 
+@start: 
+@stop: 
+
+
+<!-- ##### FUNCTION gnl_object_get_start_stop ##### -->
+<para>
+
+</para>
+
+@object: 
+@start: 
+@stop: 
+
+
+<!-- ##### FUNCTION gnl_object_set_priority ##### -->
+<para>
+
+</para>
+
+@object: 
+@priority: 
+
+
+<!-- ##### FUNCTION gnl_object_get_priority ##### -->
+<para>
+
+</para>
+
+@object: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gnl_object_get_rate_control ##### -->
+<para>
+
+</para>
+
+@object: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gnl_object_set_rate_control ##### -->
+<para>
+
+</para>
+
+@object: 
+@control: 
+
+
+<!-- ##### FUNCTION gnl_object_is_active ##### -->
+<para>
+
+</para>
+
+@object: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gnl_object_set_active ##### -->
+<para>
+
+</para>
+
+@object: 
+@active: 
+
+
+<!-- ##### FUNCTION gnl_object_covers ##### -->
+<para>
+
+</para>
+
+@object: 
+@start: 
+@stop: 
+@type: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gnl_object_nearest_change ##### -->
+<para>
+
+</para>
+
+@object: 
+@time: 
+@direction: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gnl_object_to_media_time ##### -->
+<para>
+
+</para>
+
+@object: 
+@objecttime: 
+@mediatime: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gnl_media_to_object_time ##### -->
+<para>
+
+</para>
+
+@object: 
+@mediatime: 
+@objecttime: 
+@Returns: 
+
+
diff --git a/docs/libs/tmpl/gnloperation.sgml b/docs/libs/tmpl/gnloperation.sgml
new file mode 100644
index 0000000..7221f68
--- /dev/null
+++ b/docs/libs/tmpl/gnloperation.sgml
@@ -0,0 +1,49 @@
+<!-- ##### SECTION Title ##### -->
+GnlOperation
+
+<!-- ##### SECTION Short_Description ##### -->
+Class for wrapping and using effects and filters in GNonLin
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+This class allows using effects and filters in compositions, accepting multiple
+inputs but just one output.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT GnlOperation ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT GnlOperationClass ##### -->
+<para>
+
+</para>
+
+@parent_class: 
+
+<!-- ##### FUNCTION gnl_operation_new ##### -->
+<para>
+
+</para>
+
+@name: 
+@element: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gnl_operation_get_num_sinks ##### -->
+<para>
+
+</para>
+
+@operation: 
+@Returns: 
+
+
diff --git a/docs/libs/tmpl/gnlsource.sgml b/docs/libs/tmpl/gnlsource.sgml
new file mode 100644
index 0000000..bbcc8de
--- /dev/null
+++ b/docs/libs/tmpl/gnlsource.sgml
@@ -0,0 +1,84 @@
+<!-- ##### SECTION Title ##### -->
+GnlSource
+
+<!-- ##### SECTION Short_Description ##### -->
+Adds the notion of position in time to #GstElement.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+In order to use a source #GstElement in non-linear editing work, this class
+wraps the given #GstElement and adds the notion of position in the source and
+in the container.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT GnlSource ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SIGNAL GnlSource::get-pad-for-stream ##### -->
+<para>
+
+</para>
+
+@gnlsource: the object which received the signal.
+@arg1: 
+@Returns: 
+
+<!-- ##### ARG GnlSource:element ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT GnlSourceClass ##### -->
+<para>
+
+</para>
+
+@parent_class: 
+@get_pad_for_stream: 
+
+<!-- ##### FUNCTION gnl_source_new ##### -->
+<para>
+
+</para>
+
+@name: 
+@element: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gnl_source_set_element ##### -->
+<para>
+
+</para>
+
+@source: 
+@element: 
+
+
+<!-- ##### FUNCTION gnl_source_get_element ##### -->
+<para>
+
+</para>
+
+@source: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gnl_source_get_pad_for_stream ##### -->
+<para>
+
+</para>
+
+@source: 
+@padname: 
+@Returns: 
+
+
diff --git a/docs/libs/tmpl/gnltimeline.sgml b/docs/libs/tmpl/gnltimeline.sgml
new file mode 100644
index 0000000..158b0c3
--- /dev/null
+++ b/docs/libs/tmpl/gnltimeline.sgml
@@ -0,0 +1,58 @@
+<!-- ##### SECTION Title ##### -->
+GnlTimeline
+
+<!-- ##### SECTION Short_Description ##### -->
+Assembles #GnlComposition to produce a multi-output #GstElement.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+This class assembles #GnlComposition to produce a #GstElement that can be
+used in any GStreamer pipeline.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT GnlTimeline ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT GnlTimelineClass ##### -->
+<para>
+
+</para>
+
+@parent_class: 
+
+<!-- ##### FUNCTION gnl_timeline_new ##### -->
+<para>
+
+</para>
+
+@name: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gnl_timeline_add_group ##### -->
+<para>
+
+</para>
+
+@timeline: 
+@group: 
+
+
+<!-- ##### FUNCTION gnl_timeline_get_pad_for_group ##### -->
+<para>
+
+</para>
+
+@timeline: 
+@group: 
+@Returns: 
+
+
diff --git a/docs/version.entities.in b/docs/version.entities.in
new file mode 100644
index 0000000..13690d2
--- /dev/null
+++ b/docs/version.entities.in
@@ -0,0 +1,2 @@
+<!ENTITY GST_MAJORMINOR "@GST_MAJORMINOR@">
+<!ENTITY GNL_VERSION "@VERSION@">