Add missing documentation to class properties

Change-Id: Icdcaa4c34d512c2058fa0d0e349a2cca2ca2e543
This commit is contained in:
Umherirrender 2024-08-20 23:46:31 +02:00
parent 3cb17f95da
commit 116ead6d4f
3 changed files with 22 additions and 1 deletions

View file

@ -2,7 +2,6 @@
<ruleset> <ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki"> <rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
<exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPrivate" /> <exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPrivate" />
<exclude name="MediaWiki.Commenting.PropertyDocumentation.MissingDocumentationPrivate" />
<exclude name="Squiz.Scope.MethodScope.Missing" /> <exclude name="Squiz.Scope.MethodScope.Missing" />
</rule> </rule>
<file>.</file> <file>.</file>

View file

@ -47,16 +47,27 @@ require_once "$IP/maintenance/Maintenance.php";
* @SuppressWarnings(LongVariable) * @SuppressWarnings(LongVariable)
*/ */
class ReplaceAll extends Maintenance { class ReplaceAll extends Maintenance {
/** @var User */
private $user; private $user;
/** @var string[] */
private $target; private $target;
/** @var string[] */
private $replacement; private $replacement;
/** @var int[] */
private $namespaces; private $namespaces;
/** @var string */
private $category; private $category;
/** @var string */
private $prefix; private $prefix;
/** @var int */
private $pageLimit; private $pageLimit;
/** @var bool[] */
private $useRegex; private $useRegex;
/** @var bool */
private $defaultContinue; private $defaultContinue;
/** @var bool */
private $botEdit; private $botEdit;
/** @var bool */
private $rename; private $rename;
public function __construct() { public function __construct() {

View file

@ -43,16 +43,27 @@ use Wikimedia\Rdbms\IConnectionProvider;
use Wikimedia\Rdbms\ReadOnlyMode; use Wikimedia\Rdbms\ReadOnlyMode;
class SpecialReplaceText extends SpecialPage { class SpecialReplaceText extends SpecialPage {
/** @var string */
private $target; private $target;
/** @var string */
private $targetString; private $targetString;
/** @var string */
private $replacement; private $replacement;
/** @var bool */
private $use_regex; private $use_regex;
/** @var string */
private $category; private $category;
/** @var string */
private $prefix; private $prefix;
/** @var string|int */
private $pageLimit; private $pageLimit;
/** @var bool */
private $edit_pages; private $edit_pages;
/** @var bool */
private $move_pages; private $move_pages;
/** @var int[] */
private $selected_namespaces; private $selected_namespaces;
/** @var bool */
private $botEdit; private $botEdit;
/** @var HookHelper */ /** @var HookHelper */