Disable Special:Sitesettings, as it is far far far from working.

[lhc/web/wiklou.git] / includes / MemcachedSessions.php

diff --git a/includes/MemcachedSessions.php b/includes/MemcachedSessions.php
index 304cceb..af49109 100644 (file)
--- a/includes/MemcachedSessions.php
+++ b/includes/MemcachedSessions.php
@@ -1,30 +1,41 @@
 <?php
+/**
+ * This file gets included if $wgSessionsInMemcache is set in the config.
+ * It redirects session handling functions to store their data in memcached
+ * instead of the local filesystem. Depending on circumstances, it may also
+ * be necessary to change the cookie settings to work across hostnames.
+ * See: http://www.php.net/manual/en/function.session-set-save-handler.php
+ *
+ * @package MediaWiki
+ */
 
-/*
-       This file gets included if $wgSessionsInMemcache is set in the config.
-       It redirects session handling functions to store their data in memcached
-       instead of the local filesystem. Depending on circumstances, it may also
-       be necessary to change the cookie settings to work across hostnames.
-       
-       See: http://www.php.net/manual/en/function.session-set-save-handler.php
-*/
-
-
+/**
+ * @todo document
+ */
 function memsess_key( $id ) {
        global $wgDBname;
        return "$wgDBname:session:$id";
 }
 
+/**
+ * @todo document
+ */
 function memsess_open( $save_path, $session_name ) {
        # NOP, $wgMemc should be set up already
        return true;
 }
 
+/**
+ * @todo document
+ */
 function memsess_close() {
        # NOP
        return true;
 }
 
+/**
+ * @todo document
+ */
 function memsess_read( $id ) {
        global $wgMemc;
        $data = $wgMemc->get( memsess_key( $id ) );
@@ -32,18 +43,27 @@ function memsess_read( $id ) {
        return $data;
 }
 
+/**
+ * @todo document
+ */
 function memsess_write( $id, $data ) {
        global $wgMemc;
        $wgMemc->set( memsess_key( $id ), $data, 3600 );
        return true;
 }
 
+/**
+ * @todo document
+ */
 function memsess_destroy( $id ) {
        global $wgMemc;
        $wgMemc->delete( memsess_key( $id ) );
        return true;
 }
 
+/**
+ * @todo document
+ */
 function memsess_gc( $maxlifetime ) {
        # NOP: Memcached performs garbage collection.
        return true;