[aravis] doc: overview section.

[Emmanuel Pacaud <emmanuel src gnome org>]

commit 0af3791360dce8e3d8ad815b86a483f58f686382
Author: Emmanuel Pacaud <emmanuel gnome org>
Date:   Tue May 25 10:47:02 2010 +0200

    doc: overview section.

 docs/reference/aravis/Makefile.am         |    6 +-
 docs/reference/aravis/aravis-docs.xml     |  106 +++++++++++++++--------------
 docs/reference/aravis/aravis-overview.xml |   15 ++++
 docs/reference/aravis/aravis-sections.txt |    4 +
 4 files changed, 79 insertions(+), 52 deletions(-)
---
diff --git a/docs/reference/aravis/Makefile.am b/docs/reference/aravis/Makefile.am
index 9fe764b..e8e5bf7 100644
--- a/docs/reference/aravis/Makefile.am
+++ b/docs/reference/aravis/Makefile.am
@@ -71,12 +71,14 @@ 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=
+content_files= \
+	       aravis-overview.xml
 
 # 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=
+expand_content_files= \
+	       aravis-overview.xml
 
 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
diff --git a/docs/reference/aravis/aravis-docs.xml b/docs/reference/aravis/aravis-docs.xml
index 3d09b9f..ebe4938 100644
--- a/docs/reference/aravis/aravis-docs.xml
+++ b/docs/reference/aravis/aravis-docs.xml
@@ -31,60 +31,66 @@
 		</legalnotice>
 	</bookinfo>
 
-	<chapter>
-		<title>Base</title>
-		<xi:include href="xml/arvcamera.xml"/>
-		<xi:include href="xml/arvinterface.xml"/>
-		<xi:include href="xml/arvdevice.xml"/>
-		<xi:include href="xml/arvstream.xml"/>
-		<xi:include href="xml/arvbuffer.xml"/>
-	</chapter>
+	<xi:include href="xml/aravis-overview.xml"/>
 
-	<chapter>
-		<title>Genicam</title>
-		<xi:include href="xml/arvgc.xml"/>
-		<xi:include href="xml/arvgcnode.xml"/>
-		<xi:include href="xml/arvgcinteger.xml"/>
-		<xi:include href="xml/arvgcfloat.xml"/>
-		<xi:include href="xml/arvgcstring.xml"/>
-		<xi:include href="xml/arvgccategory.xml"/>
-		<xi:include href="xml/arvgccommand.xml"/>
-		<xi:include href="xml/arvgcboolean.xml"/>
-		<xi:include href="xml/arvgcintegernode.xml"/>
-		<xi:include href="xml/arvgcfloatnode.xml"/>
-		<xi:include href="xml/arvgcregister.xml"/>
-		<xi:include href="xml/arvgcenumeration.xml"/>
-		<xi:include href="xml/arvgcenumentry.xml"/>
-		<xi:include href="xml/arvgcconverter.xml"/>
-		<xi:include href="xml/arvgcswissknife.xml"/>
-		<xi:include href="xml/arvgcport.xml"/>
-	</chapter>
+	<part id="aravis-reference">
+		<title>Aravis reference</title>
 
-	<chapter>
-		<title>Ethernet cameras</title>
-		<xi:include href="xml/arvgvinterface.xml"/>
-		<xi:include href="xml/arvgvdevice.xml"/>
-		<xi:include href="xml/arvgvstream.xml"/>
-		<xi:include href="xml/arvgvcp.xml"/>
-		<xi:include href="xml/arvgvsp.xml"/>
-	</chapter>
+		<chapter>
+			<title>Base</title>
+			<xi:include href="xml/arvcamera.xml"/>
+			<xi:include href="xml/arvinterface.xml"/>
+			<xi:include href="xml/arvdevice.xml"/>
+			<xi:include href="xml/arvstream.xml"/>
+			<xi:include href="xml/arvbuffer.xml"/>
+		</chapter>
 
-	<chapter>
-		<title>Fake camera</title>
-		<xi:include href="xml/arvfakeinterface.xml"/>
-		<xi:include href="xml/arvfakedevice.xml"/>
-		<xi:include href="xml/arvfakestream.xml"/>
-		<xi:include href="xml/arvfakecamera.xml"/>
-	</chapter>
+		<chapter>
+			<title>Genicam</title>
+			<xi:include href="xml/arvgc.xml"/>
+			<xi:include href="xml/arvgcnode.xml"/>
+			<xi:include href="xml/arvgcinteger.xml"/>
+			<xi:include href="xml/arvgcfloat.xml"/>
+			<xi:include href="xml/arvgcstring.xml"/>
+			<xi:include href="xml/arvgccategory.xml"/>
+			<xi:include href="xml/arvgccommand.xml"/>
+			<xi:include href="xml/arvgcboolean.xml"/>
+			<xi:include href="xml/arvgcintegernode.xml"/>
+			<xi:include href="xml/arvgcfloatnode.xml"/>
+			<xi:include href="xml/arvgcregister.xml"/>
+			<xi:include href="xml/arvgcenumeration.xml"/>
+			<xi:include href="xml/arvgcenumentry.xml"/>
+			<xi:include href="xml/arvgcconverter.xml"/>
+			<xi:include href="xml/arvgcswissknife.xml"/>
+			<xi:include href="xml/arvgcport.xml"/>
+		</chapter>
 
-	<chapter>
-		<title>Utils</title>
-		<xi:include href="xml/arvdebug.xml"/>
-		<xi:include href="xml/arvevaluator.xml"/>
-		<xi:include href="xml/arvstatistic.xml"/>
-		<xi:include href="xml/arvvalue.xml"/>
-		<xi:include href="xml/arvzip.xml"/>
-	</chapter>
+		<chapter>
+			<title>Ethernet cameras</title>
+			<xi:include href="xml/arvgvinterface.xml"/>
+			<xi:include href="xml/arvgvdevice.xml"/>
+			<xi:include href="xml/arvgvstream.xml"/>
+			<xi:include href="xml/arvgvcp.xml"/>
+			<xi:include href="xml/arvgvsp.xml"/>
+		</chapter>
+
+		<chapter>
+			<title>Fake camera</title>
+			<xi:include href="xml/arvfakeinterface.xml"/>
+			<xi:include href="xml/arvfakedevice.xml"/>
+			<xi:include href="xml/arvfakestream.xml"/>
+			<xi:include href="xml/arvfakecamera.xml"/>
+		</chapter>
+
+		<chapter>
+			<title>Utils</title>
+			<xi:include href="xml/arvdebug.xml"/>
+			<xi:include href="xml/arvevaluator.xml"/>
+			<xi:include href="xml/arvstatistic.xml"/>
+			<xi:include href="xml/arvvalue.xml"/>
+			<xi:include href="xml/arvzip.xml"/>
+		</chapter>
+	</part>
 
 	<chapter id="object-tree">
 		<title>Object Hierarchy</title>
diff --git a/docs/reference/aravis/aravis-overview.xml b/docs/reference/aravis/aravis-overview.xml
new file mode 100644
index 0000000..b5ba1aa
--- /dev/null
+++ b/docs/reference/aravis/aravis-overview.xml
@@ -0,0 +1,15 @@
+<part id="aravis-overview">
+
+<title>Overview</title>
+
+<para>Aravis is a GObject based library for the control and the video stream acquisition of digital cameras. It supports gobect-introspection, making it usable directly from Python (<ulink type="http" url="http://live.gnome.org/PyGI";>PyGI</ulink>) , Javascript (<ulink type="http" url="http://live.gnome.org/Gjs/";>Gjs</ulink> or <ulink type="http" url="http://live.gnome.org/Seed";>Seed</ulink>) or <ulink type="http" url="http://live.gnome.org/Vala";>Vala</ulink>.</para>
+
+<para>While using GenICam xml files for the description of the camera registers, it does not try to be a complete implementation of the Genicam API as described in the GenAPI GenICam document. Nevertheless, a good knowledge of the <ulink type="http" url="http://www.genicam.org";>GenICam</ulink> standard should help the user to understand how Aravis operates.</para>
+
+<para>Aravis currently provides an implementation of a gigabit ethernet UDP based protocol, found in a lot of ethernet industrial cameras.</para>
+
+<para>#ArvCamera is a simple API for easy access of standard camera features.</para>
+
+<para>#ArvDevice and #ArvGc are more low level APIs, which enable the full control of the cameras, allowing the use of the features specific to each model.</para>
+
+</part>
diff --git a/docs/reference/aravis/aravis-sections.txt b/docs/reference/aravis/aravis-sections.txt
index 5cfed5e..fdf9a56 100644
--- a/docs/reference/aravis/aravis-sections.txt
+++ b/docs/reference/aravis/aravis-sections.txt
@@ -216,6 +216,7 @@ ArvEvaluatorClass
 <SECTION>
 <FILE>arvgcinteger</FILE>
 <TITLE>ArvGcInteger</TITLE>
+ArvGcInteger
 arv_gc_integer_get_value
 arv_gc_integer_set_value
 arv_gc_integer_get_min
@@ -466,6 +467,7 @@ ArvGcCategoryClass
 <SECTION>
 <FILE>arvgcfloat</FILE>
 <TITLE>ArvGcFloat</TITLE>
+ArvGcFloat
 arv_gc_float_get_value
 arv_gc_float_set_value
 arv_gc_float_get_min
@@ -588,6 +590,7 @@ ArvGcRegisterClass
 <SECTION>
 <FILE>arvgcstring</FILE>
 <TITLE>ArvGcString</TITLE>
+ArvGcString
 arv_gc_string_get_value
 arv_gc_string_set_value
 arv_gc_string_get_max_length
@@ -766,6 +769,7 @@ ArvGvspPacketType
 <SECTION>
 <FILE>arvzip</FILE>
 <TITLE>ArvZip</TITLE>
+ArvZip
 arv_zip_new
 arv_zip_free
 arv_zip_get_file