Thiemo Mättig (WMDE) has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/397896 )
Change subject: Fix documentation mistakes in EntityDiffChangedAspectsFactory
......................................................................
Fix documentation mistakes in EntityDiffChangedAspectsFactory
Change-Id: I1da1c5fe856a28cd31e712c3a73593804c69600d
---
M lib/includes/Changes/EntityDiffChangedAspects.php
M lib/includes/Changes/EntityDiffChangedAspectsFactory.php
2 files changed, 8 insertions(+), 5 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Wikibase
refs/changes/96/397896/1
diff --git a/lib/includes/Changes/EntityDiffChangedAspects.php
b/lib/includes/Changes/EntityDiffChangedAspects.php
index b3cc89d..2777364 100644
--- a/lib/includes/Changes/EntityDiffChangedAspects.php
+++ b/lib/includes/Changes/EntityDiffChangedAspects.php
@@ -64,7 +64,8 @@
* @param string[] $labelChanges Language codes of the labels that
changed (added, removed or updated)
* @param string[] $descriptionChanges Language codes of the
descriptions that changed (added, removed or updated)
* @param string[] $statementChanges Property id serialization from the
statements that changed (added, removed or updated)
- * @param bool[] $siteLinkChanges Map of site ids to bool: only the
badge has changed (false) or the actual sitelink changed (true)
+ * @param array[] $siteLinkChanges Map of global site identifiers to [
string|null $oldPageName,
+ * string|null $newPageName, bool $badgesChanged ]
* @param bool $otherChanges Do we have changes that are not covered
more specifically?
*/
public function __construct(
@@ -137,7 +138,7 @@
/**
* @see Serializable::serialize
*
- * @return string
+ * @return string JSON
*/
public function serialize() {
return json_encode( $this->toArray() );
@@ -146,7 +147,9 @@
/**
* @see Serializable::unserialize
*
- * @return string
+ * @param string $serialized JSON
+ *
+ * @throws MWException
*/
public function unserialize( $serialized ) {
$data = json_decode( $serialized );
@@ -163,7 +166,7 @@
}
/**
- * @return array[]
+ * @return array
*/
public function toArray() {
return [
diff --git a/lib/includes/Changes/EntityDiffChangedAspectsFactory.php
b/lib/includes/Changes/EntityDiffChangedAspectsFactory.php
index 2ab1671..e033352 100644
--- a/lib/includes/Changes/EntityDiffChangedAspectsFactory.php
+++ b/lib/includes/Changes/EntityDiffChangedAspectsFactory.php
@@ -77,7 +77,7 @@
/**
* @param Diff $siteLinkDiff
*
- * @return string[]
+ * @return array[]
*/
private function getChangedSiteLinks( Diff $siteLinkDiff ) {
$siteLinkChanges = [];
--
To view, visit https://gerrit.wikimedia.org/r/397896
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I1da1c5fe856a28cd31e712c3a73593804c69600d
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Wikibase
Gerrit-Branch: master
Gerrit-Owner: Thiemo Mättig (WMDE) <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
