GNOME.org
 

[aravis] doc: more work.

commit 633cbde8a168e374a2ca3ef59014fde127f73618
Author: Emmanuel Pacaud <emmanuel gnome org>
Date:   Sat May 22 19:06:58 2010 +0200

    doc: more work.

 docs/reference/aravis/aravis-docs.xml     |    9 ++++-----
 docs/reference/aravis/aravis-sections.txt |   15 ++++-----------
 src/arvdebug.c                            |    5 +++++
 src/arvevaluator.c                        |    5 +++++
 src/arvfakecamera.c                       |   10 ++++++++++
 src/arvfakedevice.c                       |    5 +++++
 src/arvfakeinterface.c                    |    5 +++++
 src/arvfakestream.c                       |    5 +++++
 src/arvgc.c                               |    9 +++++++++
 src/arvgcboolean.c                        |    5 +++++
 src/arvgccategory.c                       |    5 +++++
 src/arvgccommand.c                        |    5 +++++
 src/arvgcconverter.c                      |    5 +++++
 src/arvgcenumentry.c                      |    5 +++++
 src/arvgcenumeration.c                    |    5 +++++
 src/arvgcfloat.c                          |    5 +++++
 src/arvgcfloatnode.c                      |    5 +++++
 src/arvgcinteger.c                        |    5 +++++
 src/arvgcintegernode.c                    |    5 +++++
 src/arvgcnode.c                           |    8 ++++++++
 src/arvgcport.c                           |    5 +++++
 src/arvgcregister.c                       |    5 +++++
 src/arvgcstring.c                         |    5 +++++
 src/arvgcswissknife.c                     |    5 +++++
 src/arvgvcp.c                             |    5 +++++
 src/arvgvdevice.c                         |    5 +++++
 src/arvgvinterface.c                      |    5 +++++
 src/arvgvsp.c                             |    5 +++++
 src/arvgvstream.c                         |    5 +++++
 src/arvtools.c                            |   10 +++++++++-
 src/arvzip.c                              |    5 +++++
 31 files changed, 169 insertions(+), 17 deletions(-)
---
diff --git a/docs/reference/aravis/aravis-docs.xml b/docs/reference/aravis/aravis-docs.xml
index 0ec05e2..3d09b9f 100644
--- a/docs/reference/aravis/aravis-docs.xml
+++ b/docs/reference/aravis/aravis-docs.xml
@@ -7,7 +7,7 @@
 <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
@@ -32,7 +32,7 @@
 	</bookinfo>
 
 	<chapter>
-		<title>Main</title>
+		<title>Base</title>
 		<xi:include href="xml/arvcamera.xml"/>
 		<xi:include href="xml/arvinterface.xml"/>
 		<xi:include href="xml/arvdevice.xml"/>
@@ -44,11 +44,12 @@
 		<title>Genicam</title>
 		<xi:include href="xml/arvgc.xml"/>
 		<xi:include href="xml/arvgcnode.xml"/>
-		<xi:include href="xml/arvgcboolean.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"/>
@@ -56,7 +57,6 @@
 		<xi:include href="xml/arvgcenumentry.xml"/>
 		<xi:include href="xml/arvgcconverter.xml"/>
 		<xi:include href="xml/arvgcswissknife.xml"/>
-		<xi:include href="xml/arvgccommand.xml"/>
 		<xi:include href="xml/arvgcport.xml"/>
 	</chapter>
 
@@ -80,7 +80,6 @@
 	<chapter>
 		<title>Utils</title>
 		<xi:include href="xml/arvdebug.xml"/>
-		<xi:include href="xml/arvenums.xml"/>
 		<xi:include href="xml/arvevaluator.xml"/>
 		<xi:include href="xml/arvstatistic.xml"/>
 		<xi:include href="xml/arvvalue.xml"/>
diff --git a/docs/reference/aravis/aravis-sections.txt b/docs/reference/aravis/aravis-sections.txt
index b5e3f1e..5cfed5e 100644
--- a/docs/reference/aravis/aravis-sections.txt
+++ b/docs/reference/aravis/aravis-sections.txt
@@ -27,6 +27,9 @@ arv_camera_get_exposure_time
 arv_camera_set_gain
 arv_camera_get_gain
 arv_camera_get_payload
+ArvAcquisitionMode
+arv_acquisition_mode_to_string
+arv_acquisition_mode_from_string
 <SUBSECTION Standard>
 ARV_CAMERA
 ARV_IS_CAMERA
@@ -38,6 +41,7 @@ ARV_CAMERA_GET_CLASS
 <SUBSECTION Private>
 ArvCameraPrivate
 ArvCameraClass
+ArvPixelFormat
 </SECTION>
 
 <SECTION>
@@ -80,7 +84,6 @@ ArvInterfaceClass
 <SECTION>
 <FILE>arvfakeinterface</FILE>
 <TITLE>ArvFakeInterface</TITLE>
-<TITLE>ArvFake</TITLE>
 ArvFakeInterface
 arv_fake_interface_get_instance
 <SUBSECTION Standard>
@@ -656,16 +659,6 @@ ArvGcCommandClass
 </SECTION>
 
 <SECTION>
-<FILE>arvenums</FILE>
-<TITLE>ArvEnums</TITLE>
-ArvAcquisitionMode
-arv_acquisition_mode_to_string
-arv_acquisition_mode_from_string
-<SUBSECTION Private>
-ArvPixelFormat
-</SECTION>
-
-<SECTION>
 <FILE>arvstatistic</FILE>
 <TITLE>ArvStatistic</TITLE>
 ArvStatistic
diff --git a/src/arvdebug.c b/src/arvdebug.c
index 41ecbe1..c8068ee 100644
--- a/src/arvdebug.c
+++ b/src/arvdebug.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvdebug
+ * @short_description: Debugging tools
+ */
+
 #include <arvdebug.h>
 #include <glib/gprintf.h>
 #include <stdlib.h>
diff --git a/src/arvevaluator.c b/src/arvevaluator.c
index 3fcd218..5ac4e59 100644
--- a/src/arvevaluator.c
+++ b/src/arvevaluator.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvevaluator
+ * @short_description: A math expression evaluator with Genicam syntax
+ */
+
 #include <arvevaluator.h>
 #include <arvtools.h>
 #include <arvdebug.h>
diff --git a/src/arvfakecamera.c b/src/arvfakecamera.c
index 1338b0f..98d072e 100644
--- a/src/arvfakecamera.c
+++ b/src/arvfakecamera.c
@@ -20,6 +20,16 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvfakecamera
+ * @short_description: Fake camera internals
+ *
+ * #ArvFakeCamera is a class that simulate a real camera, which provides
+ * methods for the implementation of #ArvFakeDevice and #ArvFakeStream. It's
+ * foresen to use this class for the implementation of a fake ethernet camera
+ * too, but it's still a TODO.
+ */
+
 #include <arvfakecamera.h>
 #include <arvgc.h>
 #include <arvgcregister.h>
diff --git a/src/arvfakedevice.c b/src/arvfakedevice.c
index 9a1dc1d..37de99c 100644
--- a/src/arvfakedevice.c
+++ b/src/arvfakedevice.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvfakedevice
+ * @short_description: Fake camera device
+ */
+
 #include <arvfakedevice.h>
 #include <arvfakestream.h>
 #include <arvgc.h>
diff --git a/src/arvfakeinterface.c b/src/arvfakeinterface.c
index 297f9f9..42686c6 100644
--- a/src/arvfakeinterface.c
+++ b/src/arvfakeinterface.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvfakeinterface
+ * @short_description: Fake camera interface
+ */
+
 #include <arvfakeinterface.h>
 #include <arvfakedevice.h>
 #include <arvdebug.h>
diff --git a/src/arvfakestream.c b/src/arvfakestream.c
index 125d50a..dc8938a 100644
--- a/src/arvfakestream.c
+++ b/src/arvfakestream.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvfakestream
+ * @short_description: Fake camera stream
+ */
+
 #include <arvfakestream.h>
 #include <arvbuffer.h>
 #include <arvdebug.h>
diff --git a/src/arvgc.c b/src/arvgc.c
index 7e65439..3154d74 100644
--- a/src/arvgc.c
+++ b/src/arvgc.c
@@ -20,6 +20,15 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION:arvgc
+ * @short_description: Genicam root document class
+ *
+ * #ArvGc implements the root document for the storage of the Genicam feature
+ * nodes. It builds the node tree by parsing an xml file in the Genicam
+ * standard format. See http://www.genicam.org.
+ */
+
 #include <arvgc.h>
 #include <arvgccategory.h>
 #include <arvgcenumeration.h>
diff --git a/src/arvgcboolean.c b/src/arvgcboolean.c
index 2eda354..20d48ac 100644
--- a/src/arvgcboolean.c
+++ b/src/arvgcboolean.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvgcboolean
+ * @short_description: Class for Boolean nodes
+ */
+
 #include <arvgcboolean.h>
 #include <arvgc.h>
 #include <arvtools.h>
diff --git a/src/arvgccategory.c b/src/arvgccategory.c
index 540eab6..224c699 100644
--- a/src/arvgccategory.c
+++ b/src/arvgccategory.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvgccategory
+ * @short_description: Class for Category nodes
+ */
+
 #include <arvgccategory.h>
 #include <arvgc.h>
 #include <string.h>
diff --git a/src/arvgccommand.c b/src/arvgccommand.c
index 431a506..5f054f0 100644
--- a/src/arvgccommand.c
+++ b/src/arvgccommand.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvgccommand
+ * @short_description: Class for Command nodes
+ */
+
 #include <arvgccommand.h>
 #include <arvgcinteger.h>
 #include <arvgcport.h>
diff --git a/src/arvgcconverter.c b/src/arvgcconverter.c
index ffca2b4..9c7fb53 100644
--- a/src/arvgcconverter.c
+++ b/src/arvgcconverter.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvgcconverter
+ * @short_description: Class for Converter and IntConverter nodes
+ */
+
 #include <arvgcnode.h>
 #include <arvgcconverter.h>
 #include <arvevaluator.h>
diff --git a/src/arvgcenumentry.c b/src/arvgcenumentry.c
index c92d2e8..7be74d9 100644
--- a/src/arvgcenumentry.c
+++ b/src/arvgcenumentry.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvgcenumentry
+ * @short_description: Class for EnumEntry nodes
+ */
+
 #include <arvgcenumentry.h>
 #include <arvgc.h>
 #include <string.h>
diff --git a/src/arvgcenumeration.c b/src/arvgcenumeration.c
index a831184..2f66cc8 100644
--- a/src/arvgcenumeration.c
+++ b/src/arvgcenumeration.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvgcenumeration
+ * @short_description: Class for Enumeration nodes
+ */
+
 #include <arvgcenumeration.h>
 #include <arvgcenumentry.h>
 #include <arvgc.h>
diff --git a/src/arvgcfloat.c b/src/arvgcfloat.c
index 8684981..eb8ac00 100644
--- a/src/arvgcfloat.c
+++ b/src/arvgcfloat.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvgcfloat
+ * @short_description: Float interface
+ */
+
 #include <arvgcfloat.h>
 #include <arvtools.h>
 
diff --git a/src/arvgcfloatnode.c b/src/arvgcfloatnode.c
index 194f77f..9b5814f 100644
--- a/src/arvgcfloatnode.c
+++ b/src/arvgcfloatnode.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvgcfloatnode
+ * @short_description: Class for Float nodes
+ */
+
 #include <arvgcfloatnode.h>
 #include <arvgcfloat.h>
 #include <arvgc.h>
diff --git a/src/arvgcinteger.c b/src/arvgcinteger.c
index 58eb1d2..f067185 100644
--- a/src/arvgcinteger.c
+++ b/src/arvgcinteger.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvgcinteger
+ * @short_description: Integer interface
+ */
+
 #include <arvgcinteger.h>
 #include <arvtools.h>
 
diff --git a/src/arvgcintegernode.c b/src/arvgcintegernode.c
index 9ca17ea..de31518 100644
--- a/src/arvgcintegernode.c
+++ b/src/arvgcintegernode.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvgcintegernode
+ * @short_description: Class for Integer nodes
+ */
+
 #include <arvgcintegernode.h>
 #include <arvgcinteger.h>
 #include <arvgc.h>
diff --git a/src/arvgcnode.c b/src/arvgcnode.c
index 6289943..94d387a 100644
--- a/src/arvgcnode.c
+++ b/src/arvgcnode.c
@@ -20,6 +20,14 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvgcnode
+ * @short_description: Base class for all Genicam nodes
+ *
+ * #ArvGcNode provides a base class for the implementation of the different
+ * types of Genicam node.
+ */
+
 #include <arvgcnode.h>
 #include <arvgc.h>
 #include <arvdebug.h>
diff --git a/src/arvgcport.c b/src/arvgcport.c
index 053cc40..abedcd0 100644
--- a/src/arvgcport.c
+++ b/src/arvgcport.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvgcport
+ * @short_description: Class for Port nodes
+ */
+
 #include <arvgcport.h>
 #include <arvdevice.h>
 #include <arvgc.h>
diff --git a/src/arvgcregister.c b/src/arvgcregister.c
index ae38a80..b90d40d 100644
--- a/src/arvgcregister.c
+++ b/src/arvgcregister.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvgcregister
+ * @short_description: Class for Register, IntReg, MaskedIntReg, FloatReg and StringReg nodes
+ */
+
 #include <arvgcregister.h>
 #include <arvgcinteger.h>
 #include <arvgcfloat.h>
diff --git a/src/arvgcstring.c b/src/arvgcstring.c
index 8e59cbf..baf39d4 100644
--- a/src/arvgcstring.c
+++ b/src/arvgcstring.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvgcstring
+ * @short_description: String interface
+ */
+
 #include <arvgcstring.h>
 #include <arvtools.h>
 
diff --git a/src/arvgcswissknife.c b/src/arvgcswissknife.c
index 9a4bb2b..a9d2da1 100644
--- a/src/arvgcswissknife.c
+++ b/src/arvgcswissknife.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvgcswissknife
+ * @short_description: Class for SwissKnife and IntSwissKnife nodes
+ */
+
 #include <arvgcswissknife.h>
 #include <arvevaluator.h>
 #include <arvgcinteger.h>
diff --git a/src/arvgvcp.c b/src/arvgvcp.c
index ef22059..d002b08 100644
--- a/src/arvgvcp.c
+++ b/src/arvgvcp.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvgvcp
+ * @short_description: Gvcp packet handling (control)
+ */
+
 #include <arvgvcp.h>
 #include <arvenumtypes.h>
 #include <string.h>
diff --git a/src/arvgvdevice.c b/src/arvgvdevice.c
index ec79e6b..7f9d9a3 100644
--- a/src/arvgvdevice.c
+++ b/src/arvgvdevice.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvgvdevice
+ * @short_description: Gigabit ethernet camera device
+ */
+
 #include <arvgvdevice.h>
 #include <arvgc.h>
 #include <arvdebug.h>
diff --git a/src/arvgvinterface.c b/src/arvgvinterface.c
index c819e68..ae35827 100644
--- a/src/arvgvinterface.c
+++ b/src/arvgvinterface.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvgvinterface
+ * @short_description: Gigabit ethernet camera interface
+ */
+
 #include <arvgvinterface.h>
 #include <arvgvdevice.h>
 #include <arvgvcp.h>
diff --git a/src/arvgvsp.c b/src/arvgvsp.c
index d2d6062..c0b9d87 100644
--- a/src/arvgvsp.c
+++ b/src/arvgvsp.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvgvsp
+ * @short_description: Gvsp packet handling (stream)
+ */
+
 #include <arvgvsp.h>
 #include <arvdebug.h>
 #include <arvenumtypes.h>
diff --git a/src/arvgvstream.c b/src/arvgvstream.c
index 6919101..6839f55 100644
--- a/src/arvgvstream.c
+++ b/src/arvgvstream.c
@@ -20,6 +20,11 @@
  * Author: Emmanuel Pacaud <emmanuel gnome org>
  */
 
+/**
+ * SECTION: arvgvstream
+ * @short_description: Gigabit ethernet camera stream
+ */
+
 #include <arvgvstream.h>
 #include <arvbuffer.h>
 #include <arvgvsp.h>
diff --git a/src/arvtools.c b/src/arvtools.c
index 3b32a72..ebe94c1 100644
--- a/src/arvtools.c
+++ b/src/arvtools.c
@@ -27,6 +27,11 @@
 #include <stdio.h>
 #include <zlib.h>
 
+/**
+ * SECTION: arvstatistic
+ * @short_description: An histogram tool
+ */
+
 typedef struct _ArvHistogram ArvHistogram;
 
 struct _ArvHistogram {
@@ -392,7 +397,10 @@ arv_str_parse_double (char **str, double *x)
 	return TRUE;
 }
 
-/* ArvValue implementation */
+/**
+ * SECTION: arvvalue
+ * @short_description: An int64/double value storage
+ */
 
 ArvValue *
 arv_value_new_double (double v_double)
diff --git a/src/arvzip.c b/src/arvzip.c
index dcb52cb..c01c572 100644
--- a/src/arvzip.c
+++ b/src/arvzip.c
@@ -25,6 +25,11 @@
  *
  */
 
+/**
+ * SECTION: arvzip
+ * @short_description: A simple zip extractor
+ */
+
 #include <arvzip.h>
 #include <arvdebug.h>
 #include <string.h>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]