jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/402655 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: I4f5f3e9cd0c044ad29440475b61781957f4ef507
---
M .phpcs.xml
M api/ApiCodeDiff.php
M api/ApiCodeUpdate.php
M api/ApiQueryCodeComments.php
M api/ApiQueryCodePaths.php
M api/ApiQueryCodeRevisions.php
M api/ApiQueryCodeTags.php
M api/ApiRevisionUpdate.php
M backend/Subversion.php
M ui/SpecialCode.php
10 files changed, 9 insertions(+), 8 deletions(-)
Approvals:
jenkins-bot: Verified
Thiemo Kreuz (WMDE): Looks good to me, approved
diff --git a/.phpcs.xml b/.phpcs.xml
index aa00a4e..759a46d 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -9,7 +9,6 @@
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingReturn" />
<exclude name="MediaWiki.Commenting.FunctionComment.WrongStyle"
/>
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.WrongCase"
/>
diff --git a/api/ApiCodeDiff.php b/api/ApiCodeDiff.php
index 451db8a..42d2953 100644
--- a/api/ApiCodeDiff.php
+++ b/api/ApiCodeDiff.php
@@ -86,7 +86,7 @@
}
/**
- * @see ApiBase::getExamplesMessages()
+ * @inheritDoc
*/
protected function getExamplesMessages() {
return [
diff --git a/api/ApiCodeUpdate.php b/api/ApiCodeUpdate.php
index 4a6a0a6..1c1ed4b 100644
--- a/api/ApiCodeUpdate.php
+++ b/api/ApiCodeUpdate.php
@@ -106,7 +106,7 @@
}
/**
- * @see ApiBase::getExamplesMessages()
+ * @inheritDoc
*/
protected function getExamplesMessages() {
return [
diff --git a/api/ApiQueryCodeComments.php b/api/ApiQueryCodeComments.php
index 858f57e..f7621d7 100644
--- a/api/ApiQueryCodeComments.php
+++ b/api/ApiQueryCodeComments.php
@@ -144,7 +144,7 @@
}
/**
- * @see ApiBase::getExamplesMessages()
+ * @inheritDoc
*/
protected function getExamplesMessages() {
return [
diff --git a/api/ApiQueryCodePaths.php b/api/ApiQueryCodePaths.php
index 4d70df5..eae40e2 100644
--- a/api/ApiQueryCodePaths.php
+++ b/api/ApiQueryCodePaths.php
@@ -84,7 +84,7 @@
}
/**
- * @see ApiBase::getExamplesMessages()
+ * @inheritDoc
*/
protected function getExamplesMessages() {
return [
diff --git a/api/ApiQueryCodeRevisions.php b/api/ApiQueryCodeRevisions.php
index 767a4ea..0bbff46 100644
--- a/api/ApiQueryCodeRevisions.php
+++ b/api/ApiQueryCodeRevisions.php
@@ -221,7 +221,7 @@
}
/**
- * @see ApiBase::getExamplesMessages()
+ * @inheritDoc
*/
protected function getExamplesMessages() {
return [
diff --git a/api/ApiQueryCodeTags.php b/api/ApiQueryCodeTags.php
index 16eebeb..286a9d3 100644
--- a/api/ApiQueryCodeTags.php
+++ b/api/ApiQueryCodeTags.php
@@ -67,7 +67,7 @@
}
/**
- * @see ApiBase::getExamplesMessages()
+ * @inheritDoc
*/
protected function getExamplesMessages() {
return [
diff --git a/api/ApiRevisionUpdate.php b/api/ApiRevisionUpdate.php
index 69bf1d3..e38fb56 100644
--- a/api/ApiRevisionUpdate.php
+++ b/api/ApiRevisionUpdate.php
@@ -182,7 +182,7 @@
}
/**
- * @see ApiBase::getExamplesMessages()
+ * @inheritDoc
*/
protected function getExamplesMessages() {
return [
diff --git a/backend/Subversion.php b/backend/Subversion.php
index da564ee..23f3419 100644
--- a/backend/Subversion.php
+++ b/backend/Subversion.php
@@ -84,6 +84,7 @@
* Nobody ever bothered filling in the documentation on php.net though.
* The function returns a big array of a bunch of info about the
repository
* It throws a warning if the repository does not exist.
+ * @return true
*/
function canConnect() {
// MediaWiki\suppressWarnings();
diff --git a/ui/SpecialCode.php b/ui/SpecialCode.php
index 6a2844d..aa3807e 100644
--- a/ui/SpecialCode.php
+++ b/ui/SpecialCode.php
@@ -161,6 +161,7 @@
/**
* Only list me on Special:SpecialPages when configured.
+ * @return bool
*/
public function isListed() {
return $this->getConfig()->get( 'CodeReviewListSpecialPage' );
--
To view, visit https://gerrit.wikimedia.org/r/402655
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I4f5f3e9cd0c044ad29440475b61781957f4ef507
Gerrit-PatchSet: 2
Gerrit-Project: mediawiki/extensions/CodeReview
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>
Gerrit-Reviewer: Jack Phoenix <ash...@uncyclomedia.co>
Gerrit-Reviewer: Thiemo Kreuz (WMDE) <thiemo.kr...@wikimedia.de>
Gerrit-Reviewer: Umherirrender <umherirrender_de...@web.de>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
