GNOME.org
 

[tracker] Add infrastructure for libtracker-miner docs.

commit 8bec0738e7091578ba21d3fb9bfbab7e82a49be7
Author: Carlos Garnacho <carlos lanedo com>
Date:   Fri Oct 2 13:37:26 2009 +0200

    Add infrastructure for libtracker-miner docs.

 configure.ac                                       |    2 +
 docs/reference/Makefile.am                         |    3 +-
 docs/reference/libtracker-miner/Makefile.am        |   73 ++++++++
 .../libtracker-miner/libtracker-miner-docs.sgml    |   42 ++++
 .../libtracker-miner/libtracker-miner-sections.txt |   48 +++++
 .../libtracker-miner/libtracker-miner.types        |    8 +
 .../libtracker-miner/tmpl/tracker-miner-fs.sgml    |  135 ++++++++++++++
 .../tmpl/tracker-miner-manager.sgml                |  176 ++++++++++++++++++
 .../libtracker-miner/tmpl/tracker-miner.sgml       |  196 ++++++++++++++++++++
 docs/reference/libtracker-miner/version.xml.in     |    1 +
 10 files changed, 683 insertions(+), 1 deletions(-)
---
diff --git a/configure.ac b/configure.ac
index 0594625..f630bdc 100644
--- a/configure.ac
+++ b/configure.ac
@@ -1391,6 +1391,8 @@ AC_CONFIG_FILES([
 	docs/reference/Makefile
 	docs/reference/libtracker-common/Makefile
 	docs/reference/libtracker-common/version.xml
+	docs/reference/libtracker-miner/Makefile
+	docs/reference/libtracker-miner/version.xml
 	filters/application/Makefile
 	filters/Makefile
 	filters/text/Makefile
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index b5ddfee..d57c1dc 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -1,5 +1,6 @@
 include $(top_srcdir)/Makefile.decl
 
 SUBDIRS = 			\
-	libtracker-common
+	libtracker-common	\
+	libtracker-miner
 
diff --git a/docs/reference/libtracker-miner/Makefile.am b/docs/reference/libtracker-miner/Makefile.am
new file mode 100644
index 0000000..bdbe041
--- /dev/null
+++ b/docs/reference/libtracker-miner/Makefile.am
@@ -0,0 +1,73 @@
+include $(top_srcdir)/Makefile.decl
+
+AUTOMAKE_OPTIONS = 1.6
+
+# The name of the module.
+DOC_MODULE=libtracker-miner
+
+# The top-level SGML file.
+DOC_MAIN_SGML_FILE=libtracker-miner-docs.sgml
+
+# Extra options to supply to gtkdoc-scan
+# SCAN_OPTIONS=--deprecated-guards="G_GNUC_DEPRECATED"
+
+# Extra options to pass to gtkdoc-scangobj
+# SCANGOBJ_OPTIONS=--type-init-func="gtk_type_init(0)" 
+
+# The directory containing the source code. Relative to $(srcdir)
+DOC_SOURCE_DIR=../../../src/libtracker-miner
+
+# Used for dependencies
+HFILE_GLOB=$(top_srcdir)/src/libtracker-miner/*.h
+CFILE_GLOB=$(top_srcdir)/src/libtracker-miner/*.c
+
+# Header files to ignore when scanning
+IGNORE_HFILES=	\
+	tracker-crawler.h	\
+	tracker-marshal.h	\
+	tracker-miner-client.h	\
+	tracker-miner-glue.h	\
+	tracker-monitor.h	\
+	tracker-utils.h
+
+# CFLAGS and LDFLAGS for compiling scan program. Only needed
+# if $(DOC_MODULE).types is non-empty.
+INCLUDES = 								\
+	-DTRACKER_COMPILATION						\
+	-I$(top_srcdir)/src						\
+	$(GLIB2_CFLAGS)							\
+	$(GIO_CFLAGS)							\
+	$(PANGO_CFLAGS)							\
+	$(HAL_CFLAGS)							\
+	$(DBUS_CFLAGS)							\
+	$(UNAC_CFLAGS)
+
+GTKDOC_LIBS =								\
+	$(top_builddir)/src/libtracker-miner/libtracker-miner.la	\
+	$(HAL_LIBS)							\
+	$(DBUS_LIBS)							\
+	$(UNAC_LIBS)							\
+	$(PANGO_LIBS)							\
+	$(GIO_LIBS)							\
+	$(GLIB2_LIBS)
+
+
+# Extra options to supply to gtkdoc-mkdb
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
+content_files =						\
+	version.xml
+
+expand_content_files =
+
+# Images to copy into HTML directory
+HTML_IMAGES =
+
+# Extra options to supply to gtkdoc-fixref
+FIXXREF_OPTIONS=
+
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+EXTRA_DIST += version.xml.in
diff --git a/docs/reference/libtracker-miner/libtracker-miner-docs.sgml b/docs/reference/libtracker-miner/libtracker-miner-docs.sgml
new file mode 100644
index 0000000..aa533ea
--- /dev/null
+++ b/docs/reference/libtracker-miner/libtracker-miner-docs.sgml
@@ -0,0 +1,42 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
+<!ENTITY tracker-miner SYSTEM "xml/tracker-miner.xml">
+<!ENTITY tracker-miner-fs SYSTEM "xml/tracker-miner-fs.xml">
+<!ENTITY tracker-miner-manager SYSTEM "xml/tracker-miner-manager.xml">
+<!ENTITY version SYSTEM "version.xml">
+]>
+<book id="index">
+  <bookinfo>
+    <title>Tracker Miner Library Reference Manual</title>
+    <releaseinfo>for libtracker-miner &version;</releaseinfo>
+  </bookinfo>
+
+  <part id="libtracker-miner">
+    <title>Overview</title>
+    <partintro>
+      <para>
+        The libtracker-miner library is the foundation for Tracker data miners,
+        these miners will extract metadata and insert it in SPARQL form to
+        tracker-store, following the Nepomuk ontology.
+      </para>
+      <para>
+      </para>
+    </partintro>
+  </part>
+
+    <chapter>
+      <title>Base abstract miner class</title>
+      &tracker-miner;
+    </chapter>
+
+    <chapter>
+      <title>Helper implementations</title>
+      &tracker-miner-fs;
+    </chapter>
+
+    <chapter>
+      <title>Managing miners</title>
+      &tracker-miner-manager;
+    </chapter>
+</book>
diff --git a/docs/reference/libtracker-miner/libtracker-miner-sections.txt b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
new file mode 100644
index 0000000..ec64de9
--- /dev/null
+++ b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
@@ -0,0 +1,48 @@
+<INCLUDE>libtracker-miner/tracker-miner.h</INCLUDE>
+<SECTION>
+<FILE>tracker-miner</FILE>
+<TITLE>Tracker Miner</TITLE>
+TrackerMiner
+TrackerMinerClass
+tracker_miner_error_quark
+tracker_miner_start
+tracker_miner_stop
+tracker_miner_is_started
+tracker_miner_execute_update
+tracker_miner_execute_sparql
+tracker_miner_execute_batch_update
+tracker_miner_commit
+tracker_miner_pause
+tracker_miner_resume
+</SECTION>
+
+<INCLUDE>libtracker-miner/tracker-miner-fs.h</INCLUDE>
+<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
+</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
+tracker_miner_manager_pause
+tracker_miner_manager_resume
+tracker_miner_manager_is_active
+tracker_miner_manager_is_paused
+tracker_miner_manager_get_status
+tracker_miner_manager_get_display_name
+tracker_miner_manager_get_description
+</SECTION>
diff --git a/docs/reference/libtracker-miner/libtracker-miner.types b/docs/reference/libtracker-miner/libtracker-miner.types
new file mode 100644
index 0000000..1fc1e92
--- /dev/null
+++ b/docs/reference/libtracker-miner/libtracker-miner.types
@@ -0,0 +1,8 @@
+#include <libtracker-miner/tracker-miner.h>
+#include <libtracker-miner/tracker-miner-fs.h>
+#include <libtracker-miner/tracker-miner-manager.h>
+
+tracker_miner_get_type
+tracker_miner_fs_get_type
+tracker_miner_manager_get_type
+
diff --git a/docs/reference/libtracker-miner/tmpl/tracker-miner-fs.sgml b/docs/reference/libtracker-miner/tmpl/tracker-miner-fs.sgml
new file mode 100644
index 0000000..2370c4d
--- /dev/null
+++ b/docs/reference/libtracker-miner/tmpl/tracker-miner-fs.sgml
@@ -0,0 +1,135 @@
+<!-- ##### SECTION Title ##### -->
+Tracker Filesystem Miner
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### 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: 
+
+<!-- ##### ARG TrackerMinerFS:throttle ##### -->
+<para>
+
+</para>
+
+<!-- ##### TYPEDEF TrackerMinerFSClass ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### USER_FUNCTION TrackerMinerFSDoneCb ##### -->
+<para>
+
+</para>
+
+ fs: 
+ file: 
+ builder: 
+ error: 
+ user_data: 
+
+
+<!-- ##### FUNCTION tracker_miner_fs_add_directory ##### -->
+<para>
+
+</para>
+
+ fs: 
+ file: 
+ recurse: 
+
+
+<!-- ##### FUNCTION tracker_miner_fs_remove_directory ##### -->
+<para>
+
+</para>
+
+ fs: 
+ file: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_miner_fs_set_throttle ##### -->
+<para>
+
+</para>
+
+ fs: 
+ throttle: 
+
+
+<!-- ##### FUNCTION tracker_miner_fs_get_throttle ##### -->
+<para>
+
+</para>
+
+ fs: 
+ Returns: 
+
+
diff --git a/docs/reference/libtracker-miner/tmpl/tracker-miner-manager.sgml b/docs/reference/libtracker-miner/tmpl/tracker-miner-manager.sgml
new file mode 100644
index 0000000..7de904c
--- /dev/null
+++ b/docs/reference/libtracker-miner/tmpl/tracker-miner-manager.sgml
@@ -0,0 +1,176 @@
+<!-- ##### SECTION Title ##### -->
+Tracker Miner Manager
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### 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>
+
+</para>
+
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_miner_manager_get_running ##### -->
+<para>
+
+</para>
+
+ manager: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_miner_manager_get_available ##### -->
+<para>
+
+</para>
+
+ manager: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_miner_manager_pause ##### -->
+<para>
+
+</para>
+
+ manager: 
+ miner: 
+ reason: 
+ cookie: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_miner_manager_resume ##### -->
+<para>
+
+</para>
+
+ manager: 
+ miner: 
+ cookie: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_miner_manager_is_active ##### -->
+<para>
+
+</para>
+
+ manager: 
+ miner: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_miner_manager_is_paused ##### -->
+<para>
+
+</para>
+
+ manager: 
+ miner: 
+ applications: 
+ reasons: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_miner_manager_get_status ##### -->
+<para>
+
+</para>
+
+ manager: 
+ miner: 
+ status: 
+ progress: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_miner_manager_get_display_name ##### -->
+<para>
+
+</para>
+
+ manager: 
+ miner: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_miner_manager_get_description ##### -->
+<para>
+
+</para>
+
+ manager: 
+ miner: 
+ Returns: 
+
+
diff --git a/docs/reference/libtracker-miner/tmpl/tracker-miner.sgml b/docs/reference/libtracker-miner/tmpl/tracker-miner.sgml
new file mode 100644
index 0000000..7f8ba45
--- /dev/null
+++ b/docs/reference/libtracker-miner/tmpl/tracker-miner.sgml
@@ -0,0 +1,196 @@
+<!-- ##### SECTION Title ##### -->
+Tracker Miner
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### 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>
+
+<!-- ##### TYPEDEF TrackerMinerClass ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION tracker_miner_error_quark ##### -->
+<para>
+
+</para>
+
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_miner_start ##### -->
+<para>
+
+</para>
+
+ miner: 
+
+
+<!-- ##### FUNCTION tracker_miner_stop ##### -->
+<para>
+
+</para>
+
+ miner: 
+
+
+<!-- ##### FUNCTION tracker_miner_is_started ##### -->
+<para>
+
+</para>
+
+ miner: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_miner_execute_update ##### -->
+<para>
+
+</para>
+
+ miner: 
+ sparql: 
+ error: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_miner_execute_sparql ##### -->
+<para>
+
+</para>
+
+ miner: 
+ sparql: 
+ error: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_miner_execute_batch_update ##### -->
+<para>
+
+</para>
+
+ miner: 
+ sparql: 
+ error: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_miner_commit ##### -->
+<para>
+
+</para>
+
+ miner: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_miner_pause ##### -->
+<para>
+
+</para>
+
+ miner: 
+ application: 
+ reason: 
+ error: 
+ Returns: 
+
+
+<!-- ##### FUNCTION tracker_miner_resume ##### -->
+<para>
+
+</para>
+
+ miner: 
+ cookie: 
+ error: 
+ Returns: 
+
+
diff --git a/docs/reference/libtracker-miner/version.xml.in b/docs/reference/libtracker-miner/version.xml.in
new file mode 100644
index 0000000..c7e1225
--- /dev/null
+++ b/docs/reference/libtracker-miner/version.xml.in
@@ -0,0 +1 @@
+ TRACKER_VERSION@
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]