Merge pull request #2477 from n-aleha/ticket/12557ascraeus

[ticket/12557] Fix doc block errors found by Sami for ascraeus

* n-aleha/ticket/12557ascraeus:
  [ticket/12557] Fix load active module description
  [ticket/12557] Fix php file description
  [ticket/12557] Fix post data description for notifications
  [ticket/12557] Fix pass by reference doc blocks
  [ticket/12557] Fix doc block in extension base class
  [ticket/12557] Fix doc block in mimetype guesser
  [ticket/12557] Fix var $preserve_cr description
  [ticket/12557] Fix doc block errors found by Sami
  [ticket/12557] Fix doc block errors found by Sami
  [ticket/12557] Fix doc block errors found by Sami
  [ticket/12557] Template fixes
  [ticket/12557] Search, cron and profilefields fixes
  [ticket/12557] Notification fixes
  [ticket/12557] Fix doc block errors found by Sami pt1
  [ticket/12557] Fix doc block errors found by Sami
  [ticket/12557] Fix doc block errors found by Sami

phpBB/includes/acp/acp_attachments.php

@@ -1301,7 +1301,6 @@ class acp_attachments
 	/**
 	* Check accuracy of attachment statistics.
 	*
-	* @param $resync bool	Resync stats if they're incorrect.
 	* @return bool|string	Returns false if stats are correct or error message
 	*	otherwise.
 	*/

phpBB/includes/acp/acp_modules.php

@@ -766,7 +766,8 @@ class acp_modules
 	/**
 	* Update/Add module
 	*
-	* @param bool $run_inline if set to true errors will be returned and no logs being written
+	* @param array	&$module_data	The module data
+	* @param bool	$run_inline 	if set to true errors will be returned and no logs being written
 	*/
 	function update_module_data(&$module_data, $run_inline = false)
 	{

phpBB/includes/diff/diff.php

@@ -46,8 +46,9 @@ class diff
 	/**
 	* Computes diffs between sequences of strings.
 	*
-	* @param array $from_lines  An array of strings. Typically these are lines from a file.
+	* @param array	&$from_content	An array of strings. Typically these are lines from a file.
-	* @param array $to_lines    An array of strings.
+	* @param array	&$to_content	An array of strings.
+	* @param bool	$preserve_cr	If true, \r is replaced by a new line in the diff output
 	*/
 	function diff(&$from_content, &$to_content, $preserve_cr = true)
 	{
@@ -491,9 +492,11 @@ class diff3 extends diff
 	/**
 	* Computes diff between 3 sequences of strings.
 	*
-	* @param array $orig    The original lines to use.
+	* @param array &$orig		The original lines to use.
-	* @param array $final1  The first version to compare to.
+	* @param array &$final1		The first version to compare to.
-	* @param array $final2  The second version to compare to.
+	* @param array &$final2		The second version to compare to.
+	* @param bool $preserve_cr	If true, \r\n and bare \r are replaced by a new line
+	*							in the diff output
 	*/
 	function diff3(&$orig, &$final1, &$final2, $preserve_cr = true)
 	{

phpBB/includes/functions_display.php

@@ -1426,7 +1426,7 @@ function get_user_rank($user_rank, $user_posts, &$rank_title, &$rank_img, &$rank
 * @param string $param_key Either topic_id or post_id
 * @param string $param_val The value of the topic or post id
 * @param string $phpbb_root_path The root path of the phpBB installation
-* @param string $phpEx The PHP extension
+* @param string $phpEx The PHP file extension
 *
 * @return array Array containing the link and the type of compression
 */

phpBB/includes/functions_module.php

@@ -541,7 +541,9 @@ class p_master
 	*
 	* This method loads a given module, passing it the relevant id and mode.
 	*
-	* @param string $mode mode, as passed through to the module
+	* @param string|false $mode mode, as passed through to the module
+	* @param string|false $module_url If supplied, we use this module url
+	* @param bool $execute_module If true, at the end we execute the main method for the new instance
 	*/
 	function load_active($mode = false, $module_url = false, $execute_module = true)
 	{

phpBB/includes/functions_upload.php

@@ -104,6 +104,7 @@ class filespec
 	*
 	* @param real|unique|unique_ext $mode real creates a realname, filtering some characters, lowering every character. Unique creates an unique filename
 	* @param string $prefix Prefix applied to filename
+	* @param string $user_id The user_id is only needed for when cleaning a user's avatar
 	* @access public
 	*/
 	function clean_filename($mode = 'unique', $prefix = '', $user_id = '')
@@ -277,8 +278,9 @@ class filespec
 	* Move file to destination folder
 	* The phpbb_root_path variable will be applied to the destination path
 	*
-	* @param string $destination_path Destination path, for example $config['avatar_path']
+	* @param string $destination Destination path, for example $config['avatar_path']
 	* @param bool $overwrite If set to true, an already existing file will be overwritten
+	* @param bool $skip_image_check If set to true, the check for the file to be a valid image is skipped
 	* @param string $chmod Permission mask for chmodding the file after a successful move. The mode entered here reflects the mode defined by {@link phpbb_chmod()}
 	*
 	* @access public
@@ -502,6 +504,8 @@ class fileupload
 	* @param int $min_height Minimum image height (only checked for images)
 	* @param int $max_width Maximum image width (only checked for images)
 	* @param int $max_height Maximum image height (only checked for images)
+	* @param bool|array $disallowed_content If enabled, the first 256 bytes of the file must not
+	*										contain any of its values. Defaults to false.
 	*
 	*/
 	function fileupload($error_prefix = '', $allowed_extensions = false, $max_filesize = false, $min_width = false, $min_height = false, $max_width = false, $max_height = false, $disallowed_content = false)

phpBB/includes/functions_url_matcher.php

@@ -29,7 +29,7 @@ if (!defined('IN_PHPBB'))
 * @param \phpbb\extension\manager $manager Extension manager
 * @param RequestContext $context Symfony RequestContext object
 * @param string $root_path Root path
-* @param string $php_ext PHP extension
+* @param string $php_ext PHP file extension
 * @return null
 */
 function phpbb_get_url_matcher(\phpbb\extension\manager $manager, RequestContext $context, $root_path, $php_ext)
@@ -52,7 +52,7 @@ function phpbb_get_url_matcher(\phpbb\extension\manager $manager, RequestContext
 *
 * @param \phpbb\extension\manager $manager Extension manager
 * @param string $root_path Root path
-* @param string $php_ext PHP extension
+* @param string $php_ext PHP file extension
 * @return null
 */
 function phpbb_create_dumped_url_matcher(\phpbb\extension\manager $manager, $root_path, $php_ext)
@@ -88,7 +88,7 @@ function phpbb_create_url_matcher(\phpbb\extension\manager $manager, RequestCont
 *
 * @param RequestContext $context Symfony RequestContext object
 * @param string $root_path Root path
-* @param string $php_ext PHP extension
+* @param string $php_ext PHP file extension
 * @return phpbb_url_matcher
 */
 function phpbb_load_url_matcher(RequestContext $context, $root_path, $php_ext)
@@ -103,7 +103,7 @@ function phpbb_load_url_matcher(RequestContext $context, $root_path, $php_ext)
 * The class is automatically dumped to the cache directory
 *
 * @param string $root_path Root path
-* @param string $php_ext PHP extension
+* @param string $php_ext PHP file extension
 * @return bool True if it exists, false if not
 */
 function phpbb_url_matcher_dumped($root_path, $php_ext)

phpBB/phpbb/auth/auth.php

@@ -208,9 +208,12 @@ class auth
 
 	/**
 	* Get forums with the specified permission setting
-	* if the option is prefixed with !, then the result becomes negated
 	*
-	* @param bool $clean set to true if only values needs to be returned which are set/unset
+	* @param string $opt The permission name to lookup. If prefixed with !, the result is negated.
+	* @param bool	$clean set to true if only values needs to be returned which are set/unset
+	*
+	* @return array Contains the forum ids with the specified permission set to true.
+					This is a nested array: array => forum_id => permission => true
 	*/
 	function acl_getf($opt, $clean = false)
 	{

phpBB/phpbb/auth/provider/apache.php

@@ -28,13 +28,13 @@ class apache extends \phpbb\auth\provider\base
 	/**
 	 * Apache Authentication Constructor
 	 *
-	 * @param 	\phpbb\db\driver\driver_interface 	$db
+	 * @param	\phpbb\db\driver\driver_interface 	$db		Database object
-	 * @param 	\phpbb\config\config 		$config
+	 * @param	\phpbb\config\config 		$config		Config object
-	 * @param	\phpbb\passwords\manager	$passwords_manager
+	 * @param	\phpbb\passwords\manager	$passwords_manager		Passwords Manager object
-	 * @param 	\phpbb\request\request 		$request
+	 * @param	\phpbb\request\request 		$request		Request object
-	 * @param 	\phpbb\user 			$user
+	 * @param	\phpbb\user 			$user		User object
-	 * @param 	string 				$phpbb_root_path
+	 * @param	string 				$phpbb_root_path		Relative path to phpBB root
-	 * @param 	string 				$php_ext
+	 * @param	string 				$php_ext		PHP file extension
 	 */
 	public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, \phpbb\passwords\manager $passwords_manager, \phpbb\request\request $request, \phpbb\user $user, $phpbb_root_path, $php_ext)
 	{

phpBB/phpbb/auth/provider/ldap.php

@@ -29,10 +29,10 @@ class ldap extends \phpbb\auth\provider\base
 	/**
 	 * LDAP Authentication Constructor
 	 *
-	 * @param 	\phpbb\db\driver\driver_interface		$db
+	 * @param	\phpbb\db\driver\driver_interface		$db		Database object
-	 * @param 	\phpbb\config\config		$config
+	 * @param	\phpbb\config\config		$config		Config object
-	 * @param	\phpbb\passwords\manager	$passwords_manager
+	 * @param	\phpbb\passwords\manager	$passwords_manager		Passwords manager object
-	 * @param 	\phpbb\user			$user
+	 * @param	\phpbb\user			$user		User object
 	 */
 	public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, \phpbb\passwords\manager $passwords_manager, \phpbb\user $user)
 	{

phpBB/phpbb/cache/service.php

@@ -47,7 +47,7 @@ class service
 	protected $phpbb_root_path;
 
 	/**
-	* PHP extension.
+	* PHP file extension.
 	*
 	* @var string
 	*/
@@ -60,7 +60,7 @@ class service
 	* @param \phpbb\config\config $config The config
 	* @param \phpbb\db\driver\driver_interface $db Database connection
 	* @param string $phpbb_root_path Root path
-	* @param string $php_ext PHP extension
+	* @param string $php_ext PHP file extension
 	*/
 	public function __construct(\phpbb\cache\driver\driver_interface $driver, \phpbb\config\config $config, \phpbb\db\driver\driver_interface $db, $phpbb_root_path, $php_ext)
 	{

phpBB/phpbb/controller/helper.php

@@ -50,7 +50,7 @@ class helper
 	protected $phpbb_root_path;
 
 	/**
-	* PHP extension
+	* PHP file extension
 	* @var string
 	*/
 	protected $php_ext;
@@ -65,7 +65,7 @@ class helper
 	* @param \phpbb\extension\manager $manager Extension manager object
 	* @param \phpbb\symfony_request $symfony_request Symfony Request object
 	* @param string $phpbb_root_path phpBB root path
-	* @param string $php_ext PHP extension
+	* @param string $php_ext PHP file extension
 	*/
 	public function __construct(\phpbb\template\template $template, \phpbb\user $user, \phpbb\config\config $config, \phpbb\controller\provider $provider, \phpbb\extension\manager $manager, \phpbb\symfony_request $symfony_request, $phpbb_root_path, $php_ext)
 	{
@@ -82,9 +82,11 @@ class helper
 	/**
 	* Automate setting up the page and creating the response object.
 	*
-	* @param string $handle The template handle to render
+	* @param string $template_file The template handle to render
 	* @param string $page_title The title of the page to output
 	* @param int $status_code The status code to be sent to the page header
+	* @param bool $display_online_list Do we display online users list
+	*
 	* @return Response object containing rendered page
 	*/
 	public function render($template_file, $page_title = '', $status_code = 200, $display_online_list = false)

phpBB/phpbb/cron/manager.php

@@ -35,6 +35,8 @@ class manager
 	* Constructor. Loads all available tasks.
 	*
 	* @param array|\Traversable $tasks Provides an iterable set of task names
+	* @param string $phpbb_root_path Relative path to phpBB root
+	* @param string $php_ext PHP file extension
 	*/
 	public function __construct($tasks, $phpbb_root_path, $php_ext)
 	{

phpBB/phpbb/cron/task/core/prune_all_forums.php

@@ -31,7 +31,7 @@ class prune_all_forums extends \phpbb\cron\task\base
 	* Constructor.
 	*
 	* @param string $phpbb_root_path The root path
-	* @param string $php_ext The PHP extension
+	* @param string $php_ext The PHP file extension
 	* @param \phpbb\config\config $config The config
 	* @param \phpbb\db\driver\driver_interface $db The db connection
 	*/

phpBB/phpbb/cron/task/core/prune_forum.php

@@ -41,7 +41,7 @@ class prune_forum extends \phpbb\cron\task\base implements \phpbb\cron\task\para
 	* Constructor.
 	*
 	* @param string $phpbb_root_path The root path
-	* @param string $php_ext The PHP extension
+	* @param string $php_ext PHP file extension
 	* @param \phpbb\config\config $config The config
 	* @param \phpbb\db\driver\driver_interface $db The db connection
 	*/

phpBB/phpbb/cron/task/core/prune_shadow_topics.php

@@ -43,7 +43,7 @@ class prune_shadow_topics extends \phpbb\cron\task\base implements \phpbb\cron\t
 	* Constructor.
 	*
 	* @param string $phpbb_root_path The root path
-	* @param string $php_ext The PHP extension
+	* @param string $php_ext PHP file extension
 	* @param \phpbb\config\config $config The config
 	* @param \phpbb\db\driver\driver_interface $db The db connection
 	* @param \phpbb\log\log $log The phpBB log system

phpBB/phpbb/cron/task/core/queue.php

@@ -26,7 +26,7 @@ class queue extends \phpbb\cron\task\base
 	* Constructor.
 	*
 	* @param string $phpbb_root_path The root path
-	* @param string $php_ext The PHP extension
+	* @param string $php_ext PHP file extension
 	* @param \phpbb\config\config $config The config
 	*/
 	public function __construct($phpbb_root_path, $php_ext, \phpbb\config\config $config)

phpBB/phpbb/cron/task/core/tidy_database.php

@@ -26,7 +26,7 @@ class tidy_database extends \phpbb\cron\task\base
 	* Constructor.
 	*
 	* @param string $phpbb_root_path The root path
-	* @param string $php_ext The PHP extension
+	* @param string $php_ext The PHP file extension
 	* @param \phpbb\config\config $config The config
 	*/
 	public function __construct($phpbb_root_path, $php_ext, \phpbb\config\config $config)

phpBB/phpbb/cron/task/core/tidy_search.php

@@ -31,7 +31,7 @@ class tidy_search extends \phpbb\cron\task\base
 	* Constructor.
 	*
 	* @param string $phpbb_root_path The root path
-	* @param string $php_ext The PHP extension
+	* @param string $php_ext The PHP file extension
 	* @param \phpbb\auth\auth $auth The auth
 	* @param \phpbb\config\config $config The config
 	* @param \phpbb\db\driver\driver_interface $db The db connection

phpBB/phpbb/cron/task/core/tidy_warnings.php

@@ -28,7 +28,7 @@ class tidy_warnings extends \phpbb\cron\task\base
 	* Constructor.
 	*
 	* @param string $phpbb_root_path The root path
-	* @param string $php_ext The PHP extension
+	* @param string $php_ext PHP file extension
 	* @param \phpbb\config\config $config The config
 	*/
 	public function __construct($phpbb_root_path, $php_ext, \phpbb\config\config $config)

phpBB/phpbb/cron/task/wrapper.php

@@ -29,6 +29,8 @@ class wrapper
 	* Wraps a task $task, which must implement cron_task interface.
 	*
 	* @param \phpbb\cron\task\task $task The cron task to wrap.
+	* @param string $phpbb_root_path Relative path to phpBB root
+	* @param string $php_ext PHP file extension
 	*/
 	public function __construct(\phpbb\cron\task\task $task, $phpbb_root_path, $php_ext)
 	{

phpBB/phpbb/datetime.php

@@ -38,9 +38,9 @@ class datetime extends \DateTime
 	* Constructs a new instance of \phpbb\datetime, expanded to include an argument to inject
 	* the user context and modify the timezone to the users selected timezone if one is not set.
 	*
+	* @param user $user object for context.
 	* @param string $time String in a format accepted by strtotime().
 	* @param \DateTimeZone $timezone Time zone of the time.
-	* @param user $user object for context.
 	*/
 	public function __construct($user, $time = 'now', \DateTimeZone $timezone = null)
 	{

phpBB/phpbb/db/migration/tool/permission.php

@@ -105,6 +105,7 @@ class permission implements \phpbb\db\migration\tool\tool_interface
 	* @param string $auth_option The name of the permission (auth) option
 	* @param bool $global True for checking a global permission setting,
 	* 	False for a local permission setting
+	* @param int|false $copy_from If set, contains the id of the permission from which to copy the new one.
 	* @return null
 	*/
 	public function add($auth_option, $global = true, $copy_from = false)
@@ -243,7 +244,9 @@ class permission implements \phpbb\db\migration\tool\tool_interface
 	* Add a new permission role
 	*
 	* @param string $role_name The new role name
-	* @param sting $role_type The type (u_, m_, a_)
+	* @param string $role_type The type (u_, m_, a_)
+	* @param string $role_description Description of the new role
+	*
 	* @return null
 	*/
 	public function role_add($role_name, $role_type, $role_description = '')

phpBB/phpbb/event/kernel_request_subscriber.php

@@ -28,7 +28,7 @@ class kernel_request_subscriber implements EventSubscriberInterface
 	protected $manager;
 
 	/**
-	* PHP extension
+	* PHP file extension
 	* @var string
 	*/
 	protected $php_ext;
@@ -44,7 +44,7 @@ class kernel_request_subscriber implements EventSubscriberInterface
 	*
 	* @param \phpbb\extension\manager $manager Extension manager object
 	* @param string $root_path Root path
-	* @param string $php_ext PHP extension
+	* @param string $php_ext PHP file extension
 	*/
 	public function __construct(\phpbb\extension\manager $manager, $root_path, $php_ext)
 	{

phpBB/phpbb/extension/base.php

@@ -40,6 +40,7 @@ class base implements \phpbb\extension\extension_interface
 	*
 	* @param ContainerInterface $container Container object
 	* @param \phpbb\finder $extension_finder
+	* @param \phpbb\db\migrator $migrator
 	* @param string $extension_name Name of this extension (from ext.manager)
 	* @param string $extension_path Relative path to this extension
 	*/

phpBB/phpbb/feed/helper.php

@@ -36,7 +36,7 @@ class helper
 	* @param	\phpbb\config\config	$config		Config object
 	* @param	\phpbb\user		$user		User object
 	* @param	string	$phpbb_root_path	Root path
-	* @param	string	$phpEx				PHP extension
+	* @param	string	$phpEx				PHP file extension
 	*/
 	public function __construct(\phpbb\config\config $config, \phpbb\user $user, $phpbb_root_path, $phpEx)
 	{

phpBB/phpbb/mimetype/guesser.php

@@ -99,6 +99,7 @@ class guesser
 	* Guess mimetype of supplied file
 	*
 	* @param string $file Path to file
+	* @param string $file_name The real file name
 	*
 	* @return string Guess for mimetype of file
 	*/

phpBB/phpbb/notification/manager.php

@@ -68,12 +68,14 @@ class manager
 	* @param \phpbb\user_loader $user_loader
 	* @param \phpbb\config\config $config
 	* @param \phpbb\db\driver\driver_interface $db
+	* @param \phpbb\cache\service $cache
 	* @param \phpbb\user $user
 	* @param string $phpbb_root_path
 	* @param string $php_ext
 	* @param string $notification_types_table
 	* @param string $notifications_table
 	* @param string $user_notifications_table
+	*
 	* @return \phpbb\notification\manager
 	*/
 	public function __construct($notification_types, $notification_methods, ContainerInterface $phpbb_container, \phpbb\user_loader $user_loader, \phpbb\config\config $config, \phpbb\db\driver\driver_interface $db, \phpbb\cache\service $cache, $user, $phpbb_root_path, $php_ext, $notification_types_table, $notifications_table, $user_notifications_table)
@@ -832,7 +834,7 @@ class manager
 	* Delete all notifications older than a certain time
 	*
 	* @param int $timestamp Unix timestamp to delete all notifications that were created before
-	* @param bool $only_unread True (default) to only prune read notifications
+	* @param bool $only_read True (default) to only prune read notifications
 	*/
 	public function prune_notifications($timestamp, $only_read = true)
 	{

phpBB/phpbb/notification/type/approve_post.php

@@ -67,7 +67,8 @@ class approve_post extends \phpbb\notification\type\post
 	/**
 	* Find the users who want to receive notifications
 	*
-	* @param array $post Data from
+	* @param array $post Data from submit_post
+	* @param array $options Options for finding users for notification
 	*
 	* @return array
 	*/

phpBB/phpbb/notification/type/approve_topic.php

@@ -67,7 +67,8 @@ class approve_topic extends \phpbb\notification\type\topic
 	/**
 	* Find the users who want to receive notifications
 	*
-	* @param array $post Data from
+	* @param array $post Data from submit_post
+	* @param array $options Options for finding users for notification
 	*
 	* @return array
 	*/

phpBB/phpbb/notification/type/base.php

@@ -161,6 +161,8 @@ abstract class base implements \phpbb\notification\type\type_interface
 	* Magic method to set data on this notification
 	*
 	* @param mixed $name
+	* @param mixed $value
+	*
 	* @return null
 	*/
 	public function __set($name, $value)
@@ -174,7 +176,6 @@ abstract class base implements \phpbb\notification\type\type_interface
 	*
 	* Primarily for testing
 	*
-	* @param string $name
 	* @return mixed
 	*/
 	public function __toString()

phpBB/phpbb/notification/type/bookmark.php

@@ -59,7 +59,8 @@ class bookmark extends \phpbb\notification\type\post
 	/**
 	* Find the users who want to receive notifications
 	*
-	* @param array $post Data from
+	* @param array $post Data from submit_post
+	* @param array $options Options for finding users for notification
 	*
 	* @return array
 	*/

phpBB/phpbb/notification/type/pm.php

@@ -72,7 +72,8 @@ class pm extends \phpbb\notification\type\base
 	/**
 	* Find the users who want to receive notifications
 	*
-	* @param array $pm Data from
+	* @param array $pm Data from submit_pm
+	* @param array $options Options for finding users for notification
 	*
 	* @return array
 	*/
@@ -178,7 +179,7 @@ class pm extends \phpbb\notification\type\base
 	* Function for preparing the data for insertion in an SQL query
 	* (The service handles insertion)
 	*
-	* @param array $post Data from submit_post
+	* @param array $pm Data from submit_post
 	* @param array $pre_create_data Data from pre_create_insert_array()
 	*
 	* @return array Array of data ready to be inserted into the database

phpBB/phpbb/notification/type/post.php

@@ -86,7 +86,8 @@ class post extends \phpbb\notification\type\base
 	/**
 	* Find the users who want to receive notifications
 	*
-	* @param array $post Data from
+	* @param array $post Data from submit_post
+	* @param array $options Options for finding users for notification
 	*
 	* @return array
 	*/

phpBB/phpbb/notification/type/post_in_queue.php

@@ -70,6 +70,7 @@ class post_in_queue extends \phpbb\notification\type\post
 	* Find the users who want to receive notifications
 	*
 	* @param array $post Data from the post
+	* @param array $options Options for finding users for notification
 	*
 	* @return array
 	*/

phpBB/phpbb/notification/type/quote.php

@@ -66,7 +66,8 @@ class quote extends \phpbb\notification\type\post
 	/**
 	* Find the users who want to receive notifications
 	*
-	* @param array $post Data from
+	* @param array $post Data from submit_post
+	* @param array $options Options for finding users for notification
 	*
 	* @return array
 	*/
@@ -122,7 +123,7 @@ class quote extends \phpbb\notification\type\post
 	/**
 	* Update a notification
 	*
-	* @param array $data Data specific for this type that will be updated
+	* @param array $post Data specific for this type that will be updated
 	*/
 	public function update_notifications($post)
 	{

phpBB/phpbb/notification/type/report_pm.php

@@ -94,6 +94,7 @@ class report_pm extends \phpbb\notification\type\pm
 	*  (copied from post_in_queue)
 	*
 	* @param array $post Data from the post
+	* @param array $options Options for finding users for notification
 	*
 	* @return array
 	*/

phpBB/phpbb/notification/type/report_pm_closed.php

@@ -52,7 +52,8 @@ class report_pm_closed extends \phpbb\notification\type\pm
 	/**
 	* Find the users who want to receive notifications
 	*
-	* @param array $pm Data from
+	* @param array $pm Data from submit_pm
+	* @param array $options Options for finding users for notification
 	*
 	* @return array
 	*/

phpBB/phpbb/notification/type/report_post.php

@@ -76,6 +76,7 @@ class report_post extends \phpbb\notification\type\post_in_queue
 	* Find the users who want to receive notifications
 	*
 	* @param array $post Data from the post
+	* @param array $options Options for finding users for notification
 	*
 	* @return array
 	*/

phpBB/phpbb/notification/type/report_post_closed.php

@@ -59,7 +59,8 @@ class report_post_closed extends \phpbb\notification\type\post
 	/**
 	* Find the users who want to receive notifications
 	*
-	* @param array $post Data from
+	* @param array $post Data from submit_post
+	* @param array $options Options for finding users for notification
 	*
 	* @return array
 	*/

phpBB/phpbb/notification/type/topic.php

@@ -87,6 +87,7 @@ class topic extends \phpbb\notification\type\base
 	* Find the users who want to receive notifications
 	*
 	* @param array $topic Data from the topic
+	* @param array $options Options for finding users for notification
 	*
 	* @return array
 	*/

phpBB/phpbb/notification/type/topic_in_queue.php

@@ -70,6 +70,7 @@ class topic_in_queue extends \phpbb\notification\type\topic
 	* Find the users who want to receive notifications
 	*
 	* @param array $topic Data from the topic
+	* @param array $options Options for finding users for notification
 	*
 	* @return array
 	*/

phpBB/phpbb/path_helper.php

@@ -46,7 +46,7 @@ class path_helper
 	* @param \phpbb\filesystem $filesystem
 	* @param \phpbb\request\request_interface $request
 	* @param string $phpbb_root_path Relative path to phpBB root
-	* @param string $php_ext PHP extension (php)
+	* @param string $php_ext PHP file extension
 	* @param mixed $adm_relative_path Relative path admin path to adm/ root
 	*/
 	public function __construct(\phpbb\symfony_request $symfony_request, \phpbb\filesystem $filesystem, \phpbb\request\request_interface $request, $phpbb_root_path, $php_ext, $adm_relative_path = null)

phpBB/phpbb/profilefields/type/type_interface.php

@@ -189,8 +189,8 @@ interface type_interface
 	/**
 	* Allows manipulating the intended variables if needed
 	*
-	* @param string	$key			Name of the option
 	* @param int	$step			Step on which the option is hidden
+	* @param string	$key			Name of the option
 	* @param string	$action			Currently performed action (create|edit)
 	* @param array	$field_data		Array with data for this field
 	* @return mixed		Final value of the option

phpBB/phpbb/search/base.php

@@ -85,8 +85,12 @@ class base
 	/**
 	* Retrieves cached search results
 	*
-	* @param int &$result_count will contain the number of all results for the search (not only for the current page)
+	* @param string $search_key		an md5 string generated from all the passed search options to identify the results
-	* @param array &$id_ary is filled with the ids belonging to the requested page that are stored in the cache
+	* @param int	&$result_count	will contain the number of all results for the search (not only for the current page)
+	* @param array 	&$id_ary 		is filled with the ids belonging to the requested page that are stored in the cache
+	* @param int 	&$start			indicates the first index of the page
+	* @param int 	$per_page		number of ids each page is supposed to contain
+	* @param string $sort_dir		is either a or d representing ASC and DESC
 	*
 	* @return int SEARCH_RESULT_NOT_IN_CACHE or SEARCH_RESULT_IN_CACHE or SEARCH_RESULT_INCOMPLETE
 	*/
@@ -160,8 +164,16 @@ class base
 	/**
 	* Caches post/topic ids
 	*
-	* @param array &$id_ary contains a list of post or topic ids that shall be cached, the first element
+	* @param string $search_key		an md5 string generated from all the passed search options to identify the results
+	* @param string $keywords 		contains the keywords as entered by the user
+	* @param array	$author_ary		an array of author ids, if the author should be ignored during the search the array is empty
+	* @param int 	$result_count	contains the number of all results for the search (not only for the current page)
+	* @param array	&$id_ary 		contains a list of post or topic ids that shall be cached, the first element
 	* 	must have the absolute index $start in the result set.
+	* @param int	$start			indicates the first index of the page
+	* @param string $sort_dir		is either a or d representing ASC and DESC
+	*
+	* @return null
 	*/
 	function save_ids($search_key, $keywords, $author_ary, $result_count, &$id_ary, $start, $sort_dir)
 	{

phpBB/phpbb/search/fulltext_mysql.php

@@ -73,6 +73,12 @@ class fulltext_mysql extends \phpbb\search\base
 	 * Creates a new \phpbb\search\fulltext_mysql, which is used as a search backend
 	 *
 	 * @param string|bool $error Any error that occurs is passed on through this reference variable otherwise false
+	 * @param string $phpbb_root_path Relative path to phpBB root
+	 * @param string $phpEx PHP file extension
+	 * @param \phpbb\auth\auth $auth Auth object
+	 * @param \phpbb\config\config $config Config object
+	 * @param \phpbb\db\driver\driver_interface Database object
+	 * @param \phpbb\user $user User object
 	 */
 	public function __construct(&$error, $phpbb_root_path, $phpEx, $auth, $config, $db, $user)
 	{

phpBB/phpbb/search/fulltext_postgres.php

@@ -86,6 +86,12 @@ class fulltext_postgres extends \phpbb\search\base
 	 * Creates a new \phpbb\search\fulltext_postgres, which is used as a search backend
 	 *
 	 * @param string|bool $error Any error that occurs is passed on through this reference variable otherwise false
+	 * @param string $phpbb_root_path Relative path to phpBB root
+	 * @param string $phpEx PHP file extension
+	 * @param \phpbb\auth\auth $auth Auth object
+	 * @param \phpbb\config\config $config Config object
+	 * @param \phpbb\db\driver\driver_interface Database object
+	 * @param \phpbb\user $user User object
 	 */
 	public function __construct(&$error, $phpbb_root_path, $phpEx, $auth, $config, $db, $user)
 	{

phpBB/phpbb/search/fulltext_sphinx.php

@@ -119,6 +119,12 @@ class fulltext_sphinx
 	 * Creates a new \phpbb\search\fulltext_postgres, which is used as a search backend
 	 *
 	 * @param string|bool $error Any error that occurs is passed on through this reference variable otherwise false
+	 * @param string $phpbb_root_path Relative path to phpBB root
+	 * @param string $phpEx PHP file extension
+	 * @param \phpbb\auth\auth $auth Auth object
+	 * @param \phpbb\config\config $config Config object
+	 * @param \phpbb\db\driver\driver_interface Database object
+	 * @param \phpbb\user $user User object
 	 */
 	public function __construct(&$error, $phpbb_root_path, $phpEx, $auth, $config, $db, $user)
 	{

phpBB/phpbb/session.php

@@ -1062,11 +1062,13 @@ class session
 	* Check for banned user
 	*
 	* Checks whether the supplied user is banned by id, ip or email. If no parameters
-	* are passed to the method pre-existing session data is used. If $return is false
+	* are passed to the method pre-existing session data is used.
-	* this routine does not return on finding a banned user, it outputs a relevant
-	* message and stops execution.
 	*
-	* @param string|array	$user_ips	Can contain a string with one IP or an array of multiple IPs
+	* @param int|false		$user_id		The user id
+	* @param mixed			$user_ips		Can contain a string with one IP or an array of multiple IPs
+	* @param string|false	$user_email		The user email
+	* @param bool			$return			If $return is false this routine does not return on finding a banned user,
+	*	it outputs a relevant message and stops execution.
 	*/
 	function check_ban($user_id = false, $user_ips = false, $user_email = false, $return = false)
 	{
@@ -1254,12 +1256,14 @@ class session
 
 	/**
 	* Check if ip is blacklisted
-	* This should be called only where absolutly necessary
+	* This should be called only where absolutely necessary
 	*
 	* Only IPv4 (rbldns does not support AAAA records/IPv6 lookups)
 	*
 	* @author satmd (from the php manual)
-	* @param string $mode register/post - spamcop for example is ommitted for posting
+	* @param string 		$mode	register/post - spamcop for example is ommitted for posting
+	* @param string|false	$ip		the IPv4 address to check
+	*
 	* @return false if ip is not blacklisted, else an array([checked server], [lookup])
 	*/
 	function check_dnsbl($mode, $ip = false)

phpBB/phpbb/template/asset.php

@@ -24,6 +24,7 @@ class asset
 	* Constructor
 	*
 	* @param string $url URL
+	* @param \phpbb\path_helper $path_helper Path helper object
 	*/
 	public function __construct($url, \phpbb\path_helper $path_helper)
 	{

phpBB/phpbb/template/twig/definition.php

@@ -25,6 +25,8 @@ class definition
 	* Get a DEFINE'd variable
 	*
 	* @param string $name
+	* @param array $arguments
+	*
 	* @return mixed Null if not found
 	*/
 	public function __call($name, $arguments)

phpBB/phpbb/template/twig/environment.php

@@ -36,11 +36,10 @@ class environment extends \Twig_Environment
 	/**
 	* Constructor
 	*
-	* @param \phpbb\config\config $phpbb_config
+	* @param \phpbb\config\config $phpbb_config The phpBB configuration
-	* @param \phpbb\path_helper
+	* @param \phpbb\path_helper $path_helper phpBB path helper
-	* @param \phpbb\extension\manager
+	* @param \phpbb\extension\manager $extension_manager phpBB extension manager
-	* @param string $phpbb_root_path
+	* @param \Twig_LoaderInterface $loader Twig loader interface
-	* @param \Twig_LoaderInterface $loader
 	* @param array $options Array of options to pass to Twig
 	*/
 	public function __construct($phpbb_config, \phpbb\path_helper $path_helper, \phpbb\extension\manager $extension_manager = null, \Twig_LoaderInterface $loader = null, $options = array())

phpBB/phpbb/template/twig/extension.php

@@ -162,7 +162,6 @@ class extension extends \Twig_Extension
 	* (e.g. in the ACP, L_TITLE)
 	* If not, we return the result of $user->lang()
 	*
-	* @param string $lang name
 	* @return string
 	*/
 	function lang()

phpBB/phpbb/tree/tree_interface.php

@@ -18,7 +18,7 @@ interface tree_interface
 	/**
 	* Inserts an item into the database table and into the tree.
 	*
-	* @param array	$item	The item to be added
+	* @param array	$additional_data	The item to be added
 	* @return array Array with item data as set in the database
 	*/
 	public function insert(array $additional_data);