tracker r2664 - in trunk: . src/tracker-indexer

[carlosg svn gnome org]

Author: carlosg
Date: Fri Dec  5 10:30:25 2008
New Revision: 2664
URL: http://svn.gnome.org/viewvc/tracker?rev=2664&view=rev

Log:
2008-12-05  Carlos Garnacho  <carlos imendio com>

        * src/tracker-indexer/tracker-module-file.c:
        * src/tracker-indexer/tracker-module-iteratable.c: Document missing
        symbols.

Modified:
   trunk/ChangeLog
   trunk/src/tracker-indexer/tracker-module-file.c
   trunk/src/tracker-indexer/tracker-module-iteratable.c

Modified: trunk/src/tracker-indexer/tracker-module-file.c
==============================================================================
--- trunk/src/tracker-indexer/tracker-module-file.c	(original)
+++ trunk/src/tracker-indexer/tracker-module-file.c	Fri Dec  5 10:30:25 2008
@@ -163,6 +163,15 @@
         return priv->file;
 }
 
+/**
+ * tracker_module_file_get_service_type:
+ * @file: A #TrackerModuleFile
+ *
+ * Returns the service type for @file in the current
+ * state (See #TrackerModuleIteratable).
+ *
+ * Returns: The service type name.
+ **/
 G_CONST_RETURN gchar *
 tracker_module_file_get_service_type (TrackerModuleFile *file)
 {
@@ -173,6 +182,14 @@
         return TRACKER_MODULE_FILE_GET_CLASS (file)->get_service_type (file);
 }
 
+/**
+ * tracker_module_file_get_uri:
+ * @file: A #TrackerModuleFile
+ *
+ * Returns a unique URI for @file in the current state (See #TrackerModuleIteratable)
+ *
+ * Returns: A newly allocated string containing the URI for the element.
+ **/
 gchar *
 tracker_module_file_get_uri (TrackerModuleFile *file)
 {
@@ -196,6 +213,16 @@
         return uri;
 }
 
+/**
+ * tracker_module_file_get_text:
+ * @file: A #TrackerModuleFile
+ *
+ * Extracts all the text that @file could contain in the current
+ * state (see #TrackerModuleIteratable) or %NULL if the element
+ * does not contain any text.
+ *
+ * Returns: A newly allocated string containing valid UTF-8, or %NULL.
+ **/
 gchar *
 tracker_module_file_get_text (TrackerModuleFile *file)
 {
@@ -210,9 +237,12 @@
  * tracker_module_file_get_metadata:
  * @file: A #TrackerModuleFile
  *
- * Extracts all the metadata corresponding to @file in the current state.
+ * Extracts all the metadata corresponding to @file in the current
+ * state (see #TrackerModuleIteratable) or %NULL if the element should not
+ * be indexed.
  *
- * Returns: A #TrackerModuleMetadata containing all the extracted metadata.
+ * Returns: A newly created #TrackerModuleMetadata containing all
+ *          the extracted metadata, or %NULL.
  **/
 TrackerModuleMetadata *
 tracker_module_file_get_metadata (TrackerModuleFile *file)

Modified: trunk/src/tracker-indexer/tracker-module-iteratable.c
==============================================================================
--- trunk/src/tracker-indexer/tracker-module-iteratable.c	(original)
+++ trunk/src/tracker-indexer/tracker-module-iteratable.c	Fri Dec  5 10:30:25 2008
@@ -37,12 +37,28 @@
         return type;
 }
 
+/**
+ * tracker_module_iteratable_iter_contents:
+ * @iteratable: A #TrackerModuleIteratable
+ *
+ * Iterates to the next element contained in @iteratable.
+ *
+ * Returns: %TRUE if there was such next element, %FALSE otherwise
+ **/
 gboolean
 tracker_module_iteratable_iter_contents (TrackerModuleIteratable *iteratable)
 {
         return TRACKER_MODULE_ITERATABLE_GET_IFACE (iteratable)->iter_contents (iteratable);
 }
 
+/**
+ * tracker_module_iteratable_get_count:
+ * @iteratable: A #TrackerModuleIteratable
+ *
+ * Returns the number of elements contained in @iteratable
+ *
+ * Returns: The elements count.
+ **/
 guint
 tracker_module_iteratable_get_count (TrackerModuleIteratable *iteratable)
 {