GNOME.org
 

[nautilus-actions] Reference manual: Fix NAIDuplicable Interface documentation

commit b954a052ae98806f4ac32168e4ab9d7897cb637d
Author: Pierre Wieser <pwieser trychlos org>
Date:   Sat Dec 11 17:31:07 2010 +0100

    Reference manual: Fix NAIDuplicable Interface documentation

 ChangeLog                                    |   11 +++
 docs/reference/nautilus-actions-docs.xml     |   10 +-
 docs/reference/nautilus-actions-sections.txt |   85 +++++++++++---------
 src/api/na-iduplicable.h                     |  112 +++++++++++++++++++------
 src/api/na-object-menu.h                     |   22 +++---
 src/api/na-object-profile.h                  |   21 +++--
 src/core/na-iduplicable.c                    |   45 ++++++++---
 src/core/na-object-menu.c                    |    8 ++-
 src/core/na-object-profile.c                 |   11 ++-
 9 files changed, 222 insertions(+), 103 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 910ccad..e11a9ad 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,16 @@
 2010-12-11 Pierre Wieser <pwieser trychlos org>
 
+	Fix NAIDuplicable Interface documentation.
+
+	* docs/reference/nautilus-actions-docs.xml:
+	* docs/reference/nautilus-actions-sections.txt:
+	* src/api/na-iduplicable.h:
+	* src/api/na-object-menu.h:
+	* src/api/na-object-profile.h:
+	* src/core/na-iduplicable.c:
+	* src/core/na-object-menu.c:
+	* src/core/na-object-profile.c: Updated accordingly.
+
 	Fix NAObjectAction documentation.
 
 	* docs/reference/nautilus-actions-docs.xml:
diff --git a/docs/reference/nautilus-actions-docs.xml b/docs/reference/nautilus-actions-docs.xml
index 7eb804a..aac54e3 100644
--- a/docs/reference/nautilus-actions-docs.xml
+++ b/docs/reference/nautilus-actions-docs.xml
@@ -73,11 +73,11 @@
     <xi:include href="xml/object-id.xml"/>
     <xi:include href="xml/object-item.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"/>
-    <xi:include href="xml/na-icontext.xml"/>
-    <xi:include href="xml/na-object-api.xml"/>
+    <xi:include href="xml/object-profile.xml"/>
+    <xi:include href="xml/object-menu.xml"/>
+    <xi:include href="xml/iduplicable.xml"/>
+    <xi:include href="xml/icontext.xml"/>
+    <xi:include href="xml/object-api.xml"/>
   </chapter>
 
   <chapter>
diff --git a/docs/reference/nautilus-actions-sections.txt b/docs/reference/nautilus-actions-sections.txt
index f678c22..fb5178a 100644
--- a/docs/reference/nautilus-actions-sections.txt
+++ b/docs/reference/nautilus-actions-sections.txt
@@ -358,6 +358,7 @@ NAObjectItemClassPrivate
 </SECTION>
 
 # ---------------------------------------------------------------------
+# NAObjectAction â?? The Action Class Definition
 
 <SECTION>
 <FILE>object-action</FILE>
@@ -386,72 +387,82 @@ NAObjectActionClassPrivate
 </SECTION>
 
 # ---------------------------------------------------------------------
+# NAObjectProfile â?? The Action Profile Class Definition
 
 <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>na-object-profile</FILE>
-<TITLE>NAObjectProfile</TITLE>
+<FILE>object-profile</FILE>
 NA_OBJECT_PROFILE_TYPE
-NAObjectProfilePrivate
-NAObjectProfileClassPrivate
+NA_OBJECT_PROFILE
+NA_IS_OBJECT_PROFILE
 NAObjectProfile
 na_object_profile_new
 na_object_profile_new_with_defaults
 na_object_profile_convert_v2_to_last
 
 <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
+NAObjectProfileClass
+
+<SUBSECTION Private>
+NAObjectProfilePrivate
+NAObjectProfileClassPrivate
 </SECTION>
 
 # ---------------------------------------------------------------------
+# NAObjectMenu â?? The Menu Class Definition
 
 <SECTION>
 <FILE>object-menu</FILE>
-<TITLE>NAObjectMenu</TITLE>
 NA_OBJECT_MENU_TYPE
-NAObjectMenuPrivate
-NAObjectMenuClassPrivate
+NA_OBJECT_MENU
+NA_IS_OBJECT_MENU
 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
+NAObjectMenuClass
+
+<SUBSECTION Private>
+NAObjectMenuPrivate
+NAObjectMenuClassPrivate
+</SECTION>
+
+# ---------------------------------------------------------------------
+# NAIDuplicable â?? The Duplication Interface
+
+<SECTION>
+<FILE>iduplicable</FILE>
+NA_IDUPLICABLE_TYPE
+NA_IDUPLICABLE
+NA_IS_IDUPLICABLE
+NA_IDUPLICABLE_GET_INTERFACE
+NAIDuplicable
+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_get_type
+
+<SUBSECTION Private>
+NAIDuplicableInterfacePrivate
 </SECTION>
 
 # ---------------------------------------------------------------------
diff --git a/src/api/na-iduplicable.h b/src/api/na-iduplicable.h
index ad485d1..c9f7665 100644
--- a/src/api/na-iduplicable.h
+++ b/src/api/na-iduplicable.h
@@ -33,12 +33,12 @@
 
 /**
  * SECTION: iduplicable
- * @title: #NAIDuplicable interface
- * @short_description: #NAIDuplicable interface.
+ * @title: NAIDuplicable
+ * @short_description: The Duplication Interface
  * @include: nautilus-actions/private/na-iduplicable.h
  *
  * This interface is implemented by #NAObject in order to let
- * #NAObject-derived instance duplication be easily tracked. This works
+ * #NAObject -derived instance duplication be easily tracked. This works
  * by keeping a pointer on the original object at duplication time, and
  * then only checking edition status when explicitely required.
  *
@@ -46,38 +46,90 @@
  * here, the caller has to garantee itself that the original object
  * will stay in life at least as long as the duplicated one.
  *
- * Modification status in Nautilus-Actions configuration tool.
+ * <refsect2>
+ *  <title>
+ *   Modification status in Nautilus-Actions configuration tool
+ *  </title>
+ *  <itemizedlist>
+ *   <listitem>
+ *    <para>
+ *     Objects whose origin is NULL are considered as modified ; this is
+ *     in particular the case of new, pasted, imported and dropped
+ *     objects.
+ *    </para>
+ *   </listitem>
+ *   <listitem>
+ *    <para>
+ *     when a new object, whether is is really new or it has been pasted,
+ *     imported or dropped, is inserted somewhere in the tree, its
+ *     immediate parent is also marked as modified.
+ *    </para>
+ *   </listitem>
+ *   <listitem>
+ *    <para>
+ *     Check for edition status, which positions modification and validity
+ *     status, is not recursive ; it is the responsability of the
+ *     implementation to check for edition status of childs of object..
+ *    </para>
+ *   </listitem>
+ *  </itemizedlist>
+ * </refsect2>
  *
- * - Objects whose origin is NULL are considered as modified ; this is
- *   in particular the case of new, pasted, imported and dropped
- *   objects.
- *
- * - when a new object, whether is is really new or it has been pasted,
- *   imported or dropped, is inserted somewhere in the tree, its
- *   immediate parent is also marked as modified.
- *
- * - Check for edition status, which positions modification and validity
- *   status, is not recursive ; it is the responsability of the
- *   implementation to check for edition status of childs of object..
+ * <refsect2>
+ *  <title>Versions historic</title>
+ *  <table>
+ *    <title>Historic of the versions of the #NAIDuplicable interface</title>
+ *    <tgroup rowsep="1" colsep="1" align="center" cols="3">
+ *      <colspec colname="na-version" />
+ *      <colspec colname="api-version" />
+ *      <colspec colname="current" />
+ *      <thead>
+ *        <row>
+ *          <entry>&prodname; version</entry>
+ *          <entry>#NAIDuplicable interface version</entry>
+ *          <entry></entry>
+ *        </row>
+ *      </thead>
+ *      <tbody>
+ *        <row>
+ *          <entry>since 2.30</entry>
+ *          <entry>1</entry>
+ *          <entry>current version</entry>
+ *        </row>
+ *      </tbody>
+ *    </tgroup>
+ *  </table>
+ * </refsect2>
  */
 
 #include <glib-object.h>
 
 G_BEGIN_DECLS
 
-#define NA_IDUPLICABLE_TYPE							( na_iduplicable_get_type())
-#define NA_IDUPLICABLE( instance )					( G_TYPE_CHECK_INSTANCE_CAST( instance, NA_IDUPLICABLE_TYPE, NAIDuplicable ))
-#define NA_IS_IDUPLICABLE( instance )				( G_TYPE_CHECK_INSTANCE_TYPE( instance, NA_IDUPLICABLE_TYPE ))
-#define NA_IDUPLICABLE_GET_INTERFACE( instance )	( G_TYPE_INSTANCE_GET_INTERFACE(( instance ), NA_IDUPLICABLE_TYPE, NAIDuplicableInterface ))
+#define NA_IDUPLICABLE_TYPE                        ( na_iduplicable_get_type())
+#define NA_IDUPLICABLE( instance )                 ( G_TYPE_CHECK_INSTANCE_CAST( instance, NA_IDUPLICABLE_TYPE, NAIDuplicable ))
+#define NA_IS_IDUPLICABLE( instance )              ( G_TYPE_CHECK_INSTANCE_TYPE( instance, NA_IDUPLICABLE_TYPE ))
+#define NA_IDUPLICABLE_GET_INTERFACE( instance )   ( G_TYPE_INSTANCE_GET_INTERFACE(( instance ), NA_IDUPLICABLE_TYPE, NAIDuplicableInterface ))
 
-typedef struct NAIDuplicable                 NAIDuplicable;
+typedef struct _NAIDuplicable                 NAIDuplicable;
 
-typedef struct NAIDuplicableInterfacePrivate NAIDuplicableInterfacePrivate;
+typedef struct _NAIDuplicableInterfacePrivate NAIDuplicableInterfacePrivate;
 
+/**
+ * NAIDuplicableInterface:
+ * @copy:      copies one object to another.
+ * @are_equal: tests if two objects are equals.
+ * @is_valid:  tests if one object is valid.
+ *
+ * This interface is implemented by #NAObject objects, in order to be able
+ * to keep the trace of all duplicated objects.
+ */
 typedef struct {
+	/*< private >*/
 	GTypeInterface                 parent;
 	NAIDuplicableInterfacePrivate *private;
 
+	/*< public >*/
 	/**
 	 * copy:
 	 * @target: the #NAIDuplicable target of the copy.
@@ -90,6 +142,8 @@ typedef struct {
 	 * function to copy its own data. The implementation should take
 	 * care itself of calling each function in the class hierarchy,
 	 * from topmost base class to most-derived one.
+	 *
+	 * Since: Nautilus-Actions v 2.30, NAIDuplicable interface v 1.
 	 */
 	void     ( *copy )     ( NAIDuplicable *target, const NAIDuplicable *source );
 
@@ -101,33 +155,37 @@ typedef struct {
 	 *
 	 * Compares the two objects.
 	 *
-	 * Returns: %TRUE if @a and @b are identical, %FALSE else.
-	 *
 	 * Each derived class of the implementation should define this
 	 * function to compare its own data. The implementation should take
 	 * care itself of calling each function in the class hierarchy,
 	 * from topmost base class to most-derived one.
+	 *
+	 * Returns: TRUE if @a and @b are identical, FALSE else.
+	 *
+	 * Since: Nautilus-Actions v 2.30, NAIDuplicable interface v 1.
 	 */
 	gboolean ( *are_equal )( const NAIDuplicable *a, const NAIDuplicable *b );
 
 	/**
 	 * is_valid:
-	 * @object: the #NAIDuplicable object to be checked.
+	 * @object: the NAIDuplicable object to be checked.
 	 *
 	 * Checks @object for validity.
 	 *
-	 * Returns: %TRUE if @object is valid, %FALSE else.
-	 *
 	 * Each derived class of the implementation should define this
 	 * function to compare its own data. The implementation should take
 	 * care itself of calling each function in the class hierarchy,
 	 * from topmost base class to most-derived one.
+	 *
+	 * Returns: TRUE if @object is valid, FALSE else.
+	 *
+	 * Since: Nautilus-Actions v 2.30, NAIDuplicable interface v 1.
 	 */
 	gboolean ( *is_valid )   ( const NAIDuplicable *object );
 }
 	NAIDuplicableInterface;
 
-#define NA_IDUPLICABLE_SIGNAL_STATUS_CHANGED	"na-iduplicable-status-changed"
+#define NA_IDUPLICABLE_SIGNAL_STATUS_CHANGED	"status-changed"
 
 GType          na_iduplicable_get_type( void );
 
diff --git a/src/api/na-object-menu.h b/src/api/na-object-menu.h
index 1423d42..6e160b5 100644
--- a/src/api/na-object-menu.h
+++ b/src/api/na-object-menu.h
@@ -33,8 +33,8 @@
 
 /**
  * SECTION: object-menu
- * @title: NAObjectMenu class definition
- * @short_description: #NAObjectMenu class definition.
+ * @title: NAObjectMenu
+ * @short_description: The Menu Class Definition
  * @include: nautilus-actions/na-object-menu.h
  */
 
@@ -42,24 +42,26 @@
 
 G_BEGIN_DECLS
 
-#define NA_OBJECT_MENU_TYPE					( na_object_menu_get_type())
-#define NA_OBJECT_MENU( object )			( G_TYPE_CHECK_INSTANCE_CAST( object, NA_OBJECT_MENU_TYPE, NAObjectMenu ))
-#define NA_OBJECT_MENU_CLASS( klass )		( G_TYPE_CHECK_CLASS_CAST( klass, NA_OBJECT_MENU_TYPE, NAObjectMenuClass ))
-#define NA_IS_OBJECT_MENU( object )			( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_OBJECT_MENU_TYPE ))
-#define NA_IS_OBJECT_MENU_CLASS( klass )	( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_OBJECT_MENU_TYPE ))
-#define NA_OBJECT_MENU_GET_CLASS( object )	( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_OBJECT_MENU_TYPE, NAObjectMenuClass ))
+#define NA_OBJECT_MENU_TYPE                  ( na_object_menu_get_type())
+#define NA_OBJECT_MENU( object )             ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_OBJECT_MENU_TYPE, NAObjectMenu ))
+#define NA_OBJECT_MENU_CLASS( klass )        ( G_TYPE_CHECK_CLASS_CAST( klass, NA_OBJECT_MENU_TYPE, NAObjectMenuClass ))
+#define NA_IS_OBJECT_MENU( object )          ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_OBJECT_MENU_TYPE ))
+#define NA_IS_OBJECT_MENU_CLASS( klass )     ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_OBJECT_MENU_TYPE ))
+#define NA_OBJECT_MENU_GET_CLASS( object )   ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_OBJECT_MENU_TYPE, NAObjectMenuClass ))
 
-typedef struct NAObjectMenuPrivate      NAObjectMenuPrivate;
+typedef struct _NAObjectMenuPrivate      NAObjectMenuPrivate;
 
 typedef struct {
+	/*< private >*/
 	NAObjectItem         parent;
 	NAObjectMenuPrivate *private;
 }
 	NAObjectMenu;
 
-typedef struct NAObjectMenuClassPrivate NAObjectMenuClassPrivate;
+typedef struct _NAObjectMenuClassPrivate NAObjectMenuClassPrivate;
 
 typedef struct {
+	/*< private >*/
 	NAObjectItemClass         parent;
 	NAObjectMenuClassPrivate *private;
 }
diff --git a/src/api/na-object-profile.h b/src/api/na-object-profile.h
index b3a7b3b..225a21b 100644
--- a/src/api/na-object-profile.h
+++ b/src/api/na-object-profile.h
@@ -33,7 +33,8 @@
 
 /**
  * SECTION: object-profile
- * @short_description: #NAObjectProfile class definition.
+ * @title: NAObjectProfile
+ * @short_description: The Action Profile Class Definition
  * @include: nautilus-actions/na-object-item.h
  */
 
@@ -41,24 +42,26 @@
 
 G_BEGIN_DECLS
 
-#define NA_OBJECT_PROFILE_TYPE					( na_object_profile_get_type())
-#define NA_OBJECT_PROFILE( object )				( G_TYPE_CHECK_INSTANCE_CAST( object, NA_OBJECT_PROFILE_TYPE, NAObjectProfile ))
-#define NA_OBJECT_PROFILE_CLASS( klass )		( G_TYPE_CHECK_CLASS_CAST( klass, NA_OBJECT_PROFILE_TYPE, NAObjectProfileClass ))
-#define NA_IS_OBJECT_PROFILE( object )			( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_OBJECT_PROFILE_TYPE ))
-#define NA_IS_OBJECT_PROFILE_CLASS( klass )		( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_OBJECT_PROFILE_TYPE ))
-#define NA_OBJECT_PROFILE_GET_CLASS( object )	( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_OBJECT_PROFILE_TYPE, NAObjectProfileClass ))
+#define NA_OBJECT_PROFILE_TYPE                  ( na_object_profile_get_type())
+#define NA_OBJECT_PROFILE( object )             ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_OBJECT_PROFILE_TYPE, NAObjectProfile ))
+#define NA_OBJECT_PROFILE_CLASS( klass )        ( G_TYPE_CHECK_CLASS_CAST( klass, NA_OBJECT_PROFILE_TYPE, NAObjectProfileClass ))
+#define NA_IS_OBJECT_PROFILE( object )          ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_OBJECT_PROFILE_TYPE ))
+#define NA_IS_OBJECT_PROFILE_CLASS( klass )     ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_OBJECT_PROFILE_TYPE ))
+#define NA_OBJECT_PROFILE_GET_CLASS( object )   ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_OBJECT_PROFILE_TYPE, NAObjectProfileClass ))
 
-typedef struct NAObjectProfilePrivate      NAObjectProfilePrivate;
+typedef struct _NAObjectProfilePrivate      NAObjectProfilePrivate;
 
 typedef struct {
+	/*< private >*/
 	NAObjectId              parent;
 	NAObjectProfilePrivate *private;
 }
 	NAObjectProfile;
 
-typedef struct NAObjectProfileClassPrivate NAObjectProfileClassPrivate;
+typedef struct _NAObjectProfileClassPrivate NAObjectProfileClassPrivate;
 
 typedef struct {
+	/*< private >*/
 	NAObjectIdClass              parent;
 	NAObjectProfileClassPrivate *private;
 }
diff --git a/src/core/na-iduplicable.c b/src/core/na-iduplicable.c
index 834a84a..67f283b 100644
--- a/src/core/na-iduplicable.c
+++ b/src/core/na-iduplicable.c
@@ -36,7 +36,7 @@
 
 /* private interface data
  */
-struct NAIDuplicableInterfacePrivate {
+struct _NAIDuplicableInterfacePrivate {
 	GList *consumers;
 };
 
@@ -135,9 +135,9 @@ interface_base_init( NAIDuplicableInterface *klass )
 		klass->is_valid = NULL;
 
 		/**
-		 * na-iduplicable-status-changed:
+		 * NAIDuplicable::status-changed:
 		 *
-		 * This signal is emitted by NAIDuplicable when the modification
+		 * This signal is emitted by #NAIDuplicable when the modification
 		 * or the validity status of an object has been modified.
 		 */
 		st_signals[ STATUS_CHANGED ] = g_signal_new(
@@ -180,6 +180,8 @@ interface_base_finalize( NAIDuplicableInterface *klass )
  * @object: the #NAIDuplicable object to be initialized.
  *
  * Releases resources.
+ *
+ * Since: Nautilus-Actions v 2.30, NAIDuplicable interface v 1.
  */
 void
 na_iduplicable_dispose( const NAIDuplicable *object )
@@ -207,10 +209,12 @@ na_iduplicable_dispose( const NAIDuplicable *object )
  * Dumps via g_debug the properties of the object.
  *
  * We ouput here only the data we set ourselves againt the
- * #NAIDuplicable-implemented object.
+ * #NAIDuplicable -implemented object.
  *
  * This function should be called by the implementation when it dumps
  * itself its own content.
+ *
+ * Since: Nautilus-Actions v 2.30, NAIDuplicable interface v 1.
  */
 void
 na_iduplicable_dump( const NAIDuplicable *object )
@@ -234,7 +238,7 @@ na_iduplicable_dump( const NAIDuplicable *object )
  * na_iduplicable_duplicate:
  * @object: the #NAIDuplicable object to be duplicated.
  *
- * Exactly duplicates a #NAIDuplicable-implemented object, including
+ * Exactly duplicates a #NAIDuplicable -implemented object, including
  * modification and validity status which are copied from @object to
  * the duplicated one.
  *
@@ -242,11 +246,16 @@ na_iduplicable_dump( const NAIDuplicable *object )
  * everywhere in the program that recursivity is provided but #NAObject
  * implementation.
  *
- * +------------------------------------------------------------------------------+
- * | na_object_duplicate (aka na_iduplicable_duplicate) is definitively recursive |
- * +------------------------------------------------------------------------------+
+ * <important>
+ *   <para>
+ *     na_object_duplicate() (aka na_iduplicable_duplicate())
+ *     is definitively recursive
+ *   </para>
+ * </important>
  *
  * Returns: a new #NAIDuplicable.
+ *
+ * Since: Nautilus-Actions v 2.30, NAIDuplicable interface v 1.
  */
 NAIDuplicable *
 na_iduplicable_duplicate( const NAIDuplicable *object )
@@ -292,12 +301,14 @@ na_iduplicable_duplicate( const NAIDuplicable *object )
  * functions na_iduplicable_is_modified() and na_iduplicable_is_valid()
  * will then only return the current value of the properties.
  *
- * #na_iduplicable_check_status() is not, as itself, recursive.
+ * na_iduplicable_check_status() is not, as itself, recursive.
  * That is, the modification and validity status are only set on the
  * specified object.
  * #NAObject implementation has choosen to handle itself the recursivity:
- * #na_object_check_status() so first check status for childs, before
+ * na_object_check_status() so first check status for childs, before
  * calling this function.
+ *
+ * Since: Nautilus-Actions v 2.30, NAIDuplicable interface v 1.
  */
 void
 na_iduplicable_check_status( const NAIDuplicable *object )
@@ -369,6 +380,8 @@ na_iduplicable_check_status( const NAIDuplicable *object )
  * Returns the origin of a duplicated #NAIDuplicable.
  *
  * Returns: the original #NAIDuplicable, or NULL.
+ *
+ * Since: Nautilus-Actions v 2.30, NAIDuplicable interface v 1.
  */
 NAIDuplicable *
 na_iduplicable_get_origin( const NAIDuplicable *object )
@@ -397,6 +410,8 @@ na_iduplicable_get_origin( const NAIDuplicable *object )
  * without rechecking the edition status itself.
  *
  * Returns: %TRUE is the provided object is valid.
+ *
+ * Since: Nautilus-Actions v 2.30, NAIDuplicable interface v 1.
  */
 gboolean
 na_iduplicable_is_valid( const NAIDuplicable *object )
@@ -421,11 +436,13 @@ na_iduplicable_is_valid( const NAIDuplicable *object )
  * na_iduplicable_is_modified:
  * @object: the #NAIDuplicable object whose status is to be returned.
  *
- * Returns the current value of the %PROP_IDUPLICABLE_ISMODIFIED
+ * Returns the current value of the 'is_modified'
  * property without rechecking the edition status itself.
  *
  * Returns: %TRUE is the provided object has been modified regarding of
  * the original one.
+ *
+ * Since: Nautilus-Actions v 2.30, NAIDuplicable interface v 1.
  */
 gboolean
 na_iduplicable_is_modified( const NAIDuplicable *object )
@@ -452,6 +469,8 @@ na_iduplicable_is_modified( const NAIDuplicable *object )
  * @origin: the new original #NAIDuplicable.
  *
  * Sets the new origin of a duplicated #NAIDuplicable.
+ *
+ * Since: Nautilus-Actions v 2.30, NAIDuplicable interface v 1.
  */
 void
 na_iduplicable_set_origin( NAIDuplicable *object, const NAIDuplicable *origin )
@@ -474,6 +493,8 @@ na_iduplicable_set_origin( NAIDuplicable *object, const NAIDuplicable *origin )
  * @modified: the new modification status #NAIDuplicable.
  *
  * Sets the new modified of a duplicated #NAIDuplicable.
+ *
+ * Since: Nautilus-Actions v 2.30, NAIDuplicable interface v 1.
  */
 void
 na_iduplicable_set_modified( NAIDuplicable *object, gboolean modified )
@@ -527,6 +548,8 @@ v_is_valid( const NAIDuplicable *object )
  *
  * This function registers a consumer, i.e. an instance to which edition
  * status signals will be propagated.
+ *
+ * Since: Nautilus-Actions v 2.30, NAIDuplicable interface v 1.
  */
 void
 na_iduplicable_register_consumer( GObject *consumer )
diff --git a/src/core/na-object-menu.c b/src/core/na-object-menu.c
index 572e25b..0bbdc2b 100644
--- a/src/core/na-object-menu.c
+++ b/src/core/na-object-menu.c
@@ -44,13 +44,13 @@
 
 /* private class data
  */
-struct NAObjectMenuClassPrivate {
+struct _NAObjectMenuClassPrivate {
 	void *empty;						/* so that gcc -pedantic is happy */
 };
 
 /* private instance data
  */
-struct NAObjectMenuPrivate {
+struct _NAObjectMenuPrivate {
 	gboolean dispose_has_run;
 };
 
@@ -419,6 +419,8 @@ is_valid_label( const NAObjectMenu *menu )
  * Allocates a new #NAObjectMenu object.
  *
  * Returns: the newly allocated #NAObjectMenu object.
+ *
+ * Since: Nautilus-Actions v 2.30.
  */
 NAObjectMenu *
 na_object_menu_new( void )
@@ -436,6 +438,8 @@ na_object_menu_new( void )
  * Allocates a new #NAObjectMenu object, and setup default values.
  *
  * Returns: the newly allocated #NAObjectMenu object.
+ *
+ * Since: Nautilus-Actions v 2.30.
  */
 NAObjectMenu *
 na_object_menu_new_with_defaults( void )
diff --git a/src/core/na-object-profile.c b/src/core/na-object-profile.c
index 411eb11..d08738c 100644
--- a/src/core/na-object-profile.c
+++ b/src/core/na-object-profile.c
@@ -49,13 +49,13 @@
 
 /* private class data
  */
-struct NAObjectProfileClassPrivate {
+struct _NAObjectProfileClassPrivate {
 	void *empty;							/* so that gcc -pedantic is happy */
 };
 
 /* private instance data
  */
-struct NAObjectProfilePrivate {
+struct _NAObjectProfilePrivate {
 	gboolean dispose_has_run;
 };
 
@@ -702,6 +702,8 @@ object_id_new_id( const NAObjectId *item, const NAObjectId *new_parent )
  * Allocates a new profile.
  *
  * Returns: the newly allocated #NAObjectProfile profile.
+ *
+ * Since: Nautilus-Actions v 2.30.
  */
 NAObjectProfile *
 na_object_profile_new( void )
@@ -719,6 +721,8 @@ na_object_profile_new( void )
  * Allocates a new profile, and set default values.
  *
  * Returns: the newly allocated #NAObjectProfile profile.
+ *
+ * Since: Nautilus-Actions v 2.30.
  */
 NAObjectProfile *
 na_object_profile_new_with_defaults( void )
@@ -734,8 +738,11 @@ na_object_profile_new_with_defaults( void )
 
 /**
  * na_object_profile_convert_v2_to_last:
+ * @profile: the #NAObjectProfile profile to be converted.
  *
  * Converts to v3 a @profile which has just been created from a pre-v2 action.
+ *
+ * Since: Nautilus-Actions v 2.30.
  */
 void
 na_object_profile_convert_v2_to_last( NAObjectProfile *profile )
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]