[aravis] doc: more work.

[Emmanuel Pacaud <emmanuel src gnome org>]

commit 6b68ce3aeef37db72429af24edcab5132e4db001
Author: Emmanuel Pacaud <emmanuel gnome org>
Date:   Sat May 22 16:30:10 2010 +0200

    doc: more work.

 docs/reference/aravis/aravis-docs.xml |   31 ++++++++++++++++++++++++++++---
 src/arvbuffer.c                       |   12 ++++++++++++
 src/arvcamera.c                       |   10 ++++++++++
 src/arvdevice.c                       |    9 +++++++++
 src/arvinterface.c                    |   11 +++++++++++
 src/arvstream.c                       |   10 ++++++++++
 6 files changed, 80 insertions(+), 3 deletions(-)
---
diff --git a/docs/reference/aravis/aravis-docs.xml b/docs/reference/aravis/aravis-docs.xml
index 8aaa0db..0ec05e2 100644
--- a/docs/reference/aravis/aravis-docs.xml
+++ b/docs/reference/aravis/aravis-docs.xml
@@ -7,9 +7,28 @@
 <book id="index">
 	<bookinfo>
 		<title>Aravis Reference Manual</title>
-		<releaseinfo>
-			for Aravis 0.2.
-		</releaseinfo>
+		<releaseinfo>for Aravis 0.2.</releaseinfo>
+		<legalnotice>
+			<para>
+				Permission is granted to copy, distribute and/or modify this
+				document under the terms of the <citetitle>GNU Free
+				Documentation License</citetitle>, Version 1.1 or any later
+				version published by the Free Software Foundation with no
+				Invariant Sections, no Front-Cover Texts, and no Back-Cover
+				Texts. You may obtain a copy of the <citetitle>GNU Free
+				Documentation License</citetitle> from the Free Software
+				Foundation by visiting <ulink type="http"
+				url="http://www.fsf.org";>their Web site</ulink> or by writing
+				to:
+
+				<address>
+					The Free Software Foundation, Inc.,
+					<street>59 Temple Place</street> - Suite 330,
+					<city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
+					<country>USA</country>
+				</address>
+			</para>
+		</legalnotice>
 	</bookinfo>
 
 	<chapter>
@@ -20,6 +39,7 @@
 		<xi:include href="xml/arvstream.xml"/>
 		<xi:include href="xml/arvbuffer.xml"/>
 	</chapter>
+
 	<chapter>
 		<title>Genicam</title>
 		<xi:include href="xml/arvgc.xml"/>
@@ -39,6 +59,7 @@
 		<xi:include href="xml/arvgccommand.xml"/>
 		<xi:include href="xml/arvgcport.xml"/>
 	</chapter>
+
 	<chapter>
 		<title>Ethernet cameras</title>
 		<xi:include href="xml/arvgvinterface.xml"/>
@@ -47,6 +68,7 @@
 		<xi:include href="xml/arvgvcp.xml"/>
 		<xi:include href="xml/arvgvsp.xml"/>
 	</chapter>
+
 	<chapter>
 		<title>Fake camera</title>
 		<xi:include href="xml/arvfakeinterface.xml"/>
@@ -54,6 +76,7 @@
 		<xi:include href="xml/arvfakestream.xml"/>
 		<xi:include href="xml/arvfakecamera.xml"/>
 	</chapter>
+
 	<chapter>
 		<title>Utils</title>
 		<xi:include href="xml/arvdebug.xml"/>
@@ -63,10 +86,12 @@
 		<xi:include href="xml/arvvalue.xml"/>
 		<xi:include href="xml/arvzip.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>
diff --git a/src/arvbuffer.c b/src/arvbuffer.c
index 9807eaa..42845d2 100644
--- a/src/arvbuffer.c
+++ b/src/arvbuffer.c
@@ -20,6 +20,18 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvbuffer
+ * @short_description: Buffer for storage of video frames
+ *
+ * #ArvBuffer provides a class for the instantiation of buffers used for the
+ * storage of the separate images of the video stream. The actual data space
+ * may either be allocated by #ArvBuffer during an object instatiation, of
+ * preallocated. #ArvBuffer also allows the transmission of image metadata,
+ * such as offsets and size of the transmitted region of interrest, pixel
+ * format and time stamp.
+ */
+
 #include <arvbuffer.h>
 
 static GObjectClass *parent_class = NULL;
diff --git a/src/arvcamera.c b/src/arvcamera.c
index 9c4d3f4..02082ed 100644
--- a/src/arvcamera.c
+++ b/src/arvcamera.c
@@ -20,6 +20,16 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION:arvcamera
+ * @short_description: Class for generic camera control
+ *
+ * #ArvCamera is a class for the generic control of cameras. It hides the
+ * complexity of the genicam interface by providing a simple API, with the
+ * drawback of not exposing all the available features. See #ArvDevice and
+ * #ArvGc for a more advanced use of the Aravis library.
+ */
+
 #include <arvcamera.h>
 #include <arvsystem.h>
 #include <arvgvinterface.h>
diff --git a/src/arvdevice.c b/src/arvdevice.c
index e3e19d7..5a0d8af 100644
--- a/src/arvdevice.c
+++ b/src/arvdevice.c
@@ -20,6 +20,15 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/** 
+ * SECTION: arvdevice
+ * @short_description: Abstract base class for device handling
+ *
+ * #ArvDevice is an abstract base class for the control of cameras. It provides
+ * an easy access to the camera settings, and to its genicam interface for  more
+ * advanced uses.
+ */
+
 #include <arvdevice.h>
 #include <arvgc.h>
 #include <arvgccommand.h>
diff --git a/src/arvinterface.c b/src/arvinterface.c
index c285a13..d46f945 100644
--- a/src/arvinterface.c
+++ b/src/arvinterface.c
@@ -20,6 +20,17 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvinterface
+ * @short_description: Base abstract class for camera discovery
+ *
+ * #ArvCamera is an abstract base class for camera discovery. It maintains a
+ * list of the available devices and help to instantiate the corresponding
+ * #ArvDevice object. If user already knows he name of the device, it should
+ * not worry about this class and just use arv_camera_new() or
+ * arv_new_device().
+ */
+
 #include <arvinterface.h>
 
 static GObjectClass *parent_class = NULL;
diff --git a/src/arvstream.c b/src/arvstream.c
index 6b55611..4d85f4c 100644
--- a/src/arvstream.c
+++ b/src/arvstream.c
@@ -20,6 +20,16 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvstream
+ * @short_description: Abstract base class for video stream reception
+ *
+ * #ArvStream provides an abstract base class for the implementation of video
+ * stream reception threads. The interface between the reception thread and the
+ * main thread is done using asynchronous queues, containing #ArvBuffer
+ * objects.
+ */
+
 #include <arvstream.h>
 #include <arvbuffer.h>
 #include <arvdebug.h>