[ekg2-commit] ekg2: sessions.h (HEAD) [peres]

[CVS commit]

Module name:	ekg2
Changes by:	peres	2007-05-01 13:57:22

Modified files:
	sessions.h

Log message:
Doc on session_t.

Index: sessions.h
===================================================================
RCS file: /home/cvs/ekg2/ekg/sessions.h,v
diff -d -u -r1.37 -r1.38
--- sessions.h	27 Apr 2007 12:30:52 -0000	1.37
+++ sessions.h	1 May 2007 11:57:22 -0000	1.38
@@ -29,33 +29,36 @@
 	char *value;			/* wartość parametru */
 } session_param_t;
 
+/**
+ * session_t contains all information about session
+ */
 typedef struct {
 	/* public: */
-	void *plugin;
-	char *uid;			/* id użytkownika */
-	char *alias;			/* alias sesji */
-	void *priv;			/* dla plugina obsługującego sesję */
-	list_t userlist;		/* userlista */
+	void *plugin;			/**< protocol plugin owing session */
+	char *uid;			/**< user ID */
+	char *alias;			/**< short name */
+	void *priv;			/**< protocol plugin's private data */
+	list_t userlist;		/**< session's userlist */
 
 	/* private: */
-	int status;			/* stan sesji */
-	char *descr;			/* opis stanu sesji */
-	char *password;
-	int connected;			/* czy sesja jest połączona? */
-	int activity;			/* kiedy ostatnio coś się działo? */
-	int autoaway;			/* jesteśmy w autoawayu? */
+	int status;			/**< session's user status */
+	char *descr;			/**< session's user description */
+	char *password;			/**< session's account password */
+	int connected;			/**< whether session is connected */
+	int activity;			/**< timestamp of last activity */
+	int autoaway;			/**< whether we're in autoaway */
 	int scroll_last;
 	int scroll_pos;
 	int scroll_op;
-	time_t last_conn;               /* kiedy się połączyliśmy */
+	time_t last_conn;               /**< timestamp of connecting */
 
 	int global_vars_count;
 	char **values;
 	list_t local_vars;
 	
 	/* new auto-away */
-	int laststatus;
-	char *lastdescr;
+	int laststatus;			/**< user's status before going into autoaway */
+	char *lastdescr;		/**< user's description before going into autoaway */
 } session_t;
 
 #ifndef EKG2_WIN32_NOFUNCTION