[ticket/16271] Fix invalid docblocks

PHPBB3-16271
This commit is contained in:
Marc Alexander 2019-12-27 14:58:42 +01:00
parent 41f287fbea
commit 7cf148ea13
No known key found for this signature in database
GPG key ID: 50E0D2423696F995
11 changed files with 18 additions and 8 deletions

View file

@ -44,7 +44,7 @@ class bbcode
/** /**
* Init bbcode cache entries if bitfield is specified * Init bbcode cache entries if bitfield is specified
* *
* @param string $bbcode_bitfield The bbcode bitfield * @param string $bitfield The bbcode bitfield
*/ */
function bbcode_set_bitfield($bitfield = '') function bbcode_set_bitfield($bitfield = '')
{ {

View file

@ -40,8 +40,8 @@ class ldap extends base
/** /**
* LDAP Authentication Constructor * LDAP Authentication Constructor
* *
* @param driver_interface $db DBAL driver interface
* @param config $config Config object * @param config $config Config object
* @param driver_interface $db DBAL driver interface
* @param language $language Language object * @param language $language Language object
* @param user $user User object * @param user $user User object
*/ */

View file

@ -73,8 +73,6 @@ interface service_interface
/** /**
* Returns the external library service provider once it has been set * Returns the external library service provider once it has been set
*
* @param \OAuth\Common\Service\ServiceInterface|null
*/ */
public function get_external_service_provider(); public function get_external_service_provider();

View file

@ -145,9 +145,11 @@ class run extends \phpbb\console\command\command
* and returns with status 2. * and returns with status 2.
* *
* @see execute * @see execute
* @param string $task_name The name of the task that should be run. *
* @param InputInterface $input The input stream used to get the argument and verbose option. * @param InputInterface $input The input stream used to get the argument and verbose option.
* @param OutputInterface $output The output stream, used for printing verbose-mode and error information. * @param OutputInterface $output The output stream, used for printing verbose-mode and error information.
* @param string $task_name The name of the task that should be run.
*
* @return int 0 if all is well, 2 if no task matches $task_name. * @return int 0 if all is well, 2 if no task matches $task_name.
*/ */
protected function run_one(InputInterface $input, OutputInterface $output, $task_name) protected function run_one(InputInterface $input, OutputInterface $output, $task_name)

View file

@ -223,6 +223,7 @@ class check extends \phpbb\console\command\command
* Check if all the available extensions are up to date * Check if all the available extensions are up to date
* *
* @param SymfonyStyle $io IO handler, for formatted and unified IO * @param SymfonyStyle $io IO handler, for formatted and unified IO
* @param string $stability Stability specifier string
* @param bool $recheck Disallow the use of the cache * @param bool $recheck Disallow the use of the cache
* @return int * @return int
*/ */

View file

@ -151,6 +151,7 @@ class language_file_loader
* *
* @param string $path Path to language directory * @param string $path Path to language directory
* @param string $filename Filename to load language strings from * @param string $filename Filename to load language strings from
* @param array $locales Array containing language fallback options
* *
* @return string Relative path to language file * @return string Relative path to language file
* *

View file

@ -325,6 +325,8 @@ class plupload
* by PHP and actually exists, if not, it generates an error * by PHP and actually exists, if not, it generates an error
* *
* @param string $form_name The name of the file in the form data * @param string $form_name The name of the file in the form data
* @param int $chunk Chunk number
* @param string $file_path File path
* *
* @return null * @return null
*/ */

View file

@ -268,7 +268,7 @@ class request implements \phpbb\request\request_interface
* whatever). * whatever).
* *
* @param string|array $var_name See \phpbb\request\request_interface::variable * @param string|array $var_name See \phpbb\request\request_interface::variable
* @param mixed $Default See \phpbb\request\request_interface::variable * @param mixed $default See \phpbb\request\request_interface::variable
* *
* @return mixed The server variable value. * @return mixed The server variable value.
*/ */

View file

@ -104,7 +104,7 @@ interface request_interface
* *
* @return mixed The header value. * @return mixed The header value.
*/ */
public function header($var_name, $default = ''); public function header($header_name, $default = '');
/** /**
* Checks whether a certain variable was sent via POST. * Checks whether a certain variable was sent via POST.

View file

@ -83,7 +83,7 @@ class fulltext_mysql extends \phpbb\search\base
* @param string $phpEx PHP file extension * @param string $phpEx PHP file extension
* @param \phpbb\auth\auth $auth Auth object * @param \phpbb\auth\auth $auth Auth object
* @param \phpbb\config\config $config Config object * @param \phpbb\config\config $config Config object
* @param \phpbb\db\driver\driver_interface Database object * @param \phpbb\db\driver\driver_interface $db Database object
* @param \phpbb\user $user User object * @param \phpbb\user $user User object
* @param \phpbb\event\dispatcher_interface $phpbb_dispatcher Event dispatcher object * @param \phpbb\event\dispatcher_interface $phpbb_dispatcher Event dispatcher object
*/ */

View file

@ -109,6 +109,12 @@ class fulltext_native extends \phpbb\search\base
* Initialises the fulltext_native search backend with min/max word length * Initialises the fulltext_native search backend with min/max word length
* *
* @param boolean|string &$error is passed by reference and should either be set to false on success or an error message on failure * @param boolean|string &$error is passed by reference and should either be set to false on success or an error message on failure
* @param string $phpbb_root_path phpBB root path
* @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 $db Database object
* @param \phpbb\user $user User object
* @param \phpbb\event\dispatcher_interface $phpbb_dispatcher Event dispatcher object * @param \phpbb\event\dispatcher_interface $phpbb_dispatcher Event dispatcher object
*/ */
public function __construct(&$error, $phpbb_root_path, $phpEx, $auth, $config, $db, $user, $phpbb_dispatcher) public function __construct(&$error, $phpbb_root_path, $phpEx, $auth, $config, $db, $user, $phpbb_dispatcher)