Umherirrender has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/382243 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: I5a85c6e521d97ac1d3ca1aff8f2e26e613013df2
---
M includes/Events/Event.php
M includes/api/ApiListStudents.php
M includes/notifications/INotificationType.php
M includes/notifications/PresentationModel/CourseTalk.php
M includes/notifications/PresentationModel/RoleAdd.php
M includes/pagers/RevisionPager.php
M includes/specials/SpecialManageCourses.php
M phpcs.xml
M tests/phpunit/Events/EventQueryTest.php
9 files changed, 20 insertions(+), 21 deletions(-)
git pull
ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/EducationProgram
refs/changes/43/382243/1
diff --git a/includes/Events/Event.php b/includes/Events/Event.php
index fdb7d6f..fae7d01 100644
--- a/includes/Events/Event.php
+++ b/includes/Events/Event.php
@@ -88,7 +88,7 @@
return $this->userId;
}
- /**c
+ /**
* Returns the time at which the event occurred.
* The time is a string formatted as TS_MW.
*
diff --git a/includes/api/ApiListStudents.php b/includes/api/ApiListStudents.php
index f4ebdf8..6b09ff2 100644
--- a/includes/api/ApiListStudents.php
+++ b/includes/api/ApiListStudents.php
@@ -577,7 +577,7 @@
* by a student in a course.
*
* @param int $courseId
- * @param $student Student object
+ * @param Student $student Student object
* @param ArticleStore $articleStore
* @return array
*/
@@ -593,7 +593,7 @@
/**
* Given an EPArticle, list the reviewers for that article.
*
- * @param $epArticle EPArticle object
+ * @param EPArticle $epArticle EPArticle object
* @return array
*/
protected function getArticleReviewerIds( EPArticle $epArticle ) {
diff --git a/includes/notifications/INotificationType.php
b/includes/notifications/INotificationType.php
index 59f6be5..bd5387d 100644
--- a/includes/notifications/INotificationType.php
+++ b/includes/notifications/INotificationType.php
@@ -87,8 +87,8 @@
*
* @since 0.4 alpha
*
- * @param $event \EchoEvent
- * @param $users array
+ * @param \EchoEvent $event
+ * @param array &$users
*/
function getUsersNotified( \EchoEvent $event, array &$users );
}
diff --git a/includes/notifications/PresentationModel/CourseTalk.php
b/includes/notifications/PresentationModel/CourseTalk.php
index c979154..c6af52d 100644
--- a/includes/notifications/PresentationModel/CourseTalk.php
+++ b/includes/notifications/PresentationModel/CourseTalk.php
@@ -5,7 +5,7 @@
class CourseTalk extends RoleAdd {
/**
- * {@inheritdoc}
+ * @inheritDoc
*/
public function canRender() {
return $this->event->getTitle() instanceof \Title &&
@@ -13,14 +13,14 @@
}
/**
- * {@inheritdoc}
+ * @inheritDoc
*/
public function getIconType() {
return 'ep-course-talk-icon';
}
/**
- * {@inheritdoc}
+ * @inheritDoc
*/
public function getPrimaryLink() {
return [
@@ -30,7 +30,7 @@
}
/**
- * {@inheritdoc}
+ * @inheritDoc
*/
public function getSecondaryLinks() {
$viewChangesLink = [
diff --git a/includes/notifications/PresentationModel/RoleAdd.php
b/includes/notifications/PresentationModel/RoleAdd.php
index c259b29..73146f5 100644
--- a/includes/notifications/PresentationModel/RoleAdd.php
+++ b/includes/notifications/PresentationModel/RoleAdd.php
@@ -5,21 +5,21 @@
class RoleAdd extends \EchoEventPresentationModel {
/**
- * {@inheritdoc}
+ * @inheritDoc
*/
public function canRender() {
return $this->event->getTitle() instanceof \Title;
}
/**
- * {@inheritdoc}
+ * @inheritDoc
*/
public function getIconType() {
return 'ep-added-to-course-icon';
}
/**
- * {@inheritdoc}
+ * @inheritDoc
*/
public function getPrimaryLink() {
return [
@@ -29,14 +29,14 @@
}
/**
- * {@inheritdoc}
+ * @inheritDoc
*/
public function getSecondaryLinks() {
return [ $this->getAgentLink() ];
}
/**
- * {@inheritdoc}
+ * @inheritDoc
*/
public function getHeaderMessage() {
$msg = parent::getHeaderMessage();
diff --git a/includes/pagers/RevisionPager.php
b/includes/pagers/RevisionPager.php
index 91d1f30..5e3ed4a 100644
--- a/includes/pagers/RevisionPager.php
+++ b/includes/pagers/RevisionPager.php
@@ -73,7 +73,7 @@
* representing the result row $row. Rows will be concatenated and
* returned by getBody()
*
- * @param $row Object: database row
+ * @param stdClass $row database row
*
* @return String
*/
diff --git a/includes/specials/SpecialManageCourses.php
b/includes/specials/SpecialManageCourses.php
index 79cf29e..189e8c7 100644
--- a/includes/specials/SpecialManageCourses.php
+++ b/includes/specials/SpecialManageCourses.php
@@ -112,7 +112,7 @@
*
* @since 0.1
*
- * @param $class string The name of the IRole implementing class
+ * @param string $class The name of the IRole implementing class
*/
protected function displayRoleAssociation( $class ) {
$user = $this->getUser();
diff --git a/phpcs.xml b/phpcs.xml
index 2b8d3f2..dae7193 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -2,7 +2,6 @@
<ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
<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.Commenting.FunctionComment.WrongStyle"
/>
diff --git a/tests/phpunit/Events/EventQueryTest.php
b/tests/phpunit/Events/EventQueryTest.php
index 7e79bf1..3276633 100644
--- a/tests/phpunit/Events/EventQueryTest.php
+++ b/tests/phpunit/Events/EventQueryTest.php
@@ -49,7 +49,7 @@
/**
* @dataProvider setCoursesProvider
*
- * @param $courseIds
+ * @param array $courseIds
*/
public function testSetCourses( $courseIds ) {
$query = new EventQuery();
@@ -69,8 +69,8 @@
/**
* @dataProvider timeLimitProvider
*
- * @param $timeLimit
- * @param $comparator
+ * @param string $timeLimit
+ * @param int $comparator
*/
public function testSetTimeLimit( $timeLimit, $comparator ) {
$query = new EventQuery();
@@ -115,7 +115,7 @@
/**
* @dataProvider sortOrderProvider
*
- * @param $order
+ * @param int $order
*/
public function testSetSortOrder( $order ) {
$query = new EventQuery();
--
To view, visit https://gerrit.wikimedia.org/r/382243
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I5a85c6e521d97ac1d3ca1aff8f2e26e613013df2
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/EducationProgram
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
