From a0243a8b74df613c05ba7fd86410f9c1c3575bfe Mon Sep 17 00:00:00 2001
From: Matthias Clasen <mclasen@redhat.com>
Date: Thu, 4 Feb 2010 23:09:56 -0500
Subject: [PATCH 04/22] Document the CanRestart and CanStop methods

---
 src/org.freedesktop.ConsoleKit.Manager.xml |   48 ++++++++++++++++++++++++++-
 1 files changed, 46 insertions(+), 2 deletions(-)

diff --git a/src/org.freedesktop.ConsoleKit.Manager.xml b/src/org.freedesktop.ConsoleKit.Manager.xml
index f903b55..1375174 100644
--- a/src/org.freedesktop.ConsoleKit.Manager.xml
+++ b/src/org.freedesktop.ConsoleKit.Manager.xml
@@ -15,7 +15,29 @@
 
     <method name="CanRestart">
       <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
-      <arg name="can_restart" type="b" direction="out"/>
+      <arg name="can_restart" type="b" direction="out">
+        <doc:doc>
+          <doc:summary>
+            Whether restarting is allowed. 0 means 'no', 2 means 'yes', and
+            1 means that the user may have to prove that he has the necessary
+            privileges
+          </doc:summary>
+        </doc:doc>
+      </arg>
+      <doc:doc>
+        <doc:description>
+          <doc:para>
+            This method returns information about whether the caller
+            is allowed to restart the system using the <doc:ref type="method"
+            to="Manager.Restart">Restart()</doc:ref> method.
+          </doc:para>
+          <doc:para>
+            This method will not cause any user interaction. It should be
+            used when deciding whether it is useful to present a "Restart"
+            option to the user.
+          </doc:para>
+        </doc:description>
+      </doc:doc>
     </method>
 
     <method name="Stop">
@@ -29,7 +51,29 @@
 
     <method name="CanStop">
       <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
-      <arg name="can_stop" type="b" direction="out"/>
+      <arg name="can_stop" type="b" direction="out">
+        <doc:doc>
+          <doc:summary>
+            Whether stopping is allowed. 0 means 'no', 2 means 'yes', and
+            1 means that the user may have to prove that he has the necessary
+            privileges
+          </doc:summary>
+        </doc:doc>
+      </arg>
+      <doc:doc>
+        <doc:description>
+          <doc:para>
+            This method returns information about whether the caller
+            is allowed to stop the system using the <doc:ref type="method"
+            to="Manager.Stop">Stop()</doc:ref> method.
+          </doc:para>
+          <doc:para>
+            This method will not cause any user interaction. It should be
+            used when deciding whether it is useful to present a "Stop"
+            option to the user.
+          </doc:para>
+        </doc:description>
+      </doc:doc>
     </method>
 
     <method name="OpenSession">
-- 
1.6.6