GNOME.org
 

[nautilus-actions] Fix Data Factory Management System documentation

commit 1ca8ea343d2ccd0b251195984a0f7aad9c85b766
Author: Pierre Wieser <pwieser trychlos org>
Date:   Fri Dec 10 10:24:15 2010 +0100

    Fix Data Factory Management System documentation

 ChangeLog                                    |   18 +++++
 docs/reference/nautilus-actions-docs.xml     |    4 +-
 docs/reference/nautilus-actions-sections.txt |   99 +++++++++++++++++--------
 src/api/na-extension.h                       |    2 +-
 src/api/na-iexporter.h                       |   28 +++++---
 src/api/na-ifactory-object-data.h            |   12 +++-
 src/core/na-data-boxed.c                     |    2 +-
 src/core/na-data-def.c                       |    2 +-
 src/core/na-data-types.c                     |    2 +-
 src/core/na-iexporter.c                      |    2 +-
 src/core/na-ifactory-object.c                |    2 +-
 src/core/na-ifactory-provider.c              |    2 +-
 src/core/na-iimporter.c                      |    2 +-
 src/core/na-iio-provider.c                   |    2 +-
 14 files changed, 124 insertions(+), 55 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 8aecd60..e225b0c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,21 @@
+2010-12-10 Pierre Wieser <pwieser trychlos org>
+
+	Fix Data Factory Management System documentation.
+
+	* docs/reference/nautilus-actions-docs.xml:
+	* docs/reference/nautilus-actions-sections.txt:
+	* src/api/na-extension.h:
+	* src/api/na-iexporter.h:
+	* src/api/na-ifactory-object-data.h:
+	* src/core/na-data-boxed.c:
+	* src/core/na-data-def.c:
+	* src/core/na-data-types.c:
+	* src/core/na-iexporter.c:
+	* src/core/na-ifactory-object.c:
+	* src/core/na-ifactory-provider.c:
+	* src/core/na-iimporter.c:
+	* src/core/na-iio-provider.c: Updated accordingly.
+
 2010-12-09 Pierre Wieser <pwieser trychlos org>
 
 	Document NADataBoxed class.
diff --git a/docs/reference/nautilus-actions-docs.xml b/docs/reference/nautilus-actions-docs.xml
index 667698a..99159d4 100644
--- a/docs/reference/nautilus-actions-docs.xml
+++ b/docs/reference/nautilus-actions-docs.xml
@@ -61,10 +61,10 @@
     <title>Data Factory Management System</title>
     <xi:include href="xml/ifactory-provider.xml" />
     <xi:include href="xml/ifactory-object.xml" />
+    <xi:include href="xml/data-boxed.xml"/>
     <xi:include href="xml/data-type.xml"/>
     <xi:include href="xml/data-def.xml"/>
-    <xi:include href="xml/ifactory-data.xml"/>
-    <xi:include href="xml/data-boxed.xml"/>
+    <xi:include href="xml/data-name.xml"/>
   </chapter>
 
   <chapter>
diff --git a/docs/reference/nautilus-actions-sections.txt b/docs/reference/nautilus-actions-sections.txt
index 09e2935..779bf9e 100644
--- a/docs/reference/nautilus-actions-sections.txt
+++ b/docs/reference/nautilus-actions-sections.txt
@@ -1,4 +1,7 @@
 
+# ---------------------------------------------------------------------
+# Plugins â?? The Nautilus-Actions extension interface definition v 1
+
 <SECTION>
 <FILE>extension</FILE>
 na_extension_startup
@@ -7,6 +10,9 @@ na_extension_list_types
 na_extension_shutdown
 </SECTION>
 
+# ---------------------------------------------------------------------
+# NAIIOProvider â?? The I/O Provider Interface v 1
+
 <SECTION>
 <FILE>iio-provider</FILE>
 NA_IIO_PROVIDER_TYPE
@@ -17,7 +23,6 @@ NAIIOProvider
 NAIIOProviderInterface
 NAIIOProviderWritabilityStatus
 NAIIOProviderOperationStatus
-IIO_PROVIDER_SIGNAL_ITEM_CHANGED
 na_iio_provider_item_changed
 
 <SUBSECTION Standard>
@@ -25,8 +30,13 @@ na_iio_provider_get_type
 
 <SUBSECTION Private>
 NAIIOProviderInterfacePrivate
+IIO_PROVIDER_SIGNAL_ITEM_CHANGED
+NAIIOProvider::notify-pivot
 </SECTION>
 
+# ---------------------------------------------------------------------
+# NAIImporter â?? The Import Interface v 1
+
 <SECTION>
 <FILE>iimporter</FILE>
 NA_IIMPORTER_TYPE
@@ -51,6 +61,9 @@ na_iimporter_get_type
 NAIImporterInterfacePrivate
 </SECTION>
 
+# ---------------------------------------------------------------------
+# NAIExporter â?? The Export Interface v 1
+
 <SECTION>
 <FILE>iexporter</FILE>
 NA_IEXPORTER_TYPE
@@ -71,6 +84,9 @@ na_iexporter_get_type
 NAIExporterInterfacePrivate
 </SECTION>
 
+# ---------------------------------------------------------------------
+# NAIFactoryProvider â?? The Data Factory Provider Interface v 1
+
 <SECTION>
 <FILE>ifactory-provider</FILE>
 NA_IFACTORY_PROVIDER_TYPE
@@ -89,6 +105,9 @@ na_ifactory_provider_get_type
 NAIFactoryProviderInterfacePrivate
 </SECTION>
 
+# ---------------------------------------------------------------------
+# NAIFactoryObject â?? The #NAObjectItem Interface v 1
+
 <SECTION>
 <FILE>ifactory-object</FILE>
 NA_IFACTORY_OBJECT_TYPE
@@ -109,12 +128,54 @@ na_ifactory_object_get_type
 NAIFactoryObjectInterfacePrivate
 </SECTION>
 
+# ---------------------------------------------------------------------
+# NADataBoxed â?? The Elementary Data Class Definition
+
+<SECTION>
+<FILE>data-boxed</FILE>
+NA_DATA_BOXED_TYPE
+NA_DATA_BOXED
+NA_IS_DATA_BOXED
+NADataBoxed
+na_data_boxed_new
+na_data_boxed_get_data_def
+na_data_boxed_get_param_spec
+na_data_boxed_are_equal
+na_data_boxed_is_default
+na_data_boxed_is_valid
+na_data_boxed_dump
+na_data_boxed_set_data_def
+na_data_boxed_get_as_string
+na_data_boxed_get_as_void
+na_data_boxed_get_as_value
+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_get_type
+NA_DATA_BOXED_CLASS
+NA_IS_DATA_BOXED_CLASS
+NA_DATA_BOXED_GET_CLASS
+
+<SUBSECTION Private>
+NADataBoxedPrivate
+NADataBoxedClassPrivate
+</SECTION>
+
+# ---------------------------------------------------------------------
+# NADataType â?? The Data Factory Type Definitions
+
 <SECTION>
 <FILE>data-type</FILE>
 NAFactoryDataType
 na_data_types_get_gconf_dump_key
 </SECTION>
 
+# ---------------------------------------------------------------------
+# NADataDef, NADataGroup â?? The Data Factory Structure Definitions
+
 <SECTION>
 <FILE>data-def</FILE>
 NADataDef
@@ -122,8 +183,11 @@ NADataGroup
 na_data_def_get_data_def
 </SECTION>
 
+# ---------------------------------------------------------------------
+# Constants â?? The Data Factory Constant Definitions
+
 <SECTION>
-<FILE>ifactory-data</FILE>
+<FILE>data-name</FILE>
 NA_FACTORY_OBJECT_ID_GROUP
 NAFO_DATA_ID
 NAFO_DATA_LABEL
@@ -183,36 +247,7 @@ NAFO_DATA_SHOW_IF_RUNNING
 NAFO_DATA_CAPABILITITES
 </SECTION>
 
-<SECTION>
-<FILE>data-boxed</FILE>
-NA_DATA_BOXED_TYPE
-NA_DATA_BOXED
-NA_IS_DATA_BOXED
-NADataBoxed
-na_data_boxed_new
-na_data_boxed_get_data_def
-na_data_boxed_get_param_spec
-na_data_boxed_are_equal
-na_data_boxed_is_default
-na_data_boxed_is_valid
-na_data_boxed_dump
-na_data_boxed_set_data_def
-na_data_boxed_get_as_string
-na_data_boxed_get_as_void
-na_data_boxed_get_as_value
-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_get_type
-NA_DATA_BOXED_CLASS
-NA_IS_DATA_BOXED_CLASS
-NA_DATA_BOXED_GET_CLASS
-NADataBoxedPrivate
-NADataBoxedClassPrivate
-</SECTION>
+# ---------------------------------------------------------------------
 
 <SECTION>
 <FILE>dbus</FILE>
diff --git a/src/api/na-extension.h b/src/api/na-extension.h
index 38c0fc7..354694c 100644
--- a/src/api/na-extension.h
+++ b/src/api/na-extension.h
@@ -34,7 +34,7 @@
 /**
  * SECTION: extension
  * @title: Plugins
- * @short_description: Nautilus-Actions extension interface definition.
+ * @short_description: The Nautilus-Actions Extension Interface Definition v 1
  * @include: nautilus-actions/na-extension.h
  *
  * &prodname; accepts extensions as dynamically loadable libraries
diff --git a/src/api/na-iexporter.h b/src/api/na-iexporter.h
index 69d58ad..5a71a93 100644
--- a/src/api/na-iexporter.h
+++ b/src/api/na-iexporter.h
@@ -53,8 +53,8 @@ typedef struct _NAIExporterInterfacePrivate NAIExporterInterfacePrivate;
  *               mainly used in the export assistant.
  *
  * This structure describes a supported output format.
- * It must be implemented by each #NAIExporter implementation
- * (see e.g. io-xml/naxml-formats.c).
+ * It must be provided by each #NAIExporter implementation
+ * (see e.g. <filename>src/io-xml/naxml-formats.c</filename>).
  *
  * When listing available export formats, the instance returns a #GList
  * of these structures.
@@ -89,6 +89,8 @@ typedef struct {
 	 * Returns: the version of this interface supported by the I/O provider.
 	 *
 	 * Defaults to 1.
+	 *
+	 * Since: Nautilus-Actions v 2.30, NAIExporter interface v 1.
 	 */
 	guint                     ( *get_version )( const NAIExporter *instance );
 
@@ -98,6 +100,8 @@ typedef struct {
 	 *
 	 * Returns: the name to be displayed for this instance, as a
 	 * newly allocated string which should be g_free() by the caller.
+	 *
+	 * Since: Nautilus-Actions v 2.30, NAIExporter interface v 1.
 	 */
 	gchar *                   ( *get_name )   ( const NAIExporter *instance );
 
@@ -105,11 +109,6 @@ typedef struct {
 	 * get_formats:
 	 * @instance: this #NAIExporter instance.
 	 *
-	 * Returns: a list of #NAIExporterFormat structures which describe the
-	 * formats supported by @instance.
-	 *
-	 * Defaults to %NULL (no format at all).
-	 *
 	 * The returned list is owned by the @instance. It must not be
 	 * released by the caller.
 	 *
@@ -117,6 +116,13 @@ typedef struct {
 	 * Nautilus-Actions maintainer team. If you wish develop a new
 	 * export format, and so need a new format id, please contact the
 	 * maintainers (see #nautilus-actions.doap).
+	 *
+	 * Returns: a list of #NAIExporterFormat structures which describe the
+	 * formats supported by @instance.
+	 *
+	 * Defaults to %NULL (no format at all).
+	 *
+	 * Since: Nautilus-Actions v 2.30, NAIExporter interface v 1.
 	 */
 	const NAIExporterFormat * ( *get_formats )( const NAIExporter *instance );
 
@@ -128,7 +134,9 @@ typedef struct {
 	 * Exports the specified 'exported' to the target 'folder' in the required
 	 * 'format'.
 	 *
-	 * Returns: the status of the operation.
+	 * Returns: the #NAIExporterExportStatus status of the operation.
+	 *
+	 * Since: Nautilus-Actions v 2.30, NAIExporter interface v 1.
 	 */
 	guint                     ( *to_file )    ( const NAIExporter *instance, NAIExporterFileParms *parms );
 
@@ -141,7 +149,9 @@ typedef struct {
 	 * the required 'format'. The allocated 'buffer' should be g_free()
 	 * by the caller.
 	 *
-	 * Returns: the status of the operation.
+	 * Returns: the #NAIExporterExportStatus status of the operation.
+	 *
+	 * Since: Nautilus-Actions v 2.30, NAIExporter interface v 1.
 	 */
 	guint                     ( *to_buffer )  ( const NAIExporter *instance, NAIExporterBufferParms *parms );
 }
diff --git a/src/api/na-ifactory-object-data.h b/src/api/na-ifactory-object-data.h
index dacf99e..2082e66 100644
--- a/src/api/na-ifactory-object-data.h
+++ b/src/api/na-ifactory-object-data.h
@@ -32,10 +32,16 @@
 #define __NAUTILUS_ACTIONS_API_NA_IFACTORY_OBJECT_DATA_H__
 
 /**
- * SECTION: ifactory-data
- * @title: Constant definitions
- * @short_description: Declaration of serializable elementary datas.
+ * SECTION: data-name
+ * @title: Constants
+ * @short_description: The Data Factory Constant Definitions
  * @include: nautilus-actions/na-ifactory-object-data.h
+ *
+ * Each elementary data get its own name here.
+ *
+ * Through #NADataDef and #NADataGroup definitions, each #NAObjectItem
+ * derived object which implement the #NAIFactoryObject interface will
+ * dynamically define a property for each attached elementary data.
  */
 
 #include <glib.h>
diff --git a/src/core/na-data-boxed.c b/src/core/na-data-boxed.c
index 0831c4f..0448f00 100644
--- a/src/core/na-data-boxed.c
+++ b/src/core/na-data-boxed.c
@@ -44,7 +44,7 @@
 /**
  * SECTION: data-boxed
  * @title: NADataBoxed
- * @short_description: The elementary data class definition.
+ * @short_description: The Data Factory Element Class Definition
  * @include: nautilus-actions/na-data-boxed.h
  *
  * The object which encapsulates an elementary data of #NAIFactoryObject.
diff --git a/src/core/na-data-def.c b/src/core/na-data-def.c
index 0ad02c9..eb95ebc 100644
--- a/src/core/na-data-def.c
+++ b/src/core/na-data-def.c
@@ -39,7 +39,7 @@
 /**
  * SECTION: data-def
  * @title: NADataDef, NADataGroup
- * @short_description: Data Factory Definitions.
+ * @short_description: The Data Factory Structure Definitions
  * @include: nautilus-actions/na-data-def.h
  *
  * #NADataDef and #NADataGroup are structures which handle the list of
diff --git a/src/core/na-data-types.c b/src/core/na-data-types.c
index d4f26db..1b10b36 100644
--- a/src/core/na-data-types.c
+++ b/src/core/na-data-types.c
@@ -37,7 +37,7 @@
 /**
  * SECTION: data-type
  * @title: NADataType
- * @short_description: #NADataBoxed type definitions.
+ * @short_description: The Data Factory Type Definitions
  * @include: nautilus-actions/na-data-types.h
  */
 
diff --git a/src/core/na-iexporter.c b/src/core/na-iexporter.c
index 3d552aa..686d993 100644
--- a/src/core/na-iexporter.c
+++ b/src/core/na-iexporter.c
@@ -37,7 +37,7 @@
 /**
  * SECTION: iexporter
  * @title: NAIExporter
- * @short_description: The Export Interface
+ * @short_description: The Export Interface v 1
  * @include: nautilus-actions/na-iexporter.h
  *
  * The #NAIExporter interface exports items to the outside world.
diff --git a/src/core/na-ifactory-object.c b/src/core/na-ifactory-object.c
index 2d8fd36..16545be 100644
--- a/src/core/na-ifactory-object.c
+++ b/src/core/na-ifactory-object.c
@@ -41,7 +41,7 @@
 /**
  * SECTION: ifactory-object
  * @title: NAIFactoryObject
- * @short_description: The interface implemented by NAObjectItem-derived objects.
+ * @short_description: The #NAObjectItem Interface v 1
  * @include: nautilus-actions/na-ifactory_object.h
  *
  * This interface is implemented by #NAObjectItem derived objects so that they
diff --git a/src/core/na-ifactory-provider.c b/src/core/na-ifactory-provider.c
index 54df472..74a6193 100644
--- a/src/core/na-ifactory-provider.c
+++ b/src/core/na-ifactory-provider.c
@@ -41,7 +41,7 @@
 /**
  * SECTION: ifactory-provider
  * @title: NAIFactoryProvider
- * @short_description: The Data Factory Management System
+ * @short_description: The Data Factory Provider Interface v 1
  * @include: nautilus-actions/na-ifactory_provider.h
  *
  * &prodname; has to deal with a relatively great number of elementary datas,
diff --git a/src/core/na-iimporter.c b/src/core/na-iimporter.c
index c1c86ed..0204fe5 100644
--- a/src/core/na-iimporter.c
+++ b/src/core/na-iimporter.c
@@ -41,7 +41,7 @@
 /**
  * SECTION: iimporter
  * @title: NAIImporter
- * @short_description: The Import Interface
+ * @short_description: The Import Interface v 1
  * @include: nautilus-actions/na-iimporter.h
  *
  * The #NAIImporter interface imports items from the outside world.
diff --git a/src/core/na-iio-provider.c b/src/core/na-iio-provider.c
index 7d41d5a..c425f0d 100644
--- a/src/core/na-iio-provider.c
+++ b/src/core/na-iio-provider.c
@@ -37,7 +37,7 @@
 /**
  * SECTION: iio-provider
  * @title: NAIIOProvider
- * @short_description: The I/O Provider Interface
+ * @short_description: The I/O Provider Interface v 1
  * @include: nautilus-actions/na-iio-provider.h
  *
  * The #NAIIOProvider interface is defined in order to let internal
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]