aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/phpbb/passwords/driver/driver_interface.php
diff options
context:
space:
mode:
authorMarc Alexander <admin@m-a-styles.de>2013-12-29 17:55:00 +0100
committerMarc Alexander <admin@m-a-styles.de>2013-12-29 17:55:00 +0100
commit8383d1f1d3b5f3ac12248920f7cf79d8aa6399fc (patch)
tree3ae94bfea0fc1ec44f49ebe1189d9e7983c58e60 /phpBB/phpbb/passwords/driver/driver_interface.php
parent141bef75cb924644191c90bd722a250ef60099b7 (diff)
downloadforums-8383d1f1d3b5f3ac12248920f7cf79d8aa6399fc.tar
forums-8383d1f1d3b5f3ac12248920f7cf79d8aa6399fc.tar.gz
forums-8383d1f1d3b5f3ac12248920f7cf79d8aa6399fc.tar.bz2
forums-8383d1f1d3b5f3ac12248920f7cf79d8aa6399fc.tar.xz
forums-8383d1f1d3b5f3ac12248920f7cf79d8aa6399fc.zip
[feature/passwords] Add missing documentation to docblocks
Also contains some minor spacing changes. PHPBB3-11610
Diffstat (limited to 'phpBB/phpbb/passwords/driver/driver_interface.php')
-rw-r--r--phpBB/phpbb/passwords/driver/driver_interface.php7
1 files changed, 6 insertions, 1 deletions
diff --git a/phpBB/phpbb/passwords/driver/driver_interface.php b/phpBB/phpbb/passwords/driver/driver_interface.php
index c4b57fd96e..53065dfb02 100644
--- a/phpBB/phpbb/passwords/driver/driver_interface.php
+++ b/phpBB/phpbb/passwords/driver/driver_interface.php
@@ -20,6 +20,7 @@ interface driver_interface
* @return bool True if supported, false if not
*/
public function is_supported();
+
/**
* Returns the hash prefix
*
@@ -30,7 +31,10 @@ interface driver_interface
/**
* Hash the password
*
- * @return string Password hash
+ * @param string $password The password that should be hashed
+ *
+ * @return bool|string Password hash or false if something went wrong
+ * during hashing
*/
public function hash($password);
@@ -39,6 +43,7 @@ interface driver_interface
*
* @param string $password The password to check
* @param string $hash The password hash to check against
+ *
* @return bool True if password is correct, else false
*/
public function check($password, $hash);