jenkins-bot has submitted this change and it was merged.
Change subject: Fix broken/incomplete PHPDoc tags in the Summary class
......................................................................
Fix broken/incomplete PHPDoc tags in the Summary class
Change-Id: I00940ce3a620b2e3babfc226f83c8080341f8288
---
M lib/includes/Summary.php
1 file changed, 19 insertions(+), 18 deletions(-)
Approvals:
Adrian Lang: Looks good to me, approved
jenkins-bot: Verified
diff --git a/lib/includes/Summary.php b/lib/includes/Summary.php
index 3f68204..ab32b9b 100644
--- a/lib/includes/Summary.php
+++ b/lib/includes/Summary.php
@@ -2,7 +2,6 @@
namespace Wikibase;
-use Language;
use LogicException;
/**
@@ -18,17 +17,17 @@
class Summary {
/**
- * @var string
+ * @var string|null
*/
protected $moduleName;
/**
- * @var string
+ * @var string|null
*/
protected $actionName;
/**
- * @var Language
+ * @var string|null
*/
protected $language;
@@ -55,22 +54,24 @@
const USE_ALL = 6;
/**
- * Constructs a new Summary
- *
* @since 0.4
*
- * @param string $moduleName The module part of the auto comment
- * @param string $actionName The action part of the auto comment
- * @param string $language The language to use as the second auto
comment argument
+ * @param string|null $moduleName The module part of the auto comment
+ * @param string|null $actionName The action part of the auto comment
+ * @param string|null $languageCode The language code to use as the
second auto comment argument
* @param array $commentArgs The arguments to the auto comment
* @param array $summaryArgs The arguments to the auto summary
*/
- public function __construct( $moduleName = null, $actionName = null,
$language = null,
- $commentArgs = array(), $summaryArgs = array()
+ public function __construct(
+ $moduleName = null,
+ $actionName = null,
+ $languageCode = null,
+ $commentArgs = array(),
+ $summaryArgs = array()
) {
$this->moduleName = $moduleName;
$this->actionName = $actionName;
- $this->language = $language === null ? null : (string)$language;
+ $this->language = $languageCode === null ? null :
(string)$languageCode;
$this->commentArgs = $commentArgs;
$this->summaryArgs = $summaryArgs;
}
@@ -80,7 +81,7 @@
*
* @since 0.4
*
- * @param string $summary edit summary provided by the user
+ * @param string|null $summary edit summary provided by the user
*/
public function setUserSummary( $summary = null ) {
$this->userSummary = $summary === null ? null :
(string)$summary;
@@ -91,10 +92,10 @@
*
* @since 0.4
*
- * @param string $lang the language code
+ * @param string|null $languageCode
*/
- public function setLanguage( $lang = null ) {
- $this->language = $lang === null ? null : (string)$lang;
+ public function setLanguage( $languageCode = null ) {
+ $this->language = $languageCode === null ? null :
(string)$languageCode;
}
/**
@@ -113,7 +114,7 @@
*
* @since 0.4
*
- * @return string
+ * @return string|null
*/
public function getModuleName() {
return $this->moduleName;
@@ -124,7 +125,7 @@
*
* @since 0.4
*
- * @param string $name
+ * @param string|null $name
*/
public function setAction( $name ) {
$this->actionName = $name === null ? null : (string)$name;
--
To view, visit https://gerrit.wikimedia.org/r/191594
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I00940ce3a620b2e3babfc226f83c8080341f8288
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Wikibase
Gerrit-Branch: master
Gerrit-Owner: Thiemo Mättig (WMDE) <[email protected]>
Gerrit-Reviewer: Adrian Lang <[email protected]>
Gerrit-Reviewer: Daniel Kinzler <[email protected]>
Gerrit-Reviewer: Hoo man <[email protected]>
Gerrit-Reviewer: JanZerebecki <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
