GNOME.org
 

[nautilus-actions] Update Reference Manual

commit 52c9abd97ce04327eca02ed2da68f256885ea848
Author: Pierre Wieser <pwieser trychlos org>
Date:   Thu Feb 17 00:16:56 2011 +0100

    Update Reference Manual

 docs/reference/Makefile.am                    |    6 +-
 docs/reference/nautilus-actions-docs.xml      |    6 ++
 docs/reference/nautilus-actions-overrides.txt |    6 ++
 docs/reference/nautilus-actions-sections.txt  |   71 +++++++++++++++++++++---
 run-autogen.sh                                |   15 +++++-
 src/api/na-boxed.h                            |    4 +-
 src/api/na-data-boxed.h                       |    2 +-
 src/api/na-timeout.h                          |   11 +++-
 src/core/na-data-boxed.c                      |   27 +++------
 src/core/na-gconf-migration.c                 |    2 +-
 src/core/na-gconf-monitor.c                   |    2 -
 src/core/na-gconf-utils.c                     |    9 +---
 src/core/na-iduplicable.c                     |    1 -
 13 files changed, 114 insertions(+), 48 deletions(-)
---
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 23cb312..432dfa5 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -57,10 +57,10 @@ content_files = $(shell \ls -1 *.xml)
 content_files += $(auto_created_files)
 
 if !HAVE_GCONF
-ignore_headers = "--ignore-headers=na-gconf-monitor.h"
+ignore_headers = na-gconf-monitor.h
 else
 if !ENABLE_DEPRECATED
-ignore_headers = "--ignore-headers=na-gconf-monitor.h"
+ignore_headers = na-gconf-monitor.h
 endif
 endif
 
@@ -70,7 +70,6 @@ endif
 SCAN_OPTIONS = \
 	--rebuild-types								\
 	--deprecated-guards=NA_DISABLE_DEPRECATED	\
-	$(ignore_headers)							\
 	$(NULL)
 
 # The directory containing the source code. Relative to $(srcdir)
@@ -91,6 +90,7 @@ endif
 # Headers to ignore
 IGNORE_HFILES = \
 	$(core_headers)								\
+	$(ignore_headers)							\
 	$(NULL)
 
 # CFLAGS and LDFLAGS for compiling scan program.
diff --git a/docs/reference/nautilus-actions-docs.xml b/docs/reference/nautilus-actions-docs.xml
index b74000a..d31bdc2 100644
--- a/docs/reference/nautilus-actions-docs.xml
+++ b/docs/reference/nautilus-actions-docs.xml
@@ -61,6 +61,7 @@
     <title>Data Factory Management System</title>
     <xi:include href="xml/ifactory-provider.xml" />
     <xi:include href="xml/ifactory-object.xml" />
+    <xi:include href="xml/boxed.xml"/>
     <xi:include href="xml/data-boxed.xml"/>
     <xi:include href="xml/data-type.xml"/>
     <xi:include href="xml/data-def.xml"/>
@@ -85,6 +86,7 @@
     <xi:include href="xml/gconf-monitor.xml"/>
     <xi:include href="xml/gconf-utils.xml"/>
     <xi:include href="xml/core-utils.xml"/>
+    <xi:include href="xml/timeout.xml"/>
   </chapter>
 
   <chapter id="object-tree">
@@ -104,6 +106,10 @@
     <title>Index of new symbols in &prodname; v 2.30</title>
     <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
   </index>
+  <index id="api-index-3-1" role="3.1.0">
+    <title>Index of new symbols in &prodname; v 3.1.0</title>
+    <xi:include href="xml/api-index-3.1.0.xml"><xi:fallback /></xi:include>
+  </index>
 
   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 </book>
diff --git a/docs/reference/nautilus-actions-overrides.txt b/docs/reference/nautilus-actions-overrides.txt
index c3af109..0307ade 100644
--- a/docs/reference/nautilus-actions-overrides.txt
+++ b/docs/reference/nautilus-actions-overrides.txt
@@ -15,3 +15,9 @@
  const NAObjectItem *existing
  void *fn_data 
 </FUNCTION>
+
+<FUNCTION>
+<NAME>NATimeoutFunc</NAME>
+<RETURNS>void</RETURNS>
+ void *user_data 
+</FUNCTION>
diff --git a/docs/reference/nautilus-actions-sections.txt b/docs/reference/nautilus-actions-sections.txt
index 88d503d..6b3f684 100644
--- a/docs/reference/nautilus-actions-sections.txt
+++ b/docs/reference/nautilus-actions-sections.txt
@@ -139,6 +139,45 @@ NAIFactoryObjectInterfacePrivate
 </SECTION>
 
 # ---------------------------------------------------------------------
+# NABoxed â?? The Data Base Class Definition
+
+<SECTION>
+<FILE>boxed</FILE>
+NA_BOXED_TYPE
+NA_BOXED
+NA_IS_BOXED
+NABoxed
+na_boxed_set_type
+na_boxed_are_equal
+na_boxed_copy
+na_boxed_dump
+na_boxed_get_boolean
+na_boxed_get_pointer
+na_boxed_get_string
+na_boxed_get_string_list
+na_boxed_get_uint
+na_boxed_get_uint_list
+na_boxed_get_as_value
+na_boxed_get_as_void
+na_boxed_new_from_string
+na_boxed_set_from_boxed
+na_boxed_set_from_string
+na_boxed_set_from_value
+na_boxed_set_from_void
+
+<SUBSECTION Standard>
+na_boxed_get_type
+NA_BOXED_CLASS
+NA_IS_BOXED_CLASS
+NA_BOXED_GET_CLASS
+NABoxedClass
+
+<SUBSECTION Private>
+NABoxedPrivate
+NABoxedClassPrivate
+</SECTION>
+
+# ---------------------------------------------------------------------
 # NADataBoxed â?? The Elementary Data Class Definition
 
 <SECTION>
@@ -180,7 +219,7 @@ NADataBoxedClassPrivate
 
 <SECTION>
 <FILE>data-type</FILE>
-NAFactoryDataType
+NADataType
 na_data_types_get_gconf_dump_key
 </SECTION>
 
@@ -268,8 +307,6 @@ NA_OBJECT
 NA_IS_OBJECT
 NAObject
 NAObjectClass
-na_object_object_check_status
-na_object_object_check_status_up
 na_object_object_reset_origin
 na_object_object_ref
 na_object_object_unref
@@ -277,6 +314,7 @@ na_object_object_copy
 na_object_object_dump
 na_object_object_dump_norec
 na_object_object_dump_tree
+na_object_object_check_status_rec
 na_object_object_get_hierarchy
 na_object_free_hierarchy
 na_object_object_debug_invalid
@@ -332,6 +370,8 @@ NA_IS_OBJECT_ITEM
 NAObjectItem
 NAItemTarget
 na_object_item_are_equal
+na_object_item_is_finally_writable
+na_object_item_set_writability_status
 na_object_item_get_item
 na_object_item_get_position
 na_object_item_append_item
@@ -340,8 +380,8 @@ 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_copyref_items
+na_object_item_free_items
 na_object_item_rebuild_children_slist
 na_object_item_deals_with_version
 
@@ -446,7 +486,8 @@ NA_IS_IDUPLICABLE
 NA_IDUPLICABLE_GET_INTERFACE
 NAIDuplicable
 NAIDuplicableInterface
-NA_IDUPLICABLE_SIGNAL_STATUS_CHANGED
+IDUPLICABLE_SIGNAL_MODIFIED_CHANGED
+IDUPLICABLE_SIGNAL_VALID_CHANGED
 na_iduplicable_dispose
 na_iduplicable_dump
 na_iduplicable_duplicate
@@ -497,12 +538,14 @@ na_icontext_get_type
 <FILE>object-api</FILE>
 na_object_duplicate
 na_object_check_status
-na_object_check_status_up
 na_object_get_origin
 na_object_is_valid
 na_object_is_modified
 na_object_set_origin
+na_object_set_modified
 na_object_reset_origin
+na_object_set_writability_status
+na_object_is_finally_writable
 na_object_copy
 na_object_dump
 na_object_dump_norec
@@ -554,8 +597,8 @@ na_object_insert_item
 na_object_remove_item
 na_object_get_items_count
 na_object_count_items
-na_object_unref_items
-na_object_unref_selected_items
+na_object_copyref_items
+na_object_free_items
 na_object_get_version
 na_object_is_target_selection
 na_object_is_target_location
@@ -714,3 +757,13 @@ na_core_utils_file_exists
 na_core_utils_file_load_from_uri
 na_core_utils_print_version
 </SECTION>
+
+# ---------------------------------------------------------------------
+# Timeout convenience structure 
+
+<SECTION>
+<FILE>timeout</FILE>
+NATimeout
+NATimeoutFunc
+na_timeout_event
+</SECTION>
diff --git a/run-autogen.sh b/run-autogen.sh
index 2e6b1b1..c7df905 100755
--- a/run-autogen.sh
+++ b/run-autogen.sh
@@ -16,9 +16,22 @@ done
 		--sysconfdir=/etc \
 		--with-nautilus-extdir=$(pwd)/install/lib/nautilus \
 		--disable-schemas-install \
+		--disable-deprecated \
+		--disable-gtk-doc \
+		--disable-html-manuals \
+		--disable-pdf-manuals \
+		$*
+
+# 'doc' mode: enable deprecated, manuals and gtk-doc
+[ "${autogen_target}" = "doc" ] &&
+	exec ./autogen.sh \
+		--prefix=$(pwd)/install \
+		--sysconfdir=/etc \
+		--with-nautilus-extdir=$(pwd)/install/lib/nautilus \
+		--disable-schemas-install \
+		--enable-deprecated \
 		--enable-gtk-doc \
 		--enable-gtk-doc-pdf \
-		--disable-scrollkeeper \
 		--enable-html-manuals \
 		--enable-pdf-manuals \
 		$*
diff --git a/src/api/na-boxed.h b/src/api/na-boxed.h
index a02352c..5e4d540 100644
--- a/src/api/na-boxed.h
+++ b/src/api/na-boxed.h
@@ -76,8 +76,8 @@ GType         na_boxed_get_type       ( void );
 void          na_boxed_set_type       ( NABoxed *boxed, guint type );
 
 gboolean      na_boxed_are_equal      ( const NABoxed *a, const NABoxed *b );
-NABoxed      *na_boxed_copy           ( const NABoxed *value );
-void          na_boxed_dump           ( const NABoxed *value );
+NABoxed      *na_boxed_copy           ( const NABoxed *boxed );
+void          na_boxed_dump           ( const NABoxed *boxed );
 NABoxed      *na_boxed_new_from_string( guint type, const gchar *string );
 
 gboolean      na_boxed_get_boolean    ( const NABoxed *boxed );
diff --git a/src/api/na-data-boxed.h b/src/api/na-data-boxed.h
index bd9bd55..a2df114 100644
--- a/src/api/na-data-boxed.h
+++ b/src/api/na-data-boxed.h
@@ -44,7 +44,7 @@
  * types that those defined in na-data-types.h.
  *
  * Additionally, #NADataBoxed class holds the #NADataDef data definition
- * suitable for a #NAFactoryObject object. It such provides default value
+ * suitable for a NAFactoryObject object. It such provides default value
  * and validity status.
  *
  * Since: 2.30
diff --git a/src/api/na-timeout.h b/src/api/na-timeout.h
index cdb0c4d..c81c207 100644
--- a/src/api/na-timeout.h
+++ b/src/api/na-timeout.h
@@ -47,6 +47,14 @@
 
 G_BEGIN_DECLS
 
+/**
+ * NATimeoutFunc:
+ * @user_data: data to be passed to the callback function.
+ *
+ * Prototype of the callback function.
+ *
+ * Since: 3.1.0
+ */
 typedef void ( *NATimeoutFunc )( void *user_data );
 
 /**
@@ -54,7 +62,6 @@ typedef void ( *NATimeoutFunc )( void *user_data );
  * @timeout:   (i) timeout configurable parameter (ms)
  * @handler:   (i) handler function
  * @user_data: (i) user data
- * @private:   private data
  *
  * This structure let the user (i.e. the code which uses it) manage functions
  * which should only be called after some time of inactivity, which is typically
@@ -62,7 +69,7 @@ typedef void ( *NATimeoutFunc )( void *user_data );
  *
  * The structure is supposed to be initialized at construction time with
  * @timeout in milliseconds, @handler and @user_data input parameters.
- * The @private pointer identifier must be set to %NULL.
+ * The private data should be set to %NULL.
  *
  * Such a structure must be allocated for each managed event.
  *
diff --git a/src/core/na-data-boxed.c b/src/core/na-data-boxed.c
index ac10577..f8a6fc0 100644
--- a/src/core/na-data-boxed.c
+++ b/src/core/na-data-boxed.c
@@ -387,8 +387,7 @@ na_data_boxed_get_param_spec( const NADataDef *def )
  * Returns: %TRUE if the two boxeds are equal, %FALSE else.
  *
  * Since: 2.30
- *
- * Deprecated: 3.1.0
+ * Deprecated: 3.1.0: Use na_boxed_are_equal() instead.
  */
 gboolean
 na_data_boxed_are_equal( const NADataBoxed *a, const NADataBoxed *b )
@@ -463,8 +462,7 @@ na_data_boxed_is_valid( const NADataBoxed *boxed )
  * Dump the content of @boxed.
  *
  * Since: 2.30
- *
- * Deprecated: 3.1.0
+ * Deprecated: 3.1.0: Use na_boxed_dump() instead.
  */
 void
 na_data_boxed_dump( const NADataBoxed *boxed )
@@ -480,8 +478,7 @@ na_data_boxed_dump( const NADataBoxed *boxed )
  * should be g_free() by the caller.
  *
  * Since: 2.30
- *
- * Deprecated: 3.1.0
+ * Deprecated: 3.1.0: Use na_boxed_get_string() instead.
  */
 gchar *
 na_data_boxed_get_as_string( const NADataBoxed *boxed )
@@ -497,8 +494,7 @@ na_data_boxed_get_as_string( const NADataBoxed *boxed )
  * Setup @value with the content of the @boxed.
  *
  * Since: 2.30
- *
- * Deprecated: 3.1.0
+ * Deprecated: 3.1.0: Use na_boxed_get_as_value() instead.
  */
 void
 na_data_boxed_get_as_value( const NADataBoxed *boxed, GValue *value )
@@ -517,8 +513,7 @@ na_data_boxed_get_as_value( const NADataBoxed *boxed, GValue *value )
  * allocated value, which should be released by the caller.
  *
  * Since: 2.30
- *
- * Deprecated: 3.1.0
+ * Deprecated: 3.1.0: Use na_boxed_get_as_void() instead.
  */
 void *
 na_data_boxed_get_as_void( const NADataBoxed *boxed )
@@ -534,8 +529,7 @@ na_data_boxed_get_as_void( const NADataBoxed *boxed )
  * Copy value from @value to @boxed.
  *
  * Since: 2.30
- *
- * Deprecated: 3.1.0
+ * Deprecated: 3.1.0: Use na_boxed_set_from_boxed() instead.
  */
 void
 na_data_boxed_set_from_boxed( NADataBoxed *boxed, const NADataBoxed *value )
@@ -551,8 +545,7 @@ na_data_boxed_set_from_boxed( NADataBoxed *boxed, const NADataBoxed *value )
  * Evaluates the @value and set it to the @boxed.
  *
  * Since: 2.30
- *
- * Deprecated: 3.1.0
+ * Deprecated: 3.1.0: Use na_boxed_set_from_string() instead.
  */
 void
 na_data_boxed_set_from_string( NADataBoxed *boxed, const gchar *value )
@@ -568,8 +561,7 @@ na_data_boxed_set_from_string( NADataBoxed *boxed, const gchar *value )
  * Evaluates the @value and set it to the @boxed.
  *
  * Since: 2.30
- *
- * Deprecated: 3.1.0
+ * Deprecated: 3.1.0: Use na_boxed_set_from_value() instead.
  */
 void
 na_data_boxed_set_from_value( NADataBoxed *boxed, const GValue *value )
@@ -585,8 +577,7 @@ na_data_boxed_set_from_value( NADataBoxed *boxed, const GValue *value )
  * Evaluates the @value and set it to the @boxed.
  *
  * Since: 2.30
- *
- * Deprecated: 3.1.0
+ * Deprecated: 3.1.0: Use na_boxed_set_from_void() instead.
  */
 void
 na_data_boxed_set_from_void( NADataBoxed *boxed, const void *value )
diff --git a/src/core/na-gconf-migration.c b/src/core/na-gconf-migration.c
index 5f932f4..33e0bd4 100644
--- a/src/core/na-gconf-migration.c
+++ b/src/core/na-gconf-migration.c
@@ -68,6 +68,6 @@ na_gconf_migration_run( void )
 		g_free( err );
 	}
 #else
-	g_debug( "%s: GConf support is disabled, no migration" );
+	g_debug( "%s: GConf support is disabled, no migration", thisfn );
 #endif /* HAVE_GCONF */
 }
diff --git a/src/core/na-gconf-monitor.c b/src/core/na-gconf-monitor.c
index 76e9efa..b389dff 100644
--- a/src/core/na-gconf-monitor.c
+++ b/src/core/na-gconf-monitor.c
@@ -203,7 +203,6 @@ instance_finalize( GObject *object )
  * triggeering the @handler in case of modifications.
  *
  * Since: 2.30
- *
  * Deprecated: 3.1.0
  */
 NAGConfMonitor *
@@ -272,7 +271,6 @@ install_monitor( NAGConfMonitor *monitor )
  * Release allocated monitors.
  *
  * Since: 2.30
- *
  * Deprecated: 3.1.0
  */
 void
diff --git a/src/core/na-gconf-utils.c b/src/core/na-gconf-utils.c
index b80b2b9..adfc248 100644
--- a/src/core/na-gconf-utils.c
+++ b/src/core/na-gconf-utils.c
@@ -519,7 +519,6 @@ na_gconf_utils_read_string_list( GConfClient *gconf, const gchar *path )
  * It should be g_free() by the caller.
  *
  * Since: 2.30
- *
  * Deprecated: 3.1.0
  */
 gboolean
@@ -558,7 +557,6 @@ na_gconf_utils_write_bool( GConfClient *gconf, const gchar *path, gboolean value
  * It should be g_free() by the caller.
  *
  * Since: 2.30
- *
  * Deprecated: 3.1.0
  */
 gboolean
@@ -597,7 +595,6 @@ na_gconf_utils_write_int( GConfClient *gconf, const gchar *path, gint value, gch
  * It should be g_free() by the caller.
  *
  * Since: 2.30
- *
  * Deprecated: 3.1.0
  */
 gboolean
@@ -636,7 +633,6 @@ na_gconf_utils_write_string( GConfClient *gconf, const gchar *path, const gchar
  * It should be g_free() by the caller.
  *
  * Since: 2.30
- *
  * Deprecated: 3.1.0
  */
 gboolean
@@ -676,7 +672,6 @@ na_gconf_utils_write_string_list( GConfClient *gconf, const gchar *path, GSList
  * Returns: %TRUE if the operation was successful, %FALSE else.
  *
  * Since: 2.30
- *
  * Deprecated: 3.1.0
  */
 gboolean
@@ -703,7 +698,6 @@ na_gconf_utils_remove_entry( GConfClient *gconf, const gchar *path, gchar **mess
 
 	return( ret );
 }
-#endif /* NA_DISABLE_DEPRECATED */
 
 /**
  * na_gconf_utils_slist_from_string:
@@ -717,7 +711,6 @@ na_gconf_utils_remove_entry( GConfClient *gconf, const gchar *path, gchar **mess
  * string was not of the GConf form.
  *
  * Since: 2.30
- *
  * Deprecated: 3.1.0
  */
 GSList *
@@ -754,7 +747,6 @@ na_gconf_utils_slist_from_string( const gchar *value )
  * allocated string which should be g_free() by the caller.
  *
  * Since: 2.30
- *
  * Deprecated: 3.1.0
  */
 gchar *
@@ -777,6 +769,7 @@ na_gconf_utils_slist_to_string( GSList *slist )
 
 	return( g_string_free( str, FALSE ));
 }
+#endif /* NA_DISABLE_DEPRECATED */
 
 static GConfValue *
 read_value( GConfClient *gconf, const gchar *path, gboolean use_schema, GConfValueType type )
diff --git a/src/core/na-iduplicable.c b/src/core/na-iduplicable.c
index 5abef10..1566372 100644
--- a/src/core/na-iduplicable.c
+++ b/src/core/na-iduplicable.c
@@ -521,7 +521,6 @@ na_iduplicable_set_origin( NAIDuplicable *object, const NAIDuplicable *origin )
  * Sets the new modified of a duplicated #NAIDuplicable.
  *
  * Since: 2.30
- *
  * Deprecated: 3.1.0
  */
 void
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]