Commit 8c1cbf7f authored by Sam Thursfield's avatar Sam Thursfield

Merge branch 'wip/tintou/tracker-miner-doc' into 'master'

docs: Modernize the libtracker-miner documentation

See merge request !78
parents 24f753f7 ae7640c7
Pipeline #71192 passed with stage
in 2 minutes and 11 seconds
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.5//EN'
'http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd' [
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
]>
<book id="index">
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>Tracker Miner Library Reference Manual</title>
<releaseinfo>
for libtracker-miner &version;.
The latest version of this documentation can be found on-line at
<ulink role="online-location" url="http://library.gnome.org/devel/libtracker-miner/unstable/">
http://library.gnome.org/devel/libtracker-miner/unstable
</ulink>.
</releaseinfo>
for libtracker-miner &version;.
The latest version of this documentation can be found on-line at
<ulink role="online-location" url="https://developer.gnome.org/libtracker-miner/stable/">
https://developer.gnome.org/libtracker-miner/stable
</ulink>.
</releaseinfo>
</bookinfo>
<!-- The Library Overview -->
<xi:include href="overview.sgml"/>
<xi:include href="overview.xml"/>
<!-- The API Reference -->
<part id="libtracker-miner-reference">
......@@ -40,8 +41,16 @@
<chapter>
<title>Miner classes for file system</title>
<xi:include href="xml/tracker-miner-fs.xml"/>
<xi:include href="xml/tracker-file-system.xml"/>
<xi:include href="xml/tracker-file-data-provider.xml"/>
<xi:include href="xml/tracker-file-notifier.xml"/>
<xi:include href="xml/tracker-monitor.xml"/>
<xi:include href="xml/tracker-decorator-fs.xml"/>
<xi:include href="xml/tracker-crawler.xml"/>
<xi:include href="xml/tracker-priority-queue.xml"/>
<xi:include href="xml/tracker-task-pool.xml"/>
<xi:include href="xml/tracker-sparql-buffer.xml"/>
<xi:include href="xml/tracker-utils.xml"/>
</chapter>
<chapter>
......@@ -52,5 +61,51 @@
</part>
<xi:include href="migrating-1to2.xml"/>
<index id="api-index-full">
<title>Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-deprecated" role="deprecated">
<title>Index of deprecated symbols</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-0-8" role="0.8">
<title>Index of new symbols in 0.8</title>
<xi:include href="xml/api-index-0.8.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-0-10" role="0.10">
<title>Index of new symbols in 0.10</title>
<xi:include href="xml/api-index-0.10.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-0-12" role="0.12">
<title>Index of new symbols in 0.12</title>
<xi:include href="xml/api-index-0.12.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-0-14" role="0.14">
<title>Index of new symbols in 0.14</title>
<xi:include href="xml/api-index-0.14.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-0-18" role="0.18">
<title>Index of new symbols in 0.18</title>
<xi:include href="xml/api-index-0.18.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-1-2" role="1.2">
<title>Index of new symbols in 1.2</title>
<xi:include href="xml/api-index-1.2.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-1-2-2" role="1.2.2">
<title>Index of new symbols in 1.2.2</title>
<xi:include href="xml/api-index-1.2.2.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-1-10" role="1.10">
<title>Index of new symbols in 1.10</title>
<xi:include href="xml/api-index-1.10.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-2-0" role="2.0">
<title>Index of new symbols in 2.0</title>
<xi:include href="xml/api-index-2.0.xml"><xi:fallback /></xi:include>
</index>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</book>
<SECTION>
<FILE>tracker-data-provider</FILE>
<TITLE>TrackerDataProvider</TITLE>
TrackerDataProviderIface
tracker_data_provider_begin
tracker_data_provider_begin_async
tracker_data_provider_begin_finish
TrackerDataProvider
<SUBSECTION Standard>
TRACKER_DATA_PROVIDER
TRACKER_DATA_PROVIDER_GET_IFACE
TRACKER_IS_DATA_PROVIDER
TRACKER_TYPE_DATA_PROVIDER
tracker_data_provider_get_type
</SECTION>
<SECTION>
<FILE>tracker-decorator</FILE>
<TITLE>TrackerDecorator</TITLE>
TrackerDecorator
TrackerDecoratorClass
TrackerDecoratorError
tracker_decorator_error_quark
tracker_decorator_get_data_source
tracker_decorator_get_class_names
tracker_decorator_get_n_items
tracker_decorator_prepend_id
tracker_decorator_delete_id
tracker_decorator_next
tracker_decorator_next_finish
tracker_decorator_set_priority_rdf_types
tracker_decorator_info_ref
tracker_decorator_info_unref
tracker_decorator_info_get_urn
tracker_decorator_info_get_url
tracker_decorator_info_get_mimetype
tracker_decorator_info_get_task
tracker_decorator_info_complete
tracker_decorator_info_complete_error
<SUBSECTION Standard>
TRACKER_DECORATOR
TRACKER_DECORATOR_CLASS
TRACKER_DECORATOR_GET_CLASS
TRACKER_IS_DECORATOR
TRACKER_IS_DECORATOR_CLASS
TRACKER_TYPE_DECORATOR
TrackerDecoratorInfo
tracker_decorator_get_type
tracker_decorator_info_get_type
</SECTION>
<SECTION>
<FILE>tracker-decorator-fs</FILE>
<TITLE>TrackerDecoratorFS</TITLE>
TrackerDecoratorFS
TrackerDecoratorFSClass
tracker_decorator_fs_prepend_file
<SUBSECTION Standard>
TRACKER_DECORATOR_FS
TRACKER_DECORATOR_FS_CLASS
TRACKER_DECORATOR_FS_GET_CLASS
TRACKER_IS_DECORATOR_FS
TRACKER_IS_DECORATOR_FS_CLASS
TRACKER_TYPE_DECORATOR_FS
tracker_decorator_fs_get_type
</SECTION>
<SECTION>
<FILE>tracker-file-data-provider</FILE>
<TITLE>TrackerFileDataProvider</TITLE>
TrackerFileDataProviderClass
tracker_file_data_provider_new
TrackerFileDataProvider
<SUBSECTION Standard>
TRACKER_FILE_DATA_PROVIDER
TRACKER_FILE_DATA_PROVIDER_CLASS
TRACKER_FILE_DATA_PROVIDER_GET_CLASS
TRACKER_IS_FILE_DATA_PROVIDER
TRACKER_IS_FILE_DATA_PROVIDER_CLASS
TRACKER_TYPE_FILE_DATA_PROVIDER
TrackerFileDataProviderPrivate
tracker_file_data_provider_get_type
</SECTION>
<SECTION>
<FILE>tracker-indexing-tree</FILE>
<TITLE>TrackerIndexingTree</TITLE>
TrackerIndexingTree
TrackerIndexingTreeClass
tracker_indexing_tree_new
tracker_indexing_tree_new_with_root
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_filter_hidden
tracker_indexing_tree_set_filter_hidden
tracker_indexing_tree_get_default_policy
tracker_indexing_tree_set_default_policy
tracker_indexing_tree_get_root
tracker_indexing_tree_get_master_root
tracker_indexing_tree_file_is_root
tracker_indexing_tree_list_roots
tracker_indexing_tree_notify_update
<SUBSECTION Standard>
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-miner-enum-types</FILE>
<SUBSECTION Standard>
TRACKER_TYPE_DIRECTORY_FLAGS
TRACKER_TYPE_FILTER_POLICY
TRACKER_TYPE_FILTER_TYPE
TRACKER_TYPE_NETWORK_TYPE
tracker_directory_flags_get_type
tracker_filter_policy_get_type
tracker_filter_type_get_type
tracker_network_type_get_type
</SECTION>
<SECTION>
<FILE>tracker-miner-enums</FILE>
TrackerDirectoryFlags
TrackerFilterType
TrackerFilterPolicy
TrackerNetworkType
</SECTION>
<SECTION>
<FILE>tracker-miner-fs</FILE>
<TITLE>TrackerMinerFS</TITLE>
TrackerMinerFS
TrackerMinerFSClass
TrackerMinerFSError
TrackerMinerFSEventType
tracker_miner_fs_error_quark
tracker_miner_fs_get_indexing_tree
tracker_miner_fs_get_data_provider
tracker_miner_fs_get_throttle
tracker_miner_fs_set_throttle
tracker_miner_fs_check_file
tracker_miner_fs_notify_finish
tracker_miner_fs_get_urn
tracker_miner_fs_query_urn
tracker_miner_fs_has_items_to_process
<SUBSECTION Standard>
TRACKER_IS_MINER_FS
TRACKER_IS_MINER_FS_CLASS
TRACKER_MINER_FS
TRACKER_MINER_FS_CLASS
TRACKER_MINER_FS_GET_CLASS
TRACKER_TYPE_MINER_FS
TrackerMinerFSPrivate
tracker_miner_fs_get_type
</SECTION>
<SECTION>
<FILE>tracker-miner-object</FILE>
<TITLE>TrackerMiner</TITLE>
TRACKER_MINER_DBUS_INTERFACE
TRACKER_MINER_DBUS_NAME_PREFIX
TRACKER_MINER_DBUS_PATH_PREFIX
TRACKER_MINER_ERROR_DOMAIN
TRACKER_MINER_ERROR
TrackerMiner
TrackerMinerClass
TrackerMinerError
tracker_miner_error_quark
tracker_miner_start
tracker_miner_stop
tracker_miner_is_started
tracker_miner_is_paused
tracker_miner_pause
tracker_miner_resume
tracker_miner_get_connection
<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-online</FILE>
<TITLE>TrackerMinerOnline</TITLE>
TrackerMinerOnline
TrackerMinerOnlineClass
tracker_miner_online_get_network_type
<SUBSECTION Standard>
TRACKER_IS_MINER_ONLINE
TRACKER_IS_MINER_ONLINE_CLASS
TRACKER_MINER_ONLINE
TRACKER_MINER_ONLINE_CLASS
TRACKER_MINER_ONLINE_GET_CLASS
TRACKER_TYPE_MINER_ONLINE
tracker_miner_online_get_type
</SECTION>
<SECTION>
<FILE>tracker-miner-proxy</FILE>
<TITLE>TrackerMinerProxy</TITLE>
TrackerMinerProxy
TrackerMinerProxyClass
tracker_miner_proxy_new
<SUBSECTION Standard>
TRACKER_IS_MINER_PROXY
TRACKER_IS_MINER_PROXY_CLASS
TRACKER_MINER_PROXY
TRACKER_MINER_PROXY_CLASS
TRACKER_MINER_PROXY_GET_CLASS
TRACKER_TYPE_MINER_PROXY
tracker_miner_proxy_get_type
</SECTION>
tracker_decorator_get_type
tracker_decorator_fs_get_type
tracker_indexing_tree_get_type
tracker_miner_get_type
tracker_miner_fs_get_type
tracker_miner_online_get_type
tracker_miner_proxy_get_type
......@@ -4,9 +4,9 @@ version_xml = configure_file(input: 'version.xml.in',
gnome.gtkdoc('libtracker-miner',
src_dir: minerinc,
main_sgml: 'libtracker-miner-docs.sgml',
content_files: ['overview.sgml', 'migrating-1to2.xml'],
main_xml: 'libtracker-miner-docs.xml',
content_files: ['overview.xml', 'migrating-1to2.xml'],
dependencies: tracker_miner_dep,
gobject_typesfile: 'libtracker-miner.types',
scan_args: ['--rebuild-sections'],
fixxref_args: fixxref_args,
install: true)
......@@ -118,7 +118,7 @@ tracker_data_provider_begin (TrackerDataProvider *data_provider,
* @url: a #GFile to enumerate
* @attributes: an attribute query string
* @flags: a set of #TrackerDirectoryFlags
* @io_priority: the [I/O priority][io-priority] of the request
* @io_priority: the I/O priority of the request (example: %G_PRIORITY_DEFAULT)
* @cancellable: (allow-none): optional #GCancellable object, %NULL to
* ignore
* @callback: (scope async): a #GAsyncReadyCallback to call when the
......
......@@ -55,13 +55,6 @@ typedef struct _TrackerDataProviderIface TrackerDataProviderIface;
* using @begin_finish.
* @begin_finish: Called when the data_provider is completing the
* asynchronous operation provided by @begin_async.
* @end: Called when the data_provider is synchronously
* closing and cleaning up the iteration of a given location.
* @end_async: Called when the data_provider is asynchronously
* closing and cleaning up the iteration of a given location.
* Completed using @end_finish.
* @end_finish: Called when the data_provider is completing the
* asynchronous operation provided by @end_async.
*
* Virtual methods left to implement.
**/
......
......@@ -132,7 +132,7 @@ static void notifier_events_cb (TrackerDecorator *decorator,
*
* Returns: the #GQuark used for the domain of a #GError.
*
* Since: 0.18.
* Since: 0.18
**/
G_DEFINE_QUARK (TrackerDecoratorError, tracker_decorator_error)
......@@ -175,7 +175,7 @@ tracker_decorator_info_new (TrackerDecorator *decorator,
*
* Returns: the same @info passed in, or %NULL on error.
*
* Since: 0.18.
* Since: 0.18
**/
TrackerDecoratorInfo *
tracker_decorator_info_ref (TrackerDecoratorInfo *info)
......@@ -191,7 +191,7 @@ tracker_decorator_info_ref (TrackerDecoratorInfo *info)
* Decreases the reference count of @info by 1 and frees it when the
* reference count reaches 0.
*
* Since: 0.18.
* Since: 0.18
**/
void
tracker_decorator_info_unref (TrackerDecoratorInfo *info)
......@@ -1259,7 +1259,7 @@ tracker_decorator_class_init (TrackerDecoratorClass *klass)
* #TrackerDecorator sees resources that are available for
* extended metadata extraction.
*
* Since: 0.18.
* Since: 0.18
**/
signals[ITEMS_AVAILABLE] =
g_signal_new ("items-available",
......@@ -1277,7 +1277,7 @@ tracker_decorator_class_init (TrackerDecoratorClass *klass)
* #TrackerDecorator has finished extracted extended metadata
* for resources in the database.
*
* Since: 0.18.
* Since: 0.18
**/
signals[FINISHED] =
g_signal_new ("finished",
......@@ -1323,7 +1323,7 @@ tracker_decorator_init (TrackerDecorator *decorator)
*
* Returns: a const gchar* or #NULL if an error happened.
*
* Since: 0.18.
* Since: 0.18
**/
const gchar *
tracker_decorator_get_data_source (TrackerDecorator *decorator)
......@@ -1345,7 +1345,7 @@ tracker_decorator_get_data_source (TrackerDecorator *decorator)
*
* Returns: (transfer none): a const gchar** or #NULL.
*
* Since: 0.18.
* Since: 0.18
**/
const gchar **
tracker_decorator_get_class_names (TrackerDecorator *decorator)
......@@ -1369,7 +1369,7 @@ tracker_decorator_get_class_names (TrackerDecorator *decorator)
*
* Returns: the number of items queued to be processed, always >= 0.
*
* Since: 0.18.
* Since: 0.18
**/
guint
tracker_decorator_get_n_items (TrackerDecorator *decorator)
......@@ -1393,7 +1393,7 @@ tracker_decorator_get_n_items (TrackerDecorator *decorator)
* @id is the same IDs emitted by tracker-store when the database is updated for
* consistency. For details, see the GraphUpdated signal.
*
* Since: 0.18.
* Since: 0.18
**/
void
tracker_decorator_prepend_id (TrackerDecorator *decorator,
......@@ -1420,7 +1420,7 @@ tracker_decorator_prepend_id (TrackerDecorator *decorator,
* queue. @id is the same IDs emitted by tracker-store when the database is
* updated for consistency. For details, see the GraphUpdated signal.
*
* Since: 0.18.
* Since: 0.18
**/
void
tracker_decorator_delete_id (TrackerDecorator *decorator,
......@@ -1458,7 +1458,7 @@ tracker_decorator_delete_id (TrackerDecorator *decorator,
* This function will give a #GError if the miner is paused at the
* time it is called.
*
* Since: 0.18.
* Since: 0.18
**/
void
tracker_decorator_next (TrackerDecorator *decorator,
......@@ -1503,7 +1503,7 @@ tracker_decorator_next (TrackerDecorator *decorator,
* Returns: (transfer full): a #TrackerDecoratorInfo on success or
* #NULL on error. Free with tracker_decorator_info_unref().
*
* Since: 0.18.
* Since: 0.18
**/
TrackerDecoratorInfo *
tracker_decorator_next_finish (TrackerDecorator *decorator,
......@@ -1554,7 +1554,7 @@ decorator_set_class_priority (TrackerDecorator *decorator,
* applications that need their content available sooner than the
* standard time it would take to index content.
*
* Since: 0.18.
* Since: 0.18
**/
void
tracker_decorator_set_priority_rdf_types (TrackerDecorator *decorator,
......@@ -1586,7 +1586,7 @@ tracker_decorator_set_priority_rdf_types (TrackerDecorator *decorator,
*
* Returns: the URN for #TrackerDecoratorInfo on success or #NULL on error.
*
* Since: 0.18.
* Since: 0.18
**/
const gchar *
tracker_decorator_info_get_urn (TrackerDecoratorInfo *info)
......@@ -1604,7 +1604,7 @@ tracker_decorator_info_get_urn (TrackerDecoratorInfo *info)
*
* Returns: the URL for #TrackerDecoratorInfo on success or #NULL on error.
*
* Since: 0.18.
* Since: 0.18
**/
const gchar *
tracker_decorator_info_get_url (TrackerDecoratorInfo *info)
......@@ -1625,7 +1625,7 @@ tracker_decorator_info_get_url (TrackerDecoratorInfo *info)
*
* Returns: the MIME type for #TrackerDecoratorInfo on success or #NULL on error.
*
* Since: 0.18.
* Since: 0.18
**/
const gchar *
tracker_decorator_info_get_mimetype (TrackerDecoratorInfo *info)
......@@ -1643,14 +1643,13 @@ tracker_decorator_info_get_mimetype (TrackerDecoratorInfo *info)
* information for a URN in Tracker.
*
* The task object's data (accessible with g_task_get_task_data()) is the
* #TrackerSparqlBuilder that you must populate with the results of the
* metadata extraction. This can also be accessed with
* tracker_decorator_info_get_sparql().
* #TrackerSparqlBuilder. Use tracker_decorator_info_complete() to complete
* the task instead of using this object.
*
* Returns: (transfer none): the #GTask for #TrackerDecoratorInfo on
* success or #NULL if there is no existing #GTask.
*
* Since: 0.18.
* Since: 0.18
**/
GTask *
tracker_decorator_info_get_task (TrackerDecoratorInfo *info)
......@@ -1662,7 +1661,7 @@ tracker_decorator_info_get_task (TrackerDecoratorInfo *info)
/**
* tracker_decorator_info_complete:
* @info: a #TrackerDecoratorInfo
* @sparql: SPARQL string
* @sparql: (transfer full): SPARQL string
*
* Completes the task associated to this #TrackerDecoratorInfo.
* Takes ownership of @sparql.
......@@ -1679,7 +1678,7 @@ tracker_decorator_info_complete (TrackerDecoratorInfo *info,
/**
* tracker_decorator_info_complete_error:
* @info: a #TrackerDecoratorInfo
* @error: An error occurred during SPARQL generation
* @error: (transfer full): An error occurred during SPARQL generation
*
* Completes the task associated to this #TrackerDecoratorInfo,
* returning the given @error happened during SPARQL generation.
......
......@@ -212,7 +212,7 @@ tracker_file_data_provider_file_iface_init (TrackerDataProviderIface *iface)
* Returns: (transfer full): a #TrackerDataProvider which must be
* unreferenced with g_object_unref().
*
* Since: 1.2:
* Since: 1.2
**/
TrackerDataProvider *
tracker_file_data_provider_new (void)
......
......@@ -276,7 +276,7 @@ tracker_indexing_tree_class_init (TrackerIndexingTreeClass *klass)
* signalled when the tracker_indexing_tree_add() API is
* called.
*
* Since: 0.14.0
* Since: 0.14
**/
signals[DIRECTORY_ADDED] =
g_signal_new ("directory-added",
......@@ -299,7 +299,7 @@ tracker_indexing_tree_class_init (TrackerIndexingTreeClass *klass)
* signalled when the tracker_indexing_tree_remove() API is
* called.
*
* Since: 0.14.0
* Since: 0.14
**/
signals[DIRECTORY_REMOVED] =
g_signal_new ("directory-removed",
......@@ -321,7 +321,7 @@ tracker_indexing_tree_class_init (TrackerIndexingTreeClass *klass)
* calls to tracker_indexing_tree_add()), or anytime an update is
* requested through tracker_indexing_tree_notify_update().
*
* Since: 0.14.0
* Since: 0.14
**/
signals[DIRECTORY_UPDATED] =
g_signal_new ("directory-updated",
......@@ -378,7 +378,7 @@ tracker_indexing_tree_init (TrackerIndexingTree *tree)
*
* Returns: a newly allocated #TrackerIndexingTree
*
* Since: 0.14.0
* Since: 0.14
**/
TrackerIndexingTree *
tracker_indexing_tree_new (void)
......@@ -948,7 +948,7 @@ tracker_indexing_tree_parent_is_indexable (TrackerIndexingTree *tree,
*
* Returns: %FALSE if hidden files are indexed, otherwise %TRUE.
*
* Since: 0.18.
* Since: 0.18
**/
gboolean
tracker_indexing_tree_get_filter_hidden (TrackerIndexingTree *tree)
......@@ -975,7 +975,7 @@ tracker_indexing_tree_get_filter_hidden (TrackerIndexingTree *tree)
* To ignore hidden files, @filter_hidden should be %TRUE, otherwise
* %FALSE.
*
* Since: 0.18.
* Since: 0.18
**/
void
tracker_indexing_tree_set_filter_hidden (TrackerIndexingTree *tree,
......@@ -1004,7 +1004,7 @@ tracker_indexing_tree_set_filter_hidden (TrackerIndexingTree *tree,
* For example, you can (by default), disable indexing all directories
* using this function.
*
* Since: 0.18.
* Since: 0.18
**/
void
tracker_indexing_tree_set_default_policy (TrackerIndexingTree *tree,
......@@ -1032,9 +1032,9 @@ tracker_indexing_tree_set_default_policy (TrackerIndexingTree *tree,
* (#TRACKER_FILTER_FILE).
*
* Returns: Either #TRACKER_FILTER_POLICY_DENY or
* #TRACKER_FILTER_POLICY_ALLOW.
* #TRACKER_FILTER_POLICY_ACCEPT.
*
* Since: 0.18.
* Since: 0.18
**/
TrackerFilterPolicy
tracker_indexing_tree_get_default_policy (TrackerIndexingTree *tree,
......@@ -1137,7 +1137,7 @@ tracker_indexing_tree_get_root (TrackerIndexingTree *tree,
* %NULL on error. The root is owned by @tree and should not be freed.
* It can be referenced using g_object_ref().
*
* Since: 1.2.
* Since: 1.2
**/
GFile *
tracker_indexing_tree_get_master_root (TrackerIndexingTree *tree)
......@@ -1161,7 +1161,7 @@ tracker_indexing_tree_get_master_root (TrackerIndexingTree *tree)
*
* Returns: %TRUE if @file matches the URL canonically, otherwise %FALSE.
*
* Since: 1.2.
* Since: 1.2
**/
gboolean
tracker_indexing_tree_file_is_root (TrackerIndexingTree *tree,
......
......@@ -57,6 +57,7 @@ struct _TrackerIndexingTree {
* @directory_added: Called when a directory is added.
* @directory_removed: Called when a directory is removed.
* @directory_updated: Called when a directory is updated.
* @child_updated: Called when a file inside a directory is updated.
* @padding: Reserved for future API improvements.
*
* Class for the #TrackerIndexingTree.
......
......@@ -49,7 +49,7 @@ G_BEGIN_DECLS
* used and this flag makes sure the directory is given a priority
* over other directories queued.
* @TRACKER_DIRECTORY_FLAG_NO_STAT: For cases where the content being
* crawled by the #TrackerEnumerator is not local (e.g. it's on a
* crawled by the enumerator is not local (e.g. it's on a
* server somewhere), use the #TRACKER_DIRECTORY_FLAG_NO_STAT flag.
* The default is to use stat() and assume we're mining a local or
* mounted file system.
......
......@@ -320,7 +320,7 @@ static guint signals[LAST_SIGNAL] = { 0, };
*
* Returns: the #GQuark used for the domain of a #GError.
*
* Since: 1.2.
* Since: 1.2
**/
G_DEFINE_QUARK (TrackerMinerFSError, tracker_miner_fs_error)
......@@ -2442,7 +2442,7 @@ check_file_parents (TrackerMinerFS *fs,
* Tells the filesystem miner to check and index a file at
* a given priority, this file must be part of the usual
* crawling directories of #TrackerMinerFS. See
* tracker_miner_fs_directory_add().
* tracker_indexing_tree_add().
*
* Since: 0.10
**/
......
......@@ -72,6 +72,10 @@ struct _TrackerMinerFS {
* a file's attributes changes, for example, the mtime.
* @finished_root: Called when all resources on a particular root URI
* have been processed.
* @remove_file: Called when a file is removed.
* @remove_children: Called when children have been removed.
* @move_file: Called when a file has moved.
* @filter_event: Called to filter the event happening to a file.
* @padding: Reserved for future API improvements.
*
* Prototype for the abstract class, @process_file must be implemented
......@@ -125,7 +129,7 @@ typedef struct {
* Possible errors returned when calling creating new objects based on
* the #TrackerMinerFS type and other APIs available with this class.
*
* Since: 1.2.
* Since: 1.2
**/
typedef enum {
TRACKER_MINER_FS_ERROR_INIT,
......
......@@ -38,7 +38,7 @@ G_BEGIN_DECLS
* The name of the D-Bus interface to use for all data miners that
* inter-operate with Tracker.
*
* Since: 0.8.
* Since: 0.8
**/
#define TRACKER_MINER_DBUS_INTERFACE "org.freedesktop.Tracker1.Miner"
......@@ -50,7 +50,7 @@ G_BEGIN_DECLS
* example and would show up on D-Bus under
* &quot;org.freedesktop.Tracker1.Miner.Files&quot;.
*
* Since: 0.8.
* Since: 0.8
**/
#define TRACKER_MINER_DBUS_NAME_PREFIX "org.freedesktop.Tracker1.Miner."
......@@ -62,7 +62,7 @@ G_BEGIN_DECLS
* example and would show up on D-Bus under
* &quot;/org/freedesktop/Tracker1/Miner/Files&quot;.
*
* Since: 0.8.
* Since: 0.8
**/
#define TRACKER_MINER_DBUS_PATH_PREFIX "/org/freedesktop/Tracker1/Miner/"
......@@ -78,7 +78,7 @@ G_BEGIN_DECLS
*
* Used as the domain for any #GErrors reported by @TrackerMiner objects.
*
* Since: 0.8.
* Since: 0.8
**/
#define TRACKER_MINER_ERROR_DOMAIN "TrackerMiner"
......@@ -88,7 +88,7 @@ G_BEGIN_DECLS
* Returns the @GQuark used for #GErrors and for @TrackerMiner
* implementations. This calls tracker_miner_error_quark().
*
* Since: 0.8.