GNOME.org
 

[aravis] docs: add gtk-doc support.

commit bcb57b3aa5f889bd3270334f59271887f60e8087
Author: Emmanuel Pacaud <emmanuel gnome org>
Date:   Fri May 21 22:02:50 2010 +0200

    docs: add gtk-doc support.

 .gitignore                                |    3 +
 Makefile.am                               |    4 +-
 autogen.sh                                |   16 +
 configure.ac                              |    5 +
 docs/.gitignore                           |   11 +
 docs/Makefile.am                          |    7 +
 docs/reference/Makefile.am                |    1 +
 docs/reference/aravis/.gitignore          |    2 +
 docs/reference/aravis/Makefile.am         |   96 ++++
 docs/reference/aravis/aravis-docs.xml     |   76 +++
 docs/reference/aravis/aravis-sections.txt |  784 +++++++++++++++++++++++++++++
 docs/reference/aravis/aravis.types        |   29 ++
 src/arvbuffer.c                           |   21 +-
 src/arvbuffer.h                           |   12 +-
 src/arvcamera.c                           |   89 ++--
 src/arvcamera.h                           |    7 +
 src/arvdevice.c                           |    5 +-
 src/arvenums.h                            |   10 +
 src/arvevaluator.c                        |    3 +-
 src/arvgc.c                               |    2 -
 src/arvgcregister.h                       |   15 +
 src/arvgvstream.h                         |   12 +
 src/arvstream.c                           |   14 +-
 src/arvstream.h                           |   10 +
 24 files changed, 1159 insertions(+), 75 deletions(-)
---
diff --git a/.gitignore b/.gitignore
index ce7f2fb..af995c4 100644
--- a/.gitignore
+++ b/.gitignore
@@ -6,6 +6,7 @@
 *.la
 *.gir
 *.typelib
+*.stamp
 Makefile
 Makefile.in
 aclocal.m4
@@ -31,3 +32,5 @@ genicam.xml
 test.png
 test-report.*
 perf-report.*
+gtk-doc.make
+gtk-doc.m4
diff --git a/Makefile.am b/Makefile.am
index b6bd66d..c311329 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -2,9 +2,9 @@ include $(top_srcdir)/Makefile.decl
 
 ACLOCAL_AMFLAGS = -I m4
 
-DISTCHECK_CONFIGURE_FLAGS = --enable-introspection
+DISTCHECK_CONFIGURE_FLAGS = --enable-introspection --enable-gtk-doc
 
-SUBDIRS = src gst po
+SUBDIRS = src gst po docs
 
 aravisdocdir = ${prefix}/doc/aravis
 aravisdoc_DATA = 	\
diff --git a/autogen.sh b/autogen.sh
index b3c0511..cce3807 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -20,6 +20,22 @@ fi
     exit 1
 }
 
+GTKDOCIZE=`which gtkdocize`
+if test -z $GTKDOCIZE; then
+        echo "*** No gtk-doc support ***"
+        echo "EXTRA_DIST =" > gtk-doc.make
+else
+        gtkdocize || exit $?
+        # we need to patch gtk-doc.make to support pretty output with
+        # libtool 1.x.  Should be fixed in the next version of gtk-doc.
+        # To be more resilient with the various versions of gtk-doc one
+        # can find, just sed gkt-doc.make rather than patch it.
+        sed -e 's#) --mode=compile#) --tag=CC --mode=compile#' gtk-doc.make > gtk-doc.temp \
+                && mv gtk-doc.temp gtk-doc.make
+        sed -e 's#) --mode=link#) --tag=CC --mode=link#' gtk-doc.make > gtk-doc.temp \
+                && mv gtk-doc.temp gtk-doc.make
+fi
+
 (autoconf --version) < /dev/null > /dev/null 2>&1 || {
   echo
   echo "**Error**: You must have \`autoconf' installed."
diff --git a/configure.ac b/configure.ac
index 508e2af..d0cb286 100644
--- a/configure.ac
+++ b/configure.ac
@@ -81,6 +81,8 @@ AC_SUBST(ARAVIS_LIBS)
 AC_PATH_PROG(GLIB_MKENUMS, glib-mkenums)
 
 GOBJECT_INTROSPECTION_CHECK([0.6.7])
+GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
+AM_CONDITIONAL([BUILD_GTK_DOC], [test "x$enable_gtk_doc" = "xyes" || test ! -f "autogen.sh"])
 
 AC_CONFIG_FILES([
 Makefile
@@ -88,6 +90,9 @@ src/Makefile
 src/tests/Makefile
 gst/Makefile
 po/Makefile.in
+docs/Makefile
+docs/reference/Makefile
+docs/reference/aravis/Makefile
 aravis.pc
 ])
 AC_CONFIG_FILES([gst/gst-aravis-launch], [chmod +x gst/gst-aravis-launch])
diff --git a/docs/.gitignore b/docs/.gitignore
new file mode 100644
index 0000000..9d7f9f1
--- /dev/null
+++ b/docs/.gitignore
@@ -0,0 +1,11 @@
+*-undocumented.txt
+*-unused.txt
+*-overrides.txt
+*-undeclared.txt
+*-decl.txt
+*-decl-list.txt
+*.args
+*.hierarchy
+*.interfaces
+*.prerequisites
+*.signals
diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644
index 0000000..18bfc13
--- /dev/null
+++ b/docs/Makefile.am
@@ -0,0 +1,7 @@
+SUBDIRS =
+
+if BUILD_GTK_DOC
+SUBDIRS += reference
+endif
+
+DIST_SUBDIRS = reference
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
new file mode 100644
index 0000000..b65dd93
--- /dev/null
+++ b/docs/reference/Makefile.am
@@ -0,0 +1 @@
+SUBDIRS = aravis
diff --git a/docs/reference/aravis/.gitignore b/docs/reference/aravis/.gitignore
new file mode 100644
index 0000000..08852da
--- /dev/null
+++ b/docs/reference/aravis/.gitignore
@@ -0,0 +1,2 @@
+html/
+xml/
diff --git a/docs/reference/aravis/Makefile.am b/docs/reference/aravis/Makefile.am
new file mode 100644
index 0000000..14de4aa
--- /dev/null
+++ b/docs/reference/aravis/Makefile.am
@@ -0,0 +1,96 @@
+## Process this file with automake to produce Makefile.in
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# This is a blank Makefile.am for using gtk-doc.
+# Copy this to your project's API docs directory and modify the variables to
+# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
+# of using the various options.
+
+# The name of the module, e.g. 'glib'.
+DOC_MODULE=aravis
+
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+#DOC_MODULE_VERSION=2
+
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
+
+# Directories containing the source code, relative to $(srcdir).
+# gtk-doc will search all .c and .h files beneath these paths
+# for inline comments documenting functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk ../../../gdk
+DOC_SOURCE_DIR=../../../src
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS=
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+MKTMPL_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkhtml
+MKHTML_OPTIONS=
+
+# Extra options to supply to gtkdoc-fixref. Not normally needed.
+# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
+FIXXREF_OPTIONS=
+
+# Used for dependencies. The docs will be rebuilt if any of these change.
+# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
+# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
+HFILE_GLOB=$(top_srcdir)/src/*.h
+CFILE_GLOB=$(top_srcdir)/src/*.c
+
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+EXTRA_HFILES=
+
+# Header files to ignore when scanning. Use base file name, no paths
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES=\
+	arvenumtypes.h 	\
+	arvconfig.h	\
+	arv.h
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+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=
+
+# 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=
+
+# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
+# Only needed if you are using gtkdoc-scangobj to dynamically query widget
+# signals and properties.
+# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+GTKDOC_CFLAGS=-I$(top_srcdir)/src $(ARAVIS_CFLAGS)
+GTKDOC_LIBS=$(top_builddir)/src/libaravis.la $(ARAVIS_LIBS)
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+# e.g. EXTRA_DIST += version.xml.in
+EXTRA_DIST +=
+
+# Files not to distribute
+# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
+# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
diff --git a/docs/reference/aravis/aravis-docs.xml b/docs/reference/aravis/aravis-docs.xml
new file mode 100644
index 0000000..8aaa0db
--- /dev/null
+++ b/docs/reference/aravis/aravis-docs.xml
@@ -0,0 +1,76 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd";
+[
+  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+<book id="index">
+	<bookinfo>
+		<title>Aravis Reference Manual</title>
+		<releaseinfo>
+			for Aravis 0.2.
+		</releaseinfo>
+	</bookinfo>
+
+	<chapter>
+		<title>Main</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>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/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/arvgccommand.xml"/>
+		<xi:include href="xml/arvgcport.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/arvenums.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 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>
+	</index>
+
+	<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>
diff --git a/docs/reference/aravis/aravis-sections.txt b/docs/reference/aravis/aravis-sections.txt
new file mode 100644
index 0000000..b5e3f1e
--- /dev/null
+++ b/docs/reference/aravis/aravis-sections.txt
@@ -0,0 +1,784 @@
+<SECTION>
+<FILE>arvcamera</FILE>
+<TITLE>ArvCamera</TITLE>
+ArvCameraVendor
+ArvCamera
+arv_camera_new
+arv_camera_create_stream
+arv_camera_get_vendor_name
+arv_camera_get_model_name
+arv_camera_get_device_id
+arv_camera_get_sensor_size
+arv_camera_set_region
+arv_camera_get_region
+arv_camera_set_binning
+arv_camera_get_binning
+arv_camera_set_pixel_format
+arv_camera_get_pixel_format
+arv_camera_start_acquisition
+arv_camera_stop_acquisition
+arv_camera_set_acquisition_mode
+arv_camera_get_acquisition_mode
+arv_camera_set_frame_rate
+arv_camera_get_frame_rate
+arv_camera_set_trigger
+arv_camera_set_exposure_time
+arv_camera_get_exposure_time
+arv_camera_set_gain
+arv_camera_get_gain
+arv_camera_get_payload
+<SUBSECTION Standard>
+ARV_CAMERA
+ARV_IS_CAMERA
+ARV_TYPE_CAMERA
+arv_camera_get_type
+ARV_CAMERA_CLASS
+ARV_IS_CAMERA_CLASS
+ARV_CAMERA_GET_CLASS
+<SUBSECTION Private>
+ArvCameraPrivate
+ArvCameraClass
+</SECTION>
+
+<SECTION>
+<FILE>arvbuffer</FILE>
+<TITLE>ArvBuffer</TITLE>
+ArvFrameCallback
+ArvBufferStatus
+ArvBuffer
+arv_buffer_new
+<SUBSECTION Standard>
+ARV_BUFFER
+ARV_IS_BUFFER
+ARV_TYPE_BUFFER
+arv_buffer_get_type
+ARV_BUFFER_CLASS
+ARV_IS_BUFFER_CLASS
+ARV_BUFFER_GET_CLASS
+<SUBSECTION Private>
+ArvBufferClass
+</SECTION>
+
+<SECTION>
+<FILE>arvinterface</FILE>
+<TITLE>ArvInterface</TITLE>
+ArvInterface
+arv_interface_update_device_list
+arv_interface_new_device
+<SUBSECTION Standard>
+ARV_INTERFACE
+ARV_IS_INTERFACE
+ARV_TYPE_INTERFACE
+arv_interface_get_type
+ARV_INTERFACE_CLASS
+ARV_IS_INTERFACE_CLASS
+ARV_INTERFACE_GET_CLASS
+<SUBSECTION Private>
+ArvInterfaceClass
+</SECTION>
+
+<SECTION>
+<FILE>arvfakeinterface</FILE>
+<TITLE>ArvFakeInterface</TITLE>
+<TITLE>ArvFake</TITLE>
+ArvFakeInterface
+arv_fake_interface_get_instance
+<SUBSECTION Standard>
+ARV_FAKE_INTERFACE
+ARV_IS_FAKE_INTERFACE
+ARV_TYPE_FAKE_INTERFACE
+arv_fake_interface_get_type
+ARV_FAKE_INTERFACE_CLASS
+ARV_IS_FAKE_INTERFACE_CLASS
+ARV_FAKE_INTERFACE_GET_CLASS
+<SUBSECTION Private>
+ArvFakeInterfacePrivate
+ArvFakeInterfaceClass
+ARV_FAKE_INTERFACE_DISCOVERY_TIMEOUT_MS
+ARV_FAKE_INTERFACE_SOCKET_BUFFER_SIZE
+</SECTION>
+
+<SECTION>
+<FILE>arvgcport</FILE>
+<TITLE>ArvGcPort</TITLE>
+ArvGcPort
+arv_gc_port_new
+arv_gc_port_read
+arv_gc_port_write
+<SUBSECTION Standard>
+ARV_GC_PORT
+ARV_IS_GC_PORT
+ARV_TYPE_GC_PORT
+arv_gc_port_get_type
+ARV_GC_PORT_CLASS
+ARV_IS_GC_PORT_CLASS
+ARV_GC_PORT_GET_CLASS
+<SUBSECTION Private>
+ArvGcPortClass
+</SECTION>
+
+<SECTION>
+<FILE>arvdevice</FILE>
+<TITLE>ArvDevice</TITLE>
+ArvDevice
+arv_new_device
+arv_device_create_stream
+arv_device_read_memory
+arv_device_write_memory
+arv_device_read_register
+arv_device_write_register
+arv_device_get_genicam
+arv_device_execute_command
+arv_device_set_string_feature_value
+arv_device_get_string_feature_value
+arv_device_set_integer_feature_value
+arv_device_get_integer_feature_value
+arv_device_set_float_feature_value
+arv_device_get_float_feature_value
+<SUBSECTION Standard>
+ARV_DEVICE
+ARV_IS_DEVICE
+ARV_TYPE_DEVICE
+arv_device_get_type
+ARV_DEVICE_CLASS
+ARV_IS_DEVICE_CLASS
+ARV_DEVICE_GET_CLASS
+<SUBSECTION Private>
+ArvDeviceClass
+</SECTION>
+
+<SECTION>
+<FILE>arvgcintegernode</FILE>
+<TITLE>ArvGcIntegerNode</TITLE>
+ArvGcIntegerNode
+arv_gc_integer_node_new
+<SUBSECTION Standard>
+ARV_GC_INTEGER_NODE
+ARV_IS_GC_INTEGER_NODE
+ARV_TYPE_GC_INTEGER_NODE
+arv_gc_integer_node_get_type
+ARV_GC_INTEGER_NODE_CLASS
+ARV_IS_GC_INTEGER_NODE_CLASS
+ARV_GC_INTEGER_NODE_GET_CLASS
+<SUBSECTION Private>
+ArvGcIntegerNodeClass
+</SECTION>
+
+<SECTION>
+<FILE>arvgcenumeration</FILE>
+<TITLE>ArvGcEnumeration</TITLE>
+ArvGcEnumeration
+arv_gc_enumeration_new
+arv_gc_enumeration_get_string_value
+arv_gc_enumeration_set_string_value
+arv_gc_enumeration_get_int_value
+arv_gc_enumeration_set_int_value
+arv_gc_enumeration_get_entries
+<SUBSECTION Standard>
+ARV_GC_ENUMERATION
+ARV_IS_GC_ENUMERATION
+ARV_TYPE_GC_ENUMERATION
+arv_gc_enumeration_get_type
+ARV_GC_ENUMERATION_CLASS
+ARV_IS_GC_ENUMERATION_CLASS
+ARV_GC_ENUMERATION_GET_CLASS
+<SUBSECTION Private>
+ArvGcEnumerationClass
+</SECTION>
+
+<SECTION>
+<FILE>arvevaluator</FILE>
+<TITLE>ArvEvaluator</TITLE>
+ArvEvaluator
+arv_evaluator_new
+arv_evaluator_set_expression
+arv_evaluator_get_expression
+arv_evaluator_evaluate_as_double
+arv_evaluator_evaluate_as_int64
+arv_evaluator_set_double_variable
+arv_evaluator_set_int64_variable
+<SUBSECTION Standard>
+ARV_EVALUATOR
+ARV_IS_EVALUATOR
+ARV_TYPE_EVALUATOR
+arv_evaluator_get_type
+ARV_EVALUATOR_CLASS
+ARV_IS_EVALUATOR_CLASS
+ARV_EVALUATOR_GET_CLASS
+<SUBSECTION Private>
+ArvEvaluatorPrivate
+ArvEvaluatorClass
+</SECTION>
+
+<SECTION>
+<FILE>arvgcinteger</FILE>
+<TITLE>ArvGcInteger</TITLE>
+arv_gc_integer_get_value
+arv_gc_integer_set_value
+arv_gc_integer_get_min
+arv_gc_integer_get_max
+arv_gc_integer_get_inc
+arv_gc_integer_get_unit
+arv_gc_integer_impose_min
+arv_gc_integer_impose_max
+<SUBSECTION Standard>
+ARV_GC_INTEGER
+ARV_IS_GC_INTEGER
+ARV_TYPE_GC_INTEGER
+arv_gc_integer_get_type
+ARV_GC_INTEGER_GET_INTERFACE
+<SUBSECTION Private>
+ArvGcIntegerInterface
+</SECTION>
+
+<SECTION>
+<FILE>arvgcconverter</FILE>
+<TITLE>ArvGcConverter</TITLE>
+ArvGcConverter
+arv_gc_converter_new
+arv_gc_int_converter_new
+<SUBSECTION Standard>
+ARV_GC_CONVERTER
+ARV_IS_GC_CONVERTER
+ARV_TYPE_GC_CONVERTER
+arv_gc_converter_get_type
+ARV_GC_CONVERTER_CLASS
+ARV_IS_GC_CONVERTER_CLASS
+ARV_GC_CONVERTER_GET_CLASS
+<SUBSECTION Private>
+ArvGcConverterClass
+</SECTION>
+
+<SECTION>
+<FILE>arvstream</FILE>
+<TITLE>ArvStream</TITLE>
+ArvStreamCallbackType
+ArvStreamCallback
+ArvStream
+arv_stream_push_buffer
+arv_stream_pop_buffer
+arv_stream_get_n_available_buffers
+arv_stream_get_statistics
+<SUBSECTION Standard>
+ARV_STREAM
+ARV_IS_STREAM
+ARV_TYPE_STREAM
+arv_stream_get_type
+ARV_STREAM_CLASS
+ARV_IS_STREAM_CLASS
+ARV_STREAM_GET_CLASS
+<SUBSECTION Private>
+ArvStreamClass
+</SECTION>
+
+<SECTION>
+<FILE>arvfakedevice</FILE>
+<TITLE>ArvFakeDevice</TITLE>
+ArvFakeDevice
+arv_fake_device_new
+<SUBSECTION Standard>
+ARV_FAKE_DEVICE
+ARV_IS_FAKE_DEVICE
+ARV_TYPE_FAKE_DEVICE
+arv_fake_device_get_type
+ARV_FAKE_DEVICE_CLASS
+ARV_IS_FAKE_DEVICE_CLASS
+ARV_FAKE_DEVICE_GET_CLASS
+<SUBSECTION Private>
+ArvFakeDeviceClass
+ArvFakeDevicePrivate
+</SECTION>
+
+<SECTION>
+<FILE>arvgcnode</FILE>
+<TITLE>ArvGcNode</TITLE>
+ArvGcNode
+arv_gc_node_new
+arv_gc_node_get_value_type
+arv_gc_node_set_genicam
+arv_gc_node_get_genicam
+arv_gc_node_get_name
+arv_gc_node_get_tooltip
+arv_gc_node_get_description
+arv_gc_node_set_attribute
+arv_gc_node_add_element
+arv_gc_node_can_add_child
+arv_gc_node_add_child
+arv_gc_node_get_childs
+arv_gc_node_inc_modification_count
+arv_gc_node_get_modification_count
+<SUBSECTION Standard>
+ARV_GC_NODE
+ARV_IS_GC_NODE
+ARV_TYPE_GC_NODE
+arv_gc_node_get_type
+ARV_GC_NODE_CLASS
+ARV_IS_GC_NODE_CLASS
+ARV_GC_NODE_GET_CLASS
+<SUBSECTION Private>
+ArvGcNodePrivate
+ArvGcNodeClass
+</SECTION>
+
+<SECTION>
+<FILE>arvgc</FILE>
+<TITLE>ArvGc</TITLE>
+ArvGc
+arv_gc_new
+arv_gc_get_node
+arv_gc_get_device
+<SUBSECTION Standard>
+ARV_GC
+ARV_IS_GC
+ARV_TYPE_GC
+arv_gc_get_type
+ARV_GC_CLASS
+ARV_IS_GC_CLASS
+ARV_GC_GET_CLASS
+<SUBSECTION Private>
+ArvGcClass
+ArvGcNameSpace
+ArvGcAccessMode
+ArvGcCachable
+arv_gc_get_int64_from_value
+arv_gc_set_int64_to_value
+arv_gc_get_double_from_value
+arv_gc_set_double_to_value
+</SECTION>
+
+<SECTION>
+<FILE>arvgvinterface</FILE>
+<TITLE>ArvGvInterface</TITLE>
+ArvGvInterface
+arv_gv_interface_get_instance
+<SUBSECTION Standard>
+ARV_GV_INTERFACE
+ARV_IS_GV_INTERFACE
+ARV_TYPE_GV_INTERFACE
+arv_gv_interface_get_type
+ARV_GV_INTERFACE_CLASS
+ARV_IS_GV_INTERFACE_CLASS
+ARV_GV_INTERFACE_GET_CLASS
+<SUBSECTION Private>
+ARV_GV_INTERFACE_DISCOVERY_TIMEOUT_MS
+ARV_GV_INTERFACE_SOCKET_BUFFER_SIZE
+ArvGvInterfacePrivate
+ArvGvInterfaceClass
+</SECTION>
+
+<SECTION>
+<FILE>arvgvdevice</FILE>
+<TITLE>ArvGvDevice</TITLE>
+ArvGvDevice
+arv_gv_device_new
+arv_gv_device_get_timestamp_tick_frequency
+<SUBSECTION Standard>
+ARV_GV_DEVICE
+ARV_IS_GV_DEVICE
+ARV_TYPE_GV_DEVICE
+arv_gv_device_get_type
+ARV_GV_DEVICE_CLASS
+ARV_IS_GV_DEVICE_CLASS
+ARV_GV_DEVICE_GET_CLASS
+<SUBSECTION Private>
+ARV_GV_DEVICE_GVCP_N_RETRIES_DEFAULT
+ARV_GV_DEVICE_GVCP_TIMEOUT_MS_DEFAULT
+ARV_GV_DEVICE_BUFFER_SIZE
+ArvGvDeviceClass
+ArvGvDevicePrivate
+</SECTION>
+
+<SECTION>
+<FILE>arvgcenumentry</FILE>
+<TITLE>ArvGcEnumEntry</TITLE>
+ArvGcEnumEntry
+arv_gc_enum_entry_new
+arv_gc_enum_entry_get_value
+<SUBSECTION Standard>
+ARV_GC_ENUM_ENTRY
+ARV_IS_GC_ENUM_ENTRY
+ARV_TYPE_GC_ENUM_ENTRY
+arv_gc_enum_entry_get_type
+ARV_GC_ENUM_ENTRY_CLASS
+ARV_IS_GC_ENUM_ENTRY_CLASS
+ARV_GC_ENUM_ENTRY_GET_CLASS
+<SUBSECTION Private>
+ArvGcEnumEntryClass
+</SECTION>
+
+<SECTION>
+<FILE>arvfakestream</FILE>
+<TITLE>ArvFakeStream</TITLE>
+ArvFakeStream
+arv_fake_stream_new
+<SUBSECTION Standard>
+ARV_FAKE_STREAM
+ARV_IS_FAKE_STREAM
+ARV_TYPE_FAKE_STREAM
+arv_fake_stream_get_type
+ARV_FAKE_STREAM_CLASS
+ARV_IS_FAKE_STREAM_CLASS
+ARV_FAKE_STREAM_GET_CLASS
+<SUBSECTION Private>
+ArvFakeStreamPrivate
+ArvFakeStreamClass
+</SECTION>
+
+<SECTION>
+<FILE>arvgcboolean</FILE>
+<TITLE>ArvGcBoolean</TITLE>
+ArvGcBoolean
+arv_gc_boolean_new
+arv_gc_boolean_get_value
+arv_gc_boolean_set_value
+<SUBSECTION Standard>
+ARV_GC_BOOLEAN
+ARV_IS_GC_BOOLEAN
+ARV_TYPE_GC_BOOLEAN
+arv_gc_boolean_get_type
+ARV_GC_BOOLEAN_CLASS
+ARV_IS_GC_BOOLEAN_CLASS
+ARV_GC_BOOLEAN_GET_CLASS
+<SUBSECTION Private>
+ArvGcBooleanClass
+</SECTION>
+
+<SECTION>
+<FILE>arvgccategory</FILE>
+<TITLE>ArvGcCategory</TITLE>
+ArvGcCategory
+arv_gc_category_new
+<SUBSECTION Standard>
+ARV_GC_CATEGORY
+ARV_IS_GC_CATEGORY
+ARV_TYPE_GC_CATEGORY
+arv_gc_category_get_type
+ARV_GC_CATEGORY_CLASS
+ARV_IS_GC_CATEGORY_CLASS
+ARV_GC_CATEGORY_GET_CLASS
+<SUBSECTION Private>
+ArvGcCategoryClass
+</SECTION>
+
+<SECTION>
+<FILE>arvgcfloat</FILE>
+<TITLE>ArvGcFloat</TITLE>
+arv_gc_float_get_value
+arv_gc_float_set_value
+arv_gc_float_get_min
+arv_gc_float_get_max
+arv_gc_float_get_inc
+arv_gc_float_get_unit
+arv_gc_float_impose_min
+arv_gc_float_impose_max
+<SUBSECTION Standard>
+ARV_GC_FLOAT
+ARV_IS_GC_FLOAT
+ARV_TYPE_GC_FLOAT
+arv_gc_float_get_type
+ARV_GC_FLOAT_GET_INTERFACE
+<SUBSECTION Private>
+ArvGcFloatInterface
+</SECTION>
+
+<SECTION>
+<FILE>arvgcswissknife</FILE>
+<TITLE>ArvGcSwissKnife</TITLE>
+ArvGcSwissKnife
+arv_gc_swiss_knife_new
+arv_gc_int_swiss_knife_new
+<SUBSECTION Standard>
+ARV_GC_SWISS_KNIFE
+ARV_IS_GC_SWISS_KNIFE
+ARV_TYPE_GC_SWISS_KNIFE
+arv_gc_swiss_knife_get_type
+ARV_GC_SWISS_KNIFE_CLASS
+ARV_IS_GC_SWISS_KNIFE_CLASS
+ARV_GC_SWISS_KNIFE_GET_CLASS
+<SUBSECTION Private>
+ArvGcSwissKnifeClass
+</SECTION>
+
+<SECTION>
+<FILE>arvfakecamera</FILE>
+<TITLE>ArvFakeCamera</TITLE>
+ArvFakeCamera
+arv_fake_camera_new
+arv_fake_camera_read_memory
+arv_fake_camera_write_memory
+arv_fake_camera_read_register
+arv_fake_camera_write_register
+arv_fake_camera_wait_for_next_frame
+arv_fake_camera_fill_buffer
+arv_set_fake_camera_genicam_filename
+arv_get_fake_camera_genicam_data
+<SUBSECTION Standard>
+ARV_FAKE_CAMERA
+ARV_IS_FAKE_CAMERA
+ARV_TYPE_FAKE_CAMERA
+arv_fake_camera_get_type
+ARV_FAKE_CAMERA_CLASS
+ARV_IS_FAKE_CAMERA_CLASS
+ARV_FAKE_CAMERA_GET_CLASS
+<SUBSECTION Private>
+ARV_FAKE_CAMERA_MEMORY_SIZE
+ARV_FAKE_CAMERA_REGISTER_SENSOR_WIDTH
+ARV_FAKE_CAMERA_REGISTER_SENSOR_HEIGHT
+ARV_FAKE_CAMERA_REGISTER_WIDTH
+ARV_FAKE_CAMERA_REGISTER_HEIGHT
+ARV_FAKE_CAMERA_REGISTER_X_OFFSET
+ARV_FAKE_CAMERA_REGISTER_Y_OFFSET
+ARV_FAKE_CAMERA_REGISTER_BINNING_HORIZONTAL
+ARV_FAKE_CAMERA_REGISTER_BINNING_VERTICAL
+ARV_FAKE_CAMERA_REGISTER_PIXEL_FORMAT
+ARV_FAKE_CAMERA_SENSOR_WIDTH
+ARV_FAKE_CAMERA_SENSOR_HEIGHT
+ARV_FAKE_CAMERA_WIDTH_DEFAULT
+ARV_FAKE_CAMERA_HEIGHT_DEFAULT
+ARV_FAKE_CAMERA_BINNING_HORIZONTAL_DEFAULT
+ARV_FAKE_CAMERA_BINNING_VERTICAL_DEFAULT
+ARV_FAKE_CAMERA_PIXEL_FORMAT_DEFAULT
+ARV_FAKE_CAMERA_REGISTER_ACQUISITION_MODE
+ARV_FAKE_CAMERA_REGISTER_ACQUISITION_FRAME_PERIOD_US
+ARV_FAKE_CAMERA_REGISTER_FRAME_START_OFFSET
+ARV_FAKE_CAMERA_REGISTER_ACQUISITION_START_OFFSET
+ARV_FAKE_CAMERA_REGISTER_TRIGGER_MODE
+ARV_FAKE_CAMERA_REGISTER_TRIGGER_SOURCE
+ARV_FAKE_CAMERA_REGISTER_TRIGGER_ACTIVATION
+ARV_FAKE_CAMERA_REGISTER_ACQUISITION
+ARV_FAKE_CAMERA_REGISTER_EXPOSURE_TIME_US
+ARV_FAKE_CAMERA_ACQUISITION_FRAME_RATE_DEFAULT
+ARV_FAKE_CAMERA_EXPOSURE_TIME_US_DEFAULT
+ARV_FAKE_CAMERA_REGISTER_GAIN_RAW
+ARV_FAKE_CAMERA_REGISTER_GAIN_MODE
+ArvFakeCameraClass
+ArvFakeCameraPrivate
+</SECTION>
+
+<SECTION>
+<FILE>arvgcregister</FILE>
+<TITLE>ArvGcRegister</TITLE>
+ArvGcSign
+ArvGcRegisterType
+ArvGcRegister
+arv_gc_register_new
+arv_gc_integer_register_new
+arv_gc_masked_integer_register_new
+arv_gc_float_register_new
+arv_gc_string_register_new
+arv_gc_register_get
+arv_gc_register_set
+arv_gc_register_get_address
+arv_gc_register_get_length
+<SUBSECTION Standard>
+ARV_GC_REGISTER
+ARV_IS_GC_REGISTER
+ARV_TYPE_GC_REGISTER
+arv_gc_register_get_type
+ARV_GC_REGISTER_CLASS
+ARV_IS_GC_REGISTER_CLASS
+ARV_GC_REGISTER_GET_CLASS
+<SUBSECTION Private>
+ArvGcRegisterClass
+</SECTION>
+
+<SECTION>
+<FILE>arvgcstring</FILE>
+<TITLE>ArvGcString</TITLE>
+arv_gc_string_get_value
+arv_gc_string_set_value
+arv_gc_string_get_max_length
+<SUBSECTION Standard>
+ARV_GC_STRING
+ARV_IS_GC_STRING
+ARV_TYPE_GC_STRING
+arv_gc_string_get_type
+ARV_GC_STRING_GET_INTERFACE
+<SUBSECTION Private>
+ArvGcStringInterface
+</SECTION>
+
+<SECTION>
+<FILE>arvgvstream</FILE>
+<TITLE>ArvGvStream</TITLE>
+ArvGvStreamOption
+ArvGvStreamPacketResend
+ArvGvStream
+arv_gv_stream_new
+arv_gv_stream_get_port
+arv_gv_stream_set_option
+arv_gv_stream_set_packet_resend
+<SUBSECTION Standard>
+ARV_GV_STREAM
+ARV_IS_GV_STREAM
+ARV_TYPE_GV_STREAM
+arv_gv_stream_get_type
+ARV_GV_STREAM_CLASS
+ARV_IS_GV_STREAM_CLASS
+ARV_GV_STREAM_GET_CLASS
+<SUBSECTION Private>
+ArvGvStreamClass
+</SECTION>
+
+<SECTION>
+<FILE>arvgcfloatnode</FILE>
+<TITLE>ArvGcFloatNode</TITLE>
+ArvGcFloatNode
+arv_gc_float_node_new
+<SUBSECTION Standard>
+ARV_GC_FLOAT_NODE
+ARV_IS_GC_FLOAT_NODE
+ARV_TYPE_GC_FLOAT_NODE
+arv_gc_float_node_get_type
+ARV_GC_FLOAT_NODE_CLASS
+ARV_IS_GC_FLOAT_NODE_CLASS
+ARV_GC_FLOAT_NODE_GET_CLASS
+<SUBSECTION Private>
+ArvGcFloatNodeClass
+</SECTION>
+
+<SECTION>
+<FILE>arvgccommand</FILE>
+<TITLE>ArvGcCommand</TITLE>
+ArvGcCommand
+arv_gc_command_new
+arv_gc_command_execute
+<SUBSECTION Standard>
+ARV_GC_COMMAND
+ARV_IS_GC_COMMAND
+ARV_TYPE_GC_COMMAND
+arv_gc_command_get_type
+ARV_GC_COMMAND_CLASS
+ARV_IS_GC_COMMAND_CLASS
+ARV_GC_COMMAND_GET_CLASS
+<SUBSECTION Private>
+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
+arv_statistic_new
+arv_statistic_free
+arv_statistic_reset
+arv_statistic_fill
+arv_statistic_set_name
+arv_statistic_to_string
+arv_str_parse_double
+</SECTION>
+
+<SECTION>
+<FILE>arvvalue</FILE>
+<TITLE>ArvValue</TITLE>
+arv_value_new_double
+arv_value_new_int64
+arv_value_free
+arv_value_copy
+arv_value_set_int64
+arv_value_set_double
+arv_value_get_int64
+arv_value_get_double
+arv_value_holds_int64
+arv_value_holds_double
+arv_new_g_value_int64
+arv_new_g_value_string
+arv_free_g_value
+arv_force_g_value_to_int64
+arv_force_g_value_to_double
+arv_force_g_value_to_string
+<SUBSECTION Private>
+ArvValue
+arv_copy_memory_with_endianess
+arv_decompress
+G_DEFINE_INTERFACE
+G_DEFINE_INTERFACE_WITH_CODE
+G_IMPLEMENT_INTERFACE
+</SECTION>
+
+<SECTION>
+<FILE>arvgvcp</FILE>
+<TITLE>ArvGvcp</TITLE>
+arv_gvcp_packet_free
+arv_gvcp_packet_new_read_memory_cmd
+arv_gvcp_packet_new_write_memory_cmd
+arv_gvcp_packet_new_read_register_cmd
+arv_gvcp_packet_new_write_register_cmd
+arv_gvcp_packet_new_discovery_cmd
+arv_gvcp_packet_new_packet_resend_cmd
+arv_gvcp_packet_to_string
+arv_gvcp_packet_debug
+<SUBSECTION Private>
+ARV_GVCP_PORT
+ARV_GVBS_CURRENT_IP_ADDRESS
+ARV_GVBS_MANUFACTURER_NAME
+ARV_GVBS_MANUFACTURER_NAME_SIZE
+ARV_GVBS_MODEL_NAME
+ARV_GVBS_MODEL_NAME_SIZE
+ARV_GVBS_DEVICE_VERSION
+ARV_GVBS_DEVICE_VERSION_SIZE
+ARV_GVBS_USER_DEFINED_NAME
+ARV_GVBS_USER_DEFINED_NAME_SIZE
+ARV_GVBS_SERIAL_NUMBER
+ARV_GVBS_SERIAL_NUMBER_SIZE
+ARV_GVBS_DISCOVERY_DATA_SIZE
+ARV_GVBS_FIRST_XML_URL
+ARV_GVBS_SECOND_XML_URL
+ARV_GVBS_XML_URL_SIZE
+ARV_GVBS_HEARTBEAT_TIMEOUT
+ARV_GVBS_TIMESTAMP_TICK_FREQUENCY_HIGH
+ARV_GVBS_TIMESTAMP_TICK_FREQUENCY_LOW
+ARV_GVBS_CONTROL_CHANNEL_PRIVILEGE
+ARV_GVBS_FIRST_STREAM_CHANNEL_PORT
+ARV_GVBS_FIRST_STREAM_CHANNEL_PACKET_SIZE
+ARV_GVBS_FIRST_STREAM_CHANNEL_IP_ADDRESS
+ARV_GVCP_DATA_SIZE_MAX
+ArvGvcpPacket
+ArvGvcpPacketType
+ArvGvcpCommand
+g_ntohl
+g_ntohs
+sizeof
+</SECTION>
+
+<SECTION>
+<FILE>arvdebug</FILE>
+<TITLE>ArvDebug</TITLE>
+arv_debug
+arv_debug_check
+arv_debug_enable
+<SUBSECTION Private>
+ArvDebugLevel
+</SECTION>
+
+<SECTION>
+<FILE>arvgvsp</FILE>
+<TITLE>ArvGvsp</TITLE>
+arv_gvsp_packet_debug
+<SUBSECTION Private>
+ArvGvspPacket
+ArvGvspPacketType
+</SECTION>
+
+<SECTION>
+<FILE>arvzip</FILE>
+<TITLE>ArvZip</TITLE>
+arv_zip_new
+arv_zip_free
+arv_zip_get_file
+arv_zip_get_file_list
+arv_zip_file_get_name
+arv_zip_file_get_uncompressed_size
+<SUBSECTION Private>
+ArvZipFile
+</SECTION>
diff --git a/docs/reference/aravis/aravis.types b/docs/reference/aravis/aravis.types
new file mode 100644
index 0000000..8bb797b
--- /dev/null
+++ b/docs/reference/aravis/aravis.types
@@ -0,0 +1,29 @@
+arv_buffer_get_type
+arv_camera_get_type
+arv_device_get_type
+arv_evaluator_get_type
+arv_fake_camera_get_type
+arv_fake_device_get_type
+arv_fake_interface_get_type
+arv_fake_stream_get_type
+arv_gc_boolean_get_type
+arv_gc_category_get_type
+arv_gc_command_get_type
+arv_gc_converter_get_type
+arv_gc_enum_entry_get_type
+arv_gc_enumeration_get_type
+arv_gc_float_get_type
+arv_gc_float_node_get_type
+arv_gc_get_type
+arv_gc_integer_get_type
+arv_gc_integer_node_get_type
+arv_gc_node_get_type
+arv_gc_port_get_type
+arv_gc_register_get_type
+arv_gc_string_get_type
+arv_gc_swiss_knife_get_type
+arv_gv_device_get_type
+arv_gv_interface_get_type
+arv_gv_stream_get_type
+arv_interface_get_type
+arv_stream_get_type
diff --git a/src/arvbuffer.c b/src/arvbuffer.c
index 4d00afa..9807eaa 100644
--- a/src/arvbuffer.c
+++ b/src/arvbuffer.c
@@ -25,12 +25,14 @@
 static GObjectClass *parent_class = NULL;
 
 /**
-   arv_buffer_new:
-
-   @size: payload size
-   @preallocated: (transfer none): preallocated memory buffer
-
-   Creates a new buffer for the storage of the video stream images. The data space can be either preallocated, and the caller is responsible for it's deallocation, or allocated by this function. If it is the case, data memory will be freed when the buffer is destroyed.
+ * arv_buffer_new:
+ * @size: payload size
+ * @preallocated: (transfer none): preallocated memory buffer
+ *
+ * Creates a new buffer for the storage of the video stream images. 
+ * The data space can be either preallocated, and the caller is responsible
+ * for it's deallocation, or allocated by this function. If it is the case,
+ * data memory will be freed when the buffer is destroyed.
  */
 
 ArvBuffer *
@@ -53,9 +55,10 @@ arv_buffer_new (size_t size, void *preallocated)
 }
 
 /**
-   arv_buffer_clear:
-
-   Clears the buffer status.
+ * arv_buffer_clear:
+ * @buffer: a #ArvBuffer
+ *
+ * Clears the buffer status.
  */
 
 void
diff --git a/src/arvbuffer.h b/src/arvbuffer.h
index 3fbbcde..774d475 100644
--- a/src/arvbuffer.h
+++ b/src/arvbuffer.h
@@ -29,12 +29,22 @@ G_BEGIN_DECLS
 
 typedef void (*ArvFrameCallback)	(ArvBuffer *buffer);
 
+/**
+ * ArvBufferStatus:
+ * @ARV_BUFFER_STATUS_SUCCESS: the buffer contains a valid image
+ * @ARV_BUFFER_STATUS_CLEARED: the buffer is cleared
+ * @ARV_BUFFER_STATUS_MISSING_BLOCKS: image has missing blocks
+ * @ARV_BUFFER_STATUS_SIZE_MISMATCH: the received image didn't fit in the buffer data space
+ * @ARV_BUFFER_STATUS_FILLING: the image is currently being filled
+ * @ARV_BUFFER_STATUS_ABORTED: the filling was aborted before completion
+ */
+
 typedef enum {
 	ARV_BUFFER_STATUS_SUCCESS,
 	ARV_BUFFER_STATUS_CLEARED,
-	ARV_BUFFER_STATUS_FILLING,
 	ARV_BUFFER_STATUS_MISSING_BLOCKS,
 	ARV_BUFFER_STATUS_SIZE_MISMATCH,
+	ARV_BUFFER_STATUS_FILLING,
 	ARV_BUFFER_STATUS_ABORTED
 } ArvBufferStatus;
 
diff --git a/src/arvcamera.c b/src/arvcamera.c
index ebd7141..9c4d3f4 100644
--- a/src/arvcamera.c
+++ b/src/arvcamera.c
@@ -30,6 +30,7 @@
 #include <arvgcstring.h>
 #include <arvgc.h>
 #include <arvdevice.h>
+#include <arvenums.h>
 
 static GObjectClass *parent_class = NULL;
 
@@ -42,13 +43,12 @@ struct _ArvCameraPrivate {
 
 /**
  * arv_camera_create_stream:
- *
- * @camera: a #ArvCamera object
+ * @camera: a #ArvCamera
  * @callback: a frame processing callback
  * @user_data: closure
- * Return value: a new #ArvStream object.
+ * Return value: a new #ArvStream.
  *
- * Creates a new #ArvStream object for video stream handling. See
+ * Creates a new #ArvStream for video stream handling. See
  * @arv_device_create_stream for details regarding the callback function.
  */
 
@@ -64,8 +64,7 @@ arv_camera_create_stream (ArvCamera *camera, ArvStreamCallback callback, void *u
 
 /**
  * arv_camera_get_vendor_name:
- *
- * @camera: a #ArvCamera object
+ * @camera: a #ArvCamera
  * Return value: the camera vendor name.
  */
 
@@ -79,8 +78,7 @@ arv_camera_get_vendor_name (ArvCamera *camera)
 
 /**
  * arv_camera_get_model_name:
- *
- * @camera: a #ArvCamera object
+ * @camera: a #ArvCamera
  * Return value: the camera model name.
  */
 
@@ -94,8 +92,7 @@ arv_camera_get_model_name (ArvCamera *camera)
 
 /**
  * arv_camera_get_device_id:
- *
- * @camera: a #ArvCamera object
+ * @camera: a #ArvCamera
  * Return value: the camera device ID.
  */
 
@@ -111,8 +108,7 @@ arv_camera_get_device_id (ArvCamera *camera)
 
 /**
  * arv_camera_get_sensor_size:
- *
- * @camera: a #ArvCamera object
+ * @camera: a #ArvCamera
  * @width: camera sensor width placeholder
  * @height: camera sensor height placeholder
  */
@@ -130,8 +126,7 @@ arv_camera_get_sensor_size (ArvCamera *camera, gint *width, gint *height)
 
 /**
  * arv_camera_set_region:
- *
- * @camera: a #ArvCamera object
+ * @camera: a #ArvCamera
  * @x: x offset
  * @y: y_offset
  * @width: region width
@@ -158,8 +153,7 @@ arv_camera_set_region (ArvCamera *camera, int x, int y, int width, int height)
 
 /**
  * arv_camera_get_region:
- *
- * @camera: a #ArvCamera object
+ * @camera: a #ArvCamera
  * @x: x offset placeholder
  * @y: y_offset placeholder
  * @width: region width placeholder
@@ -185,8 +179,7 @@ arv_camera_get_region (ArvCamera *camera, gint *x, gint *y, gint *width, gint *h
 
 /**
  * arv_camera_set_binning:
- *
- * @camera: a #ArvCamera object
+ * @camera: a #ArvCamera
  * @dx: horizontal binning
  * @dy: vertical binning
  *
@@ -207,8 +200,7 @@ arv_camera_set_binning (ArvCamera *camera, gint dx, gint dy)
 
 /**
  * arv_camera_get_binning:
- * 
- * @camera: a #ArvCamera object
+ * @camera: a #ArvCamera
  * @dx: horizontal binning placeholder
  * @dy: vertical binning placeholder
  *
@@ -228,8 +220,7 @@ arv_camera_get_binning (ArvCamera *camera, gint *dx, gint *dy)
 
 /**
  * arv_camera_set_pixel_format:
- *
- * @camera: a #ArvCamera object
+ * @camera: a #ArvCamera
  * @format: pixel format
  *
  * Defines the pixel format.
@@ -245,9 +236,7 @@ arv_camera_set_pixel_format (ArvCamera *camera, ArvPixelFormat format)
 
 /**
  * arv_camera_get_pixel_format:
- *
- * @camera: a #ArvCamera object
- * @format: pixel format placeholder
+ * @camera: a #ArvCamera
  *
  * Retrieves the pixel format.
  */
@@ -264,8 +253,7 @@ arv_camera_get_pixel_format (ArvCamera *camera)
 
 /**
  * arv_camera_start_acquisition:
- *
- * @camera: a #ArvCamera object
+ * @camera: a #ArvCamera
  *
  * Starts the video stream acquisition.
  */
@@ -280,8 +268,7 @@ arv_camera_start_acquisition (ArvCamera *camera)
 
 /**
  * arv_camera_stop_acquisition:
- *
- * @camera: a #ArvCamera object
+ * @camera: a #ArvCamera
  *
  * Stops the video stream acquisition.
  */
@@ -294,28 +281,26 @@ arv_camera_stop_acquisition (ArvCamera *camera)
 	arv_device_execute_command (camera->priv->device, "AcquisitionStop");
 }
 
-/**
+/*
  * arv_camera_set_acquisition_mode:
- *
- * @camera: a #ArvCamera object
- * @mode: acquisition mode
+ * @camera: a #ArvCamera
+ * @acquisition_mode: acquisition mode
  *
  * Defines the acquisition mode.
  */
 
 void
-arv_camera_set_acquisition_mode (ArvCamera *camera, ArvAcquisitionMode mode)
+arv_camera_set_acquisition_mode (ArvCamera *camera, ArvAcquisitionMode acquisition_mode)
 {
 	g_return_if_fail (ARV_IS_CAMERA (camera));
 
 	arv_device_set_string_feature_value (camera->priv->device, "AcquisitionMode",
-					     arv_acquisition_mode_to_string (mode));
+					     arv_acquisition_mode_to_string (acquisition_mode));
 }
 
 /**
  * arv_camera_get_acquisition_mode:
- *
- * @camera: a #ArvCamera object
+ * @camera: a #ArvCamera
  * Return value: the acquisition mode.
  *
  * Retrieves the acquisition mode.
@@ -335,8 +320,7 @@ arv_camera_get_acquisition_mode (ArvCamera *camera)
 
 /**
  * arv_camera_set_frame_rate: 
- *
- * @camera: a #ArvCamera object
+ * @camera: a #ArvCamera
  * @frame_rate: frame rate, in Hz
  *
  * Configures a fixed frame rate mode. Once acquisition start is triggered, the
@@ -376,8 +360,7 @@ arv_camera_set_frame_rate (ArvCamera *camera, double frame_rate)
 
 /**
  * arv_camera_get_frame_rate:
- *
- * @camera: a #ArvCamera object
+ * @camera: a #ArvCamera
  * Return value: the actual frame rate, in Hz.
  */
 
@@ -398,8 +381,7 @@ arv_camera_get_frame_rate (ArvCamera *camera)
 
 /**
  * arv_camera_set_trigger:
- *
- * @camera: a #ArvCamera object
+ * @camera: a #ArvCamera
  * @source: trigger source as string
  *
  * Configures the camera in trigger mode. Typical values for source are "Line1"
@@ -450,8 +432,7 @@ arv_camera_set_trigger (ArvCamera *camera, const char *source)
 
 /**
  * arv_camera_set_exposure_time:
- *
- * @camera: a #ArvCamera object
+ * @camera: a #ArvCamera
  * @exposure_time_us: exposure time, in µs
  *
  * Sets the exposure time. User should take care to set a value compatible with
@@ -468,8 +449,7 @@ arv_camera_set_exposure_time (ArvCamera *camera, double exposure_time_us)
 
 /**
  * arv_camera_get_exposure_time:
- *
- * @camera: a #ArvCamera object
+ * @camera: a #ArvCamera
  * Return value: the current exposure time, in µs.
  */
 
@@ -485,8 +465,7 @@ arv_camera_get_exposure_time (ArvCamera *camera)
 
 /**
  * arv_camera_set_gain:
- *
- * @camera: a #ArvCamera object
+ * @camera: a #ArvCamera
  * @gain: gain value
  *
  * Sets the gain of the ADC converter.
@@ -502,8 +481,7 @@ arv_camera_set_gain (ArvCamera *camera, gint64 gain)
 
 /**
  * arv_camera_get_gain:
- *
- * @camera: a #ArvCamera object
+ * @camera: a #ArvCamera
  * Return value: the current gain setting.
  */
 
@@ -519,8 +497,7 @@ arv_camera_get_gain (ArvCamera *camera)
 
 /**
  * arv_camera_get_payload:
- *
- * @camera: a camera object
+ * @camera: a #ArvCamera
  * Return value: the frame storage size, in bytes.
  * 
  * Retrieves the size needed for the storage of an image. This value is used
@@ -537,9 +514,11 @@ arv_camera_get_payload (ArvCamera *camera)
 
 /**
  * arv_camera_new:
+ * @name: (allow-none): name of the camera.
+ * Return value: a new #ArvCamera.
  *
- * @name: (allow-none): name of the camera. If null, it will instantiate the
- * first camera.
+ * Creates a new #ArvCamera. If @name is null, it will instantiate the
+ * first available camera
  */
 
 ArvCamera *
diff --git a/src/arvcamera.h b/src/arvcamera.h
index 2ef9d74..b65243f 100644
--- a/src/arvcamera.h
+++ b/src/arvcamera.h
@@ -28,6 +28,13 @@
 
 G_BEGIN_DECLS
 
+/**
+ * ArvCameraVendor:
+ * @ARV_CAMERA_VENDOR_UNKNOWN: unknown camera vendor
+ * @ARV_CAMERA_VENDOR_BASLER: Basler
+ * @ARV_CAMERA_VENDOR_PROSILICA: Prosilica
+ */
+
 typedef enum {
 	ARV_CAMERA_VENDOR_UNKNOWN,
 	ARV_CAMERA_VENDOR_BASLER,
diff --git a/src/arvdevice.c b/src/arvdevice.c
index 2208602..e3e19d7 100644
--- a/src/arvdevice.c
+++ b/src/arvdevice.c
@@ -78,9 +78,8 @@ arv_device_write_register (ArvDevice *device, guint32 address, guint32 value)
 }
 
 /**
- * arv_device_get_genicam:
- *
- * @device: a device object
+ * arv_device_get_genicam: 
+ * @device: a device object 
  * Return value: (transfer none): the genicam interface.
  *
  * Retrieves the genicam interface of the given device.
diff --git a/src/arvenums.h b/src/arvenums.h
index 27e93b0..2386b91 100644
--- a/src/arvenums.h
+++ b/src/arvenums.h
@@ -45,11 +45,21 @@ typedef enum {
 	ARV_GC_CACHABLE_WRITE_AROUND
 } ArvGcCachable;
 
+/**
+ * ArvAcquisitionMode:
+ * @ARV_ACQUISITION_MODE_CONTINUOUS: continuous acquisition
+ * @ARV_ACQUISITION_MODE_SINGLE_FRAME: only one frame will be acquired
+ */
+
 typedef enum {
 	ARV_ACQUISITION_MODE_CONTINUOUS,
 	ARV_ACQUISITION_MODE_SINGLE_FRAME
 } ArvAcquisitionMode;
 
+/**
+ * ArvPixelFormat:
+ */
+
 typedef enum {
 	ARV_PIXEL_FORMAT_MONO_8			= 0x01080001,
 	ARV_PIXEL_FORMAT_MONO_10		= 0x01100003,
diff --git a/src/arvevaluator.c b/src/arvevaluator.c
index e34eefc..3fcd218 100644
--- a/src/arvevaluator.c
+++ b/src/arvevaluator.c
@@ -1058,9 +1058,8 @@ arv_evaluator_set_int64_variable (ArvEvaluator *evaluator, const char *name, gin
 		   name, v_int64);
 }
 
-/**
+/** 
  * arv_evaluator_new:
- *
  * @expression: (allow-none): an evaluator expression
  * Return value: a new #ArvEvaluator object.
  *
diff --git a/src/arvgc.c b/src/arvgc.c
index 705330f..7e65439 100644
--- a/src/arvgc.c
+++ b/src/arvgc.c
@@ -281,7 +281,6 @@ arv_gc_parse_xml (ArvGc *genicam, const char *xml, size_t size)
 
 /**
  * arv_gc_get_node:
- *
  * @genicam: a #ArvGc object
  * @name: node name
  * Return value: (transfer none): a #ArvGcNode, null if not found.
@@ -299,7 +298,6 @@ arv_gc_get_node	(ArvGc *genicam, const char *name)
 
 /**
  * arv_gc_get_device:
- *
  * @genicam: a #ArvGc object
  * Return value: (transfer none): a #ArvDevice.
  *
diff --git a/src/arvgcregister.h b/src/arvgcregister.h
index d603fd3..23c4cd5 100644
--- a/src/arvgcregister.h
+++ b/src/arvgcregister.h
@@ -28,12 +28,27 @@
 
 G_BEGIN_DECLS
 
+/**
+ * ArvGcSign:
+ * @ARV_GC_SIGN_SIGNED: signed integer
+ * @ARV_GC_SIGN_UNSIGNED: unsigned integer
+ */
+
 typedef enum
 {
 	ARV_GC_SIGN_SIGNED,
 	ARV_GC_SIGN_UNSIGNED
 } ArvGcSign;
 
+/**
+ * ArvGcRegisterType:
+ * @ARV_GC_REGISTER_TYPE_REGISTER: Register node
+ * @ARV_GC_REGISTER_TYPE_INTEGER: IntReg node
+ * @ARV_GC_REGISTER_TYPE_MASKED_INTEGER: MaskedIntReg node
+ * @ARV_GC_REGISTER_TYPE_FLOAT: FloatReg node
+ * @ARV_GC_REGISTER_TYPE_STRING: StringReg node
+ */
+
 typedef enum {
        ARV_GC_REGISTER_TYPE_REGISTER,
        ARV_GC_REGISTER_TYPE_INTEGER,
diff --git a/src/arvgvstream.h b/src/arvgvstream.h
index bcb4239..fcba136 100644
--- a/src/arvgvstream.h
+++ b/src/arvgvstream.h
@@ -29,11 +29,23 @@
 
 G_BEGIN_DECLS
 
+/**
+ * ArvGvStreamOption:
+ * @ARV_GV_STREAM_OPTION_SOCKET_BUFFER_FIXED: socket buffer is set to a given fixed value
+ * @ARV_GV_STREAM_OPTION_SOCKET_BUFFER_AUTO: sockect buffer is set with respect to the payload size
+ */
+
 typedef enum {
 	ARV_GV_STREAM_OPTION_SOCKET_BUFFER_FIXED,
 	ARV_GV_STREAM_OPTION_SOCKET_BUFFER_AUTO
 } ArvGvStreamOption;
 
+/**
+ * ArvGvStreamPacketResend:
+ * @ARV_GV_STREAM_PACKET_RESEND_NEVER: never request a packet resend
+ * @ARV_GV_STREAM_PACKET_RESEND_ALWAYS: request a packet resend if a packet was missing
+ */
+
 typedef enum {
 	ARV_GV_STREAM_PACKET_RESEND_NEVER,
 	ARV_GV_STREAM_PACKET_RESEND_ALWAYS
diff --git a/src/arvstream.c b/src/arvstream.c
index bd82bf3..6b55611 100644
--- a/src/arvstream.c
+++ b/src/arvstream.c
@@ -28,8 +28,11 @@ static GObjectClass *parent_class = NULL;
 
 /**
  * arv_stream_push_buffer:
- *
+ * @stream: a #ArvStream
  * @buffer: (transfer full): buffer to push
+ *
+ * Pushes a #ArvBuffer to the @stream thread. The @stream takes ownership of @buffer,
+ * and will free all the buffers still in its queues when destroyed.
  */
 
 void
@@ -41,6 +44,15 @@ arv_stream_push_buffer (ArvStream *stream, ArvBuffer *buffer)
 	g_async_queue_push (stream->input_queue, buffer);
 }
 
+/**
+ * arv_stream_pop_buffer:
+ * @stream: a #ArvStream
+ * Returns: a #ArvBuffer
+ *
+ * Pops a buffer from the output queue of @stream. The retrieved buffer
+ * may contain an invalid image. Caller should check the buffer status before using it.
+ */
+
 ArvBuffer *
 arv_stream_pop_buffer (ArvStream *stream)
 {
diff --git a/src/arvstream.h b/src/arvstream.h
index 063ee0b..790720b 100644
--- a/src/arvstream.h
+++ b/src/arvstream.h
@@ -27,6 +27,16 @@
 
 G_BEGIN_DECLS
 
+/**
+ * ArvStreamCallbackType:
+ * @ARV_STREAM_CALLBACK_TYPE_INIT: thread initialization, happens once
+ * @ARV_STREAM_CALLBACK_TYPE_EXIT: thread end, happens once
+ * @ARV_STREAM_CALLBACK_TYPE_START_BUFFER: buffer filling start, happens at each frame
+ * @ARV_STREAM_CALLBACK_TYPE_BUFFER_DONE: buffer filled, happens at each frame
+ *
+ * Describes when the stream callback is called.
+ */
+
 typedef enum {
 	ARV_STREAM_CALLBACK_TYPE_INIT,
 	ARV_STREAM_CALLBACK_TYPE_EXIT,
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]