aboutsummaryrefslogtreecommitdiffstats
path: root/includes/Rest/Handler
diff options
context:
space:
mode:
authorthiemowmde <thiemo.kreuz@wikimedia.de>2025-01-16 14:24:44 +0100
committerthiemowmde <thiemo.kreuz@wikimedia.de>2025-01-16 14:24:44 +0100
commit659df897ea828bba243ca9879875870c35e7bb03 (patch)
treee7ed15e123fc3c70933b356b8ae55d9998a6fb57 /includes/Rest/Handler
parenta9d4d54f74d224cb068510c7715dbfa1ad46123d (diff)
downloadmediawikicore-659df897ea828bba243ca9879875870c35e7bb03.tar.gz
mediawikicore-659df897ea828bba243ca9879875870c35e7bb03.zip
Remove trivial 1-line PHPDocs that just repeat the code
I assume these are all either auto-generated by an IDE or the language-level type declarations have been added later. In any case the comments don't add any new information to what the code already says. This is just extra clutter that makes the code harder to read, I would argue. There are many, many more comments like this. In this patch I intentionally focus on the most trivial 1-line comments. Change-Id: Ia294bf4ce0d8a77036842fe25884bc175c2b0e7d
Diffstat (limited to 'includes/Rest/Handler')
-rw-r--r--includes/Rest/Handler/DiscoveryHandler.php3
-rw-r--r--includes/Rest/Handler/Helper/HtmlInputTransformHelper.php3
-rw-r--r--includes/Rest/Handler/Helper/HtmlOutputRendererHelper.php6
-rw-r--r--includes/Rest/Handler/Helper/PageContentHelper.php9
-rw-r--r--includes/Rest/Handler/Helper/PageRedirectHelper.php6
-rw-r--r--includes/Rest/Handler/Helper/RevisionContentHelper.php9
6 files changed, 0 insertions, 36 deletions
diff --git a/includes/Rest/Handler/DiscoveryHandler.php b/includes/Rest/Handler/DiscoveryHandler.php
index 17d2f3dd2767..833fc0522749 100644
--- a/includes/Rest/Handler/DiscoveryHandler.php
+++ b/includes/Rest/Handler/DiscoveryHandler.php
@@ -28,9 +28,6 @@ class DiscoveryHandler extends Handler {
/** @var ServiceOptions */
private ServiceOptions $options;
- /**
- * @param Config $config
- */
public function __construct( Config $config ) {
$options = new ServiceOptions( self::CONSTRUCTOR_OPTIONS, $config );
$options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
diff --git a/includes/Rest/Handler/Helper/HtmlInputTransformHelper.php b/includes/Rest/Handler/Helper/HtmlInputTransformHelper.php
index 6a0f8cf6f841..201c7891152a 100644
--- a/includes/Rest/Handler/Helper/HtmlInputTransformHelper.php
+++ b/includes/Rest/Handler/Helper/HtmlInputTransformHelper.php
@@ -133,9 +133,6 @@ class HtmlInputTransformHelper {
}
}
- /**
- * @return array
- */
public function getParamSettings(): array {
// JSON body schema:
/*
diff --git a/includes/Rest/Handler/Helper/HtmlOutputRendererHelper.php b/includes/Rest/Handler/Helper/HtmlOutputRendererHelper.php
index b0530af0b4b3..51ca17fceb8e 100644
--- a/includes/Rest/Handler/Helper/HtmlOutputRendererHelper.php
+++ b/includes/Rest/Handler/Helper/HtmlOutputRendererHelper.php
@@ -619,9 +619,6 @@ class HtmlOutputRendererHelper implements HtmlOutputHelper {
return $title->getPageLanguage();
}
- /**
- * @return ParserOutput
- */
private function getParserOutput(): ParserOutput {
if ( !$this->parserOutput ) {
$this->parserOptions->setRenderReason( __METHOD__ );
@@ -809,9 +806,6 @@ class HtmlOutputRendererHelper implements HtmlOutputHelper {
}
}
- /**
- * @return Status
- */
private function getParserOutputInternal(): Status {
// NOTE: ParserOutputAccess::getParserOutput() should be used for revisions
// that come from the database. Either this revision is null to indicate
diff --git a/includes/Rest/Handler/Helper/PageContentHelper.php b/includes/Rest/Handler/Helper/PageContentHelper.php
index 91b534877bb9..366124ff20a7 100644
--- a/includes/Rest/Handler/Helper/PageContentHelper.php
+++ b/includes/Rest/Handler/Helper/PageContentHelper.php
@@ -202,9 +202,6 @@ class PageContentHelper {
return $content;
}
- /**
- * @return bool
- */
public function isAccessible(): bool {
$page = $this->getPageIdentity();
return $page && $this->authority->probablyCan( 'read', $page );
@@ -251,9 +248,6 @@ class PageContentHelper {
return $this->useDefaultSystemMessage() || (bool)$this->getPage();
}
- /**
- * @return array
- */
public function constructMetadata(): array {
$revision = $this->getRevisionRecordForMetadata();
@@ -274,9 +268,6 @@ class PageContentHelper {
];
}
- /**
- * @return array
- */
public function constructRestbaseCompatibleMetadata(): array {
$revision = $this->getRevisionRecordForMetadata();
diff --git a/includes/Rest/Handler/Helper/PageRedirectHelper.php b/includes/Rest/Handler/Helper/PageRedirectHelper.php
index 32243bd0ba69..b42164bfae27 100644
--- a/includes/Rest/Handler/Helper/PageRedirectHelper.php
+++ b/includes/Rest/Handler/Helper/PageRedirectHelper.php
@@ -50,16 +50,10 @@ class PageRedirectHelper {
$this->languageConverterFactory = $languageConverterFactory;
}
- /**
- * @param bool $useRelativeRedirects
- */
public function setUseRelativeRedirects( bool $useRelativeRedirects ): void {
$this->useRelativeRedirects = $useRelativeRedirects;
}
- /**
- * @param bool $followWikiRedirects
- */
public function setFollowWikiRedirects( bool $followWikiRedirects ): void {
$this->followWikiRedirects = $followWikiRedirects;
}
diff --git a/includes/Rest/Handler/Helper/RevisionContentHelper.php b/includes/Rest/Handler/Helper/RevisionContentHelper.php
index c079f85bcaab..b717a8936285 100644
--- a/includes/Rest/Handler/Helper/RevisionContentHelper.php
+++ b/includes/Rest/Handler/Helper/RevisionContentHelper.php
@@ -55,9 +55,6 @@ class RevisionContentHelper extends PageContentHelper {
return $this->targetRevision;
}
- /**
- * @return bool
- */
public function isAccessible(): bool {
if ( !parent::isAccessible() ) {
return false;
@@ -76,9 +73,6 @@ class RevisionContentHelper extends PageContentHelper {
return true;
}
- /**
- * @return bool
- */
public function hasContent(): bool {
return (bool)$this->getTargetRevision();
}
@@ -94,9 +88,6 @@ class RevisionContentHelper extends PageContentHelper {
parent::setCacheControl( $response, $expiry );
}
- /**
- * @return array
- */
public function constructMetadata(): array {
$page = $this->getPage();
$revision = $this->getTargetRevision();