GNOME.org
 

[tracker] libtracker-miner: Fix the documentation in preparation for 0.13.x release

commit 748833e85503256f59f152fae094e270eefbf19b
Author: Martyn Russell <martyn lanedo com>
Date:   Thu Dec 15 12:18:03 2011 +0000

    libtracker-miner: Fix the documentation in preparation for 0.13.x release

 docs/reference/libtracker-miner/Makefile.am        |    5 +
 .../libtracker-miner/libtracker-miner-docs.sgml    |   12 +-
 .../libtracker-miner/libtracker-miner-sections.txt |  322 +++++++++++---------
 src/libtracker-miner/tracker-miner-fs.c            |    2 +
 src/libtracker-miner/tracker-miner-fs.h            |   14 +-
 src/libtracker-miner/tracker-miner-manager.c       |    3 +-
 src/libtracker-miner/tracker-password-provider.c   |    2 +-
 7 files changed, 201 insertions(+), 159 deletions(-)
---
diff --git a/docs/reference/libtracker-miner/Makefile.am b/docs/reference/libtracker-miner/Makefile.am
index cf1744b..9a6c5be 100644
--- a/docs/reference/libtracker-miner/Makefile.am
+++ b/docs/reference/libtracker-miner/Makefile.am
@@ -25,6 +25,8 @@ CFILE_GLOB=$(top_srcdir)/src/libtracker-miner/*.c
 IGNORE_HFILES=                                         \
 	tracker-crawler.h                              \
 	tracker-dbus.h                                 \
+	tracker-file-notifier.h                        \
+	tracker-file-system.h                          \
 	tracker-marshal.h                              \
 	tracker-miner-client.h                         \
 	tracker-miner-dbus.h                           \
@@ -35,6 +37,9 @@ IGNORE_HFILES=                                         \
 	tracker-miner-web-glue.h                       \
 	tracker-miner-web-glue.h                       \
 	tracker-monitor.h                              \
+	tracker-priority-queue.h                       \
+	tracker-sparql-buffer.h                        \
+	tracker-task-pool.h                            \
 	tracker-utils.h
 
 # CFLAGS and LDFLAGS for compiling scan program. Only needed
diff --git a/docs/reference/libtracker-miner/libtracker-miner-docs.sgml b/docs/reference/libtracker-miner/libtracker-miner-docs.sgml
index a93ba61..fb9730d 100644
--- a/docs/reference/libtracker-miner/libtracker-miner-docs.sgml
+++ b/docs/reference/libtracker-miner/libtracker-miner-docs.sgml
@@ -29,14 +29,15 @@
     </partintro>
 
     <chapter>
-      <title>Base abstract miners</title>
-      <xi:include href="xml/tracker-miner.xml"/>
+      <title>Base abstract miner classes</title>
+      <xi:include href="xml/tracker-miner-object.xml"/>
       <xi:include href="xml/tracker-miner-web.xml"/>
     </chapter>
 
     <chapter>
-      <title>Additional miners</title>
+      <title>Miner classes for file system</title>
       <xi:include href="xml/tracker-miner-fs.xml"/>
+      <xi:include href="xml/tracker-indexing-tree.xml"/>
     </chapter>
 
     <chapter>
@@ -45,14 +46,15 @@
     </chapter>
 
     <chapter>
-      <title>Base abstract utilities</title>
+      <title>Base abstract providers for network/password/etc control</title>
       <xi:include href="xml/tracker-network-provider.xml"/>
       <xi:include href="xml/tracker-password-provider.xml"/>
     </chapter>
 
     <chapter>
-      <title>Additional utilities</title>
+      <title>Utilities</title>
       <xi:include href="xml/tracker-storage.xml"/>
+      <xi:include href="xml/tracker-media-art.xml"/>
       <xi:include href="xml/tracker-thumbnailer.xml"/>
     </chapter>
   </part>
diff --git a/docs/reference/libtracker-miner/libtracker-miner-sections.txt b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
index 619b949..8187902 100644
--- a/docs/reference/libtracker-miner/libtracker-miner-sections.txt
+++ b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
@@ -1,155 +1,199 @@
 <SECTION>
-<FILE>tracker-miner-manager</FILE>
-<TITLE>TrackerMinerManager</TITLE>
-TRACKER_MINER_MANAGER_ERROR
-TrackerMinerManagerError
-tracker_miner_manager_error_quark
-TrackerMinerManager
-TrackerMinerManagerClass
-tracker_miner_manager_new
-tracker_miner_manager_new_full
-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
-tracker_miner_manager_index_file
-tracker_miner_manager_ignore_next_update
-tracker_miner_manager_reindex_by_mimetype
+<FILE>tracker-indexing-tree</FILE>
+<TITLE>TrackerIndexingTree</TITLE>
+TrackerIndexingTree
+TrackerIndexingTreeClass
+tracker_indexing_tree_add
+tracker_indexing_tree_add_filter
+tracker_indexing_tree_clear_filters
+tracker_indexing_tree_file_is_indexable
+tracker_indexing_tree_file_is_root
+tracker_indexing_tree_file_matches_filter
+tracker_indexing_tree_get_default_policy
+tracker_indexing_tree_get_filter_hidden
+tracker_indexing_tree_get_root
+tracker_indexing_tree_list_roots
+tracker_indexing_tree_new
+tracker_indexing_tree_parent_is_indexable
+tracker_indexing_tree_remove
+tracker_indexing_tree_set_default_policy
+tracker_indexing_tree_set_filter_hidden
 <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
+TRACKER_INDEXING_TREE
+TRACKER_INDEXING_TREE_CLASS
+TRACKER_INDEXING_TREE_GET_CLASS
+TRACKER_IS_INDEXING_TREE
+TRACKER_IS_INDEXING_TREE_CLASS
+TRACKER_TYPE_INDEXING_TREE
+tracker_indexing_tree_get_type
+</SECTION>
+
+<SECTION>
+<FILE>tracker-media-art</FILE>
+tracker_media_art_execute_queue
+tracker_media_art_queue_removal
 </SECTION>
 
 <SECTION>
 <FILE>tracker-miner</FILE>
-TrackerMinerPrivate
-<TITLE>TrackerMiner</TITLE>
-TRACKER_MINER_ERROR_DOMAIN
-TRACKER_MINER_ERROR
-tracker_miner_error_quark
-TrackerMiner
-TrackerMinerClass
-tracker_miner_start
-tracker_miner_stop
-tracker_miner_ignore_next_update
-tracker_miner_is_started
-tracker_miner_is_paused
-tracker_miner_get_n_pause_reasons
-tracker_miner_pause
-tracker_miner_resume
-tracker_miner_get_connection
-tracker_miner_get_dbus_connection
-tracker_miner_get_dbus_full_name
-tracker_miner_get_dbus_full_path
+
+</SECTION>
+
+<SECTION>
+<FILE>tracker-miner-common</FILE>
+TRACKER_MINER_FS_GRAPH_URN
+</SECTION>
+
+<SECTION>
+<FILE>tracker-miner-enum-types</FILE>
 <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
+TRACKER_TYPE_DIRECTORY_FLAGS
+TRACKER_TYPE_FILTER_POLICY
+TRACKER_TYPE_FILTER_TYPE
+tracker_directory_flags_get_type
+tracker_filter_policy_get_type
+tracker_filter_type_get_type
+</SECTION>
+
+<SECTION>
+<FILE>tracker-miner-enums</FILE>
+TrackerDirectoryFlags
+TrackerFilterPolicy
+TrackerFilterType
 </SECTION>
 
 <SECTION>
 <FILE>tracker-miner-fs</FILE>
-TrackerMinerFSPrivate
 <TITLE>TrackerMinerFS</TITLE>
 TrackerMinerFS
 TrackerMinerFSClass
+tracker_miner_fs_add_directory_without_parent
 tracker_miner_fs_check_directory
+tracker_miner_fs_check_directory_with_priority
 tracker_miner_fs_check_file
+tracker_miner_fs_check_file_with_priority
 tracker_miner_fs_directory_add
 tracker_miner_fs_directory_remove
 tracker_miner_fs_directory_remove_full
 tracker_miner_fs_file_notify
-tracker_miner_fs_set_throttle
-tracker_miner_fs_get_throttle
+tracker_miner_fs_force_mtime_checking
 tracker_miner_fs_force_recheck
+tracker_miner_fs_get_indexing_tree
+tracker_miner_fs_get_initial_crawling
+tracker_miner_fs_get_mtime_checking
 tracker_miner_fs_get_parent_urn
+tracker_miner_fs_get_throttle
 tracker_miner_fs_get_urn
+tracker_miner_fs_has_items_to_process
 tracker_miner_fs_query_urn
-tracker_miner_fs_add_directory_without_parent
-tracker_miner_fs_get_initial_crawling
 tracker_miner_fs_set_initial_crawling
-tracker_miner_fs_get_mtime_checking
 tracker_miner_fs_set_mtime_checking
-tracker_miner_fs_force_mtime_checking
-tracker_miner_fs_has_items_to_process
+tracker_miner_fs_set_throttle
+tracker_miner_fs_writeback_file
+tracker_miner_fs_writeback_notify
 <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
+TRACKER_MINER_FS_CLASS
 TRACKER_MINER_FS_GET_CLASS
-TRACKER_MINER_FS_GRAPH_URN
+TRACKER_TYPE_MINER_FS
+TrackerMinerFSPrivate
+tracker_miner_fs_get_type
+</SECTION>
+
+<SECTION>
+<FILE>tracker-miner-manager</FILE>
+<TITLE>TrackerMinerManager</TITLE>
+TRACKER_MINER_MANAGER_ERROR
+TrackerMinerManager
+TrackerMinerManagerClass
+TrackerMinerManagerError
+tracker_miner_manager_error_quark
+tracker_miner_manager_get_available
+tracker_miner_manager_get_description
+tracker_miner_manager_get_display_name
+tracker_miner_manager_get_running
+tracker_miner_manager_get_status
+tracker_miner_manager_ignore_next_update
+tracker_miner_manager_index_file
+tracker_miner_manager_is_active
+tracker_miner_manager_is_paused
+tracker_miner_manager_new
+tracker_miner_manager_new_full
+tracker_miner_manager_pause
+tracker_miner_manager_pause_for_process
+tracker_miner_manager_reindex_by_mimetype
+tracker_miner_manager_resume
+<SUBSECTION Standard>
+TRACKER_IS_MINER_MANAGER
+TRACKER_IS_MINER_MANAGER_CLASS
+TRACKER_MINER_MANAGER
+TRACKER_MINER_MANAGER_CLASS
+TRACKER_MINER_MANAGER_GET_CLASS
+TRACKER_TYPE_MINER_MANAGER
+tracker_miner_manager_get_type
+</SECTION>
+
+<SECTION>
+<FILE>tracker-miner-object</FILE>
+<TITLE>TrackerMiner</TITLE>
+TRACKER_MINER_ERROR
+TRACKER_MINER_ERROR_DOMAIN
+TrackerMiner
+TrackerMinerClass
+tracker_miner_error_quark
+tracker_miner_get_connection
+tracker_miner_get_dbus_connection
+tracker_miner_get_dbus_full_name
+tracker_miner_get_dbus_full_path
+tracker_miner_get_n_pause_reasons
+tracker_miner_ignore_next_update
+tracker_miner_is_paused
+tracker_miner_is_started
+tracker_miner_pause
+tracker_miner_resume
+tracker_miner_start
+tracker_miner_stop
+<SUBSECTION Standard>
+TRACKER_IS_MINER
+TRACKER_IS_MINER_CLASS
+TRACKER_MINER
+TRACKER_MINER_CLASS
+TRACKER_MINER_GET_CLASS
+TRACKER_TYPE_MINER
+TrackerMinerPrivate
+tracker_miner_get_type
 </SECTION>
 
 <SECTION>
 <FILE>tracker-miner-web</FILE>
-TrackerMinerWebPrivate
 <TITLE>TrackerMinerWeb</TITLE>
-TRACKER_MINER_WEB_ERROR_DOMAIN
-TRACKER_MINER_WEB_ERROR
-TrackerMinerWebError
-tracker_miner_web_error_quark
 TRACKER_MINER_WEB_DBUS_INTERFACE
+TRACKER_MINER_WEB_ERROR
+TRACKER_MINER_WEB_ERROR_DOMAIN
 TrackerMinerWeb
 TrackerMinerWebClass
+TrackerMinerWebError
 tracker_miner_web_associate
 tracker_miner_web_authenticate
 tracker_miner_web_dissociate
+tracker_miner_web_error_quark
 tracker_miner_web_get_association_data
 <SUBSECTION Standard>
-TRACKER_MINER_WEB
 TRACKER_IS_MINER_WEB
-TRACKER_TYPE_MINER_WEB
-tracker_miner_web_get_type
-TRACKER_MINER_WEB_CLASS
 TRACKER_IS_MINER_WEB_CLASS
+TRACKER_MINER_WEB
+TRACKER_MINER_WEB_CLASS
 TRACKER_MINER_WEB_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>tracker-password-provider</FILE>
-<TITLE>TrackerPasswordProvider</TITLE>
-TRACKER_PASSWORD_PROVIDER_ERROR_DOMAIN
-TRACKER_PASSWORD_PROVIDER_ERROR
-TrackerPasswordProviderError
-tracker_password_provider_error_quark
-TRACKER_PASSWORD_PROVIDER_GET_INTERFACE
-TrackerPasswordProvider
-TrackerPasswordProviderIface
-tracker_password_provider_get
-tracker_password_provider_get_name
-tracker_password_provider_store_password
-tracker_password_provider_get_password
-tracker_password_provider_forget_password
-tracker_password_provider_lock_password
-tracker_password_provider_unlock_password
-<SUBSECTION Standard>
-TRACKER_PASSWORD_PROVIDER
-TRACKER_IS_PASSWORD_PROVIDER
-TRACKER_TYPE_PASSWORD_PROVIDER
-tracker_password_provider_get_type
+TRACKER_TYPE_MINER_WEB
+TrackerMinerWebPrivate
+tracker_miner_web_get_type
 </SECTION>
 
 <SECTION>
 <FILE>tracker-network-provider</FILE>
 <TITLE>TrackerNetworkProvider</TITLE>
-TRACKER_NETWORK_PROVIDER_GET_INTERFACE
 TrackerNetworkProvider
 TrackerNetworkProviderIface
 TrackerNetworkProviderStatus
@@ -157,21 +201,35 @@ tracker_network_provider_get
 tracker_network_provider_get_name
 tracker_network_provider_get_status
 <SUBSECTION Standard>
-TRACKER_NETWORK_PROVIDER
 TRACKER_IS_NETWORK_PROVIDER
+TRACKER_NETWORK_PROVIDER
+TRACKER_NETWORK_PROVIDER_GET_INTERFACE
 TRACKER_TYPE_NETWORK_PROVIDER
 tracker_network_provider_get_type
 </SECTION>
 
 <SECTION>
-<FILE>tracker-thumbnailer</FILE>
-<TITLE>TrackerThumbnailer</TITLE>
-tracker_thumbnailer_init
-tracker_thumbnailer_shutdown
-tracker_thumbnailer_send
-tracker_thumbnailer_move_add
-tracker_thumbnailer_remove_add
-tracker_thumbnailer_cleanup
+<FILE>tracker-password-provider</FILE>
+<TITLE>TrackerPasswordProvider</TITLE>
+TRACKER_PASSWORD_PROVIDER_ERROR
+TRACKER_PASSWORD_PROVIDER_ERROR_DOMAIN
+TrackerPasswordProvider
+TrackerPasswordProviderError
+TrackerPasswordProviderIface
+tracker_password_provider_error_quark
+tracker_password_provider_forget_password
+tracker_password_provider_get
+tracker_password_provider_get_name
+tracker_password_provider_get_password
+tracker_password_provider_lock_password
+tracker_password_provider_store_password
+tracker_password_provider_unlock_password
+<SUBSECTION Standard>
+TRACKER_IS_PASSWORD_PROVIDER
+TRACKER_PASSWORD_PROVIDER
+TRACKER_PASSWORD_PROVIDER_GET_INTERFACE
+TRACKER_TYPE_PASSWORD_PROVIDER
+tracker_password_provider_get_type
 </SECTION>
 
 <SECTION>
@@ -180,46 +238,30 @@ tracker_thumbnailer_cleanup
 TrackerStorage
 TrackerStorageClass
 TrackerStorageType
-TRACKER_STORAGE_TYPE_IS_REMOVABLE
-TRACKER_STORAGE_TYPE_IS_OPTICAL
-tracker_storage_new
 tracker_storage_get_device_roots
 tracker_storage_get_device_uuids
 tracker_storage_get_mount_point_for_uuid
 tracker_storage_get_type_for_uuid
 tracker_storage_get_uuid_for_file
+tracker_storage_new
 <SUBSECTION Standard>
-TRACKER_STORAGE
 TRACKER_IS_STORAGE
-TRACKER_TYPE_STORAGE
-tracker_storage_get_type
-TRACKER_STORAGE_CLASS
 TRACKER_IS_STORAGE_CLASS
+TRACKER_STORAGE
+TRACKER_STORAGE_CLASS
 TRACKER_STORAGE_GET_CLASS
+TRACKER_STORAGE_TYPE_IS_OPTICAL
+TRACKER_STORAGE_TYPE_IS_REMOVABLE
+TRACKER_TYPE_STORAGE
+tracker_storage_get_type
 </SECTION>
 
 <SECTION>
-<FILE>tracker-indexing-tree</FILE>
-<TITLE>TrackerIndexingTree</TITLE>
-TrackerIndexingTree
-TrackerIndexingTreeClass
-TrackerDirectoryFlags
-TrackerFilterType
-tracker_indexing_tree_new
-tracker_indexing_tree_add
-tracker_indexing_tree_remove
-tracker_indexing_tree_add_filter
-tracker_indexing_tree_clear_filters
-tracker_indexing_tree_file_matches_filter
-tracker_indexing_tree_file_is_indexable
-tracker_indexing_tree_parent_is_indexable
-tracker_indexing_tree_get_root
-<SUBSECTION Standard>
-TRACKER_INDEXING_TREE
-TRACKER_IS_INDEXING_TREE
-TRACKER_TYPE_INDEXING_TREE
-tracker_indexing_tree_get_type
-TRACKER_INDEXING_TREE_CLASS
-TRACKER_IS_INDEXING_TREE_CLASS
-TRACKER_INDEXING_TREE_GET_CLASS
+<FILE>tracker-thumbnailer</FILE>
+tracker_thumbnailer_cleanup
+tracker_thumbnailer_init
+tracker_thumbnailer_move_add
+tracker_thumbnailer_remove_add
+tracker_thumbnailer_send
+tracker_thumbnailer_shutdown
 </SECTION>
diff --git a/src/libtracker-miner/tracker-miner-fs.c b/src/libtracker-miner/tracker-miner-fs.c
index a379770..e081ad8 100644
--- a/src/libtracker-miner/tracker-miner-fs.c
+++ b/src/libtracker-miner/tracker-miner-fs.c
@@ -451,6 +451,7 @@ tracker_miner_fs_class_init (TrackerMinerFSClass *klass)
 	 *          %FALSE on failure
 	 *
 	 * Since: 0.8
+	 *
 	 * Deprecated since: 0.12
 	 **/
 	signals[IGNORE_NEXT_UPDATE_FILE] =
@@ -3536,6 +3537,7 @@ tracker_miner_fs_get_mtime_checking (TrackerMinerFS *fs)
 /**
  * tracker_miner_fs_force_mtime_checking:
  * @fs: a #TrackerMinerFS
+ * @directory: a #GFile representing the directory
  *
  * Tells @fs to force mtime checking (regardless of the global mtime check
  * configuration) on the given @directory.
diff --git a/src/libtracker-miner/tracker-miner-fs.h b/src/libtracker-miner/tracker-miner-fs.h
index 9e300df..f4642a1 100644
--- a/src/libtracker-miner/tracker-miner-fs.h
+++ b/src/libtracker-miner/tracker-miner-fs.h
@@ -59,27 +59,17 @@ struct _TrackerMinerFS {
 /**
  * TrackerMinerFSClass:
  * @parent: parent object class
- * @check_file: Called when a file should be checked for further
- * processing.
- * @check_directory: Called when a directory should be checked for
- * further processing.
- * @check_directory_contents: Called when a directory should be
- * checked for further processing, based on the directory contents.
  * @process_file: Called when the metadata associated to a file is
  * requested.
  * @ignore_next_update_file: Called after a writeback event happens on
  * a file (deprecated since 0.12).
- * @monitor_directory: Called to check whether a directory should be
- * modified.
  * @finished: Called when all processing has been performed.
  * @process_file_attributes: Called when the metadata associated with
  * a file's attributes changes, for example, the mtime.
  * @writeback_file: Called when a file must be written back
  *
- * Prototype for the abstract class, @check_file, @check_directory,
- * @check_directory_contents, @process_file and @monitor_directory
- * must be implemented in the deriving class in order to actually
- * extract data.
+ * Prototype for the abstract class, @process_file must be implemented
+ * in the deriving class in order to actually extract data.
  **/
 typedef struct {
 	TrackerMinerClass parent;
diff --git a/src/libtracker-miner/tracker-miner-manager.c b/src/libtracker-miner/tracker-miner-manager.c
index 65f59c8..bc3ebd2 100644
--- a/src/libtracker-miner/tracker-miner-manager.c
+++ b/src/libtracker-miner/tracker-miner-manager.c
@@ -1354,6 +1354,7 @@ tracker_miner_manager_get_description (TrackerMinerManager *manager,
  * Returns: %TRUE on success, otherwise %FALSE.
  *
  * Since: 0.8
+ *
  * Deprecated since 0.12
  **/
 gboolean
@@ -1395,7 +1396,7 @@ tracker_miner_manager_ignore_next_update (TrackerMinerManager *manager,
 }
 
 /**
- * tracker_miner_manager_error_quark (skip):
+ * tracker_miner_manager_error_quark:
  *
  * Returns: the #GQuark used to identify miner manager errors in
  * GError structures.
diff --git a/src/libtracker-miner/tracker-password-provider.c b/src/libtracker-miner/tracker-password-provider.c
index e908d52..d5a7229 100644
--- a/src/libtracker-miner/tracker-password-provider.c
+++ b/src/libtracker-miner/tracker-password-provider.c
@@ -80,7 +80,7 @@ tracker_password_provider_get_type (void)
 }
 
 /**
- * tracker_password_provider_error_quark (skip):
+ * tracker_password_provider_error_quark:
  *
  * Returns: the #GQuark used to identify password provider errors in
  * GError structures.
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]