GNOME.org
 

[nautilus-actions] Reference manual: document NADataDef and NADataGroup structures

commit 4275e6255f71ac6aaa92d19a70373785632ce6f8
Author: Pierre Wieser <pwieser trychlos org>
Date:   Fri Dec 10 01:31:21 2010 +0100

    Reference manual: document NADataDef and NADataGroup structures

 ChangeLog                                    |   13 ++
 docs/reference/nautilus-actions-docs.xml     |    9 +-
 docs/reference/nautilus-actions-sections.txt |  136 +++++++++++-----------
 src/api/na-data-def.h                        |   12 +--
 src/api/na-ifactory-object-data.h            |  159 ++++++++++++++++----------
 src/api/na-ifactory-object.h                 |    7 +-
 src/core/na-data-def.c                       |   13 ++
 src/core/na-factory-object.c                 |   36 +++---
 src/core/na-factory-object.h                 |    3 +-
 src/core/na-ifactory-object.c                |    2 +-
 src/core/na-ifactory-provider.c              |    6 +-
 11 files changed, 229 insertions(+), 167 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 91e4d85..cfe05b6 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,18 @@
 2010-12-09 Pierre Wieser <pwieser trychlos org>
 
+	Document NADataDef and NADataGroup structures.
+
+	* docs/reference/nautilus-actions-docs.xml:
+	* docs/reference/nautilus-actions-sections.txt:
+	* src/api/na-data-def.h:
+	* src/api/na-ifactory-object-data.h:
+	* src/api/na-ifactory-object.h:
+	* src/core/na-data-def.c:
+	* src/core/na-factory-object.c:
+	* src/core/na-factory-object.h:
+	* src/core/na-ifactory-object.c:
+	* src/core/na-ifactory-provider.c: Updated accordingly.
+
 	Document NAIFactoryObject interface.
 
 	* docs/reference/nautilus-actions-sections.txt:
diff --git a/docs/reference/nautilus-actions-docs.xml b/docs/reference/nautilus-actions-docs.xml
index 6a96b33..79f7b01 100644
--- a/docs/reference/nautilus-actions-docs.xml
+++ b/docs/reference/nautilus-actions-docs.xml
@@ -58,9 +58,12 @@
   </chapter>
 
   <chapter>
-    <title>Data factory management system</title>
+    <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-def.xml"/>
+    <xi:include href="xml/ifactory-data.xml"/>
+    <xi:include href="xml/na-data-boxed.xml"/>
   </chapter>
 
   <chapter>
@@ -69,18 +72,14 @@
     <xi:include href="xml/na-object-action.xml"/>
     <xi:include href="xml/na-icontext.xml"/>
     <xi:include href="xml/na-gconf-monitor.xml"/>
-    <xi:include href="xml/na-data-boxed.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-ifactory-object-data.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-data-def.xml"/>
     <xi:include href="xml/na-object-api.xml"/>
   </chapter>
 
diff --git a/docs/reference/nautilus-actions-sections.txt b/docs/reference/nautilus-actions-sections.txt
index 8e5092f..df067a2 100644
--- a/docs/reference/nautilus-actions-sections.txt
+++ b/docs/reference/nautilus-actions-sections.txt
@@ -108,6 +108,74 @@ NAIFactoryObjectInterfacePrivate
 </SECTION>
 
 <SECTION>
+<FILE>data-def</FILE>
+NADataDef
+NADataGroup
+na_data_def_get_data_def
+</SECTION>
+
+<SECTION>
+<FILE>ifactory-data</FILE>
+NA_FACTORY_OBJECT_ID_GROUP
+NAFO_DATA_ID
+NAFO_DATA_LABEL
+NAFO_DATA_PARENT
+NAFO_DATA_CONDITIONS
+NA_FACTORY_OBJECT_ITEM_GROUP
+NAFO_DATA_IVERSION
+NAFO_DATA_TYPE
+NAFO_DATA_TOOLTIP
+NAFO_DATA_ICON
+NAFO_DATA_ICON_NOLOC
+NAFO_DATA_DESCRIPTION
+NAFO_DATA_SHORTCUT
+NAFO_DATA_SUBITEMS
+NAFO_DATA_SUBITEMS_SLIST
+NAFO_DATA_ENABLED
+NAFO_DATA_READONLY
+NAFO_DATA_PROVIDER
+NAFO_DATA_PROVIDER_DATA
+NA_FACTORY_OBJECT_ACTION_GROUP
+NAFO_DATA_VERSION
+NAFO_DATA_TARGET_SELECTION
+NAFO_DATA_TARGET_LOCATION
+NAFO_DATA_TARGET_TOOLBAR
+NAFO_DATA_TOOLBAR_LABEL
+NAFO_DATA_TOOLBAR_SAME_LABEL
+NAFO_DATA_LAST_ALLOCATED
+NA_FACTORY_ACTION_V1_GROUP
+NA_FACTORY_OBJECT_MENU_GROUP
+NA_FACTORY_OBJECT_PROFILE_GROUP
+NAFO_DATA_DESCNAME
+NAFO_DATA_DESCNAME_NOLOC
+NAFO_DATA_PATH
+NAFO_DATA_PARAMETERS
+NAFO_DATA_WORKING_DIR
+NAFO_DATA_EXECUTION_MODE
+NAFO_DATA_STARTUP_NOTIFY
+NAFO_DATA_STARTUP_WMCLASS
+NAFO_DATA_EXECUTE_AS
+NA_FACTORY_OBJECT_CONDITIONS_GROUP
+NAFO_DATA_BASENAMES
+NAFO_DATA_MATCHCASE
+NAFO_DATA_MIMETYPES
+NAFO_DATA_ALL_MIMETYPES
+NAFO_DATA_ISFILE
+NAFO_DATA_ISDIR
+NAFO_DATA_MULTIPLE
+NAFO_DATA_SCHEMES
+NAFO_DATA_FOLDERS
+NAFO_DATA_SELECTION_COUNT
+NAFO_DATA_ONLY_SHOW
+NAFO_DATA_NOT_SHOW
+NAFO_DATA_TRY_EXEC
+NAFO_DATA_SHOW_IF_REGISTERED
+NAFO_DATA_SHOW_IF_TRUE
+NAFO_DATA_SHOW_IF_RUNNING
+NAFO_DATA_CAPABILITITES
+</SECTION>
+
+<SECTION>
 <FILE>dbus</FILE>
 <TITLE>DBus (nautilus-actions-sections title)</TITLE>
 NAUTILUS_ACTIONS_DBUS_SERVICE
@@ -352,67 +420,6 @@ NA_DATA_BOXED_GET_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>na-ifactory-object-data</FILE>
-NA_FACTORY_OBJECT_ID_GROUP
-NAFO_DATA_ID
-NAFO_DATA_LABEL
-NAFO_DATA_PARENT
-NAFO_DATA_CONDITIONS
-NA_FACTORY_OBJECT_ITEM_GROUP
-NAFO_DATA_IVERSION
-NAFO_DATA_TYPE
-NAFO_DATA_TOOLTIP
-NAFO_DATA_ICON
-NAFO_DATA_ICON_NOLOC
-NAFO_DATA_DESCRIPTION
-NAFO_DATA_SHORTCUT
-NAFO_DATA_SUBITEMS
-NAFO_DATA_SUBITEMS_SLIST
-NAFO_DATA_ENABLED
-NAFO_DATA_READONLY
-NAFO_DATA_PROVIDER
-NAFO_DATA_PROVIDER_DATA
-NA_FACTORY_OBJECT_ACTION_GROUP
-NAFO_DATA_VERSION
-NAFO_DATA_TARGET_SELECTION
-NAFO_DATA_TARGET_LOCATION
-NAFO_DATA_TARGET_TOOLBAR
-NAFO_DATA_TOOLBAR_LABEL
-NAFO_DATA_TOOLBAR_SAME_LABEL
-NAFO_DATA_LAST_ALLOCATED
-NA_FACTORY_ACTION_V1_GROUP
-NA_FACTORY_OBJECT_MENU_GROUP
-NA_FACTORY_OBJECT_PROFILE_GROUP
-NAFO_DATA_DESCNAME
-NAFO_DATA_DESCNAME_NOLOC
-NAFO_DATA_PATH
-NAFO_DATA_PARAMETERS
-NAFO_DATA_WORKING_DIR
-NAFO_DATA_EXECUTION_MODE
-NAFO_DATA_STARTUP_NOTIFY
-NAFO_DATA_STARTUP_WMCLASS
-NAFO_DATA_EXECUTE_AS
-NA_FACTORY_OBJECT_CONDITIONS_GROUP
-NAFO_DATA_BASENAMES
-NAFO_DATA_MATCHCASE
-NAFO_DATA_MIMETYPES
-NAFO_DATA_ALL_MIMETYPES
-NAFO_DATA_ISFILE
-NAFO_DATA_ISDIR
-NAFO_DATA_MULTIPLE
-NAFO_DATA_SCHEMES
-NAFO_DATA_FOLDERS
-NAFO_DATA_SELECTION_COUNT
-NAFO_DATA_ONLY_SHOW
-NAFO_DATA_NOT_SHOW
-NAFO_DATA_TRY_EXEC
-NAFO_DATA_SHOW_IF_REGISTERED
-NAFO_DATA_SHOW_IF_TRUE
-NAFO_DATA_SHOW_IF_RUNNING
-NAFO_DATA_CAPABILITITES
-</SECTION>
-
-<SECTION>
 <FILE>na-data-types</FILE>
 na_data_types_get_gconf_dump_key
 </SECTION>
@@ -476,13 +483,6 @@ na_core_utils_print_version
 </SECTION>
 
 <SECTION>
-<FILE>data-def</FILE>
-NADataDef
-NADataGroup
-na_data_def_get_data_def
-</SECTION>
-
-<SECTION>
 <FILE>object-api</FILE>
 na_object_duplicate
 na_object_check_status
diff --git a/src/api/na-data-def.h b/src/api/na-data-def.h
index 9cc6040..3ca49b7 100644
--- a/src/api/na-data-def.h
+++ b/src/api/na-data-def.h
@@ -31,12 +31,6 @@
 #ifndef __NAUTILUS_ACTIONS_API_NA_FACTORY_DATA_DEF_H__
 #define __NAUTILUS_ACTIONS_API_NA_FACTORY_DATA_DEF_H__
 
-/**
- * SECTION: ifactory-object
- * @short_description: Data Factory Definitions.
- * @include: nautilus-actions/na-data-def.h
- */
-
 #include <glib.h>
 
 G_BEGIN_DECLS
@@ -90,9 +84,9 @@ G_BEGIN_DECLS
  *                    Defaults to @short_label if NULL.
  * @option_arg_label: the description for the argument.
  *
- * This structure fully describes an elementary factory data
+ * This structure fully describes an elementary factory data.
  * Each #NAIFactoryObject item definition may include several groups of
- * this structure
+ * this structure.
  */
 typedef struct {
 	gchar     *name;
@@ -126,7 +120,7 @@ typedef struct {
  *
  * This structure fully describes a logical group of data.
  * Each #NAIFactoryObject item definition is built from a list of
- * these groups
+ * these groups.
  */
 typedef struct {
 	gchar     *group;
diff --git a/src/api/na-ifactory-object-data.h b/src/api/na-ifactory-object-data.h
index 45c4735..dacf99e 100644
--- a/src/api/na-ifactory-object-data.h
+++ b/src/api/na-ifactory-object-data.h
@@ -32,8 +32,9 @@
 #define __NAUTILUS_ACTIONS_API_NA_IFACTORY_OBJECT_DATA_H__
 
 /**
- * SECTION: na_ifactory_object
- * @short_description: Declaration of all serializable elementary datas.
+ * SECTION: ifactory-data
+ * @title: Constant definitions
+ * @short_description: Declaration of serializable elementary datas.
  * @include: nautilus-actions/na-ifactory-object-data.h
  */
 
@@ -41,69 +42,109 @@
 
 G_BEGIN_DECLS
 
-#define NA_FACTORY_OBJECT_ID_GROUP			"na-factory-group-id"
-#define NAFO_DATA_ID						"na-factory-data-id"
-#define NAFO_DATA_LABEL						"na-factory-data-label"
-#define NAFO_DATA_PARENT					"na-factory-data-parent"
-#define NAFO_DATA_CONDITIONS				"na-factory-data-conditions"
+/**
+ * NA_FACTORY_OBJECT_ID_GROUP:
+ *
+ * #NAObjectId common data.
+ */
+#define NA_FACTORY_OBJECT_ID_GROUP          "na-factory-group-id"
+#define NAFO_DATA_ID                        "na-factory-data-id"
+#define NAFO_DATA_LABEL                     "na-factory-data-label"
+#define NAFO_DATA_PARENT                    "na-factory-data-parent"
+#define NAFO_DATA_CONDITIONS                "na-factory-data-conditions"
 
-#define NA_FACTORY_OBJECT_ITEM_GROUP		"na-factory-group-item"
-#define NAFO_DATA_IVERSION					"na-factory-data-iversion"
-#define NAFO_DATA_TYPE						"na-factory-data-type"
-#define NAFO_DATA_TOOLTIP					"na-factory-data-tooltip"
-#define NAFO_DATA_ICON						"na-factory-data-icon"
-#define NAFO_DATA_ICON_NOLOC				"na-factory-data-unlocalized-icon"
-#define NAFO_DATA_DESCRIPTION				"na-factory-data-description"
-#define NAFO_DATA_SHORTCUT					"na-factory-data-shortcut"
-#define NAFO_DATA_SUBITEMS					"na-factory-data-items"
-#define NAFO_DATA_SUBITEMS_SLIST			"na-factory-data-items-slist"
-#define NAFO_DATA_ENABLED					"na-factory-data-enabled"
-#define NAFO_DATA_READONLY					"na-factory-data-readonly"
-#define NAFO_DATA_PROVIDER					"na-factory-data-provider"
-#define NAFO_DATA_PROVIDER_DATA				"na-factory-data-provider-data"
+/**
+ * NA_FACTORY_OBJECT_ITEM_GROUP:
+ *
+ * #NAObjectItem common data.
+ */
+#define NA_FACTORY_OBJECT_ITEM_GROUP        "na-factory-group-item"
+#define NAFO_DATA_IVERSION                  "na-factory-data-iversion"
+#define NAFO_DATA_TYPE                      "na-factory-data-type"
+#define NAFO_DATA_TOOLTIP                   "na-factory-data-tooltip"
+#define NAFO_DATA_ICON                      "na-factory-data-icon"
+#define NAFO_DATA_ICON_NOLOC                "na-factory-data-unlocalized-icon"
+#define NAFO_DATA_DESCRIPTION               "na-factory-data-description"
+#define NAFO_DATA_SHORTCUT                  "na-factory-data-shortcut"
+#define NAFO_DATA_SUBITEMS                  "na-factory-data-items"
+#define NAFO_DATA_SUBITEMS_SLIST            "na-factory-data-items-slist"
+#define NAFO_DATA_ENABLED                   "na-factory-data-enabled"
+#define NAFO_DATA_READONLY                  "na-factory-data-readonly"
+#define NAFO_DATA_PROVIDER                  "na-factory-data-provider"
+#define NAFO_DATA_PROVIDER_DATA             "na-factory-data-provider-data"
 
-#define NA_FACTORY_OBJECT_ACTION_GROUP		"na-factory-group-action"
-#define NAFO_DATA_VERSION					"na-factory-data-version"
-#define NAFO_DATA_TARGET_SELECTION			"na-factory-data-target-selection"
-#define NAFO_DATA_TARGET_LOCATION			"na-factory-data-target-location"
-#define NAFO_DATA_TARGET_TOOLBAR			"na-factory-data-target-toolbar"
-#define NAFO_DATA_TOOLBAR_LABEL				"na-factory-data-toolbar-label"
-#define NAFO_DATA_TOOLBAR_SAME_LABEL		"na-factory-data-toolbar-same-label"
-#define NAFO_DATA_LAST_ALLOCATED			"na-factory-data-last-allocated"
+/**
+ * NA_FACTORY_OBJECT_ACTION_GROUP:
+ *
+ * #NAObjectAction specific datas.
+ */
+#define NA_FACTORY_OBJECT_ACTION_GROUP      "na-factory-group-action"
+#define NAFO_DATA_VERSION                   "na-factory-data-version"
+#define NAFO_DATA_TARGET_SELECTION          "na-factory-data-target-selection"
+#define NAFO_DATA_TARGET_LOCATION           "na-factory-data-target-location"
+#define NAFO_DATA_TARGET_TOOLBAR            "na-factory-data-target-toolbar"
+#define NAFO_DATA_TOOLBAR_LABEL             "na-factory-data-toolbar-label"
+#define NAFO_DATA_TOOLBAR_SAME_LABEL        "na-factory-data-toolbar-same-label"
+#define NAFO_DATA_LAST_ALLOCATED            "na-factory-data-last-allocated"
 
-#define NA_FACTORY_ACTION_V1_GROUP			"na-factory-group-action-v1"
+/**
+ * NA_FACTORY_ACTION_V1_GROUP:
+ *
+ * A group of datas which are specific to v 1 actions. It happens to be
+ * empty as all these datas have been alter embedded in #NAObjectItem
+ * data group.
+ */
+#define NA_FACTORY_ACTION_V1_GROUP          "na-factory-group-action-v1"
 
-#define NA_FACTORY_OBJECT_MENU_GROUP		"na-factory-group-menu"
+/**
+ * NA_FACTORY_OBJECT_MENU_GROUP:
+ *
+ * #NAObjectMenu specific datas. It happens to be empty as the definition
+ * of a menu is very close of those of an action.
+ */
+#define NA_FACTORY_OBJECT_MENU_GROUP        "na-factory-group-menu"
 
-#define NA_FACTORY_OBJECT_PROFILE_GROUP		"na-factory-group-profile"
-#define NAFO_DATA_DESCNAME					"na-factory-data-descname"
-#define NAFO_DATA_DESCNAME_NOLOC			"na-factory-data-unlocalized-descname"
-#define NAFO_DATA_PATH						"na-factory-data-path"
-#define NAFO_DATA_PARAMETERS				"na-factory-data-parameters"
-#define NAFO_DATA_WORKING_DIR				"na-factory-data-working-dir"
-#define NAFO_DATA_EXECUTION_MODE			"na-factory-data-execution-mode"
-#define NAFO_DATA_STARTUP_NOTIFY			"na-factory-data-startup-notify"
-#define NAFO_DATA_STARTUP_WMCLASS			"na-factory-data-startup-wm-class"
-#define NAFO_DATA_EXECUTE_AS				"na-factory-data-execute-as"
+/**
+ * NA_FACTORY_OBJECT_PROFILE_GROUP:
+ *
+ * #NAObjectProfile specific datas.
+ */
+#define NA_FACTORY_OBJECT_PROFILE_GROUP     "na-factory-group-profile"
+#define NAFO_DATA_DESCNAME                  "na-factory-data-descname"
+#define NAFO_DATA_DESCNAME_NOLOC            "na-factory-data-unlocalized-descname"
+#define NAFO_DATA_PATH                      "na-factory-data-path"
+#define NAFO_DATA_PARAMETERS                "na-factory-data-parameters"
+#define NAFO_DATA_WORKING_DIR               "na-factory-data-working-dir"
+#define NAFO_DATA_EXECUTION_MODE            "na-factory-data-execution-mode"
+#define NAFO_DATA_STARTUP_NOTIFY            "na-factory-data-startup-notify"
+#define NAFO_DATA_STARTUP_WMCLASS           "na-factory-data-startup-wm-class"
+#define NAFO_DATA_EXECUTE_AS                "na-factory-data-execute-as"
 
-#define NA_FACTORY_OBJECT_CONDITIONS_GROUP	"na-factory-group-conditions"
-#define NAFO_DATA_BASENAMES					"na-factory-data-basenames"
-#define NAFO_DATA_MATCHCASE					"na-factory-data-matchcase"
-#define NAFO_DATA_MIMETYPES					"na-factory-data-mimetypes"
-#define NAFO_DATA_ALL_MIMETYPES				"na-factory-data-all-mimetypes"
-#define NAFO_DATA_ISFILE					"na-factory-data-isfile"
-#define NAFO_DATA_ISDIR						"na-factory-data-isdir"
-#define NAFO_DATA_MULTIPLE					"na-factory-data-multiple"
-#define NAFO_DATA_SCHEMES					"na-factory-data-schemes"
-#define NAFO_DATA_FOLDERS					"na-factory-data-folders"
-#define NAFO_DATA_SELECTION_COUNT			"na-factory-data-selection-count"
-#define NAFO_DATA_ONLY_SHOW					"na-factory-data-only-show-in"
-#define NAFO_DATA_NOT_SHOW					"na-factory-data-not-show-in"
-#define NAFO_DATA_TRY_EXEC					"na-factory-data-try-exec"
-#define NAFO_DATA_SHOW_IF_REGISTERED		"na-factory-data-show-if-registered"
-#define NAFO_DATA_SHOW_IF_TRUE				"na-factory-data-show-if-true"
-#define NAFO_DATA_SHOW_IF_RUNNING			"na-factory-data-show-if-running"
-#define NAFO_DATA_CAPABILITITES				"na-factory-data-capabilitites"
+/**
+ * NA_FACTORY_OBJECT_CONDITIONS_GROUP:
+ *
+ * The datas which determine the display conditions of a menu or an action.
+ *
+ * @see_also: #NAIContext interface.
+ */
+#define NA_FACTORY_OBJECT_CONDITIONS_GROUP  "na-factory-group-conditions"
+#define NAFO_DATA_BASENAMES                 "na-factory-data-basenames"
+#define NAFO_DATA_MATCHCASE                 "na-factory-data-matchcase"
+#define NAFO_DATA_MIMETYPES                 "na-factory-data-mimetypes"
+#define NAFO_DATA_ALL_MIMETYPES             "na-factory-data-all-mimetypes"
+#define NAFO_DATA_ISFILE                    "na-factory-data-isfile"
+#define NAFO_DATA_ISDIR                     "na-factory-data-isdir"
+#define NAFO_DATA_MULTIPLE                  "na-factory-data-multiple"
+#define NAFO_DATA_SCHEMES                   "na-factory-data-schemes"
+#define NAFO_DATA_FOLDERS                   "na-factory-data-folders"
+#define NAFO_DATA_SELECTION_COUNT           "na-factory-data-selection-count"
+#define NAFO_DATA_ONLY_SHOW                 "na-factory-data-only-show-in"
+#define NAFO_DATA_NOT_SHOW                  "na-factory-data-not-show-in"
+#define NAFO_DATA_TRY_EXEC                  "na-factory-data-try-exec"
+#define NAFO_DATA_SHOW_IF_REGISTERED        "na-factory-data-show-if-registered"
+#define NAFO_DATA_SHOW_IF_TRUE              "na-factory-data-show-if-true"
+#define NAFO_DATA_SHOW_IF_RUNNING           "na-factory-data-show-if-running"
+#define NAFO_DATA_CAPABILITITES             "na-factory-data-capabilitites"
 
 G_END_DECLS
 
diff --git a/src/api/na-ifactory-object.h b/src/api/na-ifactory-object.h
index 84f9ce6..42440ab 100644
--- a/src/api/na-ifactory-object.h
+++ b/src/api/na-ifactory-object.h
@@ -58,13 +58,16 @@ typedef struct _NAIFactoryObjectInterfacePrivate NAIFactoryObjectInterfacePrivat
  * @write_start: triggered before unserializing a NAObjectItem.
  * @write_done:  triggered after a NAObjectItem has been unserialized.
  *
- * In order to take full advantage of our data managament system, NAOBjectItem-derived
- * objects all implement this #NAIFactoryObject interface.
+ * In order to take full advantage of our data managament system,
+ * NAObjectItem-derived objects all implement this #NAIFactoryObject
+ * interface.
  */
 typedef struct {
+	/*< private >*/
 	GTypeInterface                    parent;
 	NAIFactoryObjectInterfacePrivate *private;
 
+	/*< public >*/
 	/**
 	 * get_version:
 	 * @instance: this #NAIFactoryObject instance.
diff --git a/src/core/na-data-def.c b/src/core/na-data-def.c
index 76f3d8d..0ad02c9 100644
--- a/src/core/na-data-def.c
+++ b/src/core/na-data-def.c
@@ -37,12 +37,25 @@
 #include <api/na-data-def.h>
 
 /**
+ * SECTION: data-def
+ * @title: NADataDef, NADataGroup
+ * @short_description: Data Factory Definitions.
+ * @include: nautilus-actions/na-data-def.h
+ *
+ * #NADataDef and #NADataGroup are structures which handle the list of
+ * elementary datas for each and every #NAObjectItem which happens to
+ * implement the #NAIFactoryObject interface.
+ */
+
+/**
  * na_data_def_get_data_def:
  * @group: a #NADataGroup structure array.
  * @group_name: the searched group name.
  * @name: the searched data name.
  *
  * Returns: a pointer to the #NADataDef structure, or %NULL if not found.
+ *
+ * Since: Nautilus-Actions v 2.30.
  */
 const NADataDef *
 na_data_def_get_data_def( const NADataGroup *group, const gchar *group_name, const gchar *name )
diff --git a/src/core/na-factory-object.c b/src/core/na-factory-object.c
index 908ae8c..3255a61 100644
--- a/src/core/na-factory-object.c
+++ b/src/core/na-factory-object.c
@@ -111,7 +111,7 @@ static void         attach_boxed_to_object( NAIFactoryObject *object, NADataBoxe
 static void         free_data_boxed_list( NAIFactoryObject *object );
 static void         iter_on_data_defs( const NADataGroup *idgroups, guint mode, NADataDefIterFunc pfn, void *user_data );
 
-/**
+/*
  * na_factory_object_define_properties:
  * @class: the #GObjectClass.
  * @groups: the list of #NADataGroup structure which define the data of the class.
@@ -159,7 +159,7 @@ define_class_properties_iter( const NADataDef *def, GObjectClass *class )
 	return( stop );
 }
 
-/**
+/*
  * na_factory_object_get_data_def:
  * @object: this #NAIFactoryObject object.
  * @name: the searched name.
@@ -197,7 +197,7 @@ na_factory_object_get_data_def( const NAIFactoryObject *object, const gchar *nam
 	return( def );
 }
 
-/**
+/*
  * na_factory_object_get_data_groups:
  * @object: the #NAIFactoryObject instance.
  *
@@ -220,7 +220,7 @@ na_factory_object_get_data_groups( const NAIFactoryObject *object )
 	return( groups );
 }
 
-/**
+/*
  * na_factory_object_iter_on_boxed:
  * @object: this #NAIFactoryObject object.
  * @pfn: the function to be called.
@@ -250,7 +250,7 @@ na_factory_object_iter_on_boxed( const NAIFactoryObject *object, NAFactoryObject
 	}
 }
 
-/**
+/*
  * na_factory_object_get_default:
  * @object: this #NAIFactoryObject object.
  * @name: the searched name.
@@ -282,7 +282,7 @@ na_factory_object_get_default( NAIFactoryObject *object, const gchar *name )
 	return( value );
 }
 
-/**
+/*
  * na_factory_object_set_defaults:
  * @object: this #NAIFactoryObject object.
  *
@@ -340,7 +340,7 @@ set_defaults_iter( NADataDef *def, NafoDefaultIter *data )
 	return( FALSE );
 }
 
-/**
+/*
  * na_factory_object_move_boxed:
  * @target: the target #NAIFactoryObject instance.
  * @source: the source #NAIFactoryObject instance.
@@ -372,7 +372,7 @@ na_factory_object_move_boxed( NAIFactoryObject *target, const NAIFactoryObject *
 	}
 }
 
-/**
+/*
  * na_factory_object_copy:
  * @target: the target #NAIFactoryObject instance.
  * @source: the source #NAIFactoryObject instance.
@@ -413,7 +413,7 @@ na_factory_object_copy( NAIFactoryObject *target, const NAIFactoryObject *source
 	v_copy( target, source );
 }
 
-/**
+/*
  * na_factory_object_are_equal:
  * @a: the first #NAIFactoryObject instance.
  * @b: the second #NAIFactoryObject isntance.
@@ -484,7 +484,7 @@ na_factory_object_are_equal( const NAIFactoryObject *a, const NAIFactoryObject *
 	return( are_equal );
 }
 
-/**
+/*
  * na_factory_object_is_valid:
  * @object: the #NAIFactoryObject instance whose validity is to be checked.
  *
@@ -542,7 +542,7 @@ is_valid_mandatory_iter( const NADataDef *def, NafoValidIter *data )
 	return( !data->is_valid );
 }
 
-/**
+/*
  * na_factory_object_dump:
  * @object: this #NAIFactoryObject instance.
  *
@@ -580,7 +580,7 @@ na_factory_object_dump( const NAIFactoryObject *object )
 	}
 }
 
-/**
+/*
  * na_factory_object_finalize:
  * @object: the #NAIFactoryObject being finalized.
  *
@@ -592,7 +592,7 @@ na_factory_object_finalize( NAIFactoryObject *object )
 	free_data_boxed_list( object );
 }
 
-/**
+/*
  * na_factory_object_read_item:
  * @object: this #NAIFactoryObject instance.
  * @reader: the #NAIFactoryProvider which is at the origin of this read.
@@ -660,7 +660,7 @@ read_data_iter( NADataDef *def, NafoReadIter *iter )
 	return( stop );
 }
 
-/**
+/*
  * na_factory_object_write_item:
  * @object: this #NAIFactoryObject instance.
  * @writer: the #NAIFactoryProvider which is at the origin of this write.
@@ -731,7 +731,7 @@ write_data_iter( const NAIFactoryObject *object, NADataBoxed *boxed, NafoWriteIt
 	return( iter->code != NA_IIO_PROVIDER_CODE_OK );
 }
 
-/**
+/*
  * na_factory_object_get_as_value:
  * @object: this #NAIFactoryObject instance.
  * @name: the elementary data id.
@@ -757,7 +757,7 @@ na_factory_object_get_as_value( const NAIFactoryObject *object, const gchar *nam
 	}
 }
 
-/**
+/*
  * na_factory_object_get_as_void:
  * @object: this #NAIFactoryObject instance.
  * @name: the elementary data whose value is to be got.
@@ -787,7 +787,7 @@ na_factory_object_get_as_void( const NAIFactoryObject *object, const gchar *name
 	return( value );
 }
 
-/**
+/*
  * na_factory_object_set_from_value:
  * @object: this #NAIFactoryObject instance.
  * @name: the elementary data id.
@@ -820,7 +820,7 @@ na_factory_object_set_from_value( NAIFactoryObject *object, const gchar *name, c
 	}
 }
 
-/**
+/*
  * na_factory_object_set_from_void:
  * @object: this #NAIFactoryObject instance.
  * @name: the elementary data whose value is to be set.
diff --git a/src/core/na-factory-object.h b/src/core/na-factory-object.h
index 80b04a1..7a367ff 100644
--- a/src/core/na-factory-object.h
+++ b/src/core/na-factory-object.h
@@ -31,8 +31,7 @@
 #ifndef __CORE_NA_FACTORY_OBJECT_H__
 #define __CORE_NA_FACTORY_OBJECT_H__
 
-/**
- * SECTION: na_ifactory_object
+/*
  * @short_description: #NAIFactoryObject internal functions.
  * @include: core/na-factory-object.h
  *
diff --git a/src/core/na-ifactory-object.c b/src/core/na-ifactory-object.c
index 9b6798a..2d8fd36 100644
--- a/src/core/na-ifactory-object.c
+++ b/src/core/na-ifactory-object.c
@@ -99,7 +99,7 @@ static void  interface_base_finalize( NAIFactoryObjectInterface *klass );
 
 static guint ifactory_object_get_version( const NAIFactoryObject *instance );
 
-/**
+/*
  * Registers the GType of this interface.
  */
 GType
diff --git a/src/core/na-ifactory-provider.c b/src/core/na-ifactory-provider.c
index fa8ced1..54df472 100644
--- a/src/core/na-ifactory-provider.c
+++ b/src/core/na-ifactory-provider.c
@@ -64,7 +64,7 @@
  *       <para>
  *         whether they are a string, an integer, a boolean, a simple
  *         or double-linked list, each elementary data is encapsuled
- *         into a #NADataBox, small sort of structure (incidentally,
+ *         into a #NADataBoxed, small sort of structure (incidentally,
  *         which acts almost as the new GLib #GVariant, but too late,
  *         guys :)).
  *       </para>
@@ -75,7 +75,7 @@
  *       <title>Our objects are de-structured.</title>
  *       <para>
  *         Instead of organizing our elementary datas into structures,
- *         our objects are just flat lists of #NADataBox.
+ *         our objects are just flat lists of #NADataBoxed.
  *       </para>
  *     </formalpara>
  *   </listitem>
@@ -265,7 +265,7 @@ ifactory_provider_get_version( const NAIFactoryProvider *instance )
  * its items. The function takes care of collecting and structuring data,
  * while the callback interface methods #NAIFactoryProviderInterface.read_start(),
  * #NAIFactoryProviderInterface.read_data() and #NAIFactoryProviderInterface.read_done()
- * just have to fill a given #NADataBox with the ad-hoc data type.
+ * just have to fill a given #NADataBoxed with the ad-hoc data type.
  *
  * <example>
  *   <programlisting>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]