2ba01c7ee7
… including PHPDoc tags like `@return <type> $variableName`. A return value doesn't have a variable name. I can see that some people do this intentionally, repeating the variable name that was used in the final `return $var;` at the end of a method. This can indeed be helpful. I leave a lot of these untouched and removed them only when it's obviously wrong, or does not provide any additional information in addition to what the code already says. Change-Id: Ia18cd9f25ef658b08ad25b97a744897e2a8deffc
26 lines
625 B
PHP
26 lines
625 B
PHP
<?php
|
|
|
|
namespace MediaWiki\Api\Hook;
|
|
|
|
use ApiBase;
|
|
use Message;
|
|
|
|
/**
|
|
* This is a hook handler interface, see docs/Hooks.md.
|
|
* Use the hook name "APIGetParamDescriptionMessages" to register handlers implementing this interface.
|
|
*
|
|
* @stable to implement
|
|
* @ingroup Hooks
|
|
*/
|
|
interface APIGetParamDescriptionMessagesHook {
|
|
/**
|
|
* Use this hook to modify a module's parameter descriptions.
|
|
*
|
|
* @since 1.35
|
|
*
|
|
* @param ApiBase $module
|
|
* @param Message[][] &$msg
|
|
* @return bool|void True or no return value to continue or false to abort
|
|
*/
|
|
public function onAPIGetParamDescriptionMessages( $module, &$msg );
|
|
}
|