aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/phpbb/passwords/helper.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/helper.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/helper.php')
-rw-r--r--phpBB/phpbb/passwords/helper.php9
1 files changed, 5 insertions, 4 deletions
diff --git a/phpBB/phpbb/passwords/helper.php b/phpBB/phpbb/passwords/helper.php
index 59f0bd24ef..342dae62e6 100644
--- a/phpBB/phpbb/passwords/helper.php
+++ b/phpBB/phpbb/passwords/helper.php
@@ -22,7 +22,7 @@ class helper
/**
* Set the passwords manager instance
*
- * @param phpbb\passwords\manager $manager Crypto manager object
+ * @param phpbb\passwords\manager $manager Passwords manager object
*/
public function set_manager(\phpbb\passwords\manager $manager)
{
@@ -35,8 +35,9 @@ class helper
* @param string $hash Password hash of combined hash
*
* @return array An array containing the hash settings for the hash
- * types in successive order as described by the comined
- * password hash
+ * types in successive order as described by the combined
+ * password hash or an empty array if hash does not
+ * properly fit the combined hash format
*/
protected function get_combined_hash_settings($hash)
{
@@ -134,7 +135,7 @@ class helper
* @param string $type Data type of the supplied value
* @param string $value Value that should be put into the data array
*
- * @return string|none Return complete combined hash if type is neither
+ * @return string|null Return complete combined hash if type is neither
* 'prefix' nor 'settings', nothing if it is
*/
protected function combine_hash_output(&$data, $type, $value)