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

PHPBB3-12557

phpBB/includes/functions_module.php

@@ -542,6 +542,8 @@ 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 $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/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 extension (php)
 	 */
 	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/controller/helper.php

@@ -85,6 +85,8 @@ class helper
 	* @param string $handle 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/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/mimetype/guesser.php

@@ -96,11 +96,7 @@ class guesser
 	}
 
 	/**
-	* Guess mimetype of supplied file
+	* @inheritdoc
-	*
-	* @param string $file Path to file
-	*
-	* @return string Guess for mimetype of file
 	*/
 	public function guess($file, $file_name = '')
 	{

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);