Legoktm has uploaded a new change for review.
https://gerrit.wikimedia.org/r/108207
Change subject: Add some more documentation
......................................................................
Add some more documentation
Change-Id: I4a3ecc6f5bafeffd6708afe4e88d080561e0a8d2
---
M includes/Block/Block.php
M includes/Contributions/Formatter.php
M includes/Contributions/Query.php
M includes/Model/AbstractRevision.php
4 files changed, 8 insertions(+), 3 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Flow
refs/changes/07/108207/1
diff --git a/includes/Block/Block.php b/includes/Block/Block.php
index 71abbcc..bd635cf 100644
--- a/includes/Block/Block.php
+++ b/includes/Block/Block.php
@@ -45,6 +45,7 @@
protected $workflow;
protected $storage;
+ /** @var User $user */
protected $user;
protected $submitted;
protected $errors;
diff --git a/includes/Contributions/Formatter.php
b/includes/Contributions/Formatter.php
index 9e4a25a..ec5c4a6 100644
--- a/includes/Contributions/Formatter.php
+++ b/includes/Contributions/Formatter.php
@@ -9,7 +9,7 @@
class Formatter extends AbstractFormatter {
/**
* @param ContribsPager $pager
- * @param stdClass $row
+ * @param \stdClass $row
* @return string|bool HTML for contributions entry, or false on failure
*/
public function format( ContribsPager $pager, $row ) {
diff --git a/includes/Contributions/Query.php b/includes/Contributions/Query.php
index 08d25ef..c0d5a40 100644
--- a/includes/Contributions/Query.php
+++ b/includes/Contributions/Query.php
@@ -57,7 +57,6 @@
}
/**
- * @param $data array an array of results of all contribs queries, to
be merged to form all contributions data
* @param ContribsPager $pager Object hooked into
* @param string $offset Index offset, inclusive
* @param int $limit Exact query limit
@@ -196,7 +195,7 @@
* @param ContribsPager $pager
* @param AbstractRevision $revision
* @param string $blockType Block name (e.g. "topic", "header")
- * @return stdClass
+ * @return \stdClass
*/
protected function buildResult( ContribsPager $pager, AbstractRevision
$revision, $blockType ) {
$uuid = $revision->getRevisionId();
@@ -270,6 +269,7 @@
* Retrieves the root post for a given PostRevision
* @param PostRevision $revision The revision to retrieve the root
post for.
* @return PostRevision PostRevision of the root post.
+ * @throws \MWException
*/
protected function getRootPost( PostRevision $revision ) {
$rootPostId = $this->getRootPostId( $revision );
@@ -291,6 +291,7 @@
* Gets the root post ID for a given PostRevision
* @param PostRevision $revision The revision to get the root post ID
for.
* @return UUID The UUID for the root post.
+ * @throws \MWException
*/
protected function getRootPostId( PostRevision $revision ) {
$postId = $revision->getPostId();
diff --git a/includes/Model/AbstractRevision.php
b/includes/Model/AbstractRevision.php
index da1efe8..c06e62d 100644
--- a/includes/Model/AbstractRevision.php
+++ b/includes/Model/AbstractRevision.php
@@ -283,6 +283,9 @@
return self::$perms[$state]['historical'];
}
+ /**
+ * @return UUID
+ */
public function getRevisionId() {
return $this->revId;
}
--
To view, visit https://gerrit.wikimedia.org/r/108207
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I4a3ecc6f5bafeffd6708afe4e88d080561e0a8d2
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Flow
Gerrit-Branch: master
Gerrit-Owner: Legoktm <legoktm.wikipe...@gmail.com>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
