tracker r2667 - in trunk: . docs/reference/libtracker-module/tmpl

[carlosg svn gnome org]

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

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

        * docs/reference/libtracker-module/tmpl/tracker-module-file.sgml:
        * docs/reference/libtracker-module/tmpl/tracker-module-iteratable.sgml:
        * docs/reference/libtracker-module/tmpl/tracker-module-metadata.sgml:
        * docs/reference/libtracker-module/tmpl/tracker-module-metadata-utils.sgml:
        Add short/long descriptions and other missings docs. 100% coverage!

Added:
   trunk/docs/reference/libtracker-module/tmpl/
   trunk/docs/reference/libtracker-module/tmpl/tracker-module-file.sgml
   trunk/docs/reference/libtracker-module/tmpl/tracker-module-iteratable.sgml
   trunk/docs/reference/libtracker-module/tmpl/tracker-module-metadata-utils.sgml
   trunk/docs/reference/libtracker-module/tmpl/tracker-module-metadata.sgml
Modified:
   trunk/ChangeLog

Added: trunk/docs/reference/libtracker-module/tmpl/tracker-module-file.sgml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/libtracker-module/tmpl/tracker-module-file.sgml	Fri Dec  5 10:31:53 2008
@@ -0,0 +1,79 @@
+<!-- ##### SECTION Title ##### -->
+Module files
+
+<!-- ##### SECTION Short_Description ##### -->
+Implementation of files for Tracker modules.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+TrackerModuleFile represents a file, providing the necessary
+methods to provide information that Tracker can index. Files
+could also implement the TrackerModuleIteratable interface for
+files that could contain a set individual entities that could
+be relevant to Tracker (such as mail summaries)
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+TrackerModuleIteratable
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### TYPEDEF TrackerModuleFile ##### -->
+<para>
+Representation of a given file, used by the Tracker indexer to index contents.
+</para>
+
+
+<!-- ##### ARG TrackerModuleFile:file ##### -->
+<para>
+The GFile that corresponds to the TrackerModuleFile
+</para>
+
+<!-- ##### FUNCTION tracker_module_file_get_file ##### -->
+<para>
+
+</para>
+
+ file: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_module_file_get_service_type ##### -->
+<para>
+
+</para>
+
+ file: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_module_file_get_uri ##### -->
+<para>
+
+</para>
+
+ file: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_module_file_get_text ##### -->
+<para>
+
+</para>
+
+ file: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_module_file_get_metadata ##### -->
+<para>
+
+</para>
+
+ file: 
+ Returns: 
+
+

Added: trunk/docs/reference/libtracker-module/tmpl/tracker-module-iteratable.sgml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/libtracker-module/tmpl/tracker-module-iteratable.sgml	Fri Dec  5 10:31:53 2008
@@ -0,0 +1,45 @@
+<!-- ##### SECTION Title ##### -->
+Iteratable files
+
+<!-- ##### SECTION Short_Description ##### -->
+Interface for iteratable files which could contain several individual entities.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+TrackerModuleIteratable is an interface that can be implemented by
+TrackerModuleFile objects. It's used by Tracker so it can
+potentially iterate inside the contents of a file.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+TrackerModuleFile
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### TYPEDEF TrackerModuleIteratable ##### -->
+<para>
+Interface that can be implemented by files.
+</para>
+
+
+<!-- ##### FUNCTION tracker_module_iteratable_iter_contents ##### -->
+<para>
+
+</para>
+
+ iteratable: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_module_iteratable_get_count ##### -->
+<para>
+
+</para>
+
+ iteratable: 
+ Returns: 
+
+

Added: trunk/docs/reference/libtracker-module/tmpl/tracker-module-metadata-utils.sgml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/libtracker-module/tmpl/tracker-module-metadata-utils.sgml	Fri Dec  5 10:31:53 2008
@@ -0,0 +1,37 @@
+<!-- ##### SECTION Title ##### -->
+Metadata Convenience Fallback Functions
+
+<!-- ##### SECTION Short_Description ##### -->
+Helper functions to retrieve metadata or text for common files
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+#TrackerModuleMetadata, tracker_module_file_get_metadata() and tracker_module_file_get_text()
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### FUNCTION tracker_module_metadata_utils_get_data ##### -->
+<para>
+
+</para>
+
+ file: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_module_metadata_utils_get_text ##### -->
+<para>
+
+</para>
+
+ file: 
+ Returns: 
+
+

Added: trunk/docs/reference/libtracker-module/tmpl/tracker-module-metadata.sgml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/libtracker-module/tmpl/tracker-module-metadata.sgml	Fri Dec  5 10:31:53 2008
@@ -0,0 +1,117 @@
+<!-- ##### SECTION Title ##### -->
+Metadata Object
+
+<!-- ##### SECTION Short_Description ##### -->
+Object used to exchange metadata information between the modules and Tracker indexer
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+TrackerModuleMetadata is used by the modules to provide
+metadata information to Tracker indexer. Conceptually it's
+a hash table, where you can pile up metadata. Depending
+on the metadata type, it could store single (Email:Subject
+for example) or multiple values (like Email:CC)
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+tracker_module_file_get_metadata()
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### TYPEDEF TrackerModuleMetadata ##### -->
+<para>
+Metadata object
+</para>
+
+
+<!-- ##### FUNCTION tracker_module_metadata_new ##### -->
+<para>
+
+</para>
+
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_module_metadata_clear_field ##### -->
+<para>
+
+</para>
+
+ metadata: 
+ field_name: 
+
+
+<!-- ##### FUNCTION tracker_module_metadata_add_take_string ##### -->
+<para>
+
+</para>
+
+ metadata: 
+ field_name: 
+ value: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_module_metadata_add_string ##### -->
+<para>
+
+</para>
+
+ metadata: 
+ field_name: 
+ value: 
+
+
+<!-- ##### FUNCTION tracker_module_metadata_add_int ##### -->
+<para>
+
+</para>
+
+ metadata: 
+ field_name: 
+ value: 
+
+
+<!-- ##### FUNCTION tracker_module_metadata_add_uint ##### -->
+<para>
+
+</para>
+
+ metadata: 
+ field_name: 
+ value: 
+
+
+<!-- ##### FUNCTION tracker_module_metadata_add_double ##### -->
+<para>
+
+</para>
+
+ metadata: 
+ field_name: 
+ value: 
+
+
+<!-- ##### FUNCTION tracker_module_metadata_add_float ##### -->
+<para>
+
+</para>
+
+ metadata: 
+ field_name: 
+ value: 
+
+
+<!-- ##### FUNCTION tracker_module_metadata_add_date ##### -->
+<para>
+
+</para>
+
+ metadata: 
+ field_name: 
+ value: 
+
+