[gnome-session] gsm: Add gtk-doc comments for two GsmClient functions



commit ebf9afaa10c7903694df5b2fee635a6dde5213a6
Author: Vincent Untz <vuntz gnome org>
Date:   Thu May 26 12:36:35 2011 +0200

    gsm: Add gtk-doc comments for two GsmClient functions
    
    This is useful to quickly know if NULL can be returned by those, instead
    of having to hunt this down in the code.

 gnome-session/gsm-client.c |   17 +++++++++++++++++
 1 files changed, 17 insertions(+), 0 deletions(-)
---
diff --git a/gnome-session/gsm-client.c b/gnome-session/gsm-client.c
index b1c3c02..37a2483 100644
--- a/gnome-session/gsm-client.c
+++ b/gnome-session/gsm-client.c
@@ -365,6 +365,16 @@ gsm_client_peek_id (GsmClient *client)
         return client->priv->id;
 }
 
+/**
+ * gsm_client_peek_app_id:
+ * @client: a #GsmClient.
+ *
+ * Note that the application ID might not be known; this happens when for XSMP
+ * clients that we did not start ourselves, for instance.
+ *
+ * Returns: the application ID of the client, or %NULL if no such ID is
+ * known. The string is owned by @client.
+ **/
 const char *
 gsm_client_peek_app_id (GsmClient *client)
 {
@@ -457,6 +467,13 @@ gsm_client_get_unix_process_id (GsmClient  *client,
         return TRUE;
 }
 
+/**
+ * gsm_client_get_app_name:
+ * @client: a #GsmClient.
+ *
+ * Returns: a copy of the application name of the client, or %NULL if no such
+ * name is known.
+ **/
 char *
 gsm_client_get_app_name (GsmClient *client)
 {



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]