GNOME.org
 

[nautilus-actions] Reference manual: Fix NAObjectAction documentation

commit 0ec1fbc9385533fd74ffd38e373f44e6827daf44
Author: Pierre Wieser <pwieser trychlos org>
Date:   Sat Dec 11 16:56:58 2010 +0100

    Reference manual: Fix NAObjectAction documentation

 ChangeLog                                    |    8 ++++
 docs/reference/nautilus-actions-docs.xml     |    2 +-
 docs/reference/nautilus-actions-sections.txt |   53 +++++++++++++------------
 src/api/na-object-action.h                   |   39 ++++++++++++-------
 src/core/na-icontext-factory.c               |    2 +-
 src/core/na-object-action.c                  |   22 ++++++++--
 6 files changed, 79 insertions(+), 47 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 9c56e2d..910ccad 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,13 @@
 2010-12-11 Pierre Wieser <pwieser trychlos org>
 
+	Fix NAObjectAction documentation.
+
+	* docs/reference/nautilus-actions-docs.xml:
+	* docs/reference/nautilus-actions-sections.txt:
+	* src/api/na-object-action.h:
+	* src/core/na-icontext-factory.c:
+	* src/core/na-object-action.c: Updated accordingly.
+
 	Fix NAObjectItem documentation.
 
 	* docs/reference/nautilus-actions-docs.xml:
diff --git a/docs/reference/nautilus-actions-docs.xml b/docs/reference/nautilus-actions-docs.xml
index 8cc27d8..7eb804a 100644
--- a/docs/reference/nautilus-actions-docs.xml
+++ b/docs/reference/nautilus-actions-docs.xml
@@ -72,7 +72,7 @@
     <xi:include href="xml/object.xml"/>
     <xi:include href="xml/object-id.xml"/>
     <xi:include href="xml/object-item.xml"/>
-    <xi:include href="xml/na-object-action.xml"/>
+    <xi:include href="xml/object-action.xml"/>
     <xi:include href="xml/na-object-profile.xml"/>
     <xi:include href="xml/na-object-menu.xml"/>
     <xi:include href="xml/na-iduplicable.xml"/>
diff --git a/docs/reference/nautilus-actions-sections.txt b/docs/reference/nautilus-actions-sections.txt
index e5705bf..f678c22 100644
--- a/docs/reference/nautilus-actions-sections.txt
+++ b/docs/reference/nautilus-actions-sections.txt
@@ -360,6 +360,34 @@ NAObjectItemClassPrivate
 # ---------------------------------------------------------------------
 
 <SECTION>
+<FILE>object-action</FILE>
+<TITLE>NAObjectAction</TITLE>
+NA_OBJECT_ACTION_TYPE
+NA_OBJECT_ACTION
+NA_IS_OBJECT_ACTION
+NAObjectAction
+na_object_action_new
+na_object_action_new_with_profile
+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_get_type
+NA_OBJECT_ACTION_CLASS
+NA_IS_OBJECT_ACTION_CLASS
+NA_OBJECT_ACTION_GET_CLASS
+NAObjectActionClass
+
+<SUBSECTION Private>
+NAObjectActionPrivate
+NAObjectActionClassPrivate
+</SECTION>
+
+# ---------------------------------------------------------------------
+
+<SECTION>
 <FILE>iduplicable</FILE>
 NA_IDUPLICABLE_TYPE
 NA_IDUPLICABLE_GET_INTERFACE
@@ -386,31 +414,6 @@ na_iduplicable_get_type
 # ---------------------------------------------------------------------
 
 <SECTION>
-<FILE>object-action</FILE>
-<TITLE>NAObjectAction</TITLE>
-NA_OBJECT_ACTION_TYPE
-NAObjectActionPrivate
-NAObjectActionClassPrivate
-NAObjectAction
-na_object_action_new
-na_object_action_new_with_profile
-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
-na_object_action_get_type
-NA_OBJECT_ACTION_CLASS
-NA_IS_OBJECT_ACTION_CLASS
-NA_OBJECT_ACTION_GET_CLASS
-</SECTION>
-
-# ---------------------------------------------------------------------
-
-<SECTION>
 <FILE>na-object-profile</FILE>
 <TITLE>NAObjectProfile</TITLE>
 NA_OBJECT_PROFILE_TYPE
diff --git a/src/api/na-object-action.h b/src/api/na-object-action.h
index 4128113..62eac4e 100644
--- a/src/api/na-object-action.h
+++ b/src/api/na-object-action.h
@@ -33,17 +33,24 @@
 
 /**
  * SECTION: object-action
- * @title: #NAObjectAction class definition
- * @short_description: #NAObjectAction class definition.
+ * @title: NAObjectAction
+ * @short_description: The Action Class Definition
  * @include: nautilus-actions/na-object-action.h
  *
- * This is the class which maintains data and properties of a Nautilus
+ * This is the class which maintains data and properties of a &prodname;
  * action.
  *
- * Note about edition status:
- * As a particular rule of #NAItem derived class, a #NAObjectAction is
- * considered modified as soon as any of its profiles has been modified
- * itself (because they are saved as a whole).
+ * <note>
+ *   <formalpara>
+ *     <title>Edition status</title>
+ *     <para>
+ *       As a particular rule for a #NAObjectItem -derived class,
+ *       a #NAObjectAction is considered modified as soon as any of
+ *       its profiles has been modified itself
+ *       (because they are saved as a whole).
+ *     </para>
+ *   </formalpara>
+ * </note>
  */
 
 #include "na-object-item.h"
@@ -51,24 +58,26 @@
 
 G_BEGIN_DECLS
 
-#define NA_OBJECT_ACTION_TYPE					( na_object_action_get_type())
-#define NA_OBJECT_ACTION( object )				( G_TYPE_CHECK_INSTANCE_CAST( object, NA_OBJECT_ACTION_TYPE, NAObjectAction ))
-#define NA_OBJECT_ACTION_CLASS( klass )			( G_TYPE_CHECK_CLASS_CAST( klass, NA_OBJECT_ACTION_TYPE, NAObjectActionClass ))
-#define NA_IS_OBJECT_ACTION( object )			( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_OBJECT_ACTION_TYPE ))
-#define NA_IS_OBJECT_ACTION_CLASS( klass )		( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_OBJECT_ACTION_TYPE ))
-#define NA_OBJECT_ACTION_GET_CLASS( object )	( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_OBJECT_ACTION_TYPE, NAObjectActionClass ))
+#define NA_OBJECT_ACTION_TYPE                  ( na_object_action_get_type())
+#define NA_OBJECT_ACTION( object )             ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_OBJECT_ACTION_TYPE, NAObjectAction ))
+#define NA_OBJECT_ACTION_CLASS( klass )        ( G_TYPE_CHECK_CLASS_CAST( klass, NA_OBJECT_ACTION_TYPE, NAObjectActionClass ))
+#define NA_IS_OBJECT_ACTION( object )          ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_OBJECT_ACTION_TYPE ))
+#define NA_IS_OBJECT_ACTION_CLASS( klass )     ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_OBJECT_ACTION_TYPE ))
+#define NA_OBJECT_ACTION_GET_CLASS( object )   ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_OBJECT_ACTION_TYPE, NAObjectActionClass ))
 
-typedef struct NAObjectActionPrivate      NAObjectActionPrivate;
+typedef struct _NAObjectActionPrivate      NAObjectActionPrivate;
 
 typedef struct {
+	/*< private >*/
 	NAObjectItem           parent;
 	NAObjectActionPrivate *private;
 }
 	NAObjectAction;
 
-typedef struct NAObjectActionClassPrivate NAObjectActionClassPrivate;
+typedef struct _NAObjectActionClassPrivate NAObjectActionClassPrivate;
 
 typedef struct {
+	/*< private >*/
 	NAObjectItemClass           parent;
 	NAObjectActionClassPrivate *private;
 }
diff --git a/src/core/na-icontext-factory.c b/src/core/na-icontext-factory.c
index 409278d..bc7eedf 100644
--- a/src/core/na-icontext-factory.c
+++ b/src/core/na-icontext-factory.c
@@ -144,7 +144,7 @@ NADataDef data_def_conditions [] = {
 				FALSE,
 				TRUE,
 				"Does the mimetypes list is generic ?",
-				"The generic wildcard may be coded as '*', or '*/*' or 'all' or 'all/*' or 'all/all'."
+				"The generic wildcard may be coded as '*', or '*/*' or 'all' or 'all/*' or 'all/all'. "
 				"In each case, we will try to spend as less time as possible to check " \
 				"selection mimetypes",
 				NAFD_TYPE_BOOLEAN,
diff --git a/src/core/na-object-action.c b/src/core/na-object-action.c
index a2b990b..8290e46 100644
--- a/src/core/na-object-action.c
+++ b/src/core/na-object-action.c
@@ -45,13 +45,13 @@
 
 /* private class data
  */
-struct NAObjectActionClassPrivate {
+struct _NAObjectActionClassPrivate {
 	void *empty;						/* so that gcc -pedantic is happy */
 };
 
 /* private instance data
  */
-struct NAObjectActionPrivate {
+struct _NAObjectActionPrivate {
 	gboolean dispose_has_run;
 };
 
@@ -600,6 +600,8 @@ is_valid_toolbar_label( const NAObjectAction *action )
  * but without any profile.
  *
  * Returns: the newly allocated #NAObjectAction object.
+ *
+ * Since: Nautilus-Actions v 2.30.
  */
 NAObjectAction *
 na_object_action_new( void )
@@ -617,6 +619,8 @@ na_object_action_new( void )
  * Allocates a new #NAObjectAction object along with a default profile.
  *
  * Returns: the newly allocated #NAObjectAction action.
+ *
+ * Since: Nautilus-Actions v 2.30.
  */
 NAObjectAction *
 na_object_action_new_with_profile( void )
@@ -638,6 +642,8 @@ na_object_action_new_with_profile( void )
  * These two objects have suitable default values.
  *
  * Returns: the newly allocated #NAObjectAction action.
+ *
+ * Since: Nautilus-Actions v 2.30.
  */
 NAObjectAction *
 na_object_action_new_with_defaults( void )
@@ -668,12 +674,14 @@ na_object_action_new_with_defaults( void )
  * which is not yet allocated. The provided name is so only suitable
  * for the specified @action.
  *
- * Returns: a newly allocated profile name, which should be g_free() by
- * the caller.
- *
  * When inserting a list of profiles in the action, we iter first for
  * new names, before actually do the insertion. We so keep the last
  * allocated name to avoid to allocate the same one twice.
+ *
+ * Returns: a newly allocated profile name, which should be g_free() by
+ * the caller.
+ *
+ * Since: Nautilus-Actions v 2.30.
  */
 gchar *
 na_object_action_get_new_profile_name( const NAObjectAction *action )
@@ -715,6 +723,8 @@ na_object_action_get_new_profile_name( const NAObjectAction *action )
  * @profile: the #NAObjectProfile profile to be attached to @action.
  *
  * Adds a profile at the end of the list of profiles.
+ *
+ * Since: Nautilus-Actions v 2.30.
  */
 void
 na_object_action_attach_profile( NAObjectAction *action, NAObjectProfile *profile )
@@ -734,6 +744,8 @@ na_object_action_attach_profile( NAObjectAction *action, NAObjectProfile *profil
  * @action: the #NAObjectAction action to update.
  *
  * Set the version number of the @action to the last one.
+ *
+ * Since: Nautilus-Actions v 2.30.
  */
 void
 na_object_action_set_last_version( NAObjectAction *action )
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]