[ticket/289] Fix scrutinizer documentation issues

This commit is contained in:
Marc Alexander
2014-07-23 23:21:39 +02:00
parent 7732c23e3d
commit 2692429e82
16 changed files with 42 additions and 42 deletions

View File

@@ -56,10 +56,10 @@ class attachments extends module_base
/** @var \phpbb\db\driver */ /** @var \phpbb\db\driver */
protected $db; protected $db;
/** @var php file extension */ /** @var string PHP file extension */
protected $php_ext; protected $php_ext;
/** @var phpbb root path */ /** @var string phpBB root path */
protected $phpbb_root_path; protected $phpbb_root_path;
/** @var \phpbb\user */ /** @var \phpbb\user */

View File

@@ -64,25 +64,25 @@ class calendar extends module_base
const DAYS_PER_WEEK = 6; // indexes start at 0 const DAYS_PER_WEEK = 6; // indexes start at 0
const MONTHS_PER_YEAR = 12; const MONTHS_PER_YEAR = 12;
/** @var year in numeric format (YYYY) */ /** @var int year in numeric format (YYYY) */
protected $dateYYY; protected $dateYYY;
/** @var month in numeric format (MM) */ /** @var int month in numeric format (MM) */
protected $dateMM; protected $dateMM;
/** @var day in numeric format (DD) */ /** @var int day in numeric format (DD) */
protected $dateDD; protected $dateDD;
/** @var extended month (e.g. February) */ /** @var string extended month (e.g. February) */
protected $ext_dateMM; protected $ext_dateMM;
/** @var count of days in month */ /** @var int count of days in month */
protected $daysMonth; protected $daysMonth;
/** @var timestamp */ /** @var int timestamp */
protected $stamp; protected $stamp;
/** @var return array s.a. */ /** @var array return array s.a. */
protected $day; protected $day;
/** @var \phpbb\config\config */ /** @var \phpbb\config\config */
@@ -97,10 +97,10 @@ class calendar extends module_base
/** @var \phpbb\request\request */ /** @var \phpbb\request\request */
protected $request; protected $request;
/** @var php file extension */ /** @var string PHP file extension */
protected $php_ext; protected $php_ext;
/** @var phpbb root path */ /** @var string phpBB root path */
protected $phpbb_root_path; protected $phpbb_root_path;
/** @var \phpbb\user */ /** @var \phpbb\user */
@@ -109,7 +109,7 @@ class calendar extends module_base
/** @var \phpbb\path_helper */ /** @var \phpbb\path_helper */
protected $path_helper; protected $path_helper;
/** @var Portal root path */ /** @var string Portal root path */
protected $portal_root_path; protected $portal_root_path;
/** /**

View File

@@ -59,10 +59,10 @@ class custom extends module_base
/** @var \phpbb\request\request */ /** @var \phpbb\request\request */
protected $request; protected $request;
/** @var php file extension */ /** @var string PHP file extension */
protected $php_ext; protected $php_ext;
/** @var phpbb root path */ /** @var string phpBB root path */
protected $phpbb_root_path; protected $phpbb_root_path;
/** @var \phpbb\user */ /** @var \phpbb\user */

View File

@@ -56,10 +56,10 @@ class forumlist extends module_base
/** @var \phpbb\template */ /** @var \phpbb\template */
protected $template; protected $template;
/** @var php file extension */ /** @var string PHP file extension */
protected $php_ext; protected $php_ext;
/** @var phpbb root path */ /** @var string phpBB root path */
protected $phpbb_root_path; protected $phpbb_root_path;
/** @var \phpbb\user */ /** @var \phpbb\user */

View File

@@ -53,10 +53,10 @@ class leaders extends module_base
/** @var \phpbb\template */ /** @var \phpbb\template */
protected $template; protected $template;
/** @var php file extension */ /** @var string PHP file extension */
protected $php_ext; protected $php_ext;
/** @var phpbb root path */ /** @var string phpBB root path */
protected $phpbb_root_path; protected $phpbb_root_path;
/** @var \phpbb\user */ /** @var \phpbb\user */

View File

@@ -65,10 +65,10 @@ class links extends module_base
/** @var \phpbb\template */ /** @var \phpbb\template */
protected $template; protected $template;
/** @var php file extension */ /** @var string PHP file extension */
protected $php_ext; protected $php_ext;
/** @var phpbb root path */ /** @var string phpBB root path */
protected $phpbb_root_path; protected $phpbb_root_path;
/** @var \phpbb\user */ /** @var \phpbb\user */
@@ -463,7 +463,7 @@ class links extends module_base
* *
* @param string $serial_str Serialized string * @param string $serial_str Serialized string
* *
* @return string Unserialized string * @return array Unserialized string
*/ */
private function utf_unserialize($serial_str) private function utf_unserialize($serial_str)
{ {

View File

@@ -66,10 +66,10 @@ class main_menu extends module_base
/** @var \phpbb\template */ /** @var \phpbb\template */
protected $template; protected $template;
/** @var php file extension */ /** @var string PHP file extension */
protected $php_ext; protected $php_ext;
/** @var phpbb root path */ /** @var string phpBB root path */
protected $phpbb_root_path; protected $phpbb_root_path;
/** @var \phpbb\user */ /** @var \phpbb\user */
@@ -526,7 +526,7 @@ class main_menu extends module_base
* *
* @param string $serial_str Serialized string * @param string $serial_str Serialized string
* *
* @return string Unserialized string * @return array Unserialized string
*/ */
private function utf_unserialize($serial_str) private function utf_unserialize($serial_str)
{ {

View File

@@ -65,10 +65,10 @@ class news extends module_base
/** @var \phpbb\template */ /** @var \phpbb\template */
protected $template; protected $template;
/** @var php file extension */ /** @var string PHP file extension */
protected $php_ext; protected $php_ext;
/** @var phpbb root path */ /** @var string phpBB root path */
protected $phpbb_root_path; protected $phpbb_root_path;
/** @var \phpbb\user */ /** @var \phpbb\user */

View File

@@ -62,10 +62,10 @@ class poll extends module_base
/** @var \phpbb\request\request */ /** @var \phpbb\request\request */
protected $request; protected $request;
/** @var php file extension */ /** @var string PHP file extension */
protected $php_ext; protected $php_ext;
/** @var phpbb root path */ /** @var string phpBB root path */
protected $phpbb_root_path; protected $phpbb_root_path;
/** @var \phpbb\user */ /** @var \phpbb\user */

View File

@@ -62,10 +62,10 @@ class recent extends module_base
/** @var \phpbb\template */ /** @var \phpbb\template */
protected $template; protected $template;
/** @var php file extension */ /** @var string PHP file extension */
protected $php_ext; protected $php_ext;
/** @var phpbb root path */ /** @var string phpBB root path */
protected $phpbb_root_path; protected $phpbb_root_path;
/** /**

View File

@@ -50,10 +50,10 @@ class search extends module_base
/** @var \phpbb\template */ /** @var \phpbb\template */
protected $template; protected $template;
/** @var phpbb root path */ /** @var string phpBB root path */
protected $phpbb_root_path; protected $phpbb_root_path;
/** @var php file extension */ /** @var string PHP file extension */
protected $php_ext; protected $php_ext;
/** /**

View File

@@ -53,10 +53,10 @@ class stylechanger extends module_base
/** @var \phpbb\request\request */ /** @var \phpbb\request\request */
protected $request; protected $request;
/** @var php file extension */ /** @var string PHP file extension */
protected $php_ext; protected $php_ext;
/** @var phpbb root path */ /** @var string phpBB root path */
protected $phpbb_root_path; protected $phpbb_root_path;
/** @var \phpbb\user */ /** @var \phpbb\user */

View File

@@ -50,10 +50,10 @@ class topposters extends module_base
/** @var \phpbb\template */ /** @var \phpbb\template */
protected $template; protected $template;
/** @var php file extension */ /** @var string PHP file extension */
protected $php_ext; protected $php_ext;
/** @var phpbb root path */ /** @var string phpBB root path */
protected $phpbb_root_path; protected $phpbb_root_path;
/** /**

View File

@@ -62,10 +62,10 @@ class user_menu extends module_base
/** @var \phpbb\user */ /** @var \phpbb\user */
protected $user; protected $user;
/** @var php file extension */ /** @var string PHP file extension */
protected $php_ext; protected $php_ext;
/** @var phpbb root path */ /** @var string phpBB root path */
protected $phpbb_root_path; protected $phpbb_root_path;
/** /**

View File

@@ -59,10 +59,10 @@ class welcome extends module_base
/** @var \phpbb\user */ /** @var \phpbb\user */
protected $user; protected $user;
/** @var php file extension */ /** @var string PHP file extension */
protected $php_ext; protected $php_ext;
/** @var phpbb root path */ /** @var string phpBB root path */
protected $phpbb_root_path; protected $phpbb_root_path;
/** /**

View File

@@ -59,10 +59,10 @@ class whois_online extends module_base
/** @var \phpbb\user */ /** @var \phpbb\user */
protected $user; protected $user;
/** @var phpbb root path */ /** @var string phpBB root path */
protected $phpbb_root_path; protected $phpbb_root_path;
/** @var php file extension */ /** @var string PHP file extension */
protected $php_ext; protected $php_ext;
/** /**