[tracker/libtracker-sparql-porting: 24/45] libtracker-miner: Fixed various documentation issues



commit 1927857ca69652f7076205b082ac39061369671c
Author: Martyn Russell <martyn lanedo com>
Date:   Thu Jul 22 11:23:36 2010 +0100

    libtracker-miner: Fixed various documentation issues

 docs/reference/libtracker-miner/Makefile.am        |    2 +-
 .../libtracker-miner/libtracker-miner-sections.txt |   13 ++++---------
 src/libtracker-miner/tracker-miner-object.h        |    1 -
 src/libtracker-miner/tracker-miner-web.h           |    1 +
 src/libtracker-miner/tracker-network-provider.h    |    1 +
 5 files changed, 7 insertions(+), 11 deletions(-)
---
diff --git a/docs/reference/libtracker-miner/Makefile.am b/docs/reference/libtracker-miner/Makefile.am
index 45111cf..de17927 100644
--- a/docs/reference/libtracker-miner/Makefile.am
+++ b/docs/reference/libtracker-miner/Makefile.am
@@ -46,7 +46,7 @@ INCLUDES = 								\
 
 GTKDOC_LIBS =								\
 	$(top_builddir)/src/libtracker-miner/libtracker-miner- TRACKER_API_VERSION@.la	 \
-	$(top_builddir)/src/libtracker-client/libtracker-client- TRACKER_API_VERSION@.la \
+	$(top_builddir)/src/libtracker-sparql/libtracker-sparql- TRACKER_API_VERSION@.la \
 	$(top_builddir)/src/libtracker-common/libtracker-common.la	\
 	$(DBUS_LIBS)							\
 	$(GIO_LIBS)							\
diff --git a/docs/reference/libtracker-miner/libtracker-miner-sections.txt b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
index 2e2ae06..d680bae 100644
--- a/docs/reference/libtracker-miner/libtracker-miner-sections.txt
+++ b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
@@ -43,15 +43,7 @@ tracker_miner_ignore_next_update
 tracker_miner_is_started
 tracker_miner_pause
 tracker_miner_resume
-tracker_miner_execute_update
-tracker_miner_execute_update_finish
-tracker_miner_execute_sparql
-tracker_miner_execute_sparql_finish
-tracker_miner_execute_sparql_sync
-tracker_miner_execute_batch_update
-tracker_miner_execute_batch_update_finish
-tracker_miner_commit
-tracker_miner_commit_finish
+tracker_miner_get_connection
 <SUBSECTION Standard>
 TRACKER_MINER
 TRACKER_IS_MINER
@@ -80,6 +72,8 @@ tracker_miner_fs_get_parent_urn
 tracker_miner_fs_get_urn
 tracker_miner_fs_query_urn
 tracker_miner_fs_add_directory_without_parent
+tracker_miner_fs_get_initial_crawling
+tracker_miner_fs_set_initial_crawling
 <SUBSECTION Standard>
 TRACKER_MINER_FS
 TRACKER_IS_MINER_FS
@@ -88,6 +82,7 @@ tracker_miner_fs_get_type
 TRACKER_MINER_FS_CLASS
 TRACKER_IS_MINER_FS_CLASS
 TRACKER_MINER_FS_GET_CLASS
+TRACKER_MINER_FS_GRAPH_URN
 </SECTION>
 
 <SECTION>
diff --git a/src/libtracker-miner/tracker-miner-object.h b/src/libtracker-miner/tracker-miner-object.h
index ae1292d..dc27f36 100644
--- a/src/libtracker-miner/tracker-miner-object.h
+++ b/src/libtracker-miner/tracker-miner-object.h
@@ -62,7 +62,6 @@ struct TrackerMiner {
  * @paused: Called when the miner is told to pause.
  * @resumed: Called when the miner is told to resume activity.
  * @progress: progress.
- * @error: error.
  * @ignore_next_update: Called after ignore on next update event happens.
  *
  * Virtual methods left to implement.
diff --git a/src/libtracker-miner/tracker-miner-web.h b/src/libtracker-miner/tracker-miner-web.h
index af40aa3..1b21c12 100644
--- a/src/libtracker-miner/tracker-miner-web.h
+++ b/src/libtracker-miner/tracker-miner-web.h
@@ -39,6 +39,7 @@ 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.h b/src/libtracker-miner/tracker-network-provider.h
index ad450cd..ac48822 100644
--- a/src/libtracker-miner/tracker-network-provider.h
+++ b/src/libtracker-miner/tracker-network-provider.h
@@ -37,6 +37,7 @@ 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.



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]