mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/DiscussionTools
synced 2024-11-24 00:13:36 +00:00
69e8e948b2
MediaWiki's PHPCS plugin requires documentation comments on all methods, unless those methods are fully typed (all parameters and return value). It turns out that almost all of our methods are fully typed already. Procedure: 1. Find: \*(\s*\*\s*(@param \??[\w\\]+(\|null)? &?\$\w+|@return \??[\w\\]+(\|null)?)\n)+\s*\*/ Replace with: */ This deletes type annotations, except those not representable as PHP type hints such as union types `a|b` or typed arrays `a[]`, or those with documentation beyond type hints, or those on functions with any other annotations. 2. Find: /\*\*/\n\s* Replace with nothing This deletes the remaining comments on methods that had no prose documentation. 3. Undo all changes that PHPCS complains about (those comments were not redundant) 4. Review the diff carefully, these regexps are imprecise :) Change-Id: Ic82e8b23f2996f44951208dbd9cfb4c8e0738dac
52 lines
1.3 KiB
PHP
52 lines
1.3 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Extension\DiscussionTools\Tests;
|
|
|
|
use MediaWiki\Extension\DiscussionTools\ContentThreadItemSet;
|
|
use MediaWiki\Extension\DiscussionTools\Notifications\EventDispatcher;
|
|
use MediaWiki\Page\PageIdentity;
|
|
use MediaWiki\Revision\RevisionRecord;
|
|
use MediaWiki\Title\Title;
|
|
use MediaWiki\User\UserIdentity;
|
|
|
|
class MockEventDispatcher extends EventDispatcher {
|
|
|
|
/**
|
|
* Public for testing
|
|
*
|
|
* Note that we can't use TestingAccessWrapper instead of this, because it doesn't support passing
|
|
* arguments by reference (causes exceptions like "PHPUnit\Framework\Error\Warning: Parameter 1 to
|
|
* ... expected to be a reference, value given").
|
|
*/
|
|
public static function generateEventsFromItemSets(
|
|
array &$events,
|
|
ContentThreadItemSet $oldItemSet,
|
|
ContentThreadItemSet $newItemSet,
|
|
RevisionRecord $newRevRecord,
|
|
PageIdentity $title,
|
|
UserIdentity $user
|
|
): void {
|
|
parent::generateEventsFromItemSets(
|
|
$events,
|
|
$oldItemSet,
|
|
$newItemSet,
|
|
$newRevRecord,
|
|
$title,
|
|
$user
|
|
);
|
|
}
|
|
|
|
/**
|
|
* No-op for testing
|
|
*/
|
|
public static function addCommentChangeTag( RevisionRecord $newRevRecord ): void {
|
|
}
|
|
|
|
/**
|
|
* No-op for testing
|
|
*/
|
|
protected static function addAutoSubscription( UserIdentity $user, Title $title, string $itemName ): void {
|
|
}
|
|
|
|
}
|