GNOME.org
 

[tracker] libtracker-miner: Cleaned up documentation

commit cf698a29df5f9d4f41198259af6e0e2ab7c59c7b
Author: Martyn Russell <martyn lanedo com>
Date:   Wed Dec 8 12:25:05 2010 +0000

    libtracker-miner: Cleaned up documentation
    
    Cleaned up several warnings during the build and missing documentation too

 docs/reference/libtracker-miner/Makefile.am        |    2 +
 .../libtracker-miner/libtracker-miner-sections.txt |   32 ++++----
 src/libtracker-miner/tracker-miner-fs.c            |   16 ++--
 src/libtracker-miner/tracker-miner-fs.h            |   30 +++++---
 src/libtracker-miner/tracker-miner-manager.c       |   76 ++++++++++++-------
 src/libtracker-miner/tracker-miner-manager.h       |   20 +++++-
 src/libtracker-miner/tracker-miner-web.h           |    4 -
 src/libtracker-miner/tracker-network-provider.c    |    4 +-
 src/libtracker-miner/tracker-network-provider.h    |   23 +++---
 src/libtracker-miner/tracker-password-provider.c   |    4 +-
 src/libtracker-miner/tracker-storage.h             |   12 +++
 11 files changed, 139 insertions(+), 84 deletions(-)
---
diff --git a/docs/reference/libtracker-miner/Makefile.am b/docs/reference/libtracker-miner/Makefile.am
index 44418d2..5b0f236 100644
--- a/docs/reference/libtracker-miner/Makefile.am
+++ b/docs/reference/libtracker-miner/Makefile.am
@@ -29,6 +29,8 @@ IGNORE_HFILES=                                         \
 	tracker-miner-client.h                         \
 	tracker-miner-dbus.h                           \
 	tracker-miner-glue.h                           \
+	tracker-miner-files-index-client.h             \
+	tracker-miner-fs-processing-pool.h             \
 	tracker-miner-web-dbus.h                       \
 	tracker-miner-web-glue.h                       \
 	tracker-miner-web-glue.h                       \
diff --git a/docs/reference/libtracker-miner/libtracker-miner-sections.txt b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
index 972434b..a9987a9 100644
--- a/docs/reference/libtracker-miner/libtracker-miner-sections.txt
+++ b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
@@ -1,13 +1,11 @@
 <SECTION>
 <FILE>tracker-miner-manager</FILE>
 <TITLE>TrackerMinerManager</TITLE>
+TRACKER_MINER_MANAGER_ERROR
+TrackerMinerManagerError
+tracker_miner_manager_error_quark
 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
@@ -16,9 +14,11 @@ 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
+tracker_miner_manager_index_file
+tracker_miner_manager_ignore_next_update
+tracker_miner_manager_reindex_by_mimetype
 <SUBSECTION Standard>
 TRACKER_MINER_MANAGER
 TRACKER_IS_MINER_MANAGER
@@ -31,14 +31,13 @@ TRACKER_MINER_MANAGER_GET_CLASS
 
 <SECTION>
 <FILE>tracker-miner</FILE>
+TrackerMinerPrivate
 <TITLE>TrackerMiner</TITLE>
 TRACKER_MINER_ERROR_DOMAIN
 TRACKER_MINER_ERROR
-TrackerMinerPrivate
-<TITLE>TrackerMiner</TITLE>
+tracker_miner_error_quark
 TrackerMiner
 TrackerMinerClass
-tracker_miner_error_quark
 tracker_miner_start
 tracker_miner_stop
 tracker_miner_ignore_next_update
@@ -58,13 +57,15 @@ TRACKER_MINER_GET_CLASS
 
 <SECTION>
 <FILE>tracker-miner-fs</FILE>
+TrackerMinerFSPrivate
 <TITLE>TrackerMinerFS</TITLE>
 TrackerMinerFS
 TrackerMinerFSClass
+tracker_miner_fs_check_directory
+tracker_miner_fs_check_file
 tracker_miner_fs_directory_add
 tracker_miner_fs_directory_remove
 tracker_miner_fs_directory_remove_full
-tracker_miner_fs_file_add
 tracker_miner_fs_file_notify
 tracker_miner_fs_set_throttle
 tracker_miner_fs_get_throttle
@@ -88,16 +89,15 @@ TRACKER_MINER_FS_GRAPH_URN
 
 <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
-TrackerMinerWebPrivate
-<TITLE>TrackerMinerWeb</TITLE>
 TrackerMinerWeb
 TrackerMinerWebClass
-tracker_miner_web_error_quark
-TrackerMinerWebError
 tracker_miner_web_associate
 tracker_miner_web_authenticate
 tracker_miner_web_dissociate
@@ -117,11 +117,11 @@ TRACKER_MINER_WEB_GET_CLASS
 <TITLE>TrackerPasswordProvider</TITLE>
 TRACKER_PASSWORD_PROVIDER_ERROR_DOMAIN
 TRACKER_PASSWORD_PROVIDER_ERROR
+TrackerPasswordProviderError
+tracker_password_provider_error_quark
 TRACKER_PASSWORD_PROVIDER_GET_INTERFACE
 TrackerPasswordProvider
-TrackerPasswordProviderError
 TrackerPasswordProviderIface
-tracker_password_provider_error_quark
 tracker_password_provider_get
 tracker_password_provider_get_name
 tracker_password_provider_store_password
diff --git a/src/libtracker-miner/tracker-miner-fs.c b/src/libtracker-miner/tracker-miner-fs.c
index e077a86..a79f1dd 100644
--- a/src/libtracker-miner/tracker-miner-fs.c
+++ b/src/libtracker-miner/tracker-miner-fs.c
@@ -3844,7 +3844,7 @@ check_file_parents (TrackerMinerFS *fs,
  * tracker_miner_fs_check_file:
  * @fs: a #TrackerMinerFS
  * @file: #GFile for the file to check
- * @do_checks: whether to check parents and eligibility or not
+ * @check_parents: whether to check parents and eligibility or not
  *
  * Tells the filesystem miner to check and index a file,
  * this file must be part of the usual crawling directories
@@ -3853,7 +3853,7 @@ check_file_parents (TrackerMinerFS *fs,
 void
 tracker_miner_fs_check_file (TrackerMinerFS *fs,
                              GFile          *file,
-                             gboolean        do_checks)
+                             gboolean        check_parents)
 {
 	gboolean should_process = TRUE;
 	gchar *path;
@@ -3861,7 +3861,7 @@ tracker_miner_fs_check_file (TrackerMinerFS *fs,
 	g_return_if_fail (TRACKER_IS_MINER_FS (fs));
 	g_return_if_fail (G_IS_FILE (file));
 
-	if (do_checks) {
+	if (check_parents) {
 		should_process = should_check_file (fs, file, FALSE);
 	}
 
@@ -3872,7 +3872,7 @@ tracker_miner_fs_check_file (TrackerMinerFS *fs,
 	         path);
 
 	if (should_process) {
-		if (do_checks && !check_file_parents (fs, file)) {
+		if (check_parents && !check_file_parents (fs, file)) {
 			return;
 		}
 
@@ -3889,7 +3889,7 @@ tracker_miner_fs_check_file (TrackerMinerFS *fs,
  * tracker_miner_fs_check_directory:
  * @fs: a #TrackerMinerFS
  * @file: #GFile for the directory to check
- * @do_checks: whether to check parents and eligibility or not
+ * @check_parents: whether to check parents and eligibility or not
  *
  * Tells the filesystem miner to check and index a directory,
  * this file must be part of the usual crawling directories
@@ -3898,7 +3898,7 @@ tracker_miner_fs_check_file (TrackerMinerFS *fs,
 void
 tracker_miner_fs_check_directory (TrackerMinerFS *fs,
                                   GFile          *file,
-                                  gboolean        do_checks)
+                                  gboolean        check_parents)
 {
 	gboolean should_process = TRUE;
 	gchar *path;
@@ -3906,7 +3906,7 @@ tracker_miner_fs_check_directory (TrackerMinerFS *fs,
 	g_return_if_fail (TRACKER_IS_MINER_FS (fs));
 	g_return_if_fail (G_IS_FILE (file));
 
-	if (do_checks) {
+	if (check_parents) {
 		should_process = should_check_file (fs, file, TRUE);
 	}
 
@@ -3917,7 +3917,7 @@ tracker_miner_fs_check_directory (TrackerMinerFS *fs,
 	         path);
 
 	if (should_process) {
-		if (do_checks && !check_file_parents (fs, file)) {
+		if (check_parents && !check_file_parents (fs, file)) {
 			return;
 		}
 
diff --git a/src/libtracker-miner/tracker-miner-fs.h b/src/libtracker-miner/tracker-miner-fs.h
index c8f1757..80ce57d 100644
--- a/src/libtracker-miner/tracker-miner-fs.h
+++ b/src/libtracker-miner/tracker-miner-fs.h
@@ -48,8 +48,7 @@ typedef struct _TrackerMinerFSPrivate TrackerMinerFSPrivate;
 /**
  * TrackerMinerFS:
  *
- * Abstract miner abstract implementation to get data
- * from the filesystem.
+ * Abstract miner implementation to get data from the filesystem.
  **/
 struct _TrackerMinerFS {
 	TrackerMiner parent;
@@ -59,17 +58,26 @@ 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.
- * @monitor_directory: Called to check whether a directory should be modified.
+ * @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.
+ * @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.
  *
- * 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, @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.
  **/
 typedef struct {
 	TrackerMinerClass parent;
diff --git a/src/libtracker-miner/tracker-miner-manager.c b/src/libtracker-miner/tracker-miner-manager.c
index 390210f..568f86e 100644
--- a/src/libtracker-miner/tracker-miner-manager.c
+++ b/src/libtracker-miner/tracker-miner-manager.c
@@ -409,10 +409,12 @@ tracker_miner_manager_new (void)
  * tracker_miner_manager_get_running:
  * @manager: a #trackerMinerManager
  *
- * Returns a list of references for all active miners.
+ * Returns a list of references for all active miners. Active miners
+ * are miners which are running within a process.
  *
- * Returns: a #GSList of miner references. This list must be freed
- *          through g_slist_free(), and all contained data with g_free().
+ * Returns: a #GSList which must be freed with g_slist_free() and all
+ * contained data with g_free(). Otherwise %NULL is returned if there
+ * are no miners.
  **/
 GSList *
 tracker_miner_manager_get_running (TrackerMinerManager *manager)
@@ -570,10 +572,13 @@ initialize_miners_data (TrackerMinerManager *manager)
  * tracker_miner_manager_get_available:
  * @manager: a #TrackerMinerManager
  *
- * Returns a list of references for all available miners.
+ * Returns a list of references for all available miners. Available
+ * miners are miners which may or may not be running in a process at
+ * the current time.
  *
- * Returns: a #GSList of miner references. This list must be freed
- *          through g_slist_free(), and all contained data with g_free().
+ * Returns: a #GSList which must be freed with g_slist_free() and all
+ * contained data with g_free(). Otherwise %NULL is returned if there
+ * are no miners.
  **/
 GSList *
 tracker_miner_manager_get_available (TrackerMinerManager *manager)
@@ -604,7 +609,8 @@ tracker_miner_manager_get_available (TrackerMinerManager *manager)
  * several reasons, and its activity won't be resumed
  * until all pause requests have been resumed.
  *
- * Returns: %TRUE if the miner was paused successfully.
+ * Returns: %TRUE if the miner was paused successfully, otherwise
+ * %FALSE. 
  **/
 gboolean
 tracker_miner_manager_pause (TrackerMinerManager *manager,
@@ -656,9 +662,10 @@ tracker_miner_manager_pause (TrackerMinerManager *manager,
  * @cookie: pause cookie
  *
  * Tells @miner to resume activity. The miner won't actually resume
- * operations until all pause requests have been resumed.
+ * operations until all pause requests have been resumed. 
  *
- * Returns: %TRUE if the miner was successfully resumed.
+ * Returns: %TRUE if the miner was successfully resumed, otherwise
+ * %FALSE. 
  **/
 gboolean
 tracker_miner_manager_resume (TrackerMinerManager *manager,
@@ -693,9 +700,9 @@ tracker_miner_manager_resume (TrackerMinerManager *manager,
  * @manager: a #TrackerMinerManager
  * @miner: miner reference
  *
- * Returns %TRUE if @miner is currently active.
+ * Returns the miner's current activity.
  *
- * Returns: %TRUE if @miner is active.
+ * Returns: %TRUE if the @miner is active, otherwise %FALSE.
  **/
 gboolean
 tracker_miner_manager_is_active (TrackerMinerManager *manager,
@@ -733,7 +740,8 @@ tracker_miner_manager_is_active (TrackerMinerManager *manager,
  *
  * Returns the current status and progress for @miner.
  *
- * Returns: %TRUE if the status could be retrieved successfully.
+ * Returns: %TRUE if the status could be retrieved successfully,
+ * otherwise %FALSE
  **/
 gboolean
 tracker_miner_manager_get_status (TrackerMinerManager  *manager,
@@ -808,7 +816,7 @@ tracker_miner_manager_get_status (TrackerMinerManager  *manager,
  * arrays will have the same lengh, and will be sorted so the
  * application/pause reason pairs have the same index.
  *
- * Returns: %TRUE if @miner is paused.
+ * Returns: %TRUE if @miner is paused, otherwise %FALSE.
  **/
 gboolean
 tracker_miner_manager_is_paused (TrackerMinerManager *manager,
@@ -873,7 +881,7 @@ tracker_miner_manager_is_paused (TrackerMinerManager *manager,
  *
  * Returns a translated display name for @miner.
  *
- * Returns: The miner display name.
+ * Returns: A string which should not be freed or %NULL.
  **/
 const gchar *
 tracker_miner_manager_get_display_name (TrackerMinerManager *manager,
@@ -903,9 +911,9 @@ tracker_miner_manager_get_display_name (TrackerMinerManager *manager,
  * @manager: a #TrackerMinerManager
  * @miner: miner reference
  *
- * Returns the description for @miner, or %NULL if none is specified.
+ * Returns the description for the given @miner.
  *
- * Returns: The miner description.
+ * Returns: A string which should not be freed or %NULL if none is specified.
  **/
 const gchar *
 tracker_miner_manager_get_description (TrackerMinerManager *manager,
@@ -933,13 +941,16 @@ tracker_miner_manager_get_description (TrackerMinerManager *manager,
 
 /**
  * tracker_miner_manager_ignore_next_update:
- * @manager: a #TrackerMinerManager.
+ * @manager: a #TrackerMinerManager
  * @miner: miner reference
- * @urls: subjects to mark as writeback
+ * @urls: the subjects to ignore the next updates of
  *
- * Asks @miner to mark @subjects as writeback
+ * Tells the @miner to ignore any events for the next @urls. This is
+ * used for cases where a file is updated by Tracker by the
+ * tracker-writeback service. This API is used to avoid signalling up
+ * the stack the changes to @urls.
  *
- * Returns: %TRUE if the miner was asked to ignore on next update successfully.
+ * Returns: %TRUE on success, otherwise %FALSE.
  **/
 gboolean
 tracker_miner_manager_ignore_next_update (TrackerMinerManager *manager,
@@ -982,6 +993,12 @@ tracker_miner_manager_ignore_next_update (TrackerMinerManager *manager,
 	return TRUE;
 }
 
+/**
+ * tracker_miner_manager_error_quark:
+ *
+ * Returns: the #GQuark used to identify miner manager errors in
+ * GError structures.
+ **/
 GQuark
 tracker_miner_manager_error_quark (void)
 {
@@ -997,14 +1014,16 @@ tracker_miner_manager_error_quark (void)
 /**
  * tracker_miner_manager_reindex_by_mimetype:
  * @manager: a #TrackerMinerManager
- * @mimetypes: an array of mimetypes (E.G. "text/plain"). All items with a mimetype in that 
- * list will be reindexed.
+ * @mimetypes: an array of mimetypes (E.G. "text/plain"). All items
+ * with a mimetype in that list will be reindexed.
  * @error: return location for errors
  *
- * Tells the filesystem miner to reindex any file with a mimetype in the @mimetypes list. 
- * On failure @error will be set and #FALSE will be returned.
+ * Tells the filesystem miner to reindex any file with a mimetype in
+ * the @mimetypes list.
+ *
+ * On failure @error will be set.
  *
- * Returns: #TRUE if everything went fine in the miner.
+ * Returns: %TRUE on success, otherwise %FALSE.
  **/
 gboolean
 tracker_miner_manager_reindex_by_mimetype (TrackerMinerManager  *manager,
@@ -1054,10 +1073,11 @@ tracker_miner_manager_reindex_by_mimetype (TrackerMinerManager  *manager,
  * @file: a URL valid in GIO of a file to give to the miner for processing
  * @error: return location for errors
  *
- * Tells the filesystem miner to index the @file. On failure @error 
- * will be set and #FALSE will be returned.
+ * Tells the filesystem miner to index the @file.
+ * 
+ * On failure @error will be set.
  *
- * Returns: #TRUE if the miner processed the URL correctly.
+ * Returns: %TRUE on success, otherwise %FALSE.
  **/
 gboolean
 tracker_miner_manager_index_file (TrackerMinerManager  *manager,
diff --git a/src/libtracker-miner/tracker-miner-manager.h b/src/libtracker-miner/tracker-miner-manager.h
index 52498d8..763383e 100644
--- a/src/libtracker-miner/tracker-miner-manager.h
+++ b/src/libtracker-miner/tracker-miner-manager.h
@@ -40,6 +40,16 @@ G_BEGIN_DECLS
 typedef struct _TrackerMinerManager TrackerMinerManager;
 typedef struct _TrackerMinerManagerClass TrackerMinerManagerClass;
 
+/**
+ * TrackerMinerManagerError:
+ * @TRACKER_MINER_MANAGER_ERROR_NOT_AVAILABLE: The miner in question
+ * is not active and can so can not be used.
+ * @TRACKER_MINER_MANAGER_ERROR_NOENT: The resource that the
+ * miner is handling (for example a file or URI) does not exist.
+ *
+ * Enumeration values used in errors returned by the
+ * #TrackerMinerManager API.
+ **/
 typedef enum {
 	TRACKER_MINER_MANAGER_ERROR_NOT_AVAILABLE,
 	TRACKER_MINER_MANAGER_ERROR_NOENT
@@ -56,8 +66,14 @@ struct _TrackerMinerManager {
 
 /**
  * TrackerMinerManagerClass:
- *
- * #TrackerMinerManager class.
+ * @miner_progress: The progress signal for all miners including name,
+ * status and progress as a percentage between 0 and 1.
+ * @miner_paused: The paused signal for all miners known about.
+ * @miner_resumed: The resumed signal for all miners known about.
+ * @miner_activated: The activated signal for all miners which
+ * indicates the miner is available on d-bus.
+ * @miner_deactivated: The deactivate for all miners which indicates
+ * the miner is no longer available on d-bus.
  **/
 struct _TrackerMinerManagerClass {
 	GObjectClass parent_class;
diff --git a/src/libtracker-miner/tracker-miner-web.h b/src/libtracker-miner/tracker-miner-web.h
index 1b21c12..fc07029 100644
--- a/src/libtracker-miner/tracker-miner-web.h
+++ b/src/libtracker-miner/tracker-miner-web.h
@@ -38,10 +38,6 @@ G_BEGIN_DECLS
 typedef struct TrackerMinerWeb TrackerMinerWeb;
 typedef struct TrackerMinerWebPrivate TrackerMinerWebPrivate;
 
-/**
- * TRACKER_MINER_WEB_DBUS_INTERFACE:
- * The name of the DBus interface exposed by the web miners
- **/
 #define TRACKER_MINER_WEB_DBUS_INTERFACE "org.freedesktop.Tracker1.MinerWeb"
 
 /**
diff --git a/src/libtracker-miner/tracker-network-provider.c b/src/libtracker-miner/tracker-network-provider.c
index 244600e..5abf73e 100644
--- a/src/libtracker-miner/tracker-network-provider.c
+++ b/src/libtracker-miner/tracker-network-provider.c
@@ -104,8 +104,8 @@ tracker_network_provider_get_type (void)
  * "NetworkManager". Either of these is what will be returned unless new
  * providers are written.
  *
- * Returns: a newly allocated string representing the #Object:name
- * which must be freed with g_free().
+ * Returns: a newly allocated string representing the name which must
+ * be freed with g_free().
  **/
 gchar *
 tracker_network_provider_get_name (TrackerNetworkProvider *provider)
diff --git a/src/libtracker-miner/tracker-network-provider.h b/src/libtracker-miner/tracker-network-provider.h
index 0dcedd1..eea9b65 100644
--- a/src/libtracker-miner/tracker-network-provider.h
+++ b/src/libtracker-miner/tracker-network-provider.h
@@ -37,19 +37,20 @@ typedef struct TrackerNetworkProvider TrackerNetworkProvider;
 
 /**
  * TrackerNetworkProviderStatus:
- *
- * Enumerates the different types of connections that the device might use when
- * connected to internet. Note that not all providers might provide this
- * information.
- *
  * @TRACKER_NETWORK_PROVIDER_DISCONNECTED: Network is disconnected
  * @TRACKER_NETWORK_PROVIDER_UNKNOWN: Network status is unknown
- * @TRACKER_NETWORK_PROVIDER_GPRS: Network is connected over a GPRS connection
- * @TRACKER_NETWORK_PROVIDER_EDGE: Network is connected over an EDGE connection
- * @TRACKER_NETWORK_PROVIDER_3G: Network is connected over a 3G or faster
- * (HSDPA, UMTS, ...) connection
- * @TRACKER_NETWORK_PROVIDER_LAN: Network is connected over a local network
- * connection. This can be ethernet, wifi, etc.
+ * @TRACKER_NETWORK_PROVIDER_GPRS: Network is connected over a GPRS
+ * connection
+ * @TRACKER_NETWORK_PROVIDER_EDGE: Network is connected over an EDGE
+ * connection
+ * @TRACKER_NETWORK_PROVIDER_3G: Network is connected over a 3G or
+ * faster (HSDPA, UMTS, ...) connection
+ * @TRACKER_NETWORK_PROVIDER_LAN: Network is connected over a local
+ * network connection. This can be ethernet, wifi, etc.
+ *
+ * Enumerates the different types of connections that the device might
+ * use when connected to internet. Note that not all providers might
+ * provide this information.
  *
  * Since: 0.10
  **/
diff --git a/src/libtracker-miner/tracker-password-provider.c b/src/libtracker-miner/tracker-password-provider.c
index 1216137..4a5f745 100644
--- a/src/libtracker-miner/tracker-password-provider.c
+++ b/src/libtracker-miner/tracker-password-provider.c
@@ -99,8 +99,8 @@ tracker_password_provider_error_quark (void)
  * "GKeyFile". Either of these is what will be returned unless new
  * providers are written.
  *
- * Returns: a newly allocated string representing the #Object:name
- * which must be freed with g_free().
+ * Returns: a newly allocated string representing the name which must
+ * be freed with g_free().
  **/
 gchar *
 tracker_password_provider_get_name (TrackerPasswordProvider *provider)
diff --git a/src/libtracker-miner/tracker-storage.h b/src/libtracker-miner/tracker-storage.h
index 3ac584f..9970edf 100644
--- a/src/libtracker-miner/tracker-storage.h
+++ b/src/libtracker-miner/tracker-storage.h
@@ -72,10 +72,22 @@ typedef enum {
 typedef struct _TrackerStorage TrackerStorage;
 typedef struct _TrackerStorageClass TrackerStorageClass;
 
+/**
+ * TrackerStorage:
+ * @parent: parent object
+ *
+ * A storage API for using mount points and devices
+ **/
 struct _TrackerStorage {
 	GObject parent;
 };
 
+/**
+ * TrackerStorageClass:
+ * @parent_class: parent object class
+ *
+ * A storage class for #TrackerStorage.
+ **/
 struct _TrackerStorageClass {
 	GObjectClass parent_class;
 };
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]