Updating branch refs/heads/kelnos/new-sm-client
to e44458a1e205dbec1f42a0433e139929392c2805 (commit)
from 44db1a6572d7078ed00e9625a1aefc47f85e9854 (commit)
commit e44458a1e205dbec1f42a0433e139929392c2805
Author: Brian J. Tarricone <br...@tarricone.org>
Date: Wed Sep 16 22:57:38 2009 -0700
clean up docs, move stuff out of template and into .c file
docs/libxfce4ui-sections.txt | 2 -
docs/tmpl/libxfce4ui-unused.sgml | 29 ++++++++++
docs/tmpl/xfce-sm-client.sgml | 114 +++++++------------------------------
libxfce4ui/xfce-sm-client.c | 59 +++++++++++++++++++
4 files changed, 110 insertions(+), 94 deletions(-)
diff --git a/docs/libxfce4ui-sections.txt b/docs/libxfce4ui-sections.txt
index b4427ae..27a108c 100644
--- a/docs/libxfce4ui-sections.txt
+++ b/docs/libxfce4ui-sections.txt
@@ -77,7 +77,6 @@ XfceSMClient
XfceSMClientPriority
XfceSMClientRestartStyle
XfceSMClientShutdownHint
-XfceSMClientState
xfce_sm_client_get_option_group
xfce_sm_client_get
xfce_sm_client_get_with_argv
@@ -87,7 +86,6 @@ xfce_sm_client_disconnect
xfce_sm_client_is_resumed
xfce_sm_client_request_shutdown
xfce_sm_client_get_client_id
-xfce_sm_client_get_state
xfce_sm_client_get_state_file
xfce_sm_client_get_clone_command
xfce_sm_client_set_clone_command
diff --git a/docs/tmpl/libxfce4ui-unused.sgml b/docs/tmpl/libxfce4ui-unused.sgml
index ab23b1c..878629b 100644
--- a/docs/tmpl/libxfce4ui-unused.sgml
+++ b/docs/tmpl/libxfce4ui-unused.sgml
@@ -22,6 +22,27 @@ Common used functions to easily access Pango functions.
Xfce Pango Extensions
+<!-- ##### SIGNAL XfceSMClient::state-changed ##### -->
+<para>
+
+</para>
+
+...@xfcesmclient: the object which received the signal.
+...@arg1:
+...@arg2:
+
+<!-- ##### ARG XfceSMClient:session-connection ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG XfceSMClient:state ##### -->
+<para>
+
+</para>
+
+
<!-- ##### STRUCT XfceSMClientClass ##### -->
<para>
@@ -50,3 +71,11 @@ Xfce Pango Extensions
@underline:
@Returns:
+<!-- ##### FUNCTION xfce_sm_client_get_state ##### -->
+<para>
+
+</para>
+
+...@sm_client:
+...@returns:
+
diff --git a/docs/tmpl/xfce-sm-client.sgml b/docs/tmpl/xfce-sm-client.sgml
index c8139bd..5c40cd6 100644
--- a/docs/tmpl/xfce-sm-client.sgml
+++ b/docs/tmpl/xfce-sm-client.sgml
@@ -1,14 +1,12 @@
<!-- ##### SECTION Title ##### -->
-XfceSMClient
+
<!-- ##### SECTION Short_Description ##### -->
-Session management client
+
<!-- ##### SECTION Long_Description ##### -->
<para>
-#XfceSMClient is a session management client that speaks the X Session
-Management Protocol (XSMP). It's designed to be easy to use and hide some
-of the more esoteric feaures of XSMP from the API user.
+
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -21,7 +19,7 @@ of the more esoteric feaures of XSMP from the API user.
<!-- ##### STRUCT XfceSMClient ##### -->
<para>
-An opaque struct with only private fields.
+
</para>
@@ -62,15 +60,6 @@ An opaque struct with only private fields.
@xfcesmclient: the object which received the signal.
-<!-- ##### SIGNAL XfceSMClient::state-changed ##### -->
-<para>
-
-</para>
-
-...@xfcesmclient: the object which received the signal.
-...@arg1:
-...@arg2:
-
<!-- ##### ARG XfceSMClient:argc ##### -->
<para>
@@ -131,91 +120,41 @@ An opaque struct with only private fields.
</para>
-<!-- ##### ARG XfceSMClient:session-connection ##### -->
-<para>
-
-</para>
-
<!-- ##### ARG XfceSMClient:shutdown-command ##### -->
<para>
</para>
-<!-- ##### ARG XfceSMClient:state ##### -->
-<para>
-
-</para>
-
<!-- ##### ENUM XfceSMClientPriority ##### -->
<para>
-Some sample priority values for use with xfce_sm_client_set_priority().
+
</para>
-...@xfce_sm_client_priority_high: A relatively-high priority value. You
- probably don't want to use this.
-...@xfce_sm_client_priority_wm: A priority value for use by the window manager.
-...@xfce_sm_client_priority_core: A priority value for use by applications that
- place windows on the screen and possibly set
- window manager struts.
-...@xfce_sm_client_priority_desktop: A priority value for use by applications
- that draw on the desktop.
-...@xfce_sm_client_priority_default: A priority value for regular applications.
+...@xfce_sm_client_priority_high:
+...@xfce_sm_client_priority_wm:
+...@xfce_sm_client_priority_core:
+...@xfce_sm_client_priority_desktop:
+...@xfce_sm_client_priority_default:
<!-- ##### ENUM XfceSMClientRestartStyle ##### -->
<para>
-An enumeration describing how the session manager should restart
-the application.
+
</para>
-...@xfce_sm_client_restart_if_running: Only restart the application if it is
- still running at the end of the current
- session
-...@xfce_sm_client_restart_anyway: Always restart the application the next
- time the session starts
-...@xfce_sm_client_restart_immediately: Immediately restart the application
- if it ever quits
-...@xfce_sm_client_restart_never: Don't restart the application; after it
- runs once, remove it from the session
+...@xfce_sm_client_restart_if_running:
+...@xfce_sm_client_restart_anyway:
+...@xfce_sm_client_restart_immediately:
+...@xfce_sm_client_restart_never:
<!-- ##### ENUM XfceSMClientShutdownHint ##### -->
<para>
-Hints to the session manager what kind of shutdown the session manager
-should perform.
-</para>
-
-...@xfce_sm_client_shutdown_hint_ask: Prompt the user for a choice
-...@xfce_sm_client_shutdown_hint_logout: End the current session
-...@xfce_sm_client_shutdown_hint_halt: Shut down the computer
-...@xfce_sm_client_shutdown_hint_reboot: Restart the computer
-
-<!-- ##### ENUM XfceSMClientState ##### -->
-<para>
-Describes the various X Session Management Protocol states the client
-may be in
-</para>
-
-...@xfce_sm_client_state_idle: The application is running normally
-...@xfce_sm_client_state_saving_phase_1: The application is saving its state
-...@xfce_sm_client_state_waiting_for_phase_2: The application has requested
- an extended save state, and is
- waiting for the session manaer's
- response
-...@xfce_sm_client_state_saving_phase_2: The application is saving extended
- state information
-...@xfce_sm_client_state_waiting_for_interact: The application is waiting its
- turn to interact with the user
- during shutdown
-...@xfce_sm_client_state_interacting: The application is interacting with the
- user during shutdown
-...@xfce_sm_client_state_frozen: The application is frozen (and should not
- interact with the user) while waiting for
- further instructions from the session
- manager
-...@xfce_sm_client_state_disconnected: The application has disconnected from
- the session manager
-...@xfce_sm_client_state_registering: The application has just connected to
- the session manager and is in the
- registration phase
+
+</para>
+
+...@xfce_sm_client_shutdown_hint_ask:
+...@xfce_sm_client_shutdown_hint_logout:
+...@xfce_sm_client_shutdown_hint_halt:
+...@xfce_sm_client_shutdown_hint_reboot:
<!-- ##### FUNCTION xfce_sm_client_get_option_group ##### -->
<para>
@@ -310,15 +249,6 @@ may be in
@Returns:
-<!-- ##### FUNCTION xfce_sm_client_get_state ##### -->
-<para>
-
-</para>
-
-...@sm_client:
-...@returns:
-
-
<!-- ##### FUNCTION xfce_sm_client_get_state_file ##### -->
<para>
diff --git a/libxfce4ui/xfce-sm-client.c b/libxfce4ui/xfce-sm-client.c
index 68b2434..fa0aeb3 100644
--- a/libxfce4ui/xfce-sm-client.c
+++ b/libxfce4ui/xfce-sm-client.c
@@ -18,6 +18,18 @@
* Boston, MA 02111-1307, USA.
*/
+/**
+ * SECTION:xfce-sm-client
+ * @title: XfceSMClient
+ * @short_description: Session management client
+ * @stability: Unstable
+ * @include: libxfce4ui/libxfce4ui.h
+ *
+ * #XfceSMClient is a session management client that speaks the X Session
+ * Management Protocol (XSMP). It's designed to be easy to use and hide some
+ * of the more esoteric feaures of XSMP from the API user.
+ */
+
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
@@ -77,6 +89,53 @@ typedef enum
XFCE_SM_CLIENT_STATE_FROZEN,
} XfceSMClientState;
+/**
+ * XfceSMClientPriority:
+ * @XFCE_SM_CLIENT_PRIORITY_HIGH: A relatively-high priority value. You
+ * probably don't want to use this.
+ * @XFCE_SM_CLIENT_PRIORITY_WM: A priority value for use by the window manager.
+ * @XFCE_SM_CLIENT_PRIORITY_CORE: A priority value for use by applications that
+ * place windows on the screen and possibly set
+ * window manager struts.
+ * @XFCE_SM_CLIENT_PRIORITY_DESKTOP: A priority value for use by applications
+ * that draw on the desktop.
+ * @XFCE_SM_CLIENT_PRIORITY_DEFAULT: A priority value for regular applications.
+ *
+ * Some sample priority values for use with xfce_sm_client_set_priority().
+ **/
+
+/**
+ * XfceSMClientRestartStyle:
+ * @XFCE_SM_CLIENT_RESTART_IF_RUNNING: Only restart the application if it is
+ * still running at the end of the current
+ * session.
+ * @XFCE_SM_CLIENT_RESTART_ANYWAY: Always restart the application the next
+ * time the session starts.
+ * @XFCE_SM_CLIENT_RESTART_IMMEDIATELY: Immediately restart the application
+ * if it ever quits.
+ * @XFCE_SM_CLIENT_RESTART_NEVER: Don't restart the application; after it
+ * runs once, remove it from the session.
+ *
+ * An enumeration describing how the session manager should restart
+ * the application.
+ **/
+
+/**
+ * XfceSMClientShutdownHint:
+ * @XFCE_SM_CLIENT_SHUTDOWN_HINT_ASK: Prompt the user for a choice,
+ * @XFCE_SM_CLIENT_SHUTDOWN_HINT_LOGOUT: End the current session,
+ * @XFCE_SM_CLIENT_SHUTDOWN_HINT_HALT: Shut down the computer.
+ * @XFCE_SM_CLIENT_SHUTDOWN_HINT_REBOOT: Restart the computer.
+ *
+ * Hints to the session manager what kind of shutdown the session manager
+ * should perform.
+ **/
+
+/**
+ * XfceSMClient:
+ *
+ * An opaque struct with only private fields.
+ **/
struct _XfceSMClient
{
GObject parent;
_______________________________________________
Xfce4-commits mailing list
Xfce4-commits@xfce.org
http://foo-projects.org/mailman/listinfo/xfce4-commits
