GNOME.org
 

[aravis] documentation: fill some holes and fix warnings.

commit 4b4bbbfcf825de296065bf7ed7cf078f09d3bec6
Author: Emmanuel Pacaud <emmanuel gnome org>
Date:   Mon Mar 5 11:30:54 2012 +0100

    documentation: fill some holes and fix warnings.

 docs/reference/aravis/aravis-sections.txt |   42 ++++++++++++++--------------
 docs/reference/aravis/aravis.types        |   11 +++++++
 src/arvgccategory.c                       |    2 +-
 src/arvgcfeaturenode.c                    |    4 +-
 src/arvgcgroupnode.c                      |    2 +-
 src/arvgcindexnode.c                      |    2 +-
 src/arvgcinvalidatornode.c                |    2 +-
 src/arvgcnode.c                           |    2 +-
 src/arvgcpropertynode.c                   |    6 ++--
 src/arvgcregisterdescriptionnode.c        |    2 +-
 src/arvgcregisternode.c                   |    2 +-
 src/arvgcstructentrynode.c                |   14 ++++-----
 src/arvinterface.c                        |    2 +-
 13 files changed, 51 insertions(+), 42 deletions(-)
---
diff --git a/docs/reference/aravis/aravis-sections.txt b/docs/reference/aravis/aravis-sections.txt
index 39cc854..24b1d3a 100644
--- a/docs/reference/aravis/aravis-sections.txt
+++ b/docs/reference/aravis/aravis-sections.txt
@@ -204,6 +204,7 @@ ArvGcNodeClass
 <SECTION>
 <FILE>arvgcpropertynode</FILE>
 <TITLE>ArvGcPropertyNode</TITLE>
+ArvGcPropertyNode
 arv_gc_property_node_new_access_mode
 arv_gc_property_node_new_address
 arv_gc_property_node_new_bit
@@ -250,7 +251,6 @@ arv_gc_property_node_set_double
 arv_gc_property_node_set_int64
 arv_gc_property_node_set_string
 <SUBSECTION Standard>
-ArvGcPropertyNode
 arv_gc_property_node_get_type
 ARV_GC_PROPERTY_NODE
 ARV_GC_PROPERTY_NODE_CLASS
@@ -266,10 +266,10 @@ ArvGcPropertyNodeType
 <SECTION>
 <FILE>arvgcindexnode</FILE>
 <TITLE>ArvGcIndexNode</TITLE>
+ArvGcIndexNode
 arv_gc_index_node_new
 arv_gc_index_node_get_index
 <SUBSECTION Standard>
-ArvGcIndexNode
 arv_gc_index_node_get_type
 ARV_GC_INDEX_NODE
 ARV_GC_INDEX_NODE_CLASS
@@ -282,11 +282,11 @@ ARV_TYPE_GC_INDEX_NODE
 <SECTION>
 <FILE>arvgcinvalidatornode</FILE>
 <TITLE>ArvGcInvalidatorNode</TITLE>
+ArvGcInvalidatorNode
 arv_gc_invalidator_node_new
 arv_gc_invalidator_node_get_modification_count
 arv_gc_invalidator_node_set_modification_count
 <SUBSECTION Standard>
-ArvGcInvalidatorNode
 arv_gc_invalidator_node_get_type
 ARV_GC_INVALIDATOR_NODE
 ARV_GC_INVALIDATOR_NODE_CLASS
@@ -299,10 +299,10 @@ ARV_TYPE_GC_INVALIDATOR_NODE
 <SECTION>
 <FILE>arvgcvariablenode</FILE>
 <TITLE>ArvGcVariableNode</TITLE>
+ArvGcVariableNode
 arv_gc_variable_node_get_name
 arv_gc_variable_node_new
 <SUBSECTION Standard>
-ArvGcVariableNode
 arv_gc_variable_node_get_type
 ARV_GC_VARIABLE_NODE
 ARV_GC_VARIABLE_NODE_CLASS
@@ -342,6 +342,7 @@ ArvGcFeatureNodeClass
 <SECTION>
 <FILE>arvgcgroupnode</FILE>
 <TITLE>ArvGcGroupNode</TITLE>
+ArvGcGroupNode
 arv_gc_group_node_get_type
 arv_gc_group_node_new
 <SUBSECTION Standard>
@@ -457,6 +458,7 @@ ArvGcIntegerInterface
 <SECTION>
 <FILE>arvgcregister</FILE>
 <TITLE>ArvGcRegister</TITLE>
+ArvGcRegister
 arv_gc_register_get
 arv_gc_register_get_address
 arv_gc_register_get_length
@@ -468,7 +470,6 @@ ARV_GC_REGISTER_GET_CLASS
 ARV_GC_REGISTER_GET_INTERFACE
 ARV_IS_GC_REGISTER
 ARV_TYPE_GC_REGISTER
-ArvGcRegister
 ArvGcRegisterInterface
 ArvGcRegisterType
 </SECTION>
@@ -795,6 +796,21 @@ ArvFakeCameraFillPattern
 </SECTION>
 
 <SECTION>
+<FILE>arvgcstructentrynode</FILE>
+<TITLE>ArvGcStructEntryNode</TITLE>
+ArvGcStructEntryNode
+arv_gc_struct_entry_node_new
+<SUBSECTION Standard>
+ARV_GC_STRUCT_ENTRY_NODE
+ARV_GC_STRUCT_ENTRY_NODE_CLASS
+ARV_GC_STRUCT_ENTRY_NODE_GET_CLASS
+ARV_IS_GC_STRUCT_ENTRY_NODE
+ARV_IS_GC_STRUCT_ENTRY_NODE_CLASS
+ARV_TYPE_GC_STRUCT_ENTRY_NODE
+arv_gc_struct_entry_node_get_type
+</SECTION>
+
+<SECTION>
 <FILE>arvgcregisternode</FILE>
 <TITLE>ArvGcRegisterNode</TITLE>
 ArvGcSign
@@ -821,22 +837,6 @@ ArvGcRegisterNodeClass
 </SECTION>
 
 <SECTION>
-<FILE>arvgcstructentrynode</FILE>
-<TITLE>ArvGcStructEntryNode</TITLE>
-arv_gc_struct_entry_node_new
-<SUBSECTION Standard>
-ArvGcStructEntryNode
-ARV_GC_STRUCT_ENTRY_NODE
-ARV_GC_STRUCT_ENTRY_NODE_CLASS
-ARV_GC_STRUCT_ENTRY_NODE_GET_CLASS
-ARV_IS_GC_STRUCT_ENTRY_NODE
-ARV_IS_GC_STRUCT_ENTRY_NODE_CLASS
-ARV_TYPE_GC_STRUCT_ENTRY_NODE
-ArvGcStructEntryNodeClass
-arv_gc_struct_entry_node_get_type
->/SECTION>
-
-<SECTION>
 <FILE>arvgcstring</FILE>
 <TITLE>ArvGcString</TITLE>
 ArvGcString
diff --git a/docs/reference/aravis/aravis.types b/docs/reference/aravis/aravis.types
index 73b849c..3069bff 100644
--- a/docs/reference/aravis/aravis.types
+++ b/docs/reference/aravis/aravis.types
@@ -6,6 +6,15 @@ arv_fake_camera_get_type
 arv_fake_device_get_type
 arv_fake_interface_get_type
 arv_fake_stream_get_type
+arv_gc_node_get_type
+arv_gc_property_node_get_type
+arv_gc_index_node_get_type
+arv_gc_invalidator_node_get_type
+arv_gc_variable_node_get_type
+arv_gc_enum_entry_get_type
+arv_gc_feature_node_get_type
+arv_gc_register_description_node_get_type
+arv_gc_group_node_get_type
 arv_gc_boolean_get_type
 arv_gc_category_get_type
 arv_gc_command_get_type
@@ -19,7 +28,9 @@ arv_gc_integer_get_type
 arv_gc_integer_node_get_type
 arv_gc_feature_node_get_type
 arv_gc_port_get_type
+arv_gc_register_get_type
 arv_gc_register_node_get_type
+arv_gc_struct_entry_node_get_type
 arv_gc_string_get_type
 arv_gc_swiss_knife_get_type
 arv_gv_device_get_type
diff --git a/src/arvgccategory.c b/src/arvgccategory.c
index a48e28b..cb54272 100644
--- a/src/arvgccategory.c
+++ b/src/arvgccategory.c
@@ -22,7 +22,7 @@
 
 /**
  * SECTION: arvgccategory
- * @short_description: Class for Category elements
+ * @short_description: Class for Category nodes
  */
 
 #include <arvgccategory.h>
diff --git a/src/arvgcfeaturenode.c b/src/arvgcfeaturenode.c
index fb7d294..5fa26da 100644
--- a/src/arvgcfeaturenode.c
+++ b/src/arvgcfeaturenode.c
@@ -22,10 +22,10 @@
 
 /**
  * SECTION: arvgcfeaturenode
- * @short_description: Base class for all Genicam nodes
+ * @short_description: Base class for Genicam feature nodes
  *
  * #ArvGcFeatureNode provides a base class for the implementation of the different
- * types of Genicam node.
+ * types of Genicam feature node (Group, Integer, Float, Enumeration...).
  */
 
 #include <arvgcfeaturenode.h>
diff --git a/src/arvgcgroupnode.c b/src/arvgcgroupnode.c
index 29f44cd..3efc006 100644
--- a/src/arvgcgroupnode.c
+++ b/src/arvgcgroupnode.c
@@ -22,7 +22,7 @@
 
 /**
  * SECTION: arvgcgroupnode
- * @short_description: Class for GroupNode nodes
+ * @short_description: Class for Group nodes
  */
 
 #include <arvgcgroupnode.h>
diff --git a/src/arvgcindexnode.c b/src/arvgcindexnode.c
index 6998ee5..4c983d2 100644
--- a/src/arvgcindexnode.c
+++ b/src/arvgcindexnode.c
@@ -22,7 +22,7 @@
 
 /**
  * SECTION: arvgcindexnode
- * @short_description: Class for IndexNode elements
+ * @short_description: Class for Index nodes
  */
 
 #include <arvgcindexnode.h>
diff --git a/src/arvgcinvalidatornode.c b/src/arvgcinvalidatornode.c
index 9f4f0d9..7c6e1ce 100644
--- a/src/arvgcinvalidatornode.c
+++ b/src/arvgcinvalidatornode.c
@@ -22,7 +22,7 @@
 
 /**
  * SECTION: arvgcinvalidatornode
- * @short_description: Class for InvalidatorNode elements
+ * @short_description: Class for Invalidator nodes
  */
 
 #include <arvgcinvalidatornode.h>
diff --git a/src/arvgcnode.c b/src/arvgcnode.c
index f94f455..845a661 100644
--- a/src/arvgcnode.c
+++ b/src/arvgcnode.c
@@ -25,7 +25,7 @@
  * @short_description: Base class for all Genicam nodes
  *
  * #ArvGcNode provides a base class for the implementation of the different
- * types of Genicam node.
+ * types of Genicam nodes.
  */
 
 #include <arvgcnode.h>
diff --git a/src/arvgcpropertynode.c b/src/arvgcpropertynode.c
index 7b105aa..5256707 100644
--- a/src/arvgcpropertynode.c
+++ b/src/arvgcpropertynode.c
@@ -21,11 +21,11 @@
  */
 
 /**
- * SECTION: arvgcfeaturenode
- * @short_description: Base class for all Genicam nodes
+ * SECTION: arvgcpropertynode
+ * @short_description: Base class for Genicam property nodes
  *
  * #ArvGcPropertyNode provides a base class for the implementation of the different
- * types of Genicam node.
+ * types of Genicam property nodes (Value, pValue, Endianess...).
  */
 
 #include <arvgcpropertynode.h>
diff --git a/src/arvgcregisterdescriptionnode.c b/src/arvgcregisterdescriptionnode.c
index 0c8d9de..de03cb5 100644
--- a/src/arvgcregisterdescriptionnode.c
+++ b/src/arvgcregisterdescriptionnode.c
@@ -22,7 +22,7 @@
 
 /**
  * SECTION: arvgcregisterdescriptionnode
- * @short_description: Class for Register Description elements
+ * @short_description: Class for RegisterDescription nodes
  */
 
 #include <arvgcregisterdescriptionnode.h>
diff --git a/src/arvgcregisternode.c b/src/arvgcregisternode.c
index 605bdc6..8e368f2 100644
--- a/src/arvgcregisternode.c
+++ b/src/arvgcregisternode.c
@@ -22,7 +22,7 @@
 
 /**
  * SECTION: arvgcregisternode
- * @short_description: Class for Register, IntReg, MaskedIntReg, FloatReg and StringReg nodes
+ * @short_description: Class for Register, IntReg, MaskedIntReg, FloatReg, StringReg and StructReg nodes
  */
 
 #include <arvgcregisternode.h>
diff --git a/src/arvgcstructentrynode.c b/src/arvgcstructentrynode.c
index 3dc5c3c..ef690d0 100644
--- a/src/arvgcstructentrynode.c
+++ b/src/arvgcstructentrynode.c
@@ -36,14 +36,6 @@
 #include <stdlib.h>
 #include <string.h>
 
-/**
- * SECTION: arvgcstructentrynode
- * @short_description: Base class for StrucEntry nodes
- *
- * #ArvGcStructEntryNode provides a base class for the implementation of the different
- * types of Genicam node.
- */
-
 static GObjectClass *parent_class = NULL;
 
 /* ArvDomNode implementation */
@@ -136,6 +128,12 @@ _get_msb (ArvGcStructEntryNode *gc_struct_entry_node)
 	return arv_gc_property_node_get_int64 (gc_struct_entry_node->msb);
 }
 
+/**
+ * arv_gc_struct_entry_node_new:
+ *
+ * Returns: (transfer full): a newly created #ArvGcStructEntryNode.
+ */
+
 ArvGcNode *
 arv_gc_struct_entry_node_new (void)
 {
diff --git a/src/arvinterface.c b/src/arvinterface.c
index 7e96c59..f4378a1 100644
--- a/src/arvinterface.c
+++ b/src/arvinterface.c
@@ -22,7 +22,7 @@
 
 /**
  * SECTION: arvinterface
- * @short_description: Base abstract class for camera discovery
+ * @short_description: Abstract base 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
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]