[tracker] libtracker-miner: several documentation related fixes



commit f16c49f7f917a05861ebb0091c690484f7fc531c
Author: Aleksander Morgado <aleksander lanedo com>
Date:   Thu Dec 15 17:36:40 2011 +0100

    libtracker-miner: several documentation related fixes

 src/libtracker-miner/tracker-media-art.c     |    9 +++++++++
 src/libtracker-miner/tracker-miner-enums.h   |    3 ++-
 src/libtracker-miner/tracker-miner-manager.h |    4 ++--
 src/libtracker-miner/tracker-miner-object.c  |    2 +-
 src/libtracker-miner/tracker-thumbnailer.c   |    1 +
 5 files changed, 15 insertions(+), 4 deletions(-)
---
diff --git a/src/libtracker-miner/tracker-media-art.c b/src/libtracker-miner/tracker-media-art.c
index 9d6c30b..9c3c47f 100644
--- a/src/libtracker-miner/tracker-media-art.c
+++ b/src/libtracker-miner/tracker-media-art.c
@@ -29,6 +29,15 @@
 
 #include "tracker-media-art.h"
 
+/**
+ * SECTION:tracker-media-art
+ * @title: Media art management
+ * @short_description: Media art request and management.
+ * @include: libtracker-miner/tracker-media-art.h
+ *
+ * This is a convenience API using D-Bus to talk to the media management service.
+ **/
+
 static gboolean had_any = FALSE;
 static guint timer_id = 0;
 
diff --git a/src/libtracker-miner/tracker-miner-enums.h b/src/libtracker-miner/tracker-miner-enums.h
index 7405fa2..e2b978f 100644
--- a/src/libtracker-miner/tracker-miner-enums.h
+++ b/src/libtracker-miner/tracker-miner-enums.h
@@ -26,7 +26,8 @@ G_BEGIN_DECLS
 
 /**
  * SECTION:tracker-miner-enums
- * @short_description: Common types
+ * @title: Enumerations
+ * @short_description: Common enumerations
  * @include: libtracker-miner/tracker-miner-enums.h
  *
  * Common enumeration types used in libtracker-miner.
diff --git a/src/libtracker-miner/tracker-miner-manager.h b/src/libtracker-miner/tracker-miner-manager.h
index 8e25907..14e4c58 100644
--- a/src/libtracker-miner/tracker-miner-manager.h
+++ b/src/libtracker-miner/tracker-miner-manager.h
@@ -77,7 +77,7 @@ struct _TrackerMinerManager {
  * @miner_deactivated: The deactivate for all miners which indicates
  * the miner is no longer available on d-bus.
  **/
-struct _TrackerMinerManagerClass {
+typedef struct {
 	GObjectClass parent_class;
 
 	void (* miner_progress)    (TrackerMinerManager *manager,
@@ -92,7 +92,7 @@ struct _TrackerMinerManagerClass {
 	                            const gchar         *miner_name);
 	void (* miner_deactivated) (TrackerMinerManager *manager,
 	                            const gchar         *miner_name);
-};
+} TrackerMinerManagerClass;
 
 GType                tracker_miner_manager_get_type           (void) G_GNUC_CONST;
 GQuark               tracker_miner_manager_error_quark        (void) G_GNUC_CONST;
diff --git a/src/libtracker-miner/tracker-miner-object.c b/src/libtracker-miner/tracker-miner-object.c
index 5a74a48..09a2b80 100644
--- a/src/libtracker-miner/tracker-miner-object.c
+++ b/src/libtracker-miner/tracker-miner-object.c
@@ -49,7 +49,7 @@
 #endif /* MINER_STATUS_ENABLE_TRACE */
 
 /**
- * SECTION:tracker-miner
+ * SECTION:tracker-miner-object
  * @short_description: Abstract base class for data miners
  * @include: libtracker-miner/tracker-miner.h
  *
diff --git a/src/libtracker-miner/tracker-thumbnailer.c b/src/libtracker-miner/tracker-thumbnailer.c
index feb1068..f0dc6b5 100644
--- a/src/libtracker-miner/tracker-thumbnailer.c
+++ b/src/libtracker-miner/tracker-thumbnailer.c
@@ -27,6 +27,7 @@
 
 /**
  * SECTION:tracker-thumbnailer
+ * @title: Thumbnailer management
  * @short_description: Request the thumbnailer service creates or
  * updates thumbnails.
  * @include: libtracker-miner/tracker-miner.h



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