[ticket/12715] Cleanup comments in \phpbb\passwords\*

PHPBB3-12715
2025-07-30 21:40:43 +02:00 · 2014-06-15 14:46:18 +02:00
parent 52e8359497
commit 5dfb1cc66a
17 changed files with 63 additions and 63 deletions
--- a/phpBB/phpbb/passwords/driver/base.php
+++ b/phpBB/phpbb/passwords/driver/base.php
@@ -15,10 +15,10 @@ namespace phpbb\passwords\driver;

 abstract class base implements driver_interface
 {
-	/** @var phpbb\config\config */
+	/** @var \phpbb\config\config */
 	protected $config;

-	/** @var phpbb\passwords\driver\helper */
+	/** @var \phpbb\passwords\driver\helper */
 	protected $helper;

 	/** @var driver name */
@@ -37,7 +37,7 @@ abstract class base implements driver_interface
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function is_supported()
 	{
@@ -45,7 +45,7 @@ abstract class base implements driver_interface
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function is_legacy()
 	{
@@ -53,7 +53,7 @@ abstract class base implements driver_interface
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function get_settings_only($hash, $full = false)
 	{
--- a/phpBB/phpbb/passwords/driver/bcrypt.php
+++ b/phpBB/phpbb/passwords/driver/bcrypt.php
@@ -18,7 +18,7 @@ class bcrypt extends base
 	const PREFIX = '$2a$';

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function get_prefix()
 	{
@@ -26,7 +26,7 @@ class bcrypt extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function hash($password, $salt = '')
 	{
@@ -58,7 +58,7 @@ class bcrypt extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function check($password, $hash, $user_row = array())
 	{
@@ -86,7 +86,7 @@ class bcrypt extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function get_settings_only($hash, $full = false)
 	{
--- a/phpBB/phpbb/passwords/driver/bcrypt_2y.php
+++ b/phpBB/phpbb/passwords/driver/bcrypt_2y.php
@@ -18,7 +18,7 @@ class bcrypt_2y extends bcrypt
 	const PREFIX = '$2y$';

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function get_prefix()
 	{
@@ -26,7 +26,7 @@ class bcrypt_2y extends bcrypt
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function is_supported()
 	{
--- a/phpBB/phpbb/passwords/driver/bcrypt_wcf2.php
+++ b/phpBB/phpbb/passwords/driver/bcrypt_wcf2.php
@@ -20,7 +20,7 @@ class bcrypt_wcf2 extends base
 	/** @var \phpbb\passwords\driver\bcrypt */
 	protected $bcrypt;

-	/** @var phpbb\passwords\driver\helper */
+	/** @var \phpbb\passwords\driver\helper */
 	protected $helper;

 	/**
@@ -36,7 +36,7 @@ class bcrypt_wcf2 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function get_prefix()
 	{
@@ -44,7 +44,7 @@ class bcrypt_wcf2 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function is_legacy()
 	{
@@ -52,7 +52,7 @@ class bcrypt_wcf2 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function hash($password, $user_row = '')
 	{
@@ -61,7 +61,7 @@ class bcrypt_wcf2 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function check($password, $hash, $user_row = array())
 	{
--- a/phpBB/phpbb/passwords/driver/convert_password.php
+++ b/phpBB/phpbb/passwords/driver/convert_password.php
@@ -18,7 +18,7 @@ class convert_password extends base
 	const PREFIX = '$CP$';

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function get_prefix()
 	{
@@ -26,7 +26,7 @@ class convert_password extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function hash($password, $user_row = '')
 	{
@@ -34,7 +34,7 @@ class convert_password extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function check($password, $hash, $user_row = array())
 	{
--- a/phpBB/phpbb/passwords/driver/driver_interface.php
+++ b/phpBB/phpbb/passwords/driver/driver_interface.php
@@ -51,7 +51,7 @@ interface driver_interface
 	*
 	* @param string		$password The password to check
 	* @param string		$hash The password hash to check against
-	* @param string		$user_row User's row in users table
+	* @param array		$user_row User's row in users table
 	*
 	* @return bool		True if password is correct, else false
 	*/
--- a/phpBB/phpbb/passwords/driver/helper.php
+++ b/phpBB/phpbb/passwords/driver/helper.php
@@ -16,7 +16,7 @@ namespace phpbb\passwords\driver;
 class helper
 {
 	/**
-	* @var phpbb\config\config
+	* @var \phpbb\config\config
 	*/
 	protected $config;

@@ -29,7 +29,7 @@ class helper
 	/**
 	* Construct a driver helper object
 	*
-	* @param phpbb\config\config $config phpBB configuration
+	* @param \phpbb\config\config $config phpBB configuration
 	*/
 	public function __construct(\phpbb\config\config $config)
 	{
--- a/phpBB/phpbb/passwords/driver/md5_mybb.php
+++ b/phpBB/phpbb/passwords/driver/md5_mybb.php
@@ -18,7 +18,7 @@ class md5_mybb extends base
 	const PREFIX = '$md5_mybb$';

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function get_prefix()
 	{
@@ -26,7 +26,7 @@ class md5_mybb extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function is_legacy()
 	{
@@ -34,7 +34,7 @@ class md5_mybb extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function hash($password, $user_row = '')
 	{
@@ -43,7 +43,7 @@ class md5_mybb extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function check($password, $hash, $user_row = array())
 	{
--- a/phpBB/phpbb/passwords/driver/md5_phpbb2.php
+++ b/phpBB/phpbb/passwords/driver/md5_phpbb2.php
@@ -23,10 +23,10 @@ class md5_phpbb2 extends base
 	/** @var \phpbb\passwords\driver\salted_md5 */
 	protected $salted_md5;

-	/** @var phpBB root path */
+	/** @var string phpBB root path */
 	protected $phpbb_root_path;

-	/** @var php file extension */
+	/** @var string php file extension */
 	protected $php_ext;

 	/**
@@ -46,7 +46,7 @@ class md5_phpbb2 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function get_prefix()
 	{
@@ -54,7 +54,7 @@ class md5_phpbb2 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function is_legacy()
 	{
@@ -62,7 +62,7 @@ class md5_phpbb2 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function hash($password, $user_row = '')
 	{
@@ -71,7 +71,7 @@ class md5_phpbb2 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function check($password, $hash, $user_row = array())
 	{
--- a/phpBB/phpbb/passwords/driver/md5_vb.php
+++ b/phpBB/phpbb/passwords/driver/md5_vb.php
@@ -18,7 +18,7 @@ class md5_vb extends base
 	const PREFIX = '$md5_vb$';

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function get_prefix()
 	{
@@ -26,7 +26,7 @@ class md5_vb extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function is_legacy()
 	{
@@ -34,7 +34,7 @@ class md5_vb extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function hash($password, $user_row = '')
 	{
@@ -43,7 +43,7 @@ class md5_vb extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function check($password, $hash, $user_row = array())
 	{
--- a/phpBB/phpbb/passwords/driver/phpass.php
+++ b/phpBB/phpbb/passwords/driver/phpass.php
@@ -18,7 +18,7 @@ class phpass extends salted_md5
 	const PREFIX = '$P$';

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function get_prefix()
 	{
--- a/phpBB/phpbb/passwords/driver/salted_md5.php
+++ b/phpBB/phpbb/passwords/driver/salted_md5.php
@@ -46,7 +46,7 @@ class salted_md5 extends base
 	const PREFIX = '$H$';

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function get_prefix()
 	{
@@ -54,7 +54,7 @@ class salted_md5 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function is_legacy()
 	{
@@ -62,7 +62,7 @@ class salted_md5 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function hash($password, $setting = '')
 	{
@@ -98,7 +98,7 @@ class salted_md5 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function check($password, $hash, $user_row = array())
 	{
@@ -160,7 +160,7 @@ class salted_md5 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function get_settings_only($hash, $full = false)
 	{
--- a/phpBB/phpbb/passwords/driver/sha1.php
+++ b/phpBB/phpbb/passwords/driver/sha1.php
@@ -18,7 +18,7 @@ class sha1 extends base
 	const PREFIX = '$sha1$';

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function get_prefix()
 	{
@@ -26,7 +26,7 @@ class sha1 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function is_legacy()
 	{
@@ -34,7 +34,7 @@ class sha1 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function hash($password, $user_row = '')
 	{
@@ -43,7 +43,7 @@ class sha1 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function check($password, $hash, $user_row = array())
 	{
--- a/phpBB/phpbb/passwords/driver/sha1_smf.php
+++ b/phpBB/phpbb/passwords/driver/sha1_smf.php
@@ -18,7 +18,7 @@ class sha1_smf extends base
 	const PREFIX = '$smf$';

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function get_prefix()
 	{
@@ -26,7 +26,7 @@ class sha1_smf extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function is_legacy()
 	{
@@ -34,7 +34,7 @@ class sha1_smf extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function hash($password, $user_row = '')
 	{
@@ -42,7 +42,7 @@ class sha1_smf extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function check($password, $hash, $user_row = array())
 	{
--- a/phpBB/phpbb/passwords/driver/sha1_wcf1.php
+++ b/phpBB/phpbb/passwords/driver/sha1_wcf1.php
@@ -18,7 +18,7 @@ class sha1_wcf1 extends base
 	const PREFIX = '$wcf1$';

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function get_prefix()
 	{
@@ -26,7 +26,7 @@ class sha1_wcf1 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function is_legacy()
 	{
@@ -34,7 +34,7 @@ class sha1_wcf1 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function hash($password, $user_row = '')
 	{
@@ -43,7 +43,7 @@ class sha1_wcf1 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function check($password, $hash, $user_row = array())
 	{
--- a/phpBB/phpbb/passwords/driver/sha_xf1.php
+++ b/phpBB/phpbb/passwords/driver/sha_xf1.php
@@ -18,7 +18,7 @@ class sha_xf1 extends base
 	const PREFIX = '$xf1$';

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function get_prefix()
 	{
@@ -26,7 +26,7 @@ class sha_xf1 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function is_legacy()
 	{
@@ -34,7 +34,7 @@ class sha_xf1 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function hash($password, $user_row = '')
 	{
@@ -43,7 +43,7 @@ class sha_xf1 extends base
 	}

 	/**
-	* @inheritdoc
+	* {@inheritdoc}
 	*/
 	public function check($password, $hash, $user_row = array())
 	{