trivial: add some more gtk-doc markup to the new objects

6 files changed, 51 insertions, 11 deletions

diff --git a/libupower-glib/up-history-item.c b/libupower-glib/up-history-item.c
index fb547c0..604b244 100644
--- a/libupower-glib/up-history-item.c
+++ b/libupower-glib/up-history-item.c
@@ -19,6 +19,16 @@
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:up-history-item
+ * @short_description: Helper object representing one item of historical data.
+ *
+ * This object represents one item of data which may be returned from the
+ * daemon in response to a query.
+ *
+ * See also: #UpDevice, #UpClient
+ */
+
 #include "config.h"
 
 #include <glib.h>
diff --git a/libupower-glib/up-qos-item.c b/libupower-glib/up-qos-item.c
index 5867f37..1bd5f24 100644
--- a/libupower-glib/up-qos-item.c
+++ b/libupower-glib/up-qos-item.c
@@ -19,6 +19,16 @@
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:up-qos-item
+ * @short_description: Helper object representing one item of QOS data.
+ *
+ * This object represents one item of data which may be returned from the
+ * daemon in response to a query.
+ *
+ * See also: #UpDevice, #UpClient
+ */
+
 #include "config.h"
 
 #include <glib.h>
@@ -545,7 +555,7 @@ up_qos_item_class_init (UpQosItemClass *klass)
 	g_object_class_install_property (object_class,
 					 PROP_TYPE,
 					 g_param_spec_uint ("type", NULL, NULL,
-							    0, G_MAXUINT, UP_QOS_TYPE_UNKNOWN,
+							    0, G_MAXUINT, UP_QOS_KIND_UNKNOWN,
 							    G_PARAM_READWRITE));
 	/**
 	 * UpQosItem:value:
@@ -577,7 +587,7 @@ up_qos_item_init (UpQosItem *qos_item)
 	qos_item->priv->cookie = 0;
 	qos_item->priv->timespec = 0;
 	qos_item->priv->persistent = FALSE;
-	qos_item->priv->type = UP_QOS_TYPE_UNKNOWN;
+	qos_item->priv->type = UP_QOS_KIND_UNKNOWN;
 	qos_item->priv->value = 0;
 }
 
diff --git a/libupower-glib/up-stats-item.c b/libupower-glib/up-stats-item.c
index 291b7de..786f185 100644
--- a/libupower-glib/up-stats-item.c
+++ b/libupower-glib/up-stats-item.c
@@ -19,6 +19,16 @@
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:up-stats-item
+ * @short_description: Helper object representing one item of statistics data.
+ *
+ * This object represents one item of data which may be returned from the
+ * daemon in response to a query.
+ *
+ * See also: #UpDevice, #UpClient
+ */
+
 #include "config.h"
 
 #include <glib.h>
diff --git a/libupower-glib/up-types.c b/libupower-glib/up-types.c
index f7e24ed..8663cbd 100644
--- a/libupower-glib/up-types.c
+++ b/libupower-glib/up-types.c
@@ -261,9 +261,9 @@ up_device_technology_from_string (const gchar *technology)
 const gchar *
 up_qos_kind_to_string (UpQosKind type)
 {
-	if (type == UP_QOS_TYPE_NETWORK)
+	if (type == UP_QOS_KIND_NETWORK)
 		return "network";
-	if (type == UP_QOS_TYPE_CPU_DMA)
+	if (type == UP_QOS_KIND_CPU_DMA)
 		return "cpu_dma";
 	return NULL;
 }
@@ -281,9 +281,9 @@ UpQosKind
 up_qos_kind_from_string (const gchar *type)
 {
 	if (g_strcmp0 (type, "network") == 0)
-		return UP_QOS_TYPE_NETWORK;
+		return UP_QOS_KIND_NETWORK;
 	if (g_strcmp0 (type, "cpu_dma") == 0)
-		return UP_QOS_TYPE_CPU_DMA;
-	return UP_QOS_TYPE_UNKNOWN;
+		return UP_QOS_KIND_CPU_DMA;
+	return UP_QOS_KIND_UNKNOWN;
 }
 
diff --git a/libupower-glib/up-types.h b/libupower-glib/up-types.h
index 607fe18..a5a54e6 100644
--- a/libupower-glib/up-types.h
+++ b/libupower-glib/up-types.h
@@ -86,10 +86,10 @@ typedef enum {
  * The type of QOS request.
  **/
 typedef enum {
-	UP_QOS_TYPE_UNKNOWN,
-	UP_QOS_TYPE_NETWORK,
-	UP_QOS_TYPE_CPU_DMA,
-	UP_QOS_TYPE_LAST
+	UP_QOS_KIND_UNKNOWN,
+	UP_QOS_KIND_NETWORK,
+	UP_QOS_KIND_CPU_DMA,
+	UP_QOS_KIND_LAST
 } UpQosKind;
 
 const gchar	*up_device_kind_to_string		(UpDeviceKind		 type_enum);
diff --git a/libupower-glib/up-wakeup-item.c b/libupower-glib/up-wakeup-item.c
index 58e40b4..91413b1 100644
--- a/libupower-glib/up-wakeup-item.c
+++ b/libupower-glib/up-wakeup-item.c
@@ -19,6 +19,16 @@
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:up-wakeup-item
+ * @short_description: Helper object representing one item of wakeup data.
+ *
+ * This object represents one item of data which may be returned from the
+ * daemon in response to a query.
+ *
+ * See also: #UpDevice, #UpClient
+ */
+
 #include "config.h"
 
 #include <glib.h>