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

[Martyn James Russell <mr src gnome org>]

commit 0fcc076d2aa88183446cc9953b9b450278fd37dc
Author: Martyn Russell <martyn lanedo com>
Date:   Thu Dec 15 12:18:51 2011 +0000

    libtracker-extract: Fix the documentation in preparation for 0.13.x release
    
    Conflicts:
    
    	src/libtracker-extract/tracker-guarantee.c

 .../libtracker-extract-sections.txt                |   36 ++++++++++++++++++++
 src/libtracker-extract/tracker-module-manager.h    |   20 +++++++++++
 src/libtracker-extract/tracker-utils.c             |   23 ++++++------
 3 files changed, 68 insertions(+), 11 deletions(-)
---
diff --git a/docs/reference/libtracker-extract/libtracker-extract-sections.txt b/docs/reference/libtracker-extract/libtracker-extract-sections.txt
index 3b731da..286b480 100644
--- a/docs/reference/libtracker-extract/libtracker-extract-sections.txt
+++ b/docs/reference/libtracker-extract/libtracker-extract-sections.txt
@@ -1,10 +1,32 @@
 <SECTION>
+<FILE>tracker-module-manager</FILE>
+TrackerExtractInitFunc
+TrackerExtractMetadataFunc
+TrackerExtractShutdownFunc
+TrackerModuleThreadAwareness
+tracker_extract_module_init
+tracker_extract_module_manager_get_fallback_rdf_types
+tracker_extract_module_manager_get_for_mimetype
+tracker_extract_module_manager_get_mimetype_handlers
+tracker_extract_module_manager_init
+tracker_extract_module_manager_mimetype_is_handled
+tracker_extract_module_shutdown
+<SUBSECTION Standard>
+TrackerMimetypeInfo
+tracker_mimetype_info_free
+tracker_mimetype_info_get_module
+tracker_mimetype_info_iter_next
+</SECTION>
+
+<SECTION>
 <FILE>tracker-xmp</FILE>
 TrackerXmpData
+TrackerXmpRegion
 tracker_xmp_new
 tracker_xmp_free
 tracker_xmp_read
 tracker_xmp_apply
+tracker_xmp_apply_regions
 </SECTION>
 
 <SECTION>
@@ -21,6 +43,20 @@ tracker_extract_get_metadata
 </SECTION>
 
 <SECTION>
+<FILE>tracker-encoding</FILE>
+tracker_encoding_can_guess
+tracker_encoding_guess
+tracker_encoding_guess_enca
+tracker_encoding_guess_meegotouch
+</SECTION>
+
+<SECTION>
+<FILE>tracker-guarantee</FILE>
+tracker_guarantee_date_from_file_mtime
+tracker_guarantee_title_from_file
+</SECTION>
+
+<SECTION>
 <FILE>tracker-utils</FILE>
 tracker_coalesce
 tracker_coalesce_strip
diff --git a/src/libtracker-extract/tracker-module-manager.h b/src/libtracker-extract/tracker-module-manager.h
index d2ba0d7..f11618a 100644
--- a/src/libtracker-extract/tracker-module-manager.h
+++ b/src/libtracker-extract/tracker-module-manager.h
@@ -32,6 +32,26 @@
 
 G_BEGIN_DECLS
 
+/**
+ * TrackerModuleThreadAwareness:
+ * @TRACKER_MODULE_NONE: Extractions are completed in the main event
+ * loop.
+ * @TRACKER_MODULE_MAIN_THREAD: Extractions will be dispatched in the
+ * main thread.
+ * @TRACKER_MODULE_SINGLE_THREAD: Extractions will be dispatched in a
+ * separate thread which is not the main thread. This means a new
+ * thread is created and used for all extractions with this value.
+ * @TRACKER_MODULE_MULTI_THREAD: A thread pool is used for all
+ * extractions of this module. This requires that the module is thread
+ * aware.
+ *
+ * Enumerates the different types of thread awareness which extractor
+ * modules need to be aware of. This is useful to know because it
+ * changes the way we queue and notify extractions with modules for
+ * metadata from files.
+ *
+ * Since: 0.14
+ **/
 typedef enum {
 	TRACKER_MODULE_NONE,
 	TRACKER_MODULE_MAIN_THREAD,
diff --git a/src/libtracker-extract/tracker-utils.c b/src/libtracker-extract/tracker-utils.c
index e3043e2..175f3f8 100644
--- a/src/libtracker-extract/tracker-utils.c
+++ b/src/libtracker-extract/tracker-utils.c
@@ -76,11 +76,11 @@ static const char imonths[] = {
 
 /**
  * tracker_coalesce_strip:
- * @n_values: the number of @Varargs supplied
- * @Varargs: the string pointers to coalesce
+ * @n_values: the number of @... supplied
+ * @...: the string pointers to coalesce
  *
  * This function iterates through a series of string pointers passed
- * using @Varargs and returns the first which is not %NULL, not empty
+ * using @... and returns the first which is not %NULL, not empty
  * (i.e. "") and not comprised of one or more spaces (i.e. " ").
  *
  * The returned value is stripped using g_strstrip(). It is MOST
@@ -117,13 +117,14 @@ tracker_coalesce_strip (gint n_values,
 }
 
 // LCOV_EXCL_START
+
 /**
  * tracker_coalesce:
  * @n_values: the number of @Varargs supplied
- * @Varargs: the string pointers to coalesce
+ * @...: the string pointers to coalesce
  *
  * This function iterates through a series of string pointers passed
- * using @Varargs and returns the first which is not %NULL, not empty
+ * using @... and returns the first which is not %NULL, not empty
  * (i.e. "") and not comprised of one or more spaces (i.e. " ").
  *
  * The returned value is stripped using g_strstrip(). All other values
@@ -168,11 +169,11 @@ tracker_coalesce (gint n_values,
 /**
  * tracker_merge_const:
  * @delimiter: the delimiter to use when merging
- * @n_values: the number of @Varargs supplied
- * @Varargs: the string pointers to merge
+ * @n_values: the number of @... supplied
+ * @...: the string pointers to merge
  *
  * This function iterates through a series of string pointers passed
- * using @Varargs and returns a newly allocated string of the merged
+ * using @... and returns a newly allocated string of the merged
  * strings.
  *
  * The @delimiter can be %NULL. If specified, it will be used in
@@ -224,11 +225,11 @@ tracker_merge_const (const gchar *delimiter,
 /**
  * tracker_merge:
  * @delimiter: the delimiter to use when merging
- * @n_values: the number of @Varargs supplied
- * @Varargs: the string pointers to merge
+ * @n_values: the number of @... supplied
+ * @...: the string pointers to merge
  *
  * This function iterates through a series of string pointers passed
- * using @Varargs and returns a newly allocated string of the merged
+ * using @... and returns a newly allocated string of the merged
  * strings. All passed strings are freed (don't pass const values)/
  *
  * The @delimiter can be %NULL. If specified, it will be used in