Merge pull request #1654 from rechosen/ticket/11786

[ticket/11786] Fix various defects in PHPDoc in-code documentation
This commit is contained in:
Nathan Guse 2013-10-03 20:22:41 -07:00
commit 31aebb355c
7 changed files with 17 additions and 17 deletions

View file

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

View file

@ -595,7 +595,7 @@ switch ($mode)
* Modify user data before we display the profile * Modify user data before we display the profile
* *
* @event core.memberlist_view_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 * @var bool user_notes_enabled Is the mcp user notes module
* enabled? * enabled?
* @var bool warn_user_enabled Is the mcp warnings module * @var bool warn_user_enabled Is the mcp warnings module

View file

@ -556,7 +556,7 @@ class content_visibility
* *
* @param $data array Contains information from the topics table about given topic * @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 * @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) 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 $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 * @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) 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 $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 $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 * @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) public function remove_topic_from_statistic($topic_id, $forum_id, &$topic_row, &$sql_data)
{ {

View file

@ -19,7 +19,7 @@ if (!defined('IN_PHPBB'))
/** /**
* Post quoting notifications class * 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 * @package notifications
*/ */

View file

@ -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 * This class handles notifications for private messages when they are reported
* *
* @package notifications * @package notifications