GNOME.org
 

[tracker] docs: additional documentation fixes in libtracker-miner and libtracker-extract

commit e3b8d3d736810e09adac1eaa6a206a95954fbcdb
Author: Aleksander Morgado <aleksander lanedo com>
Date:   Thu Dec 15 14:33:22 2011 +0100

    docs: additional documentation fixes in libtracker-miner and libtracker-extract

 .../libtracker-miner/libtracker-miner-sections.txt |    3 +
 src/libtracker-extract/tracker-exif.h              |   33 ++++++++
 src/libtracker-extract/tracker-iptc.h              |   17 ++++
 src/libtracker-extract/tracker-xmp.h               |   85 +++++++++++++++++---
 src/libtracker-miner/tracker-indexing-tree.h       |   21 ++++-
 src/libtracker-miner/tracker-miner-enums.h         |   26 ++++++
 6 files changed, 169 insertions(+), 16 deletions(-)
---
diff --git a/docs/reference/libtracker-miner/libtracker-miner-sections.txt b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
index 8187902..1e692e2 100644
--- a/docs/reference/libtracker-miner/libtracker-miner-sections.txt
+++ b/docs/reference/libtracker-miner/libtracker-miner-sections.txt
@@ -1,6 +1,9 @@
 <SECTION>
 <FILE>tracker-indexing-tree</FILE>
 <TITLE>TrackerIndexingTree</TITLE>
+TrackerDirectoryFlags
+TrackerFilterType
+TrackerFilterPolicy
 TrackerIndexingTree
 TrackerIndexingTreeClass
 tracker_indexing_tree_add
diff --git a/src/libtracker-extract/tracker-exif.h b/src/libtracker-extract/tracker-exif.h
index 2d3af07..7d00711 100644
--- a/src/libtracker-extract/tracker-exif.h
+++ b/src/libtracker-extract/tracker-exif.h
@@ -28,6 +28,39 @@
 
 G_BEGIN_DECLS
 
+/**
+ * TrackerExifData:
+ * @y_dimension: Y dimension.
+ * @x_dimension: X dimension.
+ * @image_width: Image width.
+ * @document_name: Document name.
+ * @time: Time.
+ * @time_original: Original time.
+ * @artist: Artist.
+ * @user_comment: User-provided comment.
+ * @description: Description.
+ * @make: Make info.
+ * @model: Model info.
+ * @orientation: Orientation.
+ * @exposure_time: Exposure time.
+ * @fnumber: Focal ratio
+ * @flash: Flash info.
+ * @focal_length: Focal length.
+ * @iso_speed_ratings: ISO speed ratings.
+ * @metering_mode: Metering mode.
+ * @white_balance: White balance.
+ * @copyright: Copyright.
+ * @software: Software used.
+ * @x_resolution: Horizontal resolution.
+ * @y_resolution: Vertical resolution.
+ * @resolution_unit: Resolution units.
+ * @gps_altitude: GPS altitude.
+ * @gps_latitude: GPS latitude.
+ * @gps_longitude: GPS longitude.
+ * @gps_direction: GPS direction information.
+ *
+ * Structure defining EXIF data.
+ */
 typedef struct {
 	gchar *y_dimension;
 	gchar *x_dimension;
diff --git a/src/libtracker-extract/tracker-iptc.h b/src/libtracker-extract/tracker-iptc.h
index c38dc7e..534e495 100644
--- a/src/libtracker-extract/tracker-iptc.h
+++ b/src/libtracker-extract/tracker-iptc.h
@@ -30,6 +30,23 @@
 
 G_BEGIN_DECLS
 
+/**
+ * TrackerIptcData:
+ * @keywords: Keywords.
+ * @date_created: Date created.
+ * @byline: Byline.
+ * @credit: Credits.
+ * @copyright_notice: Copyright.
+ * @image_orientation: Image orientation.
+ * @byline_title: Byline title.
+ * @city: City.
+ * @state: State.
+ * @sublocation: Sublocation.
+ * @country_name: Country.
+ * @contact: Contact info.
+ *
+ * Structure defining IPTC data.
+ */
 typedef struct {
 	gchar *keywords;
 	gchar *date_created;
diff --git a/src/libtracker-extract/tracker-xmp.h b/src/libtracker-extract/tracker-xmp.h
index 5029021..ce8a2d4 100644
--- a/src/libtracker-extract/tracker-xmp.h
+++ b/src/libtracker-extract/tracker-xmp.h
@@ -29,6 +29,55 @@
 
 G_BEGIN_DECLS
 
+/**
+ * TrackerXmpData:
+ * @title: Value for the dc:title property.
+ * @rights: Value for the dc:rights property.
+ * @creator: Value for the dc:creator property.
+ * @description: Value for the dc:description property.
+ * @date: Value for the dc:date property.
+ * @keywords: Value for the dc:keywords property.
+ * @subject: Value for the dc:subject property.
+ * @publisher: Value for the dc:publisher property.
+ * @contributor: Value for the dc:contributor property.
+ * @type: Value for the dc:type property.
+ * @format: Value for the dc:format property.
+ * @identifier: Value for the dc:identifier property.
+ * @source: Value for the dc:source property.
+ * @language: Value for the dc:language property.
+ * @relation: Value for the dc:relation property.
+ * @coverage: Value for the dc:coverage property.
+ * @license: Value for the nie:license property.
+ * @pdf_title: Title of the PDF.
+ * @pdf_keywords: Keywords in the PDF.
+ * @title2: Title from the EXIF data.
+ * @time_original: Original time from the EXIF data.
+ * @artist: Artist from the EXIF data.
+ * @make: Make info from the EXIF data.
+ * @model: Model from the EXIF data.
+ * @orientation: Orientation info from the EXIF data.
+ * @flash: Flash info from the EXIF data.
+ * @metering_mode: Metering mode from the EXIF data.
+ * @exposure_time: Exposure time from the EXIF data.
+ * @fnumber: Focal ratio from the EXIF data.
+ * @focal_length: Focal length from the EXIF data.
+ * @iso_speed_ratings: ISO speed ratings from the EXIF data.
+ * @white_balance: White balance info from the EXIF data.
+ * @copyright: Copyright info from the EXIF data.
+ * @rating: Rating.
+ * @address: Address.
+ * @country: Country.
+ * @state: State.
+ * @city: City.
+ * @gps_altitude: GPS altitude.
+ * @gps_altitude_ref: GPS altitude reference.
+ * @gps_latitude: GPS latitude.
+ * @gps_longitude: GPS longitude.
+ * @gps_direction: GPS direction information.
+ * @regions: List of #TrackerXmpRegion items.
+ *
+ * Structure defining XMP data of a given file.
+ */
 typedef struct {
 	/* NS_DC */
 	gchar *title;
@@ -38,7 +87,6 @@ typedef struct {
 	gchar *date;
 	gchar *keywords;
 	gchar *subject;
-
 	gchar *publisher;
 	gchar *contributor;
 	gchar *type;
@@ -68,7 +116,6 @@ typedef struct {
 	gchar *exposure_time;
 	gchar *fnumber;
 	gchar *focal_length;
-
 	gchar *iso_speed_ratings;
 	gchar *white_balance;
 	gchar *copyright;
@@ -91,19 +138,33 @@ typedef struct {
 	gchar *gps_direction;
 
 	/* List of TrackerXmpRegion */
-        GSList *regions;
+	GSList *regions;
 } TrackerXmpData;
 
+/**
+ * TrackerXmpRegion:
+ * @title: Title of the region.
+ * @description: Description of the region.
+ * @type: Type of the region.
+ * @x: X axis position.
+ * @y: Y axis position.
+ * @width: Width.
+ * @height: Height.
+ * @link_class: Link class.
+ * @link_uri: Link URI.
+ *
+ * Structure defining data of a given region in a #TrackerXmpData.
+ */
 typedef struct {
-        gchar *title;
-        gchar *description;
-        gchar *type;
-        gchar *x;
-        gchar *y;
-        gchar *width;
-        gchar *height;
-        gchar *link_class;
-        gchar *link_uri;
+	gchar *title;
+	gchar *description;
+	gchar *type;
+	gchar *x;
+	gchar *y;
+	gchar *width;
+	gchar *height;
+	gchar *link_class;
+	gchar *link_uri;
 } TrackerXmpRegion;
 
 TrackerXmpData *tracker_xmp_new           (const gchar          *buffer,
diff --git a/src/libtracker-miner/tracker-indexing-tree.h b/src/libtracker-miner/tracker-indexing-tree.h
index ba2e8fb..65fc430 100644
--- a/src/libtracker-miner/tracker-indexing-tree.h
+++ b/src/libtracker-miner/tracker-indexing-tree.h
@@ -38,8 +38,13 @@ G_BEGIN_DECLS
 #define TRACKER_IS_INDEXING_TREE_CLASS(c)  (G_TYPE_CHECK_CLASS_TYPE ((c),    TRACKER_TYPE_INDEXING_TREE))
 #define TRACKER_INDEXING_TREE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o),  TRACKER_TYPE_INDEXING_TREE, TrackerIndexingTreeClass))
 
+/**
+ * TrackerIndexingTree:
+ *
+ * Base object used to configure indexing within #TrackerMinerFS items.
+ */
+
 typedef struct _TrackerIndexingTree TrackerIndexingTree;
-typedef struct _TrackerIndexingTreeClass TrackerIndexingTreeClass;
 
 struct _TrackerIndexingTree
 {
@@ -47,8 +52,16 @@ struct _TrackerIndexingTree
 	gpointer priv;
 };
 
-struct _TrackerIndexingTreeClass
-{
+/**
+ * TrackerIndexingTreeClass:
+ * @parent_class: parent object class
+ * @directory_added: Called when a directory is added.
+ * @directory_removed: Called when a directory is removed.
+ * @directory_updated: Called when a directory is updated.
+ *
+ * Class for the #TrackerIndexingTree.
+ */
+typedef struct {
 	GObjectClass parent_class;
 
 	void (* directory_added)   (TrackerIndexingTree *indexing_tree,
@@ -57,7 +70,7 @@ struct _TrackerIndexingTreeClass
 	                            GFile               *directory);
 	void (* directory_updated) (TrackerIndexingTree *indexing_tree,
 	                            GFile               *directory);
-};
+} TrackerIndexingTreeClass;
 
 GType                 tracker_indexing_tree_get_type (void) G_GNUC_CONST;
 
diff --git a/src/libtracker-miner/tracker-miner-enums.h b/src/libtracker-miner/tracker-miner-enums.h
index cdaf9e5..8408966 100644
--- a/src/libtracker-miner/tracker-miner-enums.h
+++ b/src/libtracker-miner/tracker-miner-enums.h
@@ -24,6 +24,17 @@
 
 G_BEGIN_DECLS
 
+/**
+ * TrackerDirectoryFlags:
+ * @TRACKER_DIRECTORY_FLAG_NONE: No flags.
+ * @TRACKER_DIRECTORY_FLAG_RECURSE: Should recurse in the directory.
+ * @TRACKER_DIRECTORY_FLAG_CHECK_MTIME: Should check mtimes of items in the directory.
+ * @TRACKER_DIRECTORY_FLAG_MONITOR: Should setup monitors in the items found in the directory.
+ * @TRACKER_DIRECTORY_FLAG_IGNORE: Should ignore the directory contents.
+ * @TRACKER_DIRECTORY_FLAG_PRESERVE: Should preserve items in the directory even if the directory gets removed.
+ *
+ * Flags used when adding a new directory to be indexed in the #TrackerIndexingTree.
+ */
 typedef enum {
 	TRACKER_DIRECTORY_FLAG_NONE        = 0,
 	TRACKER_DIRECTORY_FLAG_RECURSE     = 1 << 1,
@@ -33,12 +44,27 @@ typedef enum {
 	TRACKER_DIRECTORY_FLAG_PRESERVE    = 1 << 5
 } TrackerDirectoryFlags;
 
+/**
+ * TrackerFilterType:
+ * @TRACKER_FILTER_FILE: All files matching this filter will be filtered out.
+ * @TRACKER_FILTER_DIRECTORY: All directories matching this filter will be filtered out.
+ * @TRACKER_FILTER_PARENT_DIRECTORY: All files in directories matching this filter will be filtered out.
+ *
+ * Flags used when adding a new filter in the #TrackerIndexingTree.
+ */
 typedef enum {
 	TRACKER_FILTER_FILE,
 	TRACKER_FILTER_DIRECTORY,
 	TRACKER_FILTER_PARENT_DIRECTORY
 } TrackerFilterType;
 
+/**
+ * TrackerFilterPolicy:
+ * @TRACKER_FILTER_POLICY_DENY: Items matching the filter will be skipped.
+ * @TRACKER_FILTER_POLICY_ACCEPT: Items matching the filter will be accepted.
+ *
+ * Flags used when defining default filter policy in the #TrackerIndexingTree.
+ */
 typedef enum {
 	TRACKER_FILTER_POLICY_DENY,
 	TRACKER_FILTER_POLICY_ACCEPT
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]