diff options
| author | Martyn Russell <martyn@lanedo.com> | 2014-06-04 13:20:02 +0100 |
|---|---|---|
| committer | Martyn Russell <martyn@lanedo.com> | 2014-08-12 19:45:30 +0100 |
| commit | b7415f18913c0b4d52d599abf5e9cf006cb1c62f (patch) | |
| tree | a0114399345b3bab7ea19bab741115691d749c69 /docs | |
| parent | 5959909d97f15fd5fd749d0d0001bca347bd9c3e (diff) | |
| download | tracker-b7415f18913c0b4d52d599abf5e9cf006cb1c62f.tar.gz | |
libtracker-miner: Update all documentation around TrackerEnumerator interface
Including:
- How we use it in TrackerMinerFS
- TrackerEnumerator itself
- TrackerFileEnumerator
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/reference/libtracker-miner/libtracker-miner-docs.sgml | 2 | ||||
| -rw-r--r-- | docs/reference/libtracker-miner/libtracker-miner-sections.txt | 34 |
2 files changed, 35 insertions, 1 deletions
diff --git a/docs/reference/libtracker-miner/libtracker-miner-docs.sgml b/docs/reference/libtracker-miner/libtracker-miner-docs.sgml index 074f485bf..582c152c7 100644 --- a/docs/reference/libtracker-miner/libtracker-miner-docs.sgml +++ b/docs/reference/libtracker-miner/libtracker-miner-docs.sgml @@ -32,12 +32,14 @@ <title>Base abstract miner classes</title> <xi:include href="xml/tracker-miner-object.xml"/> <xi:include href="xml/tracker-miner-online.xml"/> + <xi:include href="xml/tracker-enumerator.xml"/> <xi:include href="xml/tracker-decorator.xml"/> </chapter> <chapter> <title>Miner classes for file system</title> <xi:include href="xml/tracker-miner-fs.xml"/> + <xi:include href="xml/tracker-file-enumerator.xml"/> <xi:include href="xml/tracker-indexing-tree.xml"/> <xi:include href="xml/tracker-decorator-fs.xml"/> </chapter> diff --git a/docs/reference/libtracker-miner/libtracker-miner-sections.txt b/docs/reference/libtracker-miner/libtracker-miner-sections.txt index cd3dd117c..f2d789274 100644 --- a/docs/reference/libtracker-miner/libtracker-miner-sections.txt +++ b/docs/reference/libtracker-miner/libtracker-miner-sections.txt @@ -30,7 +30,7 @@ tracker_indexing_tree_get_type <SECTION> <FILE>tracker-miner</FILE> - +TrackerMinerError </SECTION> <SECTION> @@ -216,3 +216,35 @@ TRACKER_IS_DECORATOR_FS TRACKER_IS_DECORATOR_FS_CLASS TRACKER_TYPE_DECORATOR_FS </SECTION> + +<SECTION> +<FILE>tracker-enumerator</FILE> +<TITLE>TrackerEnumerator</TITLE> +TrackerEnumeratorIface +tracker_enumerator_get_children +tracker_enumerator_get_children_async +tracker_enumerator_get_children_finish +TrackerEnumerator +<SUBSECTION Standard> +TRACKER_ENUMERATOR +TRACKER_ENUMERATOR_GET_IFACE +TRACKER_IS_ENUMERATOR +TRACKER_TYPE_ENUMERATOR +tracker_enumerator_get_type +</SECTION> + +<SECTION> +<FILE>tracker-file-enumerator</FILE> +<TITLE>TrackerFileEnumerator</TITLE> +tracker_file_enumerator_new +<SUBSECTION Standard> +TRACKER_FILE_ENUMERATOR +TRACKER_FILE_ENUMERATOR_CLASS +TRACKER_FILE_ENUMERATOR_GET_CLASS +TRACKER_IS_FILE_ENUMERATOR +TRACKER_IS_FILE_ENUMERATOR_CLASS +TRACKER_TYPE_FILE_ENUMERATOR +TrackerFileEnumerator +TrackerFileEnumeratorClass +tracker_file_enumerator_get_type +</SECTION> |