[nautilus-actions] Reorganize reference manual

From: Pierre Wieser <pwieser src gnome org>
To: commits-list gnome org
Cc:
Subject: [nautilus-actions] Reorganize reference manual
Date: Sun, 5 Dec 2010 18:09:27 +0000 (UTC)
commit 80561d63fca398ecb41d12145e1a2f46f3fabf9a
Author: Pierre Wieser <pwieser trychlos org>
Date:   Sun Dec 5 19:09:43 2010 +0100

    Reorganize reference manual

 ChangeLog                                          |    2 +
 configure.ac                                       |    6 +-
 docs/Makefile.am                                   |    4 +-
 docs/README                                        |   26 +-
 docs/api/version.xml.in                            |    1 -
 docs/internals/Makefile.am                         |   27 --
 docs/product/Makefile.am                           |   27 --
 docs/{api => reference}/.gitignore                 |    0
 docs/{api => reference}/Makefile.am                |   50 +--
 docs/reference/compiling.xml                       |  200 ++++++++++
 docs/reference/dist-content.xml                    |   30 ++
 docs/{api => reference}/nautilus-actions-docs.xml  |   45 ++-
 .../nautilus-actions-sections.txt                  |  421 ++++++++++----------
 docs/reference/version.xml.in                      |    1 +
 docs/reference/what-is-it.xml                      |   30 ++
 src/api/na-core-utils.h                            |    2 +-
 src/api/na-data-boxed.h                            |    2 +-
 src/api/na-data-def.h                              |    2 +-
 src/api/na-dbus.h                                  |   10 +-
 src/api/na-gconf-monitor.h                         |    2 +-
 src/api/na-icontext.h                              |    2 +-
 src/api/na-iduplicable.h                           |    3 +-
 src/api/na-iexporter.h                             |    8 +-
 src/api/na-ifactory-object.h                       |   10 +-
 src/api/na-ifactory-provider-provider.h            |   10 +-
 src/api/na-ifactory-provider.h                     |    6 +-
 src/api/na-iimporter.h                             |    8 +-
 src/api/na-iio-provider.h                          |   41 +-
 src/api/na-object-action.h                         |    3 +-
 src/api/na-object-api.h                            |    2 +-
 src/api/na-object-id.h                             |    3 +-
 src/api/na-object-item.h                           |    2 +-
 src/api/na-object-menu.h                           |    3 +-
 src/api/na-object-profile.h                        |    5 +-
 src/api/na-object.h                                |    2 +-
 src/core/na-ifactory-provider.c                    |    4 +
 src/core/na-iio-provider.c                         |   38 ++
 37 files changed, 655 insertions(+), 383 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 0064c0f..abc5109 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,5 @@
+2010-12-04 Pierre Wieser <pwieser trychlos org>
+
 2010-12-03 Pierre Wieser <pwieser trychlos org>
 
 	* docs/nact/Makefile.am:
diff --git a/configure.ac b/configure.ac
index db91607..44ada2b 100644
--- a/configure.ac
+++ b/configure.ac
@@ -45,11 +45,9 @@ AC_CONFIG_FILES([
 	data/exports/Makefile
 	data/gconf-schemas/Makefile
 	docs/Makefile
-	docs/api/Makefile
-	docs/api/version.xml
-	docs/internals/Makefile
 	docs/nact/Makefile
-	docs/product/Makefile
+	docs/reference/Makefile
+	docs/reference/version.xml
 	m4/Makefile
 	icons/Makefile
 	icons/16x16/Makefile
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 04d4cba..53474b1 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -27,10 +27,8 @@
 #   ... and many others (see AUTHORS)
 
 SUBDIRS = \
-	api									\
-	internals							\
 	nact								\
-	product								\
+	reference							\
 	$(NULL)
 
 pkgdocdir = $(datarootdir)/doc/@PACKAGE -@VERSION@
diff --git a/docs/README b/docs/README
index 1c98218..cec15c6 100644
--- a/docs/README
+++ b/docs/README
@@ -1,21 +1,11 @@
-The documentation associated with Nautilus-Actions is composed of
-several parts:
+docs
+----
+As of Nautilus-Actions 3.0, the documentation is composed of two main
+parts:
 
-- a global documentation which describes all features of the product,
-  such as D-Bus interface, command-line utilities, what is an I/O
-  provider and which I/O providers are provided by default, a description
-  of the export formats, an annexe for .desktop files, a note about
-  versions
-  product/
+- the Reference Manual describes all features of the product, and
+  rather targets developers and packagers;
   
-- the Nautilus-Actions configuration tool user's manual
-  nact/
+- the Nautilus-Actions Configuration Tool User's Manual.
 
-- the public API which must be used to develop Nautilus-Actions plugins
-  api/
-  only document here the public API
-
-- some articles which target the Nautilus-Actions core developer.
-  internals/
-  put here all informations which may be relevant to the core developer
-  included the internal API
+P. Wieser, Dec. 2010
diff --git a/docs/api/.gitignore b/docs/reference/.gitignore
similarity index 100%
rename from docs/api/.gitignore
rename to docs/reference/.gitignore
diff --git a/docs/api/Makefile.am b/docs/reference/Makefile.am
similarity index 73%
rename from docs/api/Makefile.am
rename to docs/reference/Makefile.am
index 9c25b01..c6145d6 100644
--- a/docs/api/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -26,6 +26,10 @@
 #   Pierre Wieser <pwieser trychlos org>
 #   ... and many others (see AUTHORS)
 
+#
+# Nautilus-Actions Reference Manual
+#
+
 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 include $(top_srcdir)/gtk-doc.make
 
@@ -35,34 +39,13 @@ DOC_MODULE_VERSION = 3
 
 DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml
 
-doc_sections = $(DOC_MODULE)-sections.txt
-
 # from the public API documentation point of view
 # we have to ignore all headers in src/core, and all corresponding source
 # that is, only consider in src/core .c sources whose header is in src/api
-
-core_headers = \
-	na-exporter.h								\
-	na-export-format.h							\
-	na-factory-object.h							\
-	na-factory-provider.h						\
-	na-gnome-vfs-uri.h							\
-	na-gtk-utils.h								\
-	na-iabout.h									\
-	na-importer-ask.h							\
-	na-importer.h								\
-	na-io-provider.h							\
-	na-ipivot-consumer.h						\
-	na-iprefs.h									\
-	na-module.h									\
-	na-pivot.h									\
-	na-selected-info.h							\
-	na-tokens.h									\
-	na-updater.h								\
-	$(NULL)
+core_headers = $(patsubst $(top_srcdir)/src/core/%,%,$(shell \ls -1 $(top_srcdir)/src/core/*.h))
 
 # Extra options to supply to gtkdoc-scan
-#	--ignore-headers="config.h devkit-disks-daemon-glue.h devkit-disks-device-glue.h gdu-private.h gdu-marshal.h gdu-shared.h"
+#	--ignore-headers="config.h devkit-disks-daemon-glue.h"
 #	--rebuild-sections
 SCAN_OPTIONS = \
 	--rebuild-types								\
@@ -74,10 +57,6 @@ DOC_SOURCE_DIR = \
 	--source-dir=$(top_srcdir)/src/core			\
 	$(NULL)
 
-# Used for dependencies
-#HFILE_GLOB = $(top_srcdir)/src/gdu*/*.h
-#CFILE_GLOB = $(top_srcdir)/src/gdu*/*.c
-
 # Headers to ignore
 IGNORE_HFILES = \
 	$(core_headers)								\
@@ -112,7 +91,6 @@ gtkdoc_run_prefix = \
 	$(NULL)
 
 # Extra options to supply to gtkdoc-mkdb
-#	--ignore-files="devkit-disks-daemon-glue.h devkit-disks-device-glue.h gdu-private.h gdu-marshal.h gdu-shared.h"
 MKDB_OPTIONS = \
 	--sgml-mode 								\
 	--output-format=xml							\
@@ -149,17 +127,6 @@ xml_files = $(xml_in_files:.xml.in=.xml)
 #CLEANFILES += \
 #	*~											\
 #	gnome-disk-utility-scan*					\
-#	gnome-disk-utility.args						\
-#	gnome-disk-utility.hierarchy				\
-#	gnome-disk-utility.interfaces				\
-#	gnome-disk-utility.prerequisites			\
-#	gnome-disk-utility.signals					\
-#	*.bak										\
-#	gnome-disk-utility-decl-list.txt			\
-#	gnome-disk-utility-decl.txt					\
-#	gnome-disk-utility-overrides.txt			\
-#	gnome-disk-utility-undeclared.txt			\
-#	gnome-disk-utility-undocumented.txt			\
 #	gnome-disk-utility-sections.txt				\
 #	*.stamp										\
 #	-rf html xml tmpl							\
@@ -170,4 +137,9 @@ EXTRA_DIST += \
 	$(xml_in_files)								\
 	$(NULL)
 
+install-data-local: install-data-local-hook
+
+install-data-local-hook:
+	echo "core_headers=$(core_headers)"
+
 #TESTS = $(GTKDOC_CHECK)
diff --git a/docs/reference/compiling.xml b/docs/reference/compiling.xml
new file mode 100644
index 0000000..cfcd78d
--- /dev/null
+++ b/docs/reference/compiling.xml
@@ -0,0 +1,200 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd";
+[
+  <!ENTITY prodname "<productname>Nautilus-Actions</productname>">
+  <!ENTITY nautilus "<productname>Nautilus</productname>">
+]>
+
+<refentry id="na-compiling" revision="4 Dec 2010">
+
+  <refmeta>
+    <refentrytitle>Compiling the Nautilus-Actions package</refentrytitle>
+    <manvolnum>3</manvolnum>
+    <refmiscinfo>Nautilus-Actions</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>Compiling the Nautilus-Actions Package</refname>
+    <refpurpose>
+      How to compile Nautilus-Actions itself
+    </refpurpose>
+  </refnamediv>
+
+  <refsect1 id="building">
+    <title>Building &prodname; on UNIX</title>
+
+    <para>
+      On UNIX, &prodname; uses the standard GNU build system,
+      using <application>autoconf</application> for package
+      configuration and resolving portability issues,
+      <application>automake</application> for building makefiles
+      that comply with the GNU Coding Standards, and
+      <application>libtool</application> for building shared
+      libraries on multiple platforms.  The normal sequence for
+      compiling and installing the &prodname; package is thus:
+
+      <literallayout>
+        <userinput>./configure</userinput>
+        <userinput>make</userinput>
+        <userinput>make install</userinput>
+      </literallayout>
+    </para>
+
+    <para>
+      The standard options provided by <application>GNU
+      autoconf</application> may be passed to the
+      <command>configure</command> script.  Please see the
+      <application>autoconf</application> documentation or run
+      <command>./configure --help</command> for information about
+      the standard options.
+    </para>
+  </refsect1>
+
+  <refsect1 id="dependencies">
+    <title>Dependencies</title>
+
+    <para>
+      Before you can compile the &prodname; package, you need to have
+      various other tools and libraries installed on your
+      system. The two tools needed during the build process (as
+      differentiated from the tools used in when creating &prodname;
+      mentioned above such as <application>autoconf</application>)
+      are <command>pkg-config</command> and GNU make.
+    </para>
+
+    <itemizedlist>
+      <listitem>
+        <para>
+          <ulink url="http://www.freedesktop.org/software/pkgconfig/";>pkg-config</ulink>
+          is a tool for tracking the compilation flags needed for
+          libraries that are used by the &prodname; package.
+          (For each library, a small <literal>.pc</literal> text file is
+          installed in a standard location that contains the compilation
+          flags needed for that library along with version number
+          information.)
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          The &prodname; makefiles will mostly work with different versions
+          of <command>make</command>. However, there tends to be
+          a few incompatibilities, so the &prodname; team recommends
+          installing <ulink url="http://www.gnu.org/software/make";>GNU
+          make</ulink> if you don't already have it on your system
+          and using it. (It may be called <command>gmake</command>
+          rather than <command>make</command>.)
+        </para>
+      </listitem>
+    </itemizedlist>
+
+    <para>
+      &prodname; depends on a number of other libraries.
+    </para>
+
+    <itemizedlist>
+      <listitem>
+        <para>
+          <ulink url="http://library.gnome.org/devel/glib/stable/";>GLib</ulink>
+          and <ulink url="http://www.gtk.org/";>Gtk+</ulink> are fondamental
+          libraries, both for user interface and for portability and
+          internationalization management.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <ulink url="http://xmlsoft.org/";>libxml2</ulink> is used to
+          manage XML imports and exports.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <ulink url="http://library.gnome.org/devel/libgtop/stable/";>libgtop2</ulink>
+          is used to detect and identify running processes as part of the validation
+          process of a candidate context.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <ulink url="http://www.x.org/";>libSM</ulink>
+          is used as a session management library, in order to be sure the session
+          will not terminate without at least proposing the user to save his
+          modifications.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <ulink url="ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng";>libUUID</ulink>
+          is the universally unique ID library used to automatically generate a
+          unique identifiant at item creation.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <ulink url="http://www.gnome.org/~ebassi/source/";>libunique</ulink>
+          is required so that the Nautilus-Actions Configuration Tool only
+          executes one instance.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          And, of course,
+          <ulink url="http://projects.gnome.org/nautilus/";>&nautilus; extension</ulink>
+          is required because &prodname; is first a &nautilus; extension.
+        </para>
+      </listitem>
+    </itemizedlist>
+  </refsect1>
+
+  <refsect1 id="extra-configuration-options">
+    <title>Extra Configuration Options</title>
+
+    <para>
+      In addition to the normal options, the
+      <command>configure</command> script in the &prodname; package
+      supports these additional arguments:
+
+      <cmdsynopsis>
+        <command>configure</command>
+        <group>
+          <arg>--with-nautilus-extdir=DIR</arg>
+        </group>
+        <group>
+          <arg>--with-default-io-provider=na-gconf|na-desktop</arg>
+        </group>
+        <group>
+          <arg>--enable-html-manuals[=gdt|db2html]</arg>
+        </group>
+        <group>
+          <arg>--enable-pdf-manuals[=dblatex]</arg>
+        </group>
+      </cmdsynopsis>
+    </para>
+
+    <formalpara>
+      <title><systemitem>--with-nautilus-extdir=DIR</systemitem></title>
+      <para>
+      </para>
+    </formalpara>
+
+    <formalpara>
+      <title><systemitem>--with-default-io-provider=na-gconf|na-desktop</systemitem></title>
+      <para>
+      </para>
+    </formalpara>
+
+    <formalpara>
+      <title><systemitem>--enable-html-manuals[=gdt|db2html]</systemitem></title>
+      <para>
+      </para>
+    </formalpara>
+
+    <formalpara>
+      <title><systemitem>--enable-pdf-manuals[=dblatex]</systemitem></title>
+      <para>
+      </para>
+    </formalpara>
+
+  </refsect1>
+
+</refentry>
\ No newline at end of file
diff --git a/docs/reference/dist-content.xml b/docs/reference/dist-content.xml
new file mode 100644
index 0000000..67ce1e7
--- /dev/null
+++ b/docs/reference/dist-content.xml
@@ -0,0 +1,30 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd";
+[
+  <!ENTITY prodname "<productname>Nautilus-Actions</productname>">
+  <!ENTITY nautilus "<productname>Nautilus</productname>">
+]>
+
+<refentry id="na-dist-content" revision="4 Dec 2010">
+
+  <refmeta>
+    <refentrytitle>Distribution content</refentrytitle>
+    <manvolnum>3</manvolnum>
+    <refmiscinfo>Nautilus-Actions</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>Distribution content</refname>
+    <refpurpose>
+      What is distributed ?
+    </refpurpose>
+  </refnamediv>
+
+  <refsect1 id="dist-content">
+    <title>What is distributed ?</title>
+    <para>
+    </para>
+  </refsect1>
+
+</refentry>
\ No newline at end of file
diff --git a/docs/api/nautilus-actions-docs.xml b/docs/reference/nautilus-actions-docs.xml
similarity index 63%
rename from docs/api/nautilus-actions-docs.xml
rename to docs/reference/nautilus-actions-docs.xml
index 7b7beb2..9db6e80 100644
--- a/docs/api/nautilus-actions-docs.xml
+++ b/docs/reference/nautilus-actions-docs.xml
@@ -3,49 +3,74 @@
                "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'">
+  <!ENTITY version SYSTEM "version.xml">
+  <!ENTITY prodname "<productname>Nautilus-Actions</productname>">
+  <!ENTITY nautilus "<productname>Nautilus</productname>">
 ]>
 <book id="index">
   <bookinfo>
-    <title>nautilus-actions Reference Manual</title>
+    <title>&prodname; Reference Manual</title>
     <releaseinfo>
-      for nautilus-actions [VERSION]
+      For Nautilus-Actions &version;
+      <!--
       The latest version of this documentation can be found on-line at
       <ulink role="online-location" url="http://[SERVER]/nautilus-actions/index.html";>http://[SERVER]/nautilus-actions/</ulink>.
+      -->
     </releaseinfo>
   </bookinfo>
 
   <chapter>
-    <title>[Insert title here]</title>
-        <xi:include href="xml/na-iio-provider.xml"/>
+    <title>&prodname; Overview</title>
+    <xi:include href="what-is-it.xml" />
+    <xi:include href="compiling.xml" />
+    <xi:include href="dist-content.xml" />
+  </chapter>
+
+  <chapter>
+    <title>&prodname; Overview</title>
+  </chapter>
+
+  <chapter>
+    <title>Available interfaces</title>
+    <xi:include href="xml/iio-provider.xml" />
+    <xi:include href="xml/iimporter.xml" />
+    <xi:include href="xml/iexporter.xml" />
+    <xi:include href="xml/ifactory-provider.xml" />
+    <xi:include href="xml/ifactory-object.xml" />
+  </chapter>
+
+  <chapter>
+    <title>DBus services (nautilus-actions-api.xml title)</title>
+    <xi:include href="xml/dbus.xml" />
+  </chapter>
+
+  <chapter>
+    <title>Others (nautilus-actions-api.xml title)</title>
     <xi:include href="xml/na-object-id.xml"/>
     <xi:include href="xml/na-object-action.xml"/>
     <xi:include href="xml/na-icontext.xml"/>
-    <xi:include href="xml/na-ifactory-provider.xml"/>
     <xi:include href="xml/na-gconf-monitor.xml"/>
     <xi:include href="xml/na-data-boxed.xml"/>
-    <xi:include href="xml/na-iimporter.xml"/>
-    <xi:include href="xml/na-ifactory-object.xml"/>
     <xi:include href="xml/na-object-menu.xml"/>
     <xi:include href="xml/na-object-item.xml"/>
     <xi:include href="xml/na-object.xml"/>
     <xi:include href="xml/na-object-profile.xml"/>
     <xi:include href="xml/na-iduplicable.xml"/>
-    <xi:include href="xml/na-iexporter.xml"/>
     <xi:include href="xml/na-ifactory-object-data.xml"/>
     <xi:include href="xml/na-extension.xml"/>
     <xi:include href="xml/na-data-types.xml"/>
     <xi:include href="xml/na-gconf-utils.xml"/>
     <xi:include href="xml/na-ifactory-provider-provider.xml"/>
     <xi:include href="xml/na-core-utils.xml"/>
-    <xi:include href="xml/na-dbus.xml"/>
     <xi:include href="xml/na-data-def.xml"/>
     <xi:include href="xml/na-object-api.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/docs/api/nautilus-actions-sections.txt b/docs/reference/nautilus-actions-sections.txt
similarity index 96%
rename from docs/api/nautilus-actions-sections.txt
rename to docs/reference/nautilus-actions-sections.txt
index 62765c3..9d881a3 100644
--- a/docs/api/nautilus-actions-sections.txt
+++ b/docs/reference/nautilus-actions-sections.txt
@@ -1,30 +1,162 @@
+
 <SECTION>
-<FILE>na-iio-provider</FILE>
-NA_IIO_PROVIDER_TYPE
-NA_IIO_PROVIDER_GET_INTERFACE
+<FILE>iio-provider</FILE>
 NAIIOProvider
-NAIIOProviderInterfacePrivate
 NAIIOProviderInterface
 na_iio_provider_item_changed
 IIO_PROVIDER_SIGNAL_ITEM_CHANGED
+
 <SUBSECTION Standard>
 NA_IIO_PROVIDER
 NA_IS_IIO_PROVIDER
+NA_IIO_PROVIDER_TYPE
+NA_IIO_PROVIDER_GET_INTERFACE
+
+<SUBSECTION Private>
+NAIIOProviderInterfacePrivate
 na_iio_provider_get_type
 </SECTION>
 
 <SECTION>
-<FILE>na-object-id</FILE>
+<FILE>ifactory-object</FILE>
+NA_IFACTORY_OBJECT_TYPE
+NA_IFACTORY_OBJECT_GET_INTERFACE
+NAIFactoryObject
+NAIFactoryObjectInterfacePrivate
+NAIFactoryObjectInterface
+na_ifactory_object_get_data_groups
+na_ifactory_object_get_data_boxed
+na_ifactory_object_get_as_void
+na_ifactory_object_set_from_void
+
+<SUBSECTION Standard>
+NA_IFACTORY_OBJECT
+NA_IS_IFACTORY_OBJECT
+na_ifactory_object_get_type
+</SECTION>
+
+<SECTION>
+<FILE>ifactory-provider</FILE>
+NA_IFACTORY_PROVIDER_TYPE
+NA_IFACTORY_PROVIDER_GET_INTERFACE
+NAIFactoryProviderInterfacePrivate
+NAIFactoryProviderInterface
+na_ifactory_provider_read_item
+na_ifactory_provider_write_item
+
+<SUBSECTION Standard>
+NA_IFACTORY_PROVIDER
+NA_IS_IFACTORY_PROVIDER
+na_ifactory_provider_get_type
+</SECTION>
+
+<SECTION>
+<FILE>iimporter</FILE>
+NA_IIMPORTER_TYPE
+NA_IIMPORTER_GET_INTERFACE
+NAIImporter
+NAIImporterInterfacePrivate
+NAIImporterImportFromUriParms
+NAIImporterManageImportModeParms
+NAIImporterInterface
+na_iimporter_import_from_uri
+na_iimporter_manage_import_mode
+
+<SUBSECTION Standard>
+NA_IIMPORTER
+NA_IS_IIMPORTER
+na_iimporter_get_type
+</SECTION>
+
+<SECTION>
+<FILE>iexporter</FILE>
+NA_IEXPORTER_TYPE
+NA_IEXPORTER_GET_INTERFACE
+NAIExporter
+NAIExporterFileParms
+NAIExporterBufferParms
+NAIExporterInterfacePrivate
+NAIExporterFormat
+NAIExporterInterface
+
+<SUBSECTION Standard>
+NA_IEXPORTER
+NA_IS_IEXPORTER
+na_iexporter_get_type
+</SECTION>
+
+<SECTION>
+<FILE>dbus</FILE>
+<TITLE>DBus (nautilus-actions-sections title)</TITLE>
+NAUTILUS_ACTIONS_DBUS_SERVICE
+</SECTION>
+
+<SECTION>
+<FILE>object</FILE>
+<TITLE>NAObject</TITLE>
+NA_OBJECT_TYPE
+NAObjectPrivate
+NAObjectClassPrivate
+NAObject
+na_object_object_check_status
+na_object_object_check_status_up
+na_object_object_reset_origin
+na_object_object_ref
+na_object_object_unref
+na_object_object_copy
+na_object_object_dump
+na_object_object_dump_norec
+na_object_object_dump_tree
+na_object_object_get_hierarchy
+na_object_free_hierarchy
+na_object_object_debug_invalid
+
+<SUBSECTION Standard>
+NA_OBJECT
+NA_IS_OBJECT
+na_object_object_get_type
+NA_OBJECT_CLASS
+NA_IS_OBJECT_CLASS
+NA_OBJECT_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>iduplicable</FILE>
+NA_IDUPLICABLE_TYPE
+NA_IDUPLICABLE_GET_INTERFACE
+NAIDuplicable
+NAIDuplicableInterfacePrivate
+NAIDuplicableInterface
+NA_IDUPLICABLE_SIGNAL_STATUS_CHANGED
+na_iduplicable_dispose
+na_iduplicable_dump
+na_iduplicable_duplicate
+na_iduplicable_check_status
+na_iduplicable_get_origin
+na_iduplicable_is_valid
+na_iduplicable_is_modified
+na_iduplicable_set_origin
+na_iduplicable_set_modified
+na_iduplicable_register_consumer
+<SUBSECTION Standard>
+NA_IDUPLICABLE
+NA_IS_IDUPLICABLE
+na_iduplicable_get_type
+</SECTION>
+
+<SECTION>
+<FILE>object-id</FILE>
+<TITLE>NAObjectId</TITLE>
 NA_OBJECT_ID_TYPE
 NAObjectIdPrivate
 NAObjectIdClassPrivate
-<TITLE>NAObjectId</TITLE>
 NAObjectId
 na_object_id_sort_alpha_asc
 na_object_id_sort_alpha_desc
 na_object_id_prepare_for_paste
 na_object_id_set_copy_of_label
 na_object_id_set_new_id
+
 <SUBSECTION Standard>
 NA_OBJECT_ID
 NA_IS_OBJECT_ID
@@ -35,11 +167,40 @@ NA_OBJECT_ID_GET_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>na-object-action</FILE>
+<FILE>object-item</FILE>
+<TITLE>NAObjectItem</TITLE>
+NA_OBJECT_ITEM_TYPE
+NAObjectItemPrivate
+NAObjectItemClassPrivate
+NAObjectItem
+na_object_item_are_equal
+na_object_item_get_item
+na_object_item_get_position
+na_object_item_append_item
+na_object_item_insert_at
+na_object_item_insert_item
+na_object_item_remove_item
+na_object_item_get_items_count
+na_object_item_count_items
+na_object_item_unref_items
+na_object_item_unref_items_rec
+na_object_item_rebuild_children_slist
+
+<SUBSECTION Standard>
+NA_OBJECT_ITEM
+NA_IS_OBJECT_ITEM
+na_object_item_get_type
+NA_OBJECT_ITEM_CLASS
+NA_IS_OBJECT_ITEM_CLASS
+NA_OBJECT_ITEM_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>object-action</FILE>
+<TITLE>NAObjectAction</TITLE>
 NA_OBJECT_ACTION_TYPE
 NAObjectActionPrivate
 NAObjectActionClassPrivate
-<TITLE>NAObjectAction</TITLE>
 NAObjectAction
 na_object_action_new
 na_object_action_new_with_profile
@@ -47,6 +208,7 @@ na_object_action_new_with_defaults
 na_object_action_get_new_profile_name
 na_object_action_attach_profile
 na_object_action_set_last_version
+
 <SUBSECTION Standard>
 NA_OBJECT_ACTION
 NA_IS_OBJECT_ACTION
@@ -57,7 +219,45 @@ NA_OBJECT_ACTION_GET_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>na-icontext</FILE>
+<FILE>na-object-profile</FILE>
+<TITLE>NAObjectProfile</TITLE>
+NA_OBJECT_PROFILE_TYPE
+NAObjectProfilePrivate
+NAObjectProfileClassPrivate
+NAObjectProfile
+na_object_profile_new
+na_object_profile_new_with_defaults
+
+<SUBSECTION Standard>
+NA_OBJECT_PROFILE
+NA_IS_OBJECT_PROFILE
+na_object_profile_get_type
+NA_OBJECT_PROFILE_CLASS
+NA_IS_OBJECT_PROFILE_CLASS
+NA_OBJECT_PROFILE_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>object-menu</FILE>
+<TITLE>NAObjectMenu</TITLE>
+NA_OBJECT_MENU_TYPE
+NAObjectMenuPrivate
+NAObjectMenuClassPrivate
+NAObjectMenu
+na_object_menu_new
+na_object_menu_new_with_defaults
+
+<SUBSECTION Standard>
+NA_OBJECT_MENU
+NA_IS_OBJECT_MENU
+na_object_menu_get_type
+NA_OBJECT_MENU_CLASS
+NA_IS_OBJECT_MENU_CLASS
+NA_OBJECT_MENU_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>icontext</FILE>
 NA_ICONTEXT_TYPE
 NA_ICONTEXT_GET_INTERFACE
 NAIContext
@@ -71,6 +271,7 @@ na_icontext_set_scheme
 na_icontext_set_only_desktop
 na_icontext_set_not_desktop
 na_icontext_replace_folder
+
 <SUBSECTION Standard>
 NA_ICONTEXT
 NA_IS_ICONTEXT
@@ -78,28 +279,15 @@ na_icontext_get_type
 </SECTION>
 
 <SECTION>
-<FILE>na-ifactory-provider</FILE>
-NA_IFACTORY_PROVIDER_TYPE
-NA_IFACTORY_PROVIDER_GET_INTERFACE
-NAIFactoryProviderInterfacePrivate
-NAIFactoryProviderInterface
-na_ifactory_provider_read_item
-na_ifactory_provider_write_item
-<SUBSECTION Standard>
-NA_IFACTORY_PROVIDER
-NA_IS_IFACTORY_PROVIDER
-na_ifactory_provider_get_type
-</SECTION>
-
-<SECTION>
-<FILE>na-gconf-monitor</FILE>
+<FILE>gconf-monitor</FILE>
+<TITLE>NAGConfMonitor</TITLE>
 NA_GCONF_MONITOR_TYPE
 NAGConfMonitorPrivate
 NAGConfMonitorClassPrivate
-<TITLE>NAGConfMonitor</TITLE>
 NAGConfMonitor
 na_gconf_monitor_new
 na_gconf_monitor_release_monitors
+
 <SUBSECTION Standard>
 NA_GCONF_MONITOR
 NA_IS_GCONF_MONITOR
@@ -110,11 +298,11 @@ NA_GCONF_MONITOR_GET_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>na-data-boxed</FILE>
+<FILE>data-boxed</FILE>
+<TITLE>NADataBoxed</TITLE>
 NA_DATA_BOXED_TYPE
 NADataBoxedPrivate
 NADataBoxedClassPrivate
-<TITLE>NADataBoxed</TITLE>
 NADataBoxed
 na_data_boxed_get_param_spec
 na_data_boxed_new
@@ -131,6 +319,7 @@ na_data_boxed_set_from_boxed
 na_data_boxed_set_from_string
 na_data_boxed_set_from_value
 na_data_boxed_set_from_void
+
 <SUBSECTION Standard>
 NA_DATA_BOXED
 NA_IS_DATA_BOXED
@@ -141,172 +330,6 @@ NA_DATA_BOXED_GET_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>na-iimporter</FILE>
-NA_IIMPORTER_TYPE
-NA_IIMPORTER_GET_INTERFACE
-NAIImporter
-NAIImporterInterfacePrivate
-NAIImporterImportFromUriParms
-NAIImporterManageImportModeParms
-NAIImporterInterface
-na_iimporter_import_from_uri
-na_iimporter_manage_import_mode
-<SUBSECTION Standard>
-NA_IIMPORTER
-NA_IS_IIMPORTER
-na_iimporter_get_type
-</SECTION>
-
-<SECTION>
-<FILE>na-ifactory-object</FILE>
-NA_IFACTORY_OBJECT_TYPE
-NA_IFACTORY_OBJECT_GET_INTERFACE
-NAIFactoryObject
-NAIFactoryObjectInterfacePrivate
-NAIFactoryObjectInterface
-na_ifactory_object_get_data_groups
-na_ifactory_object_get_data_boxed
-na_ifactory_object_get_as_void
-na_ifactory_object_set_from_void
-<SUBSECTION Standard>
-NA_IFACTORY_OBJECT
-NA_IS_IFACTORY_OBJECT
-na_ifactory_object_get_type
-</SECTION>
-
-<SECTION>
-<FILE>na-object-menu</FILE>
-NA_OBJECT_MENU_TYPE
-NAObjectMenuPrivate
-NAObjectMenuClassPrivate
-<TITLE>NAObjectMenu</TITLE>
-NAObjectMenu
-na_object_menu_new
-na_object_menu_new_with_defaults
-<SUBSECTION Standard>
-NA_OBJECT_MENU
-NA_IS_OBJECT_MENU
-na_object_menu_get_type
-NA_OBJECT_MENU_CLASS
-NA_IS_OBJECT_MENU_CLASS
-NA_OBJECT_MENU_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>na-object-item</FILE>
-NA_OBJECT_ITEM_TYPE
-NAObjectItemPrivate
-NAObjectItemClassPrivate
-<TITLE>NAObjectItem</TITLE>
-NAObjectItem
-na_object_item_are_equal
-na_object_item_get_item
-na_object_item_get_position
-na_object_item_append_item
-na_object_item_insert_at
-na_object_item_insert_item
-na_object_item_remove_item
-na_object_item_get_items_count
-na_object_item_count_items
-na_object_item_unref_items
-na_object_item_unref_items_rec
-na_object_item_rebuild_children_slist
-<SUBSECTION Standard>
-NA_OBJECT_ITEM
-NA_IS_OBJECT_ITEM
-na_object_item_get_type
-NA_OBJECT_ITEM_CLASS
-NA_IS_OBJECT_ITEM_CLASS
-NA_OBJECT_ITEM_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>na-object</FILE>
-NA_OBJECT_TYPE
-NAObjectPrivate
-NAObjectClassPrivate
-<TITLE>NAObject</TITLE>
-NAObject
-na_object_object_check_status
-na_object_object_check_status_up
-na_object_object_reset_origin
-na_object_object_ref
-na_object_object_unref
-na_object_object_copy
-na_object_object_dump
-na_object_object_dump_norec
-na_object_object_dump_tree
-na_object_object_get_hierarchy
-na_object_free_hierarchy
-na_object_object_debug_invalid
-<SUBSECTION Standard>
-NA_OBJECT
-NA_IS_OBJECT
-na_object_object_get_type
-NA_OBJECT_CLASS
-NA_IS_OBJECT_CLASS
-NA_OBJECT_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>na-object-profile</FILE>
-NA_OBJECT_PROFILE_TYPE
-NAObjectProfilePrivate
-NAObjectProfileClassPrivate
-<TITLE>NAObjectProfile</TITLE>
-NAObjectProfile
-na_object_profile_new
-na_object_profile_new_with_defaults
-<SUBSECTION Standard>
-NA_OBJECT_PROFILE
-NA_IS_OBJECT_PROFILE
-na_object_profile_get_type
-NA_OBJECT_PROFILE_CLASS
-NA_IS_OBJECT_PROFILE_CLASS
-NA_OBJECT_PROFILE_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>na-iduplicable</FILE>
-NA_IDUPLICABLE_TYPE
-NA_IDUPLICABLE_GET_INTERFACE
-NAIDuplicable
-NAIDuplicableInterfacePrivate
-NAIDuplicableInterface
-NA_IDUPLICABLE_SIGNAL_STATUS_CHANGED
-na_iduplicable_dispose
-na_iduplicable_dump
-na_iduplicable_duplicate
-na_iduplicable_check_status
-na_iduplicable_get_origin
-na_iduplicable_is_valid
-na_iduplicable_is_modified
-na_iduplicable_set_origin
-na_iduplicable_set_modified
-na_iduplicable_register_consumer
-<SUBSECTION Standard>
-NA_IDUPLICABLE
-NA_IS_IDUPLICABLE
-na_iduplicable_get_type
-</SECTION>
-
-<SECTION>
-<FILE>na-iexporter</FILE>
-NA_IEXPORTER_TYPE
-NA_IEXPORTER_GET_INTERFACE
-NAIExporter
-NAIExporterFileParms
-NAIExporterBufferParms
-NAIExporterInterfacePrivate
-NAIExporterFormat
-NAIExporterInterface
-<SUBSECTION Standard>
-NA_IEXPORTER
-NA_IS_IEXPORTER
-na_iexporter_get_type
-</SECTION>
-
-<SECTION>
 <FILE>na-ifactory-object-data</FILE>
 NA_FACTORY_OBJECT_ID_GROUP
 NAFO_DATA_ID
@@ -410,7 +433,7 @@ NAIFactoryProvider
 </SECTION>
 
 <SECTION>
-<FILE>na-core-utils</FILE>
+<FILE>core-utils</FILE>
 na_core_utils_boolean_from_string
 na_core_utils_str_add_prefix
 na_core_utils_str_collate
@@ -444,19 +467,14 @@ na_core_utils_print_version
 </SECTION>
 
 <SECTION>
-<FILE>na-dbus</FILE>
-NAUTILUS_ACTIONS_DBUS_SERVICE
-</SECTION>
-
-<SECTION>
-<FILE>na-data-def</FILE>
+<FILE>data-def</FILE>
 NADataDef
 NADataGroup
 na_data_def_get_data_def
 </SECTION>
 
 <SECTION>
-<FILE>na-object-api</FILE>
+<FILE>object-api</FILE>
 na_object_duplicate
 na_object_check_status
 na_object_check_status_up
@@ -588,4 +606,3 @@ na_object_set_show_if_running
 na_object_set_selection_count
 na_object_set_capabilities
 </SECTION>
-
diff --git a/docs/reference/version.xml.in b/docs/reference/version.xml.in
new file mode 100644
index 0000000..27323da
--- /dev/null
+++ b/docs/reference/version.xml.in
@@ -0,0 +1 @@
+ VERSION@
\ No newline at end of file
diff --git a/docs/reference/what-is-it.xml b/docs/reference/what-is-it.xml
new file mode 100644
index 0000000..3c16112
--- /dev/null
+++ b/docs/reference/what-is-it.xml
@@ -0,0 +1,30 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd";
+[
+  <!ENTITY prodname "<productname>Nautilus-Actions</productname>">
+  <!ENTITY nautilus "<productname>Nautilus</productname>">
+]>
+
+<refentry id="na-what-is-it" revision="4 Dec 2010">
+
+  <refmeta>
+    <refentrytitle>What is it ?</refentrytitle>
+    <manvolnum>3</manvolnum>
+    <refmiscinfo>Nautilus-Actions</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>What is it ?</refname>
+    <refpurpose>
+      What is Nautilus-Actions ?
+    </refpurpose>
+  </refnamediv>
+
+  <refsect1 id="what-is-it">
+    <title>What is Nautilus-Actions ?</title>
+    <para>
+    </para>
+  </refsect1>
+
+</refentry>
\ No newline at end of file
diff --git a/src/api/na-core-utils.h b/src/api/na-core-utils.h
index 1e4ea55..2fc34c2 100644
--- a/src/api/na-core-utils.h
+++ b/src/api/na-core-utils.h
@@ -32,7 +32,7 @@
 #define __NAUTILUS_ACTIONS_API_NA_CORE_UTILS_H__
 
 /**
- * SECTION: na_core_utils
+ * SECTION: core-utils
  * @short_description: Core library utilities.
  * @include: nautilus-action/na-core-utils.h
  */
diff --git a/src/api/na-data-boxed.h b/src/api/na-data-boxed.h
index 843cbc7..7b1a4ff 100644
--- a/src/api/na-data-boxed.h
+++ b/src/api/na-data-boxed.h
@@ -32,7 +32,7 @@
 #define __NAUTILUS_ACTIONS_API_NA_DATA_BOXED_H__
 
 /**
- * SECTION: na_data_boxed
+ * SECTION: data-boxed
  * @short_description: #NADataBoxed class definition.
  * @include: nautilus-actions/na-data-boxed.h
  *
diff --git a/src/api/na-data-def.h b/src/api/na-data-def.h
index f6a2636..9cc6040 100644
--- a/src/api/na-data-def.h
+++ b/src/api/na-data-def.h
@@ -32,7 +32,7 @@
 #define __NAUTILUS_ACTIONS_API_NA_FACTORY_DATA_DEF_H__
 
 /**
- * SECTION: na_ifactory_object
+ * SECTION: ifactory-object
  * @short_description: Data Factory Definitions.
  * @include: nautilus-actions/na-data-def.h
  */
diff --git a/src/api/na-dbus.h b/src/api/na-dbus.h
index d6a1dcb..da73129 100644
--- a/src/api/na-dbus.h
+++ b/src/api/na-dbus.h
@@ -32,9 +32,15 @@
 #define __NAUTILUS_ACTIONS_API_NA_DBUS_H__
 
 /**
- * SECTION: na_dbus
- * @short_description: Nautilus-Actions DBus description.
+ * SECTION: dbus
+ * @section_id: dbus
+ * @title: DBus interface (na-dbus.h title)
+ * @short_description: DBus interface (na-dbus.h short description)
  * @include: nautilus-actions/na-dbus.h
+ *
+ * Nautilus-Actions, through its Tracker plugin, exposes several DBus interfaces.
+ * These interfaces may be queried in order to get informations about current
+ * selection, Nautilus-Actions status, and so on.
  */
 
 #include <glib.h>
diff --git a/src/api/na-gconf-monitor.h b/src/api/na-gconf-monitor.h
index 0c7a63a..7ca5c17 100644
--- a/src/api/na-gconf-monitor.h
+++ b/src/api/na-gconf-monitor.h
@@ -32,7 +32,7 @@
 #define __NAUTILUS_ACTIONS_API_NA_GCONF_MONITOR_H__
 
 /**
- * SECTION: na_gconf_monitor
+ * SECTION: gconf-monitor
  * @short_description: #NAGConfMonitor class definition.
  * @include: nautilus-actions/na-gconf-monitor.h
  *
diff --git a/src/api/na-icontext.h b/src/api/na-icontext.h
index a6d7c63..5cde422 100644
--- a/src/api/na-icontext.h
+++ b/src/api/na-icontext.h
@@ -32,7 +32,7 @@
 #define __NAUTILUS_ACTIONS_API_NA_ICONTEXT_H__
 
 /**
- * SECTION: na_icontext
+ * SECTION: icontext
  * @short_description: #NAIContext interface definition.
  * @include: nautilus-actions/na-icontext.h
  *
diff --git a/src/api/na-iduplicable.h b/src/api/na-iduplicable.h
index 798dbc1..ad485d1 100644
--- a/src/api/na-iduplicable.h
+++ b/src/api/na-iduplicable.h
@@ -32,7 +32,8 @@
 #define __NAUTILUS_ACTIONS_API_NA_IDUPLICABLE_H__
 
 /**
- * SECTION: na_iduplicable
+ * SECTION: iduplicable
+ * @title: #NAIDuplicable interface
  * @short_description: #NAIDuplicable interface.
  * @include: nautilus-actions/private/na-iduplicable.h
  *
diff --git a/src/api/na-iexporter.h b/src/api/na-iexporter.h
index abeece8..4dd7747 100644
--- a/src/api/na-iexporter.h
+++ b/src/api/na-iexporter.h
@@ -32,13 +32,15 @@
 #define __NAUTILUS_ACTIONS_API_NA_IEXPORTER_H__
 
 /**
- * SECTION: na_iexporter
- * @short_description: #NAIExporter interface definition.
+ * SECTION: iexporter
+ * @section_id: iexporter
+ * @title: NAIExporter (na-iexporter.h title)
+ * @short_description: #NAIExporter interface definition na-iexporter.h short description)
  * @include: nautilus-actions/na-iexporter.h
  *
  * The #NAIExporter interface exports items to the outside world.
  *
- * Nautilus-Actions v 2.30 - API version:  1
+ * Since: Nautilus-Actions v 2.30 (API version 1)
  */
 
 #include "na-object-item.h"
diff --git a/src/api/na-ifactory-object.h b/src/api/na-ifactory-object.h
index 360fb9d..4d72731 100644
--- a/src/api/na-ifactory-object.h
+++ b/src/api/na-ifactory-object.h
@@ -32,8 +32,10 @@
 #define __NAUTILUS_ACTIONS_API_NA_IFACTORY_OBJECT_H__
 
 /**
- * SECTION: na_ifactory_object
- * @short_description: #NAIFactoryObject interface definition.
+ * SECTION: ifactory-object
+ * @section_id: ifactory-object
+ * @title: NAIFactoryObject (na-ifactory-object.h title)
+ * @short_description: #NAIFactoryObject interface definition (na-ifactory-object.h short description).
  * @include: nautilus-actions/na-ifactory_object.h
  *
  * This interface must be implemented by #NAObject-derived objects which
@@ -43,9 +45,9 @@
  * interface must meet following conditions:
  * - must accept an empty constructor
  *
- * Elementary data are implemented as a GList of NADataBoxed objects.
+ * Elementary data are implemented as a #GList of #NADataBoxed objects.
  *
- * Nautilus-Actions v 2.30 - API version:  1
+ * Since: Nautilus-Actions v 2.30 (API version 1)
  */
 
 #include "na-data-def.h"
diff --git a/src/api/na-ifactory-provider-provider.h b/src/api/na-ifactory-provider-provider.h
index 7946b39..b4b1a13 100644
--- a/src/api/na-ifactory-provider-provider.h
+++ b/src/api/na-ifactory-provider-provider.h
@@ -32,16 +32,18 @@
 #define __NAUTILUS_ACTIONS_API_NA_IFACTORY_PROVIDER_PROVIDER_H__
 
 /**
- * SECTION: na_ifactory_provider
- * @short_description: #NAIFactoryProvider interface definition.
- * @include: nautilus-actions/na-ifactory_provider-fn.h
+ * SECTION: ifactory-provider
+ * @section_id: ifactory-provider
+ * @title: NAIFactoryProvider (na-ifactory-provider-provider.h title)
+ * @short_description: #NAIFactoryProvider interface definition (na-ifactory-provider-provider.h short description)
+ * @include: nautilus-actions/na-ifactory_provider-provider.h
  */
 
 #include <glib.h>
 
 G_BEGIN_DECLS
 
-typedef struct NAIFactoryProvider                 NAIFactoryProvider;
+typedef struct NAIFactoryProvider NAIFactoryProvider;
 
 G_END_DECLS
 
diff --git a/src/api/na-ifactory-provider.h b/src/api/na-ifactory-provider.h
index 1fab2a5..dbfce2d 100644
--- a/src/api/na-ifactory-provider.h
+++ b/src/api/na-ifactory-provider.h
@@ -32,8 +32,10 @@
 #define __NAUTILUS_ACTIONS_API_NA_IFACTORY_PROVIDER_H__
 
 /**
- * SECTION: na_ifactory_provider
- * @short_description: #NAIFactoryProvider interface definition.
+ * SECTION: ifactory-provider
+ * @section_id: ifactory-provider
+ * @title: NAIFactoryProvider (na-ifactory-provider.h title)
+ * @short_description: #NAIFactoryProvider interface definition (na-ifactory-provider.h short description)
  * @include: nautilus-actions/na-ifactory_provider.h
  *
  * This is the interface used by data factory management system for
diff --git a/src/api/na-iimporter.h b/src/api/na-iimporter.h
index 40adf81..876099b 100644
--- a/src/api/na-iimporter.h
+++ b/src/api/na-iimporter.h
@@ -32,13 +32,15 @@
 #define __NAUTILUS_ACTIONS_API_NA_IIMPORTER_H__
 
 /**
- * SECTION: na_iimporter
- * @short_description: #NAIImporter interface definition.
+ * SECTION: iimporter
+ * @section_id: iimporter
+ * @title: NAIImporter (na-iimporter.h title)
+ * @short_description: #NAIImporter interface definition (na-iimporter.h short description)
  * @include: nautilus-actions/na-iimporter.h
  *
  * The #NAIImporter interface imports items from the outside world.
  *
- * Nautilus-Actions v 2.30 - API version:  1
+ * Since: Nautilus-Actions v 2.30 (API version 1)
  */
 
 #include "na-object-item.h"
diff --git a/src/api/na-iio-provider.h b/src/api/na-iio-provider.h
index 52d0be6..ac91136 100644
--- a/src/api/na-iio-provider.h
+++ b/src/api/na-iio-provider.h
@@ -31,22 +31,6 @@
 #ifndef __NAUTILUS_ACTIONS_API_NA_IIO_PROVIDER_H__
 #define __NAUTILUS_ACTIONS_API_NA_IIO_PROVIDER_H__
 
-/**
- * SECTION: na_iio_provider
- * @short_description: #NAIIOProvider interface definition.
- * @include: nautilus-actions/na-iio-provider.h
- *
- * The #NAIIOProvider interface provides two types of services:
- * - load all items at startup
- * - create, update or delete items via the management user interface.
- *
- * These services may be fully implemented by the I/O provider itself.
- * Or, the I/O provider may also prefer to take advantage of the data
- * factory management (see #NAIFactoryObject and #NAIFactoryProvider interfaces).
- *
- * Nautilus-Actions v 2.30 - API version:  1
- */
-
 #include "na-object-item.h"
 
 G_BEGIN_DECLS
@@ -221,10 +205,30 @@ void  na_iio_provider_item_changed ( const NAIIOProvider *instance );
 
 #define IIO_PROVIDER_SIGNAL_ITEM_CHANGED	"na-iio-provider-notify-pivot"
 
-/* The reasons for which an item may not be writable
- * adding a new status here should imply also adding a new tooltip
+/* Adding a new status here should imply also adding a new tooltip
  * in #na_io_provider_get_readonly_tooltip().
  */
+/**
+ * NAIIOProviderWritabilityStatus:
+ *
+ * @NA_IIO_PROVIDER_STATUS_UNDETERMINED: undertermined.
+ * @NA_IIO_PROVIDER_STATUS_WRITABLE: the item is writable.
+ * @NA_IIO_PROVIDER_STATUS_ITEM_READONLY: the item is read-only.
+ * @NA_IIO_PROVIDER_STATUS_PROVIDER_NOT_WILLING_TO: the provider is not
+ *  willing to write this item, or doest not implement the required
+ *  interface.
+ * @NA_IIO_PROVIDER_STATUS_NO_PROVIDER_FOUND: the provider has not been
+ *  found.
+ * @NA_IIO_PROVIDER_STATUS_PROVIDER_LOCKED_BY_ADMIN: the provider has been
+ *  locked by the administrator.
+ * @NA_IIO_PROVIDER_STATUS_PROVIDER_LOCKED_BY_USER: the provider has been
+ *  locked by the user.
+ * @NA_IIO_PROVIDER_STATUS_CONFIGURATION_LOCKED_BY_ADMIN: the whole
+ *  configuration has been locked by the administrator.
+ * @NA_IIO_PROVIDER_STATUS_NO_API: no API has been found.
+ *
+ * The reasons for which an item may not be writable.
+ */
 enum {
 	NA_IIO_PROVIDER_STATUS_UNDETERMINED = 0,
 	NA_IIO_PROVIDER_STATUS_WRITABLE,
@@ -235,6 +239,7 @@ enum {
 	NA_IIO_PROVIDER_STATUS_PROVIDER_LOCKED_BY_USER,
 	NA_IIO_PROVIDER_STATUS_CONFIGURATION_LOCKED_BY_ADMIN,
 	NA_IIO_PROVIDER_STATUS_NO_API,
+	/*< private >*/
 	NA_IIO_PROVIDER_STATUS_LAST,
 };
 
diff --git a/src/api/na-object-action.h b/src/api/na-object-action.h
index dd1965d..4128113 100644
--- a/src/api/na-object-action.h
+++ b/src/api/na-object-action.h
@@ -32,7 +32,8 @@
 #define __NAUTILUS_ACTIONS_API_NA_OBJECT_ACTION_H__
 
 /**
- * SECTION: na_object_action
+ * SECTION: object-action
+ * @title: #NAObjectAction class definition
  * @short_description: #NAObjectAction class definition.
  * @include: nautilus-actions/na-object-action.h
  *
diff --git a/src/api/na-object-api.h b/src/api/na-object-api.h
index 241629c..a5a4f5f 100644
--- a/src/api/na-object-api.h
+++ b/src/api/na-object-api.h
@@ -32,7 +32,7 @@
 #define __NAUTILUS_ACTIONS_API_NA_OBJECT_API_H__
 
 /**
- * SECTION: na_object
+ * SECTION: object-api
  * @short_description: #NAObject public API.
  * @include: nautilus-actions/na-object-api.h
  *
diff --git a/src/api/na-object-id.h b/src/api/na-object-id.h
index a12267b..8c71ed1 100644
--- a/src/api/na-object-id.h
+++ b/src/api/na-object-id.h
@@ -32,7 +32,8 @@
 #define __NAUTILUS_ACTIONS_API_NA_OBJECT_ID_H__
 
 /**
- * SECTION: na_object_id
+ * SECTION: object-id
+ * @title: NAObjectId class definition
  * @short_description: #NAObjectId class definition.
  * @include: nautilus-actions/na-object-id.h
  *
diff --git a/src/api/na-object-item.h b/src/api/na-object-item.h
index d4e77a3..4ffa72c 100644
--- a/src/api/na-object-item.h
+++ b/src/api/na-object-item.h
@@ -32,7 +32,7 @@
 #define __NAUTILUS_ACTIONS_API_NA_OBJECT_ITEM_H__
 
 /**
- * SECTION: na_object_item
+ * SECTION: object-item
  * @short_description: #NAObjectItem class definition.
  * @include: nautilus-actions/na-object-item.h
  *
diff --git a/src/api/na-object-menu.h b/src/api/na-object-menu.h
index 4d0240c..1423d42 100644
--- a/src/api/na-object-menu.h
+++ b/src/api/na-object-menu.h
@@ -32,7 +32,8 @@
 #define __NAUTILUS_ACTIONS_API_NA_OBJECT_MENU_H__
 
 /**
- * SECTION: na_object_menu
+ * SECTION: object-menu
+ * @title: NAObjectMenu class definition
  * @short_description: #NAObjectMenu class definition.
  * @include: nautilus-actions/na-object-menu.h
  */
diff --git a/src/api/na-object-profile.h b/src/api/na-object-profile.h
index e8b255a..b3a7b3b 100644
--- a/src/api/na-object-profile.h
+++ b/src/api/na-object-profile.h
@@ -32,12 +32,9 @@
 #define __NAUTILUS_ACTIONS_API_NA_OBJECT_PROFILE_H__
 
 /**
- * SECTION: na_object_profile
+ * SECTION: object-profile
  * @short_description: #NAObjectProfile class definition.
  * @include: nautilus-actions/na-object-item.h
- *
- * This is a pure virtual class, i.e. not an instantiatable one, but
- * serves as the base class for #NAObjectAction and #NAObjectMenu.
  */
 
 #include "na-object-id.h"
diff --git a/src/api/na-object.h b/src/api/na-object.h
index 36cfd5c..801d564 100644
--- a/src/api/na-object.h
+++ b/src/api/na-object.h
@@ -32,7 +32,7 @@
 #define __NAUTILUS_ACTIONS_API_NA_OBJECT_H__
 
 /**
- * SECTION: na_object
+ * SECTION: object
  * @short_description: #NAObject class definition.
  * @include: nautilus-actions/na-object.h
  *
diff --git a/src/core/na-ifactory-provider.c b/src/core/na-ifactory-provider.c
index 42b359d..2558829 100644
--- a/src/core/na-ifactory-provider.c
+++ b/src/core/na-ifactory-provider.c
@@ -59,7 +59,11 @@ static guint v_factory_provider_write_start( const NAIFactoryProvider *writer, v
 static guint v_factory_provider_write_done( const NAIFactoryProvider *writer, void *writer_data, NAIFactoryObject *serializable, GSList **messages );
 
 /**
+ * na_ifactory_provider_get_type:
+ *
  * Registers the GType of this interface.
+ *
+ * Returns: the #NAIFactoryProvider #GType.
  */
 GType
 na_ifactory_provider_get_type( void )
diff --git a/src/core/na-iio-provider.c b/src/core/na-iio-provider.c
index 8d6be7f..2396396 100644
--- a/src/core/na-iio-provider.c
+++ b/src/core/na-iio-provider.c
@@ -34,6 +34,44 @@
 
 #include <api/na-iio-provider.h>
 
+/**
+ * SECTION: iio-provider
+ * @section_id: iio-provider
+ * @title: NAIIOProvider
+ * @short_description: An interface to provide I/O services
+ * @include: nautilus-actions/na-iio-provider.h
+ *
+ * The #NAIIOProvider interface has been defined in order to let internal
+ * and external plugins be written. With this interface, a plugin may
+ * provide read and write accesses to an alternate storage subsystem.
+ *
+ * The #NAIIOProvider interface provides three types of services:
+ * <itemizedlist>
+ *  <listitem>
+ *   <para>
+ *    load all items at startup;
+ *   </para>
+ *  </listitem>
+ *  <listitem>
+ *   <para>
+ *    create, update or delete items via the management user interface;
+ *   </para>
+ *  </listitem>
+ *  <listitem>
+ *   <para>
+ *    advertize Nautilus-Actions when an item has been modified on the
+ *    underlying storage subsystems.
+ *   </para>
+ *  </listitem>
+ * </itemizedlist>
+ *
+ * These services may be fully implemented by the I/O provider itself.
+ * Or, the I/O provider may also prefer to take advantage of the data
+ * factory management (see #NAIFactoryObject and #NAIFactoryProvider interfaces).
+ *
+ * Since Nautilus-Actions v 2.30 (API version 1)
+ */
+
 /* private interface data
  */
 struct NAIIOProviderInterfacePrivate {
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]