gnome-session r4857 - in branches/dbus_based: . gnome-session

[mccann svn gnome org]

Author: mccann
Date: Sun Jul 27 17:25:15 2008
New Revision: 4857
URL: http://svn.gnome.org/viewvc/gnome-session?rev=4857&view=rev

Log:
2008-07-27  William Jon McCann  <jmccann redhat com>

	* gnome-session/gsm-manager.h:
	* gnome-session/gsm-manager.xml:
	Add docs for logout mode.



Modified:
   branches/dbus_based/ChangeLog
   branches/dbus_based/gnome-session/gsm-manager.h
   branches/dbus_based/gnome-session/gsm-manager.xml

Modified: branches/dbus_based/gnome-session/gsm-manager.h
==============================================================================
--- branches/dbus_based/gnome-session/gsm-manager.h	(original)
+++ branches/dbus_based/gnome-session/gsm-manager.h	Sun Jul 27 17:25:15 2008
@@ -95,7 +95,7 @@
 #define GSM_MANAGER_ERROR gsm_manager_error_quark ()
 
 typedef enum {
-        GSM_MANAGER_LOGOUT_MODE_NORMAL,
+        GSM_MANAGER_LOGOUT_MODE_NORMAL = 0,
         GSM_MANAGER_LOGOUT_MODE_NO_CONFIRMATION,
         GSM_MANAGER_LOGOUT_MODE_FORCE
 } GsmManagerLogoutMode;

Modified: branches/dbus_based/gnome-session/gsm-manager.xml
==============================================================================
--- branches/dbus_based/gnome-session/gsm-manager.xml	(original)
+++ branches/dbus_based/gnome-session/gsm-manager.xml	Sun Jul 27 17:25:15 2008
@@ -168,7 +168,7 @@
       </arg>
       <doc:doc>
         <doc:description>
-          <doc:para>Cancel a previous call to Inhibit() identified by the cookie.</doc:para>
+          <doc:para>Cancel a previous call to <doc:ref type="method" to="org.gnome.SessionManager.Inhibit">Inhibit()</doc:ref> identified by the cookie.</doc:para>
         </doc:description>
       </doc:doc>
     </method>
@@ -184,12 +184,30 @@
     <method name="Logout">
       <arg name="mode" type="i" direction="in">
         <doc:doc>
-          <doc:summary>The variable name</doc:summary>
+          <doc:summary>The type of logout that is being requested</doc:summary>
         </doc:doc>
       </arg>
       <doc:doc>
         <doc:description>
           <doc:para>Request a logout dialog</doc:para>
+          <doc:para>
+            Allowed values for the mode parameter are:
+            <doc:list>
+              <doc:item>
+                <doc:term>0</doc:term>
+                <doc:definition>Normal.</doc:definition>
+              </doc:item>
+              <doc:item>
+                <doc:term>1</doc:term>
+                <doc:definition>No confirmation inferface should be shown.</doc:definition>
+              </doc:item>
+              <doc:item>
+                <doc:term>2</doc:term>
+                <doc:definition>Forcefully logout.  No confirmation will be shown and any inhibitors will be ignored.</doc:definition>
+              </doc:item>
+            </doc:list>
+            Values for flags may be bitwise or'ed together.
+          </doc:para>
         </doc:description>
       </doc:doc>
     </method>