Add some docs to the sessions interface.

diff --git a/lib/public/isession.php b/lib/public/isession.php
index 5f9ce32f3b1c6407e6af51946a03d5544c27c8c3..0a77b0c823b042cef5d840bc66723bcf4adc2bea 100644 (file)
--- a/lib/public/isession.php
+++ b/lib/public/isession.php
@@ -10,34 +10,46 @@
 
 namespace OCP;
 
+/**
+ * Interface ISession
+ *
+ * wrap PHP's internal session handling into the ISession interface
+ */
 interface ISession {
+
        /**
+        * Set a value in the session
+        *
         * @param string $key
         * @param mixed $value
         */
        public function set($key, $value);
 
        /**
+        * Get a value from the session
+        *
         * @param string $key
         * @return mixed should return null if $key does not exist
         */
        public function get($key);
 
        /**
+        * Check if a named key exists in the session
+        *
         * @param string $key
         * @return bool
         */
        public function exists($key);
 
        /**
-        * should not throw any errors if $key does not exist
+        * Remove a $key/$value pair from the session
         *
         * @param string $key
         */
        public function remove($key);
 
        /**
-        * removes all entries within the cache namespace
+        * Reset and recreate the session
         */
        public function clear();