GNOME.org
 

tracker r2306 - in trunk: . docs/reference/libtracker-common src/libtracker-common

Author: carlosg
Date: Fri Oct  3 14:59:38 2008
New Revision: 2306
URL: http://svn.gnome.org/viewvc/tracker?rev=2306&view=rev

Log:
2008-10-03  Carlos Garnacho  <carlos imendio com>

        * src/libtracker-common/tracker-hal.c:
        * src/libtracker-common/tracker-field.c: Add some docs.

        * docs/reference/libtracker-common/libtracker-common-sections.txt:
        Make gtk-doc interpret GObjects as such. Finish correctly the
        "SECTION" tag so gtk-doc also dumps output for TrackerField and
        TrackerFieldData.

        * docs/reference/libtracker-common/libtracker-common-docs.sgml: Add
        the sections for TrackerField and TrackerFieldData.

        * docs/reference/libtracker-common/Makefile.am: Fixes to compile the
        docs scanner.


Modified:
   trunk/ChangeLog
   trunk/docs/reference/libtracker-common/Makefile.am
   trunk/docs/reference/libtracker-common/libtracker-common-docs.sgml
   trunk/docs/reference/libtracker-common/libtracker-common-sections.txt
   trunk/src/libtracker-common/tracker-field.c
   trunk/src/libtracker-common/tracker-hal.c

Modified: trunk/docs/reference/libtracker-common/Makefile.am
==============================================================================
--- trunk/docs/reference/libtracker-common/Makefile.am	(original)
+++ trunk/docs/reference/libtracker-common/Makefile.am	Fri Oct  3 14:59:38 2008
@@ -37,6 +37,7 @@
 
 GTKDOC_LIBS =						\
 	$(top_builddir)/src/libstemmer/libstemmer.la	\
+	$(top_builddir)/src/libtracker-common/libtracker-common.la	\
 	$(HAL_LIBS)					\
 	$(DBUS_LIBS)					\
 	$(UNAC_LIBS)					\

Modified: trunk/docs/reference/libtracker-common/libtracker-common-docs.sgml
==============================================================================
--- trunk/docs/reference/libtracker-common/libtracker-common-docs.sgml	(original)
+++ trunk/docs/reference/libtracker-common/libtracker-common-docs.sgml	Fri Oct  3 14:59:38 2008
@@ -51,6 +51,8 @@
       <title>Ontology</title>
       &tracker-ontology;
       &tracker-service;
+      &tracker-field;
+      &tracker-field-data;
     </chapter>
 
     <chapter>

Modified: trunk/docs/reference/libtracker-common/libtracker-common-sections.txt
==============================================================================
--- trunk/docs/reference/libtracker-common/libtracker-common-sections.txt	(original)
+++ trunk/docs/reference/libtracker-common/libtracker-common-sections.txt	Fri Oct  3 14:59:38 2008
@@ -4,7 +4,6 @@
 <TITLE>Config</TITLE>
 TrackerConfig
 tracker_config_new
-tracker_config_get_type
 tracker_config_add_crawl_directory_roots
 tracker_config_add_disabled_modules
 tracker_config_add_no_watch_directory_roots
@@ -63,6 +62,15 @@
 tracker_config_set_nfs_locking
 tracker_config_set_throttle
 tracker_config_set_verbosity
+<SUBSECTION Standard>
+TrackerConfigClass
+TRACKER_CONFIG
+TRACKER_IS_CONFIG
+TRACKER_TYPE_CONFIG
+tracker_config_get_type
+TRACKER_CONFIG_CLASS
+TRACKER_IS_CONFIG_CLASS
+TRACKER_CONFIG_GET_CLASS
 </SECTION>
 
 <INCLUDE>libtracker-common/tracker-type-utils.h</INCLUDE>
@@ -136,7 +144,6 @@
 <TITLE>Fields</TITLE>
 TrackerField
 tracker_field_new
-tracker_field_get_type
 tracker_field_append_child_id
 tracker_field_get_child_ids
 tracker_field_get_data_type
@@ -160,16 +167,25 @@
 tracker_field_set_name
 tracker_field_set_store_metadata
 tracker_field_set_weight
-tracker_field_type_get_type
 tracker_field_type_to_string
-<SECTION>
+<SUBSECTION Standard>
+TRACKER_FIELD
+TRACKER_IS_FIELD
+TRACKER_TYPE_FIELD
+tracker_field_get_type
+TRACKER_FIELD_CLASS
+TRACKER_IS_FIELD_CLASS
+TRACKER_FIELD_GET_CLASS
+TRACKER_TYPE_FIELD_TYPE
+tracker_field_type_get_type
+</SECTION>
 
 <INCLUDE>libtracker-common/tracker-field-data.h</INCLUDE>
 <SECTION>
 <FILE>tracker-field-data</FILE>
 <TITLE>Field Data</TITLE>
+TrackerFieldData
 tracker_field_data_new
-tracker_field_data_get_type
 tracker_field_data_get_alias
 tracker_field_data_get_data_type
 tracker_field_data_get_field_name
@@ -192,7 +208,15 @@
 tracker_field_data_set_select_field
 tracker_field_data_set_table_name
 tracker_field_data_set_where_field
-<SECTION>
+<SUBSECTION Standard>
+TRACKER_FIELD_DATA
+TRACKER_IS_FIELD_DATA
+TRACKER_TYPE_FIELD_DATA
+tracker_field_data_get_type
+TRACKER_FIELD_DATA_CLASS
+TRACKER_IS_FIELD_DATA_CLASS
+TRACKER_FIELD_DATA_GET_CLASS
+</SECTION>
 
 <INCLUDE>libtracker-common/tracker-type-utils.h</INCLUDE>
 <SECTION>
@@ -220,11 +244,19 @@
 <TITLE>HAL</TITLE>
 TrackerHal
 tracker_hal_new
-tracker_hal_get_type
 tracker_hal_get_battery_exists
 tracker_hal_get_battery_in_use
 tracker_hal_get_mounted_directory_roots
 tracker_hal_get_removable_device_roots
+<SUBSECTION Standard>
+TrackerHalClass
+TRACKER_HAL
+TRACKER_IS_HAL
+TRACKER_TYPE_HAL
+tracker_hal_get_type
+TRACKER_HAL_CLASS
+TRACKER_IS_HAL_CLASS
+TRACKER_HAL_GET_CLASS
 </SECTION>
 
 <INCLUDE>libtracker-common/tracker-ioprio.h</INCLUDE>
@@ -240,13 +272,20 @@
 <TITLE>Language</TITLE>
 TrackerLanguage
 tracker_language_new
-tracker_language_get_type
 tracker_language_check_exists
 tracker_language_get_config
 tracker_language_get_default_code
 tracker_language_get_stop_words
 tracker_language_set_config
 tracker_language_stem_word
+<SUBSECTION Standard>
+TRACKER_LANGUAGE
+TRACKER_IS_LANGUAGE
+TRACKER_TYPE_LANGUAGE
+tracker_language_get_type
+TRACKER_LANGUAGE_CLASS
+TRACKER_IS_LANGUAGE_CLASS
+TRACKER_LANGUAGE_GET_CLASS
 </SECTION>
 
 <INCLUDE>libtracker-common/tracker-log.h</INCLUDE>
@@ -345,8 +384,6 @@
 <TITLE>Service</TITLE>
 TrackerService
 tracker_service_new
-tracker_service_get_type
-tracker_db_type_get_type
 tracker_service_get_content_metadata
 tracker_service_get_db_type
 tracker_service_get_embedded
@@ -375,4 +412,12 @@
 tracker_service_set_property_prefix
 tracker_service_set_show_service_directories
 tracker_service_set_show_service_files
+<SUBSECTION Standard>
+TRACKER_SERVICE
+TRACKER_IS_SERVICE
+TRACKER_TYPE_SERVICE
+tracker_service_get_type
+TRACKER_SERVICE_CLASS
+TRACKER_IS_SERVICE_CLASS
+TRACKER_SERVICE_GET_CLASS
 </SECTION>

Modified: trunk/src/libtracker-common/tracker-field.c
==============================================================================
--- trunk/src/libtracker-common/tracker-field.c	(original)
+++ trunk/src/libtracker-common/tracker-field.c	Fri Oct  3 14:59:38 2008
@@ -386,6 +386,13 @@
 	return TRUE;
 }
 
+/**
+ * tracker_field_new:
+ *
+ * Creates a new #TrackerField instance.
+ *
+ * Returns: The newly created #TrackerField
+ **/
 TrackerField *
 tracker_field_new (void)
 {

Modified: trunk/src/libtracker-common/tracker-hal.c
==============================================================================
--- trunk/src/libtracker-common/tracker-hal.c	(original)
+++ trunk/src/libtracker-common/tracker-hal.c	Fri Oct  3 14:59:38 2008
@@ -129,8 +129,8 @@
 	g_object_class_install_property (object_class,
 					 PROP_BATTERY_IN_USE,
 					 g_param_spec_boolean ("battery-in-use",
-							       "Battery exists",
-							       "There is a battery on this machine",
+							       "Battery in use",
+							       "Whether the battery is being used",
 							       FALSE,
 							       G_PARAM_READABLE));
 
@@ -819,12 +819,27 @@
 	}
 }
 
+/**
+ * tracker_hal_new:
+ *
+ * Creates a new instance of #TrackerHal.
+ *
+ * Returns: The newly created #TrackerHal.
+ **/
 TrackerHal *
-tracker_hal_new (void)
+tracker_hal_new ()
 {
 	return g_object_new (TRACKER_TYPE_HAL, NULL);
 }
 
+/**
+ * tracker_hal_get_battery_in_use:
+ * @hal: A #TrackerHal.
+ *
+ * Returns whether the computer battery (if any) is currently in use.
+ *
+ * Returns: #TRUE if the computer is running on battery power.
+ **/
 gboolean
 tracker_hal_get_battery_in_use (TrackerHal *hal)
 {
@@ -837,6 +852,14 @@
 	return priv->battery_in_use;
 }
 
+/**
+ * tracker_hal_get_battery_exists:
+ * @hal: A #TrackerHal
+ *
+ * Returns whether the computer has batteries.
+ *
+ * Returns: #TRUE if the computer has batteries available.
+ **/
 gboolean
 tracker_hal_get_battery_exists (TrackerHal *hal)
 {
@@ -881,6 +904,15 @@
 	libhal_volume_free (volume);
 }
 
+/**
+ * tracker_hal_get_mounted_directory_roots:
+ * @hal: A #TrackerHal
+ *
+ * Returns a #GSlist of strings containing the root directories for mounted devices.
+ * Each element must be freed using g_free() and the list itself using g_slist_free().
+ *
+ * Returns: The list of root directories.
+ **/
 GSList *
 tracker_hal_get_mounted_directory_roots (TrackerHal *hal)
 {
@@ -901,6 +933,15 @@
 	return gr.roots;
 }
 
+/**
+ * tracker_hal_get_removable_device_roots:
+ * @hal: A #TrackerHal
+ *
+ * Returns a #GSList of strings containing the root directories for removable devices.
+ * Each element must be freed using g_free() and the list itself through g_slist_free().
+ *
+ * Returns: The list of root directories.
+ **/
 GSList *
 tracker_hal_get_removable_device_roots (TrackerHal *hal)
 {
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]