summaryrefslogtreecommitdiffstats
path: root/sesman/session.h
diff options
context:
space:
mode:
authorilsimo <ilsimo>2006-05-25 20:34:32 +0000
committerilsimo <ilsimo>2006-05-25 20:34:32 +0000
commit013ab3c61f5e8b72239c901c1fed608427880eb9 (patch)
tree9413d8fcecc300e1a0ee3bd5cc7fb0560387975c /sesman/session.h
parentbff658c96bdd7cf0986995ef262f363f4320e681 (diff)
downloadxrdp-proprietary-013ab3c61f5e8b72239c901c1fed608427880eb9.tar.gz
xrdp-proprietary-013ab3c61f5e8b72239c901c1fed608427880eb9.zip
updated code documentation
Diffstat (limited to 'sesman/session.h')
-rw-r--r--sesman/session.h27
1 files changed, 13 insertions, 14 deletions
diff --git a/sesman/session.h b/sesman/session.h
index 86e00a39..bc499d97 100644
--- a/sesman/session.h
+++ b/sesman/session.h
@@ -15,11 +15,16 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
+*/
- session manager
- linux only
+/**
+ *
+ * @file session.h
+ * @brief Session management definitions
+ * @author Jay Sorg, Simone Fedele
+ *
+ */
-*/
#ifndef SESSION_H
#define SESSION_H
@@ -66,8 +71,7 @@ struct session_chain
/**
*
- * finds a session matching the supplied parameters
- *
+ * @brief finds a session matching the supplied parameters
* @return session data or 0
*
*/
@@ -79,8 +83,7 @@ session_get_bydata(char* name, int width, int height, int bpp);
/**
*
- * starts a session
- *
+ * @brief starts a session
* @return 0 on error, display number if success
*
*/
@@ -90,10 +93,8 @@ session_start(int width, int height, int bpp, char* username, char* password,
/**
*
- * kills a session
- *
- * @param the id of the session to be killed
- *
+ * @brief kills a session
+ * @param pid the pid of the session to be killed
* @return
*
*/
@@ -102,10 +103,8 @@ session_kill(int pid);
/**
*
- * retrieves a session's descriptor
- *
+ * @brief retrieves a session's descriptor
* @param pid the session pid
- *
* @return a pointer to the session descriptor on success, NULL otherwise
*
*/