GNOME.org
 

[tracker] Fixed various documentation warnings and missing chapters

commit 3d886efdc727edbb5edab06acd29d747aef6c663
Author: Martyn Russell <martyn lanedo com>
Date:   Thu Feb 11 14:13:57 2010 +0100

    Fixed various documentation warnings and missing chapters
    
    For:
    
      libtracker-client
      libtracker-common
      libtracker-miner
      libtracker-extract

 .../libtracker-client-sections.txt                 |    1 +
 .../libtracker-common/libtracker-common-docs.sgml  |    2 +
 .../libtracker-common-sections.txt                 |   80 ++++++++++-----
 .../libtracker-miner/libtracker-miner-sections.txt |  110 +++++++++++++++-----
 .../libtracker-miner/libtracker-miner.types        |    7 +-
 src/libtracker-common/tracker-language.c           |   10 +-
 src/libtracker-common/tracker-language.h           |    2 +-
 src/libtracker-extract/tracker-xmp.h               |    2 +-
 src/libtracker-miner/tracker-miner.c               |    1 +
 src/libtracker-miner/tracker-miner.h               |    1 -
 10 files changed, 154 insertions(+), 62 deletions(-)
---
diff --git a/docs/reference/libtracker-client/libtracker-client-sections.txt b/docs/reference/libtracker-client/libtracker-client-sections.txt
index ded5eea..f05d679 100644
--- a/docs/reference/libtracker-client/libtracker-client-sections.txt
+++ b/docs/reference/libtracker-client/libtracker-client-sections.txt
@@ -6,6 +6,7 @@ TRACKER_DBUS_INTERFACE_RESOURCES
 TRACKER_DBUS_INTERFACE_STATISTICS
 <TITLE>TrackerClient</TITLE>
 TrackerClient
+TrackerClientClass
 TrackerClientFlags
 tracker_client_new
 <SUBSECTION Standard>
diff --git a/docs/reference/libtracker-common/libtracker-common-docs.sgml b/docs/reference/libtracker-common/libtracker-common-docs.sgml
index b6d05ae..9ecf8d7 100644
--- a/docs/reference/libtracker-common/libtracker-common-docs.sgml
+++ b/docs/reference/libtracker-common/libtracker-common-docs.sgml
@@ -3,6 +3,7 @@
                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
 <!ENTITY tracker-class SYSTEM "xml/tracker-class.xml">
 <!ENTITY tracker-config-file SYSTEM "xml/tracker-config-file.xml">
+<!ENTITY tracker-crc SYSTEM "xml/tracker-crc.xml">
 <!ENTITY tracker-dbus SYSTEM "xml/tracker-dbus.xml">
 <!ENTITY tracker-file-utils SYSTEM "xml/tracker-file-utils.xml">
 <!ENTITY tracker-ioprio SYSTEM "xml/tracker-ioprio.xml">
@@ -64,6 +65,7 @@
 
     <chapter>
       <title>Utilities</title>
+      &tracker-crc;
       &tracker-type-utils;
       &tracker-file-utils;
       &tracker-utils;
diff --git a/docs/reference/libtracker-common/libtracker-common-sections.txt b/docs/reference/libtracker-common/libtracker-common-sections.txt
index eab218d..867623b 100644
--- a/docs/reference/libtracker-common/libtracker-common-sections.txt
+++ b/docs/reference/libtracker-common/libtracker-common-sections.txt
@@ -2,6 +2,7 @@
 <FILE>tracker-config-file</FILE>
 <TITLE>TrackerConfigFile</TITLE>
 TrackerConfigFile
+TrackerConfigFileClass
 tracker_config_file_save
 <SUBSECTION Standard>
 TRACKER_CONFIG_FILE
@@ -15,13 +16,16 @@ TRACKER_CONFIG_FILE_GET_CLASS
 
 <SECTION>
 <FILE>tracker-class</FILE>
-<TITLE>Tracker</TITLE>
 <TITLE>TrackerClass</TITLE>
+TrackerClass
+TrackerClassClass
 tracker_class_new
+tracker_class_get_id
 tracker_class_get_uri
 tracker_class_get_name
 tracker_class_get_count
 tracker_class_get_super_classes
+tracker_class_set_id
 tracker_class_set_uri
 tracker_class_set_count
 tracker_class_set_super_classes
@@ -40,6 +44,7 @@ TRACKER_CLASS_GET_CLASS
 <FILE>tracker-storage</FILE>
 <TITLE>TrackerStorage</TITLE>
 TrackerStorage
+TrackerStorageClass
 tracker_storage_new
 tracker_storage_get_mounted_directory_roots
 tracker_storage_get_removable_device_roots
@@ -62,6 +67,7 @@ TRACKER_STORAGE_GET_CLASS
 <FILE>tracker-power</FILE>
 <TITLE>TrackerPower</TITLE>
 TrackerPower
+TrackerPowerClass
 tracker_power_new
 tracker_power_get_on_battery
 tracker_power_get_on_low_battery
@@ -80,6 +86,7 @@ TRACKER_POWER_GET_CLASS
 <FILE>tracker-namespace</FILE>
 <TITLE>TrackerNamespace</TITLE>
 TrackerNamespace
+TrackerNamespaceClass
 tracker_namespace_new
 tracker_namespace_get_uri
 tracker_namespace_get_prefix
@@ -97,7 +104,6 @@ TRACKER_NAMESPACE_GET_CLASS
 
 <SECTION>
 <FILE>tracker-sparql-builder</FILE>
-TrackerSparqlBuilderPrivate
 TRACKER_TYPE_TURTLE_WRITER
 TRACKER_TURTLE_WRITER
 TRACKER_TURTLE_WRITER_CLASS
@@ -107,13 +113,29 @@ TRACKER_TURTLE_WRITER_GET_CLASS
 TrackerTurtleWriterPrivate
 <TITLE>TrackerSparqlBuilder</TITLE>
 TrackerSparqlBuilder
+TrackerSparqlBuilderClass
+TrackerSparqlBuilderPrivate
 <TITLE>TrackerTurtleWriter</TITLE>
 TrackerTurtleWriter
+TrackerTurtleWriterClass
+tracker_sparql_builder_new
+tracker_sparql_builder_new_embedded_insert
 tracker_sparql_builder_new_update
+tracker_sparql_builder_construct
+tracker_sparql_builder_construct_embedded_insert
 tracker_sparql_builder_construct_update
-tracker_sparql_builder_drop_graph
+tracker_sparql_builder_get_result
+tracker_sparql_builder_get_length
+tracker_sparql_builder_append
+tracker_sparql_builder_prepend
 tracker_sparql_builder_insert_open
 tracker_sparql_builder_insert_close
+tracker_sparql_builder_where_open
+tracker_sparql_builder_where_close
+tracker_sparql_builder_delete_open
+tracker_sparql_builder_delete_close
+tracker_sparql_builder_drop_graph
+tracker_sparql_builder_subject_variable
 tracker_sparql_builder_subject_iri
 tracker_sparql_builder_subject
 tracker_sparql_builder_predicate_iri
@@ -124,13 +146,10 @@ tracker_sparql_builder_object_string
 tracker_sparql_builder_object_boolean
 tracker_sparql_builder_object_int64
 tracker_sparql_builder_object_date
+tracker_sparql_builder_object_double
+tracker_sparql_builder_object_variable
 tracker_sparql_builder_object_blank_open
 tracker_sparql_builder_object_blank_close
-tracker_sparql_builder_append
-tracker_sparql_builder_new
-tracker_sparql_builder_construct
-tracker_sparql_builder_get_result
-tracker_sparql_builder_get_length
 tracker_turtle_writer_get_type
 tracker_turtle_writer_new
 tracker_turtle_writer_construct
@@ -161,6 +180,7 @@ TRACKER_SPARQL_BUILDER_GET_CLASS
 <FILE>tracker-language</FILE>
 <TITLE>TrackerLanguage</TITLE>
 TrackerLanguage
+TrackerLanguageClass
 tracker_language_new
 tracker_language_get_enable_stemmer
 tracker_language_get_stop_words
@@ -190,8 +210,11 @@ TrackerPropertyType
 tracker_property_type_to_string
 <TITLE>TrackerProperty</TITLE>
 TrackerProperty
+TrackerPropertyClass
 tracker_property_get_type
 tracker_property_new
+tracker_property_get_id
+tracker_property_get_is_inverse_functional_property
 tracker_property_get_uri
 tracker_property_get_name
 tracker_property_get_data_type
@@ -205,6 +228,8 @@ tracker_property_get_multiple_values
 tracker_property_get_filtered
 tracker_property_get_transient
 tracker_property_get_super_properties
+tracker_property_set_id
+tracker_property_set_is_inverse_functional_property
 tracker_property_set_uri
 tracker_property_set_data_type
 tracker_property_set_domain
@@ -246,8 +271,12 @@ tracker_file_get_size
 tracker_file_get_mtime
 tracker_file_get_mime_type
 tracker_file_system_has_enough_space
+tracker_file_is_locked
+tracker_file_lock
+tracker_file_unlock
 tracker_path_remove
 tracker_path_is_in_path
+tracker_path_has_write_access_or_was_created
 tracker_path_hash_table_filter_duplicates
 tracker_path_list_filter_duplicates
 tracker_path_evaluate_name
@@ -270,19 +299,22 @@ TRACKER_NAO_PREFIX
 TRACKER_NID3_PREFIX
 TRACKER_NFO_PREFIX
 TRACKER_NMM_PREFIX
+TRACKER_MLO_PREFIX
 TRACKER_DATASOURCE_URN_PREFIX
 TRACKER_NON_REMOVABLE_MEDIA_DATASOURCE_URN
 tracker_ontology_init
 tracker_ontology_shutdown
+tracker_ontology_add_namespace
 tracker_ontology_add_class
-tracker_ontology_get_class_by_uri
+tracker_ontology_add_property
+tracker_ontology_add_id_uri_pair
 tracker_ontology_get_namespaces
+tracker_ontology_get_namespace_by_uri
 tracker_ontology_get_classes
+tracker_ontology_get_class_by_uri
 tracker_ontology_get_properties
-tracker_ontology_add_property
 tracker_ontology_get_property_by_uri
-tracker_ontology_add_namespace
-tracker_ontology_get_namespace_by_uri
+tracker_ontology_get_uri_by_id
 </SECTION>
 
 <SECTION>
@@ -290,6 +322,7 @@ tracker_ontology_get_namespace_by_uri
 TRACKER_DBUS_ERROR_DOMAIN
 TRACKER_DBUS_ERROR
 TRACKER_TYPE_G_STRV_ARRAY
+TRACKER_TYPE_STR_STRV_MAP
 TRACKER_TYPE_EVENT_ARRAY
 tracker_dbus_async_return_if_fail
 tracker_dbus_return_val_if_fail
@@ -307,12 +340,14 @@ tracker_dbus_queue_str_to_strv
 tracker_dbus_queue_gfile_to_strv
 tracker_dbus_results_ptr_array_free
 tracker_dbus_get_next_request_id
+tracker_dbus_enable_client_lookup
 tracker_dbus_request_add_hook
 tracker_dbus_request_remove_hook
 tracker_dbus_request_new
 tracker_dbus_request_success
 tracker_dbus_request_failed
 tracker_dbus_request_comment
+tracker_dbus_request_info
 tracker_dbus_request_debug
 tracker_dbus_request_block_hooks
 tracker_dbus_request_unblock_hooks
@@ -343,6 +378,8 @@ tracker_memory_setrlimits
 <FILE>tracker-log</FILE>
 tracker_log_init
 tracker_log_shutdown
+tracker_log_should_handle
+tracker_info
 </SECTION>
 
 <SECTION>
@@ -365,6 +402,7 @@ tracker_string_list_to_string
 tracker_string_to_string_list
 tracker_gslist_to_string_list
 tracker_gslist_copy_with_string_data
+tracker_gslist_with_string_data_equal
 tracker_glist_copy_with_string_data
 tracker_string_boolean_to_string_gint
 </SECTION>
@@ -401,17 +439,11 @@ tracker_uri_vprintf_escaped
 tracker_uri_printf_escaped
 tracker_coalesce
 tracker_merge
-tracker_dngettext
+tracker_text_normalize
 </SECTION>
 
-
-TrackerClass
-TrackerClassClass
-TrackerConfigFileClass
-TrackerLanguageClass
-TrackerNamespaceClass
-TrackerPowerClass
-TrackerPropertyClass
-TrackerSparqlBuilderClass
-TrackerStorageClass
-TrackerTurtleWriterClass
+<SECTION>
+<FILE>tracker-crc</FILE>
+<TITLE>CRC</TITLE>
+tracker_crc32
+</SECTION>
diff --git a/docs/reference/libtracker-miner/libtracker-miner-sections.txt b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
index 424b4bc..c764f10 100644
--- a/docs/reference/libtracker-miner/libtracker-miner-sections.txt
+++ b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
@@ -1,48 +1,110 @@
-<INCLUDE>libtracker-miner/tracker-miner.h</INCLUDE>
+<SECTION>
+<FILE>tracker-miner-manager</FILE>
+TrackerMinerManager
+TrackerMinerManagerClass
+miner_progress
+miner_paused
+miner_resumed
+miner_activated
+miner_deactivated
+tracker_miner_manager_new
+tracker_miner_manager_get_running
+tracker_miner_manager_get_available
+tracker_miner_manager_pause
+tracker_miner_manager_resume
+tracker_miner_manager_is_active
+tracker_miner_manager_is_paused
+tracker_miner_manager_get_status
+tracker_miner_manager_ignore_next_update
+tracker_miner_manager_get_display_name
+tracker_miner_manager_get_description
+<SUBSECTION Standard>
+TRACKER_MINER_MANAGER
+TRACKER_IS_MINER_MANAGER
+TRACKER_TYPE_MINER_MANAGER
+tracker_miner_manager_get_type
+TRACKER_MINER_MANAGER_CLASS
+TRACKER_IS_MINER_MANAGER_CLASS
+TRACKER_MINER_MANAGER_GET_CLASS
+</SECTION>
+
 <SECTION>
 <FILE>tracker-miner</FILE>
-<TITLE>Tracker Miner</TITLE>
+TRACKER_MINER_ERROR_DOMAIN
+TRACKER_MINER_ERROR
+TrackerMinerPrivate
+<TITLE>TrackerMiner</TITLE>
 TrackerMiner
 TrackerMinerClass
 tracker_miner_error_quark
 tracker_miner_start
 tracker_miner_stop
+tracker_miner_ignore_next_update
 tracker_miner_is_started
+tracker_miner_pause
+tracker_miner_resume
 tracker_miner_execute_update
+tracker_miner_execute_update_finish
 tracker_miner_execute_sparql
+tracker_miner_execute_sparql_finish
 tracker_miner_execute_batch_update
+tracker_miner_execute_batch_update_finish
 tracker_miner_commit
-tracker_miner_pause
-tracker_miner_resume
+tracker_miner_commit_finish
+<SUBSECTION Standard>
+TRACKER_MINER
+TRACKER_IS_MINER
+TRACKER_TYPE_MINER
+tracker_miner_get_type
+TRACKER_MINER_CLASS
+TRACKER_IS_MINER_CLASS
+TRACKER_MINER_GET_CLASS
 </SECTION>
 
-<INCLUDE>libtracker-miner/tracker-miner-fs.h</INCLUDE>
 <SECTION>
 <FILE>tracker-miner-fs</FILE>
-<TITLE>Tracker Filesystem Miner</TITLE>
+TrackerMinerFSPrivate
+<TITLE>TrackerMinerFS</TITLE>
 TrackerMinerFS
 TrackerMinerFSClass
-tracker_miner_fs_add_directory
-tracker_miner_fs_remove_directory
+tracker_miner_fs_directory_add
+tracker_miner_fs_directory_remove
+tracker_miner_fs_file_add
+tracker_miner_fs_file_notify
 tracker_miner_fs_set_throttle
 tracker_miner_fs_get_throttle
-tracker_miner_fs_notify_file
+<SUBSECTION Standard>
+TRACKER_MINER_FS
+TRACKER_IS_MINER_FS
+TRACKER_TYPE_MINER_FS
+tracker_miner_fs_get_type
+TRACKER_MINER_FS_CLASS
+TRACKER_IS_MINER_FS_CLASS
+TRACKER_MINER_FS_GET_CLASS
 </SECTION>
 
-<INCLUDE>libtracker-miner/tracker-miner-manager.h</INCLUDE>
 <SECTION>
-<FILE>tracker-miner-manager</FILE>
-<TITLE>Tracker Miner Manager</TITLE>
-TrackerMinerManager
-TrackerMinerManagerClass
-tracker_miner_manager_new
-tracker_miner_manager_get_running
-tracker_miner_manager_get_available
-tracker_miner_manager_pause
-tracker_miner_manager_resume
-tracker_miner_manager_is_active
-tracker_miner_manager_is_paused
-tracker_miner_manager_get_status
-tracker_miner_manager_get_display_name
-tracker_miner_manager_get_description
+<FILE>tracker-miner-dbus</FILE>
+TRACKER_MINER_DBUS_INTERFACE
+TRACKER_MINER_DBUS_NAME_PREFIX
+TRACKER_MINER_DBUS_PATH_PREFIX
+tracker_miner_dbus_get_name
+tracker_miner_dbus_get_description
+tracker_miner_dbus_get_status
+tracker_miner_dbus_get_progress
+tracker_miner_dbus_get_pause_details
+tracker_miner_dbus_pause
+tracker_miner_dbus_resume
+tracker_miner_dbus_ignore_next_update
 </SECTION>
+
+<SECTION>
+<FILE>tracker-thumbnailer</FILE>
+tracker_thumbnailer_init
+tracker_thumbnailer_shutdown
+tracker_thumbnailer_send
+tracker_thumbnailer_move_add
+tracker_thumbnailer_remove_add
+tracker_thumbnailer_cleanup
+</SECTION>
+
diff --git a/docs/reference/libtracker-miner/libtracker-miner.types b/docs/reference/libtracker-miner/libtracker-miner.types
index 1fc1e92..64a138a 100644
--- a/docs/reference/libtracker-miner/libtracker-miner.types
+++ b/docs/reference/libtracker-miner/libtracker-miner.types
@@ -1,8 +1,3 @@
-#include <libtracker-miner/tracker-miner.h>
-#include <libtracker-miner/tracker-miner-fs.h>
-#include <libtracker-miner/tracker-miner-manager.h>
-
+tracker_miner_manager_get_type
 tracker_miner_get_type
 tracker_miner_fs_get_type
-tracker_miner_manager_get_type
-
diff --git a/src/libtracker-common/tracker-language.c b/src/libtracker-common/tracker-language.c
index aef5893..da20a9b 100644
--- a/src/libtracker-common/tracker-language.c
+++ b/src/libtracker-common/tracker-language.c
@@ -424,14 +424,14 @@ tracker_language_set_enable_stemmer (TrackerLanguage *language,
 /**
  * tracker_language_set_language_code:
  * @language: a #TrackerLanguage
- * @value: an ISO 639-1 language code
+ * @language_code: an ISO 639-1 language code
  *
- * Sets the @language to @value, a %NULL value will reset this to
- * "en" (English).
+ * Sets the @language to @language_code, a %NULL value will reset this
+ * to "en" (English).
  **/
 void
 tracker_language_set_language_code (TrackerLanguage *language,
-                                    const gchar     *value)
+                                    const gchar     *language_code)
 {
 	TrackerLanguagePriv *priv;
 
@@ -441,7 +441,7 @@ tracker_language_set_language_code (TrackerLanguage *language,
 
 	g_free (priv->language_code);
 
-	priv->language_code = g_strdup (value);
+	priv->language_code = g_strdup (language_code);
 
 	if (!priv->language_code) {
 		priv->language_code = g_strdup ("en");
diff --git a/src/libtracker-common/tracker-language.h b/src/libtracker-common/tracker-language.h
index 07c5232..0918042 100644
--- a/src/libtracker-common/tracker-language.h
+++ b/src/libtracker-common/tracker-language.h
@@ -68,7 +68,7 @@ gboolean         tracker_language_check_exists       (const gchar     *language_
 gchar *          tracker_language_get_default_code   (void);
 GSList *         tracker_language_get_all_by_code    (void);
 const gchar *    tracker_language_get_name_by_code   (const gchar     *language_code);
-const gchar *    tracker_language_get_code_by_name   (const gchar     *langauge_name);
+const gchar *    tracker_language_get_code_by_name   (const gchar     *language_name);
 
 G_END_DECLS
 
diff --git a/src/libtracker-extract/tracker-xmp.h b/src/libtracker-extract/tracker-xmp.h
index 1d42029..116c56b 100644
--- a/src/libtracker-extract/tracker-xmp.h
+++ b/src/libtracker-extract/tracker-xmp.h
@@ -88,7 +88,7 @@ gboolean tracker_xmp_read  (const gchar          *buffer,
                             TrackerXmpData       *data);
 gboolean tracker_xmp_apply (TrackerSparqlBuilder *metadata,
                             const gchar          *uri,
-                            TrackerXmpData       *xmp_data);
+                            TrackerXmpData       *data);
 
 G_END_DECLS
 
diff --git a/src/libtracker-miner/tracker-miner.c b/src/libtracker-miner/tracker-miner.c
index 85203dd..9c312ad 100644
--- a/src/libtracker-miner/tracker-miner.c
+++ b/src/libtracker-miner/tracker-miner.c
@@ -1101,6 +1101,7 @@ tracker_miner_execute_sparql (TrackerMiner        *miner,
  * Finishes the async operation and returns the query results. If an error
  * occured during the query, @error will be set.
  *
+* Returns: a #GPtrArray with the sparql results which should not be freed.
  **/
 const GPtrArray *
 tracker_miner_execute_sparql_finish (TrackerMiner  *miner,
diff --git a/src/libtracker-miner/tracker-miner.h b/src/libtracker-miner/tracker-miner.h
index 74af0dd..b32d2ab 100644
--- a/src/libtracker-miner/tracker-miner.h
+++ b/src/libtracker-miner/tracker-miner.h
@@ -56,7 +56,6 @@ struct TrackerMiner {
  * @stopped: Called when the miner is told to stop collecting data.
  * @paused: Called when the miner is told to pause.
  * @resumed: Called when the miner is told to resume activity.
- * @terminated: terminated.
  * @progress: progress.
  * @error: error.
  * @ignore_next_update: Called after ignore on next update event happens.
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]