From 2692429e82a75a88e46d29008509450d982fa42c Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Wed, 23 Jul 2014 23:21:39 +0200 Subject: [PATCH] [ticket/289] Fix scrutinizer documentation issues --- modules/attachments.php | 4 ++-- modules/calendar.php | 20 ++++++++++---------- modules/custom.php | 4 ++-- modules/forumlist.php | 4 ++-- modules/leaders.php | 4 ++-- modules/links.php | 6 +++--- modules/main_menu.php | 6 +++--- modules/news.php | 4 ++-- modules/poll.php | 4 ++-- modules/recent.php | 4 ++-- modules/search.php | 4 ++-- modules/stylechanger.php | 4 ++-- modules/topposters.php | 4 ++-- modules/user_menu.php | 4 ++-- modules/welcome.php | 4 ++-- modules/whois_online.php | 4 ++-- 16 files changed, 42 insertions(+), 42 deletions(-) diff --git a/modules/attachments.php b/modules/attachments.php index 3935ba86..a315d9ee 100644 --- a/modules/attachments.php +++ b/modules/attachments.php @@ -56,10 +56,10 @@ class attachments extends module_base /** @var \phpbb\db\driver */ protected $db; - /** @var php file extension */ + /** @var string PHP file extension */ protected $php_ext; - /** @var phpbb root path */ + /** @var string phpBB root path */ protected $phpbb_root_path; /** @var \phpbb\user */ diff --git a/modules/calendar.php b/modules/calendar.php index 4931b025..b1092d81 100644 --- a/modules/calendar.php +++ b/modules/calendar.php @@ -64,25 +64,25 @@ class calendar extends module_base const DAYS_PER_WEEK = 6; // indexes start at 0 const MONTHS_PER_YEAR = 12; - /** @var year in numeric format (YYYY) */ + /** @var int year in numeric format (YYYY) */ protected $dateYYY; - /** @var month in numeric format (MM) */ + /** @var int month in numeric format (MM) */ protected $dateMM; - /** @var day in numeric format (DD) */ + /** @var int day in numeric format (DD) */ protected $dateDD; - /** @var extended month (e.g. February) */ + /** @var string extended month (e.g. February) */ protected $ext_dateMM; - /** @var count of days in month */ + /** @var int count of days in month */ protected $daysMonth; - /** @var timestamp */ + /** @var int timestamp */ protected $stamp; - /** @var return array s.a. */ + /** @var array return array s.a. */ protected $day; /** @var \phpbb\config\config */ @@ -97,10 +97,10 @@ class calendar extends module_base /** @var \phpbb\request\request */ protected $request; - /** @var php file extension */ + /** @var string PHP file extension */ protected $php_ext; - /** @var phpbb root path */ + /** @var string phpBB root path */ protected $phpbb_root_path; /** @var \phpbb\user */ @@ -109,7 +109,7 @@ class calendar extends module_base /** @var \phpbb\path_helper */ protected $path_helper; - /** @var Portal root path */ + /** @var string Portal root path */ protected $portal_root_path; /** diff --git a/modules/custom.php b/modules/custom.php index ab2e04ca..3f42ebc3 100644 --- a/modules/custom.php +++ b/modules/custom.php @@ -59,10 +59,10 @@ class custom extends module_base /** @var \phpbb\request\request */ protected $request; - /** @var php file extension */ + /** @var string PHP file extension */ protected $php_ext; - /** @var phpbb root path */ + /** @var string phpBB root path */ protected $phpbb_root_path; /** @var \phpbb\user */ diff --git a/modules/forumlist.php b/modules/forumlist.php index 5f7d5aaa..8065a4cd 100644 --- a/modules/forumlist.php +++ b/modules/forumlist.php @@ -56,10 +56,10 @@ class forumlist extends module_base /** @var \phpbb\template */ protected $template; - /** @var php file extension */ + /** @var string PHP file extension */ protected $php_ext; - /** @var phpbb root path */ + /** @var string phpBB root path */ protected $phpbb_root_path; /** @var \phpbb\user */ diff --git a/modules/leaders.php b/modules/leaders.php index 23321090..b85e1597 100644 --- a/modules/leaders.php +++ b/modules/leaders.php @@ -53,10 +53,10 @@ class leaders extends module_base /** @var \phpbb\template */ protected $template; - /** @var php file extension */ + /** @var string PHP file extension */ protected $php_ext; - /** @var phpbb root path */ + /** @var string phpBB root path */ protected $phpbb_root_path; /** @var \phpbb\user */ diff --git a/modules/links.php b/modules/links.php index 19523ba2..dce1315c 100644 --- a/modules/links.php +++ b/modules/links.php @@ -65,10 +65,10 @@ class links extends module_base /** @var \phpbb\template */ protected $template; - /** @var php file extension */ + /** @var string PHP file extension */ protected $php_ext; - /** @var phpbb root path */ + /** @var string phpBB root path */ protected $phpbb_root_path; /** @var \phpbb\user */ @@ -463,7 +463,7 @@ class links extends module_base * * @param string $serial_str Serialized string * - * @return string Unserialized string + * @return array Unserialized string */ private function utf_unserialize($serial_str) { diff --git a/modules/main_menu.php b/modules/main_menu.php index bb7d0572..fc36f6b2 100644 --- a/modules/main_menu.php +++ b/modules/main_menu.php @@ -66,10 +66,10 @@ class main_menu extends module_base /** @var \phpbb\template */ protected $template; - /** @var php file extension */ + /** @var string PHP file extension */ protected $php_ext; - /** @var phpbb root path */ + /** @var string phpBB root path */ protected $phpbb_root_path; /** @var \phpbb\user */ @@ -526,7 +526,7 @@ class main_menu extends module_base * * @param string $serial_str Serialized string * - * @return string Unserialized string + * @return array Unserialized string */ private function utf_unserialize($serial_str) { diff --git a/modules/news.php b/modules/news.php index 97f9c017..47a81fc2 100644 --- a/modules/news.php +++ b/modules/news.php @@ -65,10 +65,10 @@ class news extends module_base /** @var \phpbb\template */ protected $template; - /** @var php file extension */ + /** @var string PHP file extension */ protected $php_ext; - /** @var phpbb root path */ + /** @var string phpBB root path */ protected $phpbb_root_path; /** @var \phpbb\user */ diff --git a/modules/poll.php b/modules/poll.php index 74b6b7ad..e6534a8a 100644 --- a/modules/poll.php +++ b/modules/poll.php @@ -62,10 +62,10 @@ class poll extends module_base /** @var \phpbb\request\request */ protected $request; - /** @var php file extension */ + /** @var string PHP file extension */ protected $php_ext; - /** @var phpbb root path */ + /** @var string phpBB root path */ protected $phpbb_root_path; /** @var \phpbb\user */ diff --git a/modules/recent.php b/modules/recent.php index 272118da..81d7f379 100644 --- a/modules/recent.php +++ b/modules/recent.php @@ -62,10 +62,10 @@ class recent extends module_base /** @var \phpbb\template */ protected $template; - /** @var php file extension */ + /** @var string PHP file extension */ protected $php_ext; - /** @var phpbb root path */ + /** @var string phpBB root path */ protected $phpbb_root_path; /** diff --git a/modules/search.php b/modules/search.php index 37ae2bad..9832d607 100644 --- a/modules/search.php +++ b/modules/search.php @@ -50,10 +50,10 @@ class search extends module_base /** @var \phpbb\template */ protected $template; - /** @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; /** diff --git a/modules/stylechanger.php b/modules/stylechanger.php index 3f7bcfe9..3c4806fe 100644 --- a/modules/stylechanger.php +++ b/modules/stylechanger.php @@ -53,10 +53,10 @@ class stylechanger extends module_base /** @var \phpbb\request\request */ protected $request; - /** @var php file extension */ + /** @var string PHP file extension */ protected $php_ext; - /** @var phpbb root path */ + /** @var string phpBB root path */ protected $phpbb_root_path; /** @var \phpbb\user */ diff --git a/modules/topposters.php b/modules/topposters.php index 92fc4fd0..958e768d 100644 --- a/modules/topposters.php +++ b/modules/topposters.php @@ -50,10 +50,10 @@ class topposters extends module_base /** @var \phpbb\template */ protected $template; - /** @var php file extension */ + /** @var string PHP file extension */ protected $php_ext; - /** @var phpbb root path */ + /** @var string phpBB root path */ protected $phpbb_root_path; /** diff --git a/modules/user_menu.php b/modules/user_menu.php index a9afb419..ff8a1e4c 100644 --- a/modules/user_menu.php +++ b/modules/user_menu.php @@ -62,10 +62,10 @@ class user_menu extends module_base /** @var \phpbb\user */ protected $user; - /** @var php file extension */ + /** @var string PHP file extension */ protected $php_ext; - /** @var phpbb root path */ + /** @var string phpBB root path */ protected $phpbb_root_path; /** diff --git a/modules/welcome.php b/modules/welcome.php index 493affd8..8556a9ec 100644 --- a/modules/welcome.php +++ b/modules/welcome.php @@ -59,10 +59,10 @@ class welcome extends module_base /** @var \phpbb\user */ protected $user; - /** @var php file extension */ + /** @var string PHP file extension */ protected $php_ext; - /** @var phpbb root path */ + /** @var string phpBB root path */ protected $phpbb_root_path; /** diff --git a/modules/whois_online.php b/modules/whois_online.php index 758e070a..744f9c02 100644 --- a/modules/whois_online.php +++ b/modules/whois_online.php @@ -59,10 +59,10 @@ class whois_online extends module_base /** @var \phpbb\user */ protected $user; - /** @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; /**