[tracker] Fix up API docs for libtracker-miner.



commit 21e3115cbe6003eb4c56704ab56ed267985abdc7
Author: Carlos Garnacho <carlos lanedo com>
Date:   Thu Oct 8 14:19:59 2009 +0200

    Fix up API docs for libtracker-miner.
    
    GObject docs weren't being generated due to object and class structs not being
    added to libtracker-miner-sections.txt, also tracker_miner_fs_notify_file() has
    been added there.

 .../libtracker-miner/libtracker-miner-sections.txt |    6 +-
 .../libtracker-miner/tmpl/tracker-miner-fs.sgml    |   98 +++++++++++++++++---
 .../tmpl/tracker-miner-manager.sgml                |   54 +++++++++++
 .../libtracker-miner/tmpl/tracker-miner.sgml       |   74 +++++++++++++++-
 src/libtracker-miner/tracker-miner-fs.h            |    6 +
 src/libtracker-miner/tracker-miner-manager.h       |   10 ++
 src/libtracker-miner/tracker-miner.h               |    5 +
 7 files changed, 239 insertions(+), 14 deletions(-)
---
diff --git a/docs/reference/libtracker-miner/libtracker-miner-sections.txt b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
index e308b79..424b4bc 100644
--- a/docs/reference/libtracker-miner/libtracker-miner-sections.txt
+++ b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
@@ -2,6 +2,7 @@
 <SECTION>
 <FILE>tracker-miner</FILE>
 <TITLE>Tracker Miner</TITLE>
+TrackerMiner
 TrackerMinerClass
 tracker_miner_error_quark
 tracker_miner_start
@@ -19,18 +20,21 @@ tracker_miner_resume
 <SECTION>
 <FILE>tracker-miner-fs</FILE>
 <TITLE>Tracker Filesystem Miner</TITLE>
+TrackerMinerFS
 TrackerMinerFSClass
-TrackerMinerFSDoneCb
 tracker_miner_fs_add_directory
 tracker_miner_fs_remove_directory
 tracker_miner_fs_set_throttle
 tracker_miner_fs_get_throttle
+tracker_miner_fs_notify_file
 </SECTION>
 
 <INCLUDE>libtracker-miner/tracker-miner-manager.h</INCLUDE>
 <SECTION>
 <FILE>tracker-miner-manager</FILE>
 <TITLE>Tracker Miner Manager</TITLE>
+TrackerMinerManager
+TrackerMinerManagerClass
 tracker_miner_manager_new
 tracker_miner_manager_get_running
 tracker_miner_manager_get_available
diff --git a/docs/reference/libtracker-miner/tmpl/tracker-miner-fs.sgml b/docs/reference/libtracker-miner/tmpl/tracker-miner-fs.sgml
index ce7e551..801e88e 100644
--- a/docs/reference/libtracker-miner/tmpl/tracker-miner-fs.sgml
+++ b/docs/reference/libtracker-miner/tmpl/tracker-miner-fs.sgml
@@ -17,6 +17,82 @@ Tracker Filesystem Miner
 <!-- ##### SECTION Stability_Level ##### -->
 
 
+<!-- ##### TYPEDEF TrackerMinerFS ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SIGNAL TrackerMinerFS::check-directory ##### -->
+<para>
+
+</para>
+
+ trackerminerfs: the object which received the signal.
+ arg1: 
+ Returns: 
+
+<!-- ##### SIGNAL TrackerMinerFS::check-directory-contents ##### -->
+<para>
+
+</para>
+
+ trackerminerfs: the object which received the signal.
+ arg1: 
+ arg2: 
+ Returns: 
+
+<!-- ##### SIGNAL TrackerMinerFS::check-file ##### -->
+<para>
+
+</para>
+
+ trackerminerfs: the object which received the signal.
+ arg1: 
+ Returns: 
+
+<!-- ##### SIGNAL TrackerMinerFS::finished ##### -->
+<para>
+
+</para>
+
+ trackerminerfs: the object which received the signal.
+ arg1: 
+ arg2: 
+ arg3: 
+ arg4: 
+ arg5: 
+
+<!-- ##### SIGNAL TrackerMinerFS::monitor-directory ##### -->
+<para>
+
+</para>
+
+ trackerminerfs: the object which received the signal.
+ arg1: 
+ Returns: 
+
+<!-- ##### SIGNAL TrackerMinerFS::process-file ##### -->
+<para>
+
+</para>
+
+ trackerminerfs: the object which received the signal.
+ arg1: 
+ arg2: 
+ arg3: 
+ Returns: 
+
+<!-- ##### ARG TrackerMinerFS:process-pool-limit ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG TrackerMinerFS:throttle ##### -->
+<para>
+
+</para>
+
 <!-- ##### STRUCT TrackerMinerFSClass ##### -->
 <para>
 
@@ -30,18 +106,6 @@ Tracker Filesystem Miner
 @monitor_directory: 
 @finished: 
 
-<!-- ##### USER_FUNCTION TrackerMinerFSDoneCb ##### -->
-<para>
-
-</para>
-
- fs: 
- file: 
- builder: 
- error: 
- user_data: 
-
-
 <!-- ##### FUNCTION tracker_miner_fs_add_directory ##### -->
 <para>
 
@@ -80,3 +144,13 @@ Tracker Filesystem Miner
 @Returns: 
 
 
+<!-- ##### FUNCTION tracker_miner_fs_notify_file ##### -->
+<para>
+
+</para>
+
+ fs: 
+ file: 
+ error: 
+
+
diff --git a/docs/reference/libtracker-miner/tmpl/tracker-miner-manager.sgml b/docs/reference/libtracker-miner/tmpl/tracker-miner-manager.sgml
index cea12bc..7de904c 100644
--- a/docs/reference/libtracker-miner/tmpl/tracker-miner-manager.sgml
+++ b/docs/reference/libtracker-miner/tmpl/tracker-miner-manager.sgml
@@ -17,6 +17,60 @@ Tracker Miner Manager
 <!-- ##### SECTION Stability_Level ##### -->
 
 
+<!-- ##### TYPEDEF TrackerMinerManager ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SIGNAL TrackerMinerManager::miner-activated ##### -->
+<para>
+
+</para>
+
+ trackerminermanager: the object which received the signal.
+ arg1: 
+
+<!-- ##### SIGNAL TrackerMinerManager::miner-deactivated ##### -->
+<para>
+
+</para>
+
+ trackerminermanager: the object which received the signal.
+ arg1: 
+
+<!-- ##### SIGNAL TrackerMinerManager::miner-paused ##### -->
+<para>
+
+</para>
+
+ trackerminermanager: the object which received the signal.
+ arg1: 
+
+<!-- ##### SIGNAL TrackerMinerManager::miner-progress ##### -->
+<para>
+
+</para>
+
+ trackerminermanager: the object which received the signal.
+ arg1: 
+ arg2: 
+ arg3: 
+
+<!-- ##### SIGNAL TrackerMinerManager::miner-resumed ##### -->
+<para>
+
+</para>
+
+ trackerminermanager: the object which received the signal.
+ arg1: 
+
+<!-- ##### TYPEDEF TrackerMinerManagerClass ##### -->
+<para>
+
+</para>
+
+
 <!-- ##### FUNCTION tracker_miner_manager_new ##### -->
 <para>
 
diff --git a/docs/reference/libtracker-miner/tmpl/tracker-miner.sgml b/docs/reference/libtracker-miner/tmpl/tracker-miner.sgml
index 1415507..2b54abb 100644
--- a/docs/reference/libtracker-miner/tmpl/tracker-miner.sgml
+++ b/docs/reference/libtracker-miner/tmpl/tracker-miner.sgml
@@ -17,6 +17,79 @@ Tracker Miner
 <!-- ##### SECTION Stability_Level ##### -->
 
 
+<!-- ##### TYPEDEF TrackerMiner ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SIGNAL TrackerMiner::error ##### -->
+<para>
+
+</para>
+
+ trackerminer: the object which received the signal.
+ arg1: 
+
+<!-- ##### SIGNAL TrackerMiner::paused ##### -->
+<para>
+
+</para>
+
+ trackerminer: the object which received the signal.
+
+<!-- ##### SIGNAL TrackerMiner::progress ##### -->
+<para>
+
+</para>
+
+ trackerminer: the object which received the signal.
+ arg1: 
+ arg2: 
+
+<!-- ##### SIGNAL TrackerMiner::resumed ##### -->
+<para>
+
+</para>
+
+ trackerminer: the object which received the signal.
+
+<!-- ##### SIGNAL TrackerMiner::started ##### -->
+<para>
+
+</para>
+
+ trackerminer: the object which received the signal.
+
+<!-- ##### SIGNAL TrackerMiner::stopped ##### -->
+<para>
+
+</para>
+
+ trackerminer: the object which received the signal.
+
+<!-- ##### SIGNAL TrackerMiner::terminated ##### -->
+<para>
+
+</para>
+
+ trackerminer: the object which received the signal.
+
+<!-- ##### ARG TrackerMiner:name ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG TrackerMiner:progress ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG TrackerMiner:status ##### -->
+<para>
+
+</para>
+
 <!-- ##### STRUCT TrackerMinerClass ##### -->
 <para>
 
@@ -112,7 +185,6 @@ Tracker Miner
 </para>
 
 @miner: 
- application: 
 @reason: 
 @error: 
 @Returns: 
diff --git a/src/libtracker-miner/tracker-miner-fs.h b/src/libtracker-miner/tracker-miner-fs.h
index ccc0d68..6d933b0 100644
--- a/src/libtracker-miner/tracker-miner-fs.h
+++ b/src/libtracker-miner/tracker-miner-fs.h
@@ -40,6 +40,12 @@ G_BEGIN_DECLS
 typedef struct TrackerMinerFS        TrackerMinerFS;
 typedef struct TrackerMinerFSPrivate TrackerMinerFSPrivate;
 
+/**
+ * TrackerMinerFS:
+ *
+ * Abstract miner abstract implementation to get data
+ * from the filesystem.
+ **/
 struct TrackerMinerFS {
 	TrackerMiner parent;
 	TrackerMinerFSPrivate *private;
diff --git a/src/libtracker-miner/tracker-miner-manager.h b/src/libtracker-miner/tracker-miner-manager.h
index 466cac5..bd8f28e 100644
--- a/src/libtracker-miner/tracker-miner-manager.h
+++ b/src/libtracker-miner/tracker-miner-manager.h
@@ -35,10 +35,20 @@ G_BEGIN_DECLS
 typedef struct TrackerMinerManager TrackerMinerManager;
 typedef struct TrackerMinerManagerClass TrackerMinerManagerClass;
 
+/**
+ * TrackerMinerManager:
+ *
+ * Object to query and control miners.
+ **/
 struct TrackerMinerManager {
 	GObject parent_instance;
 };
 
+/**
+ * TrackerMinerManagerClass:
+ *
+ * #TrackerMinerManager class.
+ **/
 struct TrackerMinerManagerClass {
 	GObjectClass parent_class;
 
diff --git a/src/libtracker-miner/tracker-miner.h b/src/libtracker-miner/tracker-miner.h
index 329d9a1..3406947 100644
--- a/src/libtracker-miner/tracker-miner.h
+++ b/src/libtracker-miner/tracker-miner.h
@@ -39,6 +39,11 @@ G_BEGIN_DECLS
 typedef struct TrackerMiner TrackerMiner;
 typedef struct TrackerMinerPrivate TrackerMinerPrivate;
 
+/**
+ * TrackerMiner:
+ *
+ * Abstract miner object.
+ **/
 struct TrackerMiner {
         GObject parent_instance;
         TrackerMinerPrivate *private;



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