1fc8d79ac6
For example, documenting the method getUser() with "get the User object" does not add any information that's not already there. But I have to read the text first to understand that it doesn't document anything that's not already obvious from the code. Some of this is from a time when we had a PHPCS sniff that was complaining when a line like `@param User $user` doesn't end with some descriptive text. Some users started adding text like `@param User $user The User` back then. Let's please remove this. Change-Id: I0ea8d051bc732466c73940de9259f87ffb86ce7a
28 lines
870 B
PHP
28 lines
870 B
PHP
<?php
|
|
|
|
namespace MediaWiki\Api\Hook;
|
|
|
|
use ApiBase;
|
|
|
|
/**
|
|
* This is a hook handler interface, see docs/Hooks.md.
|
|
* Use the hook name "APIHelpModifyOutput" to register handlers implementing this interface.
|
|
*
|
|
* @stable to implement
|
|
* @ingroup Hooks
|
|
*/
|
|
interface APIHelpModifyOutputHook {
|
|
/**
|
|
* Use this hook to modify an API module's help output.
|
|
*
|
|
* @since 1.35
|
|
*
|
|
* @param ApiBase $module
|
|
* @param string[] &$help Array of HTML strings to be joined for the output
|
|
* @param array $options Array of formatting options passed to ApiHelp::getHelp
|
|
* @param array &$tocData If a TOC is being generated, this array has keys as anchors in
|
|
* the page and values as for Linker::generateTOC().
|
|
* @return bool|void True or no return value to continue or false to abort
|
|
*/
|
|
public function onAPIHelpModifyOutput( $module, &$help, $options, &$tocData );
|
|
}
|