[MediaWiki-commits] [Gerrit] mediawiki...CodeReview[master]: Improve some parameter docs
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 @@
-
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
Gerrit-Reviewer: Jack Phoenix
Gerrit-Reviewer: Thiemo Kreuz (WMDE)
Gerrit-Reviewer: Umherirrender
Gerrit-Reviewer: jenkins-bot <>
___
MediaWiki-commits mailing list
[MediaWiki-commits] [Gerrit] mediawiki...CodeReview[master]: Improve some parameter docs
Umherirrender has uploaded a new change for review. (
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(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/CodeReview
refs/changes/55/402655/1
diff --git a/.phpcs.xml b/.phpcs.xml
index aa00a4e..759a46d 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -9,7 +9,6 @@
-
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..553de39 100644
--- a/ui/SpecialCode.php
+++ b/ui/SpecialCode.php
@@ -161,6 +161,7 @@
/**
* Only list me on Special:SpecialPages when configured.
+* @return true
*/
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: newchange
Gerrit-Change-Id: I4f5f3e9cd0c044ad29440475b61781957f4ef507
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/CodeReview
Gerrit-Branch: master
Gerrit-Owner: Umherirrender
___
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
[MediaWiki-commits] [Gerrit] mediawiki...CodeReview[master]: Improve some parameter docs
jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/374068 )
Change subject: Improve some parameter docs
..
Improve some parameter docs
Change-Id: I40aeba848e7969b219242631daced88d96939438
---
M CodeReviewHooks.php
M api/ApiQueryCodeRevisions.php
M backend/CodeComment.php
M backend/CodePropChange.php
M backend/CodeRepository.php
M backend/CodeRevision.php
M backend/CodeSignoff.php
M backend/DiffHighlighter.php
M backend/RepoStats.php
M backend/Subversion.php
M maintenance/showEmails.php
M phpcs.xml
M ui/CodeRepoListView.php
M ui/CodeRevisionCommitter.php
M ui/CodeRevisionListView.php
M ui/CodeRevisionView.php
M ui/CodeView.php
M ui/SpecialCode.php
M ui/SpecialRepoAdmin.php
M ui/WordCloud.php
20 files changed, 98 insertions(+), 105 deletions(-)
Approvals:
Legoktm: Looks good to me, approved
jenkins-bot: Verified
diff --git a/CodeReviewHooks.php b/CodeReviewHooks.php
index 767acbd..0d7ab0e 100644
--- a/CodeReviewHooks.php
+++ b/CodeReviewHooks.php
@@ -28,7 +28,7 @@
*
* Only MySQL(/MariaDB) and SQLite are supported at the moment.
*
-* @param $updater DatabaseUpdater
+* @param DatabaseUpdater $updater
* @return bool
*/
public static function onLoadExtensionSchemaUpdates( $updater ) {
@@ -117,8 +117,8 @@
* current repository when we're on Special:Code, or to be more
specific,
* a subpage of a repository on Special:Code.
*
-* @param $values array
-* @param $out OutputPage
+* @param array &$values
+* @param OutputPage $out
* @return bool
*/
public static function onMakeGlobalVariablesScript( &$values, $out ) {
@@ -136,7 +136,7 @@
/**
* For integration with the Renameuser extension.
*
-* @param $renameUserSQL RenameuserSQL
+* @param RenameuserSQL $renameUserSQL
* @return bool
*/
public static function onRenameUserSQL( $renameUserSQL ) {
@@ -156,7 +156,7 @@
/**
* For integration with the UserMerge extension.
*
-* @param array $updateFields
+* @param array &$updateFields
* @return bool
*/
public static function onUserMergeAccountFields( &$updateFields ) {
diff --git a/api/ApiQueryCodeRevisions.php b/api/ApiQueryCodeRevisions.php
index e9d3703..2b7af03 100644
--- a/api/ApiQueryCodeRevisions.php
+++ b/api/ApiQueryCodeRevisions.php
@@ -107,9 +107,9 @@
}
/**
-* @param $row
-* @param $repo CodeRepository
-* @param $result ApiResult
+* @param stdClass $row
+* @param CodeRepository $repo
+* @param ApiResult $result
* @return array
*/
private function formatRow( $row, $repo, $result ) {
@@ -160,7 +160,7 @@
}
/**
-* @param $rev CodeRevision
+* @param CodeRevision $rev
* @return array
*/
protected function addReferenced( $rev ) {
diff --git a/backend/CodeComment.php b/backend/CodeComment.php
index abf0e10..aa3f442 100644
--- a/backend/CodeComment.php
+++ b/backend/CodeComment.php
@@ -20,7 +20,7 @@
/**
* @param CodeRevision $rev
-* @param $row
+* @param stdClass $row
* @return CodeComment
*/
static function newFromRow( $rev, $row ) {
diff --git a/backend/CodePropChange.php b/backend/CodePropChange.php
index 3657b6c..ec89da8 100644
--- a/backend/CodePropChange.php
+++ b/backend/CodePropChange.php
@@ -18,7 +18,7 @@
/**
* @param CodeRevision $rev
-* @param $row
+* @param stdClass $row
* @return CodePropChange
*/
static function newFromRow( $rev, $row ) {
@@ -27,7 +27,7 @@
/**
* @param CodeRevision $rev
-* @param $data
+* @param array $data
* @return CodePropChange
*/
static function newFromData( $rev, $data ) {
diff --git a/backend/CodeRepository.php b/backend/CodeRepository.php
index 21e6fb4..02525e8 100644
--- a/backend/CodeRepository.php
+++ b/backend/CodeRepository.php
@@ -93,7 +93,7 @@
}
/**
-* @param $row
+* @param stdClass $row
* @return CodeRepository
*/
static function newFromRow( $row ) {
@@ -158,7 +158,7 @@
/**
* Return a bug URL or false
*
-* @param $bugId int|string
+* @param int|string $bugId
* @return string|bool
*/
public function getBugPath( $bugId ) {
@@ -227,7 +227,7 @@
/**
* Get a list of all tags in use in the repository
-* @param $recache Bool whether to get clean data
+* @param bool $recache whether to get clean data
* @return array
*/
public function getTagList( $recache = false ) {
@@
[MediaWiki-commits] [Gerrit] mediawiki...CodeReview[master]: Improve some parameter docs
Umherirrender has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/374068 )
Change subject: Improve some parameter docs
..
Improve some parameter docs
Change-Id: I40aeba848e7969b219242631daced88d96939438
---
M CodeReviewHooks.php
M api/ApiQueryCodeRevisions.php
M backend/CodeComment.php
M backend/CodePropChange.php
M backend/CodeRepository.php
M backend/CodeRevision.php
M backend/CodeSignoff.php
M backend/DiffHighlighter.php
M backend/RepoStats.php
M backend/Subversion.php
M maintenance/showEmails.php
M phpcs.xml
M ui/CodeRepoListView.php
M ui/CodeRevisionCommitter.php
M ui/CodeRevisionListView.php
M ui/CodeRevisionView.php
M ui/CodeView.php
M ui/SpecialCode.php
M ui/SpecialRepoAdmin.php
M ui/WordCloud.php
20 files changed, 98 insertions(+), 105 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/CodeReview
refs/changes/68/374068/1
diff --git a/CodeReviewHooks.php b/CodeReviewHooks.php
index 767acbd..0d7ab0e 100644
--- a/CodeReviewHooks.php
+++ b/CodeReviewHooks.php
@@ -28,7 +28,7 @@
*
* Only MySQL(/MariaDB) and SQLite are supported at the moment.
*
-* @param $updater DatabaseUpdater
+* @param DatabaseUpdater $updater
* @return bool
*/
public static function onLoadExtensionSchemaUpdates( $updater ) {
@@ -117,8 +117,8 @@
* current repository when we're on Special:Code, or to be more
specific,
* a subpage of a repository on Special:Code.
*
-* @param $values array
-* @param $out OutputPage
+* @param array &$values
+* @param OutputPage $out
* @return bool
*/
public static function onMakeGlobalVariablesScript( &$values, $out ) {
@@ -136,7 +136,7 @@
/**
* For integration with the Renameuser extension.
*
-* @param $renameUserSQL RenameuserSQL
+* @param RenameuserSQL $renameUserSQL
* @return bool
*/
public static function onRenameUserSQL( $renameUserSQL ) {
@@ -156,7 +156,7 @@
/**
* For integration with the UserMerge extension.
*
-* @param array $updateFields
+* @param array &$updateFields
* @return bool
*/
public static function onUserMergeAccountFields( &$updateFields ) {
diff --git a/api/ApiQueryCodeRevisions.php b/api/ApiQueryCodeRevisions.php
index e9d3703..2b7af03 100644
--- a/api/ApiQueryCodeRevisions.php
+++ b/api/ApiQueryCodeRevisions.php
@@ -107,9 +107,9 @@
}
/**
-* @param $row
-* @param $repo CodeRepository
-* @param $result ApiResult
+* @param stdClass $row
+* @param CodeRepository $repo
+* @param ApiResult $result
* @return array
*/
private function formatRow( $row, $repo, $result ) {
@@ -160,7 +160,7 @@
}
/**
-* @param $rev CodeRevision
+* @param CodeRevision $rev
* @return array
*/
protected function addReferenced( $rev ) {
diff --git a/backend/CodeComment.php b/backend/CodeComment.php
index abf0e10..aa3f442 100644
--- a/backend/CodeComment.php
+++ b/backend/CodeComment.php
@@ -20,7 +20,7 @@
/**
* @param CodeRevision $rev
-* @param $row
+* @param stdClass $row
* @return CodeComment
*/
static function newFromRow( $rev, $row ) {
diff --git a/backend/CodePropChange.php b/backend/CodePropChange.php
index 3657b6c..ec89da8 100644
--- a/backend/CodePropChange.php
+++ b/backend/CodePropChange.php
@@ -18,7 +18,7 @@
/**
* @param CodeRevision $rev
-* @param $row
+* @param stdClass $row
* @return CodePropChange
*/
static function newFromRow( $rev, $row ) {
@@ -27,7 +27,7 @@
/**
* @param CodeRevision $rev
-* @param $data
+* @param array $data
* @return CodePropChange
*/
static function newFromData( $rev, $data ) {
diff --git a/backend/CodeRepository.php b/backend/CodeRepository.php
index 21e6fb4..02525e8 100644
--- a/backend/CodeRepository.php
+++ b/backend/CodeRepository.php
@@ -93,7 +93,7 @@
}
/**
-* @param $row
+* @param stdClass $row
* @return CodeRepository
*/
static function newFromRow( $row ) {
@@ -158,7 +158,7 @@
/**
* Return a bug URL or false
*
-* @param $bugId int|string
+* @param int|string $bugId
* @return string|bool
*/
public function getBugPath( $bugId ) {
@@ -227,7 +227,7 @@
/**
* Get a list of all tags in use in the repository
-* @param $recache Bool whether to get clean data
+* @param bool $recache whether to get clean data
* @return array
*/
public function getTagList(
