diff options
author | Sam Thursfield <sam@afuera.me.uk> | 2016-06-27 01:04:10 +0100 |
---|---|---|
committer | Sam Thursfield <sam@afuera.me.uk> | 2016-06-27 01:06:46 +0100 |
commit | cce027ab0c0d42e7e9ad138b851f4b311aca2d16 (patch) | |
tree | 5a557e80bb526cf7c69343a619d19c99d2b5404e | |
parent | a30363d26ada6eb20b65384f90a57c02df989e64 (diff) | |
download | tracker-wip/sam/resource.tar.gz |
squash! Use TrackerResource instead of TrackerSparqlBuilder in all extractorswip/sam/resource
Update libtracker-extract documentation to make it clear that the
library is private, and remove an outdated example.
We don't actually generate gtk-doc documentation for libtracker-extract
at all right now, but the existing comments should still be useful for
folk reading the code.
-rw-r--r-- | src/libtracker-extract/tracker-data.h | 61 |
1 files changed, 8 insertions, 53 deletions
diff --git a/src/libtracker-extract/tracker-data.h b/src/libtracker-extract/tracker-data.h index d2245075e..05b00dbc1 100644 --- a/src/libtracker-extract/tracker-data.h +++ b/src/libtracker-extract/tracker-data.h @@ -32,62 +32,17 @@ G_BEGIN_DECLS /** - * SECTION:tracker-data - * @title: How to use libtracker-extract - * @short_description: The essentials by example - * @stability: Stable + * SECTION:tracker-extract + * @title: libtracker-extract + * @stability: Unstable * @include: libtracker-extract/tracker-extract.h * - * The libtracker-extract library is the foundation for Tracker - * metadata extraction of embedded data in files. + * The libtracker-extract library is an internal, private library for Tracker + * metadata extraction modules. Third party applications should not link + * against libtracker-extract, because its API may change at any time. * - * Tracker comes with extractors written for the most common file - * types (like MP3, JPEG, PNG, etc.), however, for more special cases, - * 3rd party applications may want to write their own plugin to - * extract their own file formats. This documentation describes how to - * do that. - * - * <example> - * <title>Basic extractor example</title> - * An example of how to write an extractor to retrieve PNG embedded - * metadata. - * FIXME: rewrite with TrackerResource! - * <programlisting> - * G_MODULE_EXPORT gboolean - * tracker_extract_get_metadata (TrackerExtractInfo *info) - * { - * GFile *file; - * TrackerSparqlBuilder *metadata; - * gint height, width; - * - * file = tracker_extract_info_get_file (info); - * metadata = tracker_extract_info_get_metadata_builder (info); - * - * /* Do data extraction. */ - * height = ... - * width = ... - * - * /* Insert data into TrackerSparqlBuilder object. */ - * tracker_sparql_builder_predicate (metadata, "a"); - * tracker_sparql_builder_object (metadata, "nfo:Image"); - * tracker_sparql_builder_object (metadata, "nmm:Photo"); - * - * tracker_sparql_builder_predicate (metadata, "nfo:width"); - * tracker_sparql_builder_object_int64 (metadata, width); - * - * tracker_sparql_builder_predicate (metadata, "nfo:height"); - * tracker_sparql_builder_object_int64 (metadata, height); - * - * /* Were we successful or not? */ - * return TRUE; - * } - * </programlisting> - * </example> - * - * NOTE: This example has changed subtly since 0.10. For details see - * tracker_extract_get_metadata(). - * - * Since: 0.12 + * If you want to insert metadata into the Tracker store from a 3rd party + * application, look at the TrackerDecorator class from libtracker-miner. */ gboolean tracker_extract_module_init (TrackerModuleThreadAwareness *thread_awareness_ret, |