Merge pull request #1654 from rechosen/ticket/11786

[ticket/11786] Fix various defects in PHPDoc in-code documentation

phpBB/includes/functions_user.php

@@ -2754,8 +2754,8 @@ function group_user_del($group_id, $user_id_ary = false, $username_ary = false,
 	* Event before users are removed from a group
 	*
 	* @event core.group_delete_user_before
-	* @var	int		group_id	ID of the group from which users are deleted
-	* @var	string	group_name	Name of the group
+	* @var	int		group_id		ID of the group from which users are deleted
+	* @var	string	group_name		Name of the group
 	* @var	array	user_id_ary		IDs of the users which are removed
 	* @var	array	username_ary	names of the users which are removed
 	* @since 3.1-A1

phpBB/includes/ucp/ucp_pm_viewmessage.php

@@ -254,8 +254,8 @@ function view_message($id, $mode, $folder_id, $msg_id, $folder, $message_row)
 	* @var	string	mode		Active module
 	* @var	int		folder_id	ID of the folder the message is in
 	* @var	int		msg_id		ID of the private message
-	* var	array	folder		Array with data of user's message folders
-	* @var	array	message_row		Array with message data
+	* @var	array	folder		Array with data of user's message folders
+	* @var	array	message_row	Array with message data
 	* @var	array	cp_row		Array with senders custom profile field data
 	* @var	array	msg_data	Template array with message data
 	* @since 3.1-A1

phpBB/memberlist.php

@@ -595,7 +595,7 @@ switch ($mode)
 		* Modify user data before we display the profile
 		*
 		* @event core.memberlist_view_profile
-		* @var	array	member					Title of the index page
+		* @var	array	member					Array with user's data
 		* @var	bool	user_notes_enabled		Is the mcp user notes module
 		*										enabled?
 		* @var	bool	warn_user_enabled		Is the mcp warnings module

phpBB/phpbb/content_visibility.php

@@ -556,7 +556,7 @@ class content_visibility
 	*
 	* @param $data			array	Contains information from the topics table about given topic
 	* @param $sql_data		array	Populated with the SQL changes, may be empty at call time
-	* @return void
+	* @return null
 	*/
 	public function add_post_to_statistic($data, &$sql_data)
 	{
@@ -577,7 +577,7 @@ class content_visibility
 	*
 	* @param $data			array	Contains information from the topics table about given topic
 	* @param $sql_data		array	Populated with the SQL changes, may be empty at call time
-	* @return void
+	* @return null
 	*/
 	public function remove_post_from_statistic($data, &$sql_data)
 	{
@@ -599,7 +599,7 @@ class content_visibility
 	* @param $forum_id		int		Forum where the topic is found
 	* @param $topic_row		array	Contains information from the topic, may be empty at call time
 	* @param $sql_data		array	Populated with the SQL changes, may be empty at call time
-	* @return void
+	* @return null
 	*/
 	public function remove_topic_from_statistic($topic_id, $forum_id, &$topic_row, &$sql_data)
 	{

phpBB/phpbb/notification/type/quote.php

@@ -19,7 +19,7 @@ if (!defined('IN_PHPBB'))
 
 /**
 * Post quoting notifications class
-* This class handles notifications for quoting users in a post
+* This class handles notifying users when they have been quoted in a post
 *
 * @package notifications
 */

phpBB/phpbb/notification/type/report_pm.php

@@ -18,7 +18,7 @@ if (!defined('IN_PHPBB'))
 }
 
 /**
-* Private message reproted notifications class
+* Private message reported notifications class
 * This class handles notifications for private messages when they are reported
 *
 * @package notifications

phpBB/viewtopic.php

@@ -1115,8 +1115,8 @@ while ($row = $db->sql_fetchrow($result))
 			*
 			* @event core.viewtopic_cache_guest_data
 			* @var	array	user_cache_data	Array with the user's data
-			* @var	int		poster_id	Poster's user id
-			* @var	array	row			Array with original user and post data
+			* @var	int		poster_id		Poster's user id
+			* @var	array	row				Array with original user and post data
 			* @since 3.1-A1
 			*/
 			$vars = array('user_cache_data', 'poster_id', 'row');
@@ -1181,8 +1181,8 @@ while ($row = $db->sql_fetchrow($result))
 			*
 			* @event core.viewtopic_cache_user_data
 			* @var	array	user_cache_data	Array with the user's data
-			* @var	int		poster_id	Poster's user id
-			* @var	array	row			Array with original user and post data
+			* @var	int		poster_id		Poster's user id
+			* @var	array	row				Array with original user and post data
 			* @since 3.1-A1
 			*/
 			$vars = array('user_cache_data', 'poster_id', 'row');
@@ -1673,10 +1673,10 @@ for ($i = 0, $end = sizeof($post_list); $i < $end; ++$i)
 	* Modify the posts template block
 	*
 	* @event core.viewtopic_modify_post_row
-	* @var	array	row				Array with original post and user data
-	* @var	array	cp_row			Custom profile field data of the poster
+	* @var	array	row					Array with original post and user data
+	* @var	array	cp_row				Custom profile field data of the poster
 	* @var	array	user_poster_data	Poster's data from user cache
-	* @var	array	post_row		Template block array of the post
+	* @var	array	post_row			Template block array of the post
 	* @since 3.1-A1
 	*/
 	$vars = array('row', 'cp_row', 'user_poster_data', 'post_row');