diff options
| author | apaskulin <apaskulin@wikimedia.org> | 2020-03-16 16:31:05 -0700 |
|---|---|---|
| committer | Tim Starling <tstarling@wikimedia.org> | 2020-04-21 09:10:08 +1000 |
| commit | c44488f72549331733ef261b90058fd73d7badde (patch) | |
| tree | 91ac013c191dbab31525b506083ccb0b37ce3a57 /includes/diff/Hook/DiffViewHeaderHook.php | |
| parent | f5aaf75ad15813bfeb93dcb4e5fbaaa52b23c7fe (diff) | |
| download | mediawikicore-c44488f72549331733ef261b90058fd73d7badde.tar.gz mediawikicore-c44488f72549331733ef261b90058fd73d7badde.zip | |
docs: Hook interface doc comment review
Edited doc comments for hook interfaces to improve
consistency and add type hints.
Bug: T246855
Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
Diffstat (limited to 'includes/diff/Hook/DiffViewHeaderHook.php')
| -rw-r--r-- | includes/diff/Hook/DiffViewHeaderHook.php | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/includes/diff/Hook/DiffViewHeaderHook.php b/includes/diff/Hook/DiffViewHeaderHook.php index 580a6106f120..66e87b84cbb6 100644 --- a/includes/diff/Hook/DiffViewHeaderHook.php +++ b/includes/diff/Hook/DiffViewHeaderHook.php @@ -2,19 +2,22 @@ namespace MediaWiki\Diff\Hook; +use DifferenceEngine; +use Revision; + /** * @stable for implementation * @ingroup Hooks */ interface DiffViewHeaderHook { /** - * Called before diff display + * This hook is called before diff display. * * @since 1.35 * - * @param ?mixed $diff DifferenceEngine object that's calling - * @param ?mixed $oldRev Revision object of the "old" revision (may be null/invalid) - * @param ?mixed $newRev Revision object of the "new" revision + * @param DifferenceEngine $diff + * @param Revision|null $oldRev Old revision (may be null/invalid) + * @param Revision $newRev New revision * @return bool|void True or no return value to continue or false to abort */ public function onDiffViewHeader( $diff, $oldRev, $newRev ); |