Umherirrender has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/384222 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: Idd5787928b87f5af63864dc626cb603f281515d7
---
M includes/api/ApiEchoArticleReminder.php
M includes/api/ApiEchoMarkRead.php
M includes/api/ApiEchoMarkSeen.php
M includes/api/ApiEchoNotifications.php
M includes/api/ApiEchoUnreadNotificationPages.php
M includes/controller/NotificationController.php
M includes/jobs/NotificationDeleteJob.php
M includes/mapper/AbstractMapper.php
M includes/ooui/LabelIconWidget.php
M phpcs.xml
10 files changed, 19 insertions(+), 21 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Echo
refs/changes/22/384222/1
diff --git a/includes/api/ApiEchoArticleReminder.php
b/includes/api/ApiEchoArticleReminder.php
index 5ed2679..bc76dac 100644
--- a/includes/api/ApiEchoArticleReminder.php
+++ b/includes/api/ApiEchoArticleReminder.php
@@ -90,7 +90,7 @@
}
/**
- * @see ApiBase::getExamplesMessages()
+ * @inheritDoc
*/
protected function getExamplesMessages() {
$todayDate = new DateTime();
diff --git a/includes/api/ApiEchoMarkRead.php b/includes/api/ApiEchoMarkRead.php
index 1b264e9..87305f8 100644
--- a/includes/api/ApiEchoMarkRead.php
+++ b/includes/api/ApiEchoMarkRead.php
@@ -92,7 +92,7 @@
}
/**
- * @see ApiBase::getExamplesMessages()
+ * @inheritDoc
*/
protected function getExamplesMessages() {
return [
diff --git a/includes/api/ApiEchoMarkSeen.php b/includes/api/ApiEchoMarkSeen.php
index d06852a..e00520e 100644
--- a/includes/api/ApiEchoMarkSeen.php
+++ b/includes/api/ApiEchoMarkSeen.php
@@ -65,7 +65,7 @@
}
/**
- * @see ApiBase::getExamplesMessages()
+ * @inheritDoc
*/
protected function getExamplesMessages() {
return [
diff --git a/includes/api/ApiEchoNotifications.php
b/includes/api/ApiEchoNotifications.php
index 62e406c..4a2392b 100644
--- a/includes/api/ApiEchoNotifications.php
+++ b/includes/api/ApiEchoNotifications.php
@@ -630,8 +630,7 @@
}
/**
- * @see ApiBase::getExamplesMessages()
- * @return array
+ * @inheritDoc
*/
protected function getExamplesMessages() {
return [
diff --git a/includes/api/ApiEchoUnreadNotificationPages.php
b/includes/api/ApiEchoUnreadNotificationPages.php
index 64f2af7..8b89d8b 100644
--- a/includes/api/ApiEchoUnreadNotificationPages.php
+++ b/includes/api/ApiEchoUnreadNotificationPages.php
@@ -198,7 +198,7 @@
}
/**
- * @see ApiBase::getExamplesMessages()
+ * @inheritDoc
*/
protected function getExamplesMessages() {
return [
diff --git a/includes/controller/NotificationController.php
b/includes/controller/NotificationController.php
index ca142d2..670a25c 100644
--- a/includes/controller/NotificationController.php
+++ b/includes/controller/NotificationController.php
@@ -49,15 +49,15 @@
}
/**
- * Format the notification count as a string. This should only be used
for an
- * isolated string count, e.g. as displayed in personal tools or
returned by the API.
- *
- * If using it in sentence context, pass the value from
getCappedNotificationCount
- * into a message and use PLURAL. Example:
notification-bundle-header-page-linked
- *
- * @param int $count Notification count
- * @return string Formatted count, after applying cap then formatting to
string
- */
+ * Format the notification count as a string. This should only be used
for an
+ * isolated string count, e.g. as displayed in personal tools or
returned by the API.
+ *
+ * If using it in sentence context, pass the value from
getCappedNotificationCount
+ * into a message and use PLURAL. Example:
notification-bundle-header-page-linked
+ *
+ * @param int $count Notification count
+ * @return string Formatted count, after applying cap then formatting
to string
+ */
public static function formatNotificationCount( $count ) {
$cappedCount = self::getCappedNotificationCount( $count );
diff --git a/includes/jobs/NotificationDeleteJob.php
b/includes/jobs/NotificationDeleteJob.php
index 2b6064e..b8d565f 100644
--- a/includes/jobs/NotificationDeleteJob.php
+++ b/includes/jobs/NotificationDeleteJob.php
@@ -30,6 +30,7 @@
/**
* Run the job of finding & deleting older notifications
+ * @return true
*/
public function run() {
global $wgEchoMaxUpdateCount;
diff --git a/includes/mapper/AbstractMapper.php
b/includes/mapper/AbstractMapper.php
index d9603e0..b5a9d22 100644
--- a/includes/mapper/AbstractMapper.php
+++ b/includes/mapper/AbstractMapper.php
@@ -61,6 +61,7 @@
/**
* Get the listener for a method
*
+ * @param string $method
* @return array
* @throws MWException
*/
diff --git a/includes/ooui/LabelIconWidget.php
b/includes/ooui/LabelIconWidget.php
index e44e8ff..6cceec2 100644
--- a/includes/ooui/LabelIconWidget.php
+++ b/includes/ooui/LabelIconWidget.php
@@ -18,9 +18,9 @@
/**
* @param array $config Configuration options
- * @param string|HtmlSnippet $config['label'] Label text
- * @param string $config['title'] Title text
- * @param string $config['icon'] Icon key
+ * - string|HtmlSnippet $config['label'] Label text
+ * - string $config['title'] Title text
+ * - string $config['icon'] Icon key
*/
public function __construct( $config ) {
parent::__construct( $config );
diff --git a/phpcs.xml b/phpcs.xml
index 2adc8f6..6bf4fd6 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -5,9 +5,6 @@
<exclude name="Generic.Files.LineLength.TooLong" />
<exclude
name="MediaWiki.Commenting.FunctionComment.ExtraParamComment" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamName" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingReturn" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.WrongCase"
/>
<exclude name="MediaWiki.Files.OneClassPerFile.MultipleFound" />
--
To view, visit https://gerrit.wikimedia.org/r/384222
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Idd5787928b87f5af63864dc626cb603f281515d7
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Echo
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
