jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/383623 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: I96b3d8826212dff75d78bea537e76ae0f3d41e36
---
M Calendar.hooks.php
M CalendarTable.class.php
M phpcs.xml
3 files changed, 23 insertions(+), 26 deletions(-)
Approvals:
Krinkle: Looks good to me, approved
jenkins-bot: Verified
diff --git a/Calendar.hooks.php b/Calendar.hooks.php
index 0dd519e..e9bc1a3 100644
--- a/Calendar.hooks.php
+++ b/Calendar.hooks.php
@@ -5,7 +5,7 @@
*/
class CalendarHooks {
/**
- * @param $parser Parser
+ * @param Parser $parser
* @return bool
*/
public static function setupParserHooks( $parser ) {
@@ -14,7 +14,7 @@
}
/**
- * @param $parser Parser
+ * @param Parser &$parser
* @return string
*/
public static function calendarMagicWord( &$parser ) {
diff --git a/CalendarTable.class.php b/CalendarTable.class.php
index 196b864..0a2be3c 100644
--- a/CalendarTable.class.php
+++ b/CalendarTable.class.php
@@ -21,7 +21,7 @@
protected $monthArr, $dayArr;
/**
- * @param $timestamp
+ * @param int $timestamp
* @return int
*/
public function dayOfWeek( $timestamp ) {
@@ -29,8 +29,8 @@
}
/**
- * @param $aMonth
- * @param $aYear
+ * @param int $aMonth
+ * @param int $aYear
* @return int
*/
public function daysInMonth( $aMonth, $aYear ) {
@@ -42,7 +42,7 @@
}
/**
- * @param $aYear
+ * @param int $aYear
* @return bool
*/
public function isLeapYear( $aYear ) {
@@ -50,8 +50,8 @@
}
/**
- * @param $aMonth
- * @param $aYear
+ * @param int $aMonth
+ * @param int $aYear
* @return int
*/
public function dayOfWeekOfFirstOfMonth( $aMonth, $aYear ) {
@@ -59,8 +59,8 @@
}
/**
- * @param $aMonth
- * @param $aLen
+ * @param int $aMonth
+ * @param int $aLen
* @return string
*/
public function getMonthName( $aMonth, $aLen ) {
@@ -69,8 +69,8 @@
}
/**
- * @param $aMonth
- * @param $aLen
+ * @param int $aMonth
+ * @param int $aLen
* @return string
*/
public function getMonthNameAbbrev( $aMonth, $aLen ) {
@@ -79,8 +79,8 @@
}
/**
- * @param $aDay
- * @param $aLen
+ * @param int $aDay
+ * @param int $aLen
* @return string
*/
public function getWeekday( $aDay, $aLen ) {
@@ -90,8 +90,8 @@
}
/**
- * @param $aDay
- * @param $aLen
+ * @param int $aDay
+ * @param int $aLen
* @return string
*/
public function getWeekdayAbbrev( $aDay, $aLen ) {
@@ -101,8 +101,8 @@
}
/**
- * @param $string string
- * @param $len int
+ * @param string $string
+ * @param int $len
* @return string
*/
private function cutLength( $string, $len ) {
@@ -125,8 +125,8 @@
}
/**
- * @param $str
- * @param $array
+ * @param string $str
+ * @param array $array
* @return mixed
*/
public function replace( $str, $array ) {
@@ -246,7 +246,7 @@
}
/**
- * @param $args array
+ * @param array &$args
*/
public function setParameters( &$args ) {
$this->today = strtotime( "now" );
diff --git a/phpcs.xml b/phpcs.xml
index 7d11fa4..90e8108 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -1,13 +1,10 @@
<?xml version="1.0"?>
<ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamName" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
+ <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
</rule>
<file>.</file>
<arg name="extensions" value="php,php5,inc" />
- <arg name="encoding" value="utf8" />
- <exclude-pattern>vendor</exclude-pattern>
- <exclude-pattern>node_modules</exclude-pattern>
+ <arg name="encoding" value="UTF-8" />
</ruleset>
--
To view, visit https://gerrit.wikimedia.org/r/383623
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I96b3d8826212dff75d78bea537e76ae0f3d41e36
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Calendar
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <[email protected]>
Gerrit-Reviewer: Krinkle <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
