From ed1b1481f2c907c6dc3583fbca15212dc0ec6eb3 Mon Sep 17 00:00:00 2001
From: Alexandre Emsenhuber <ialex@users.mediawiki.org>
Date: Fri, 20 Aug 2010 21:20:18 +0000
Subject: [PATCH] Document functions

---
 includes/MemcachedSessions.php | 43 ++++++++++++++++++++++++++--------
 1 file changed, 33 insertions(+), 10 deletions(-)

diff --git a/includes/MemcachedSessions.php b/includes/MemcachedSessions.php
index e3bcea1b02..4f10f99c66 100644
--- a/includes/MemcachedSessions.php
+++ b/includes/MemcachedSessions.php
@@ -11,30 +11,42 @@
  */
 
 /**
- * @todo document
+ * Get a cache key for the given session id.
+ *
+ * @param $id String: session id
+ * @return String: cache key
  */
 function memsess_key( $id ) {
 	return wfMemcKey( 'session', $id );
 }
 
 /**
- * @todo document
+ * Callback when opening a session.
+ * NOP: $wgMemc should be set up already.
+ *
+ * @param $save_path String: path used to store session files, unused
+ * @param $session_name String: session name
+ * @return Boolean: success
  */
 function memsess_open( $save_path, $session_name ) {
-	# NOP, $wgMemc should be set up already
 	return true;
 }
 
 /**
- * @todo document
+ * Callback when closing a session.
+ * NOP.
+ *
+ * @return Boolean: success
  */
 function memsess_close() {
-	# NOP
 	return true;
 }
 
 /**
- * @todo document
+ * Callback when reading session data.
+ *
+ * @param $id String: session id
+ * @return Mixed: session data
  */
 function memsess_read( $id ) {
 	global $wgMemc;
@@ -44,7 +56,11 @@ function memsess_read( $id ) {
 }
 
 /**
- * @todo document
+ * Callback when writing session data.
+ *
+ * @param $id String: session id
+ * @param $data Mixed: session data
+ * @return Boolean: success
  */
 function memsess_write( $id, $data ) {
 	global $wgMemc;
@@ -53,19 +69,26 @@ function memsess_write( $id, $data ) {
 }
 
 /**
- * @todo document
+ * Callback to destroy a session when calling session_destroy().
+ *
+ * @param $id String: session id
+ * @return Boolean: success
  */
 function memsess_destroy( $id ) {
 	global $wgMemc;
+
 	$wgMemc->delete( memsess_key( $id ) );
 	return true;
 }
 
 /**
- * @todo document
+ * Callback to execute garbage collection.
+ * NOP: Memcached performs garbage collection.
+ *
+ * @param $maxlifetime Integer: maximum session life time
+ * @return Boolean: success
  */
 function memsess_gc( $maxlifetime ) {
-	# NOP: Memcached performs garbage collection.
 	return true;
 }
 
-- 
2.20.1