From 9c19c1437f8dc993665763515305a92ce873a97c Mon Sep 17 00:00:00 2001
From: Richard Hughes <richard@hughsie.com>
Date: Fri, 15 Aug 2008 11:40:57 +0100
Subject: [PATCH] document the output of the Device.GetStatistics() method

---
 ...org.freedesktop.DeviceKit.Power.Device.xml | 26 ++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)

diff --git a/src/org.freedesktop.DeviceKit.Power.Device.xml b/src/org.freedesktop.DeviceKit.Power.Device.xml
index 74560f0..b8d8711 100644
--- a/src/org.freedesktop.DeviceKit.Power.Device.xml
+++ b/src/org.freedesktop.DeviceKit.Power.Device.xml
@@ -59,7 +59,31 @@
         <doc:doc><doc:summary>The amount of data to return in seconds, or 0 for all.</doc:summary></doc:doc>
       </arg>
       <arg name="data" direction="out" type="a(uds)">
-        <doc:doc><doc:summary>The data for the power device.</doc:summary></doc:doc>
+        <doc:doc><doc:summary>
+            The statistics data for the power device. Each element contains
+            the following members:
+            <doc:list>
+              <doc:item>
+                <doc:term>time</doc:term>
+                <doc:definition>
+                  The time value in seconds from the <literal>gettimeofday()</literal> method.
+                </doc:definition>
+              </doc:item>
+              <doc:item>
+                <doc:term>value</doc:term>
+                <doc:definition>
+                  The data value, for instance the rate in W or the charge in %.
+                </doc:definition>
+              </doc:item>
+              <doc:item>
+                <doc:term>state</doc:term>
+                <doc:definition>
+                  The state of the device, for instance <literal>charging</literal> or
+                  <literal>discharging</literal>.
+                </doc:definition>
+              </doc:item>
+            </doc:list>
+        </doc:summary></doc:doc>
       </arg>
       <doc:doc>
         <doc:description>