Thiemo Mättig (WMDE) has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/351139 )
Change subject: Fix a lot of non-standard @var and @param PHPDoc lines
......................................................................
Fix a lot of non-standard @var and @param PHPDoc lines
Change-Id: I63cffd17228d8d2d6dac69afc6e0447b0a38e7d1
---
M includes/Api/ApiFlow.php
M includes/Api/ApiFlowBase.php
M includes/Block/Block.php
M includes/Data/Listener/WorkflowTopicListListener.php
M includes/Data/ObjectManager.php
M includes/DbFactory.php
M includes/Import/Importer.php
M includes/Import/Wikitext/ConversionStrategy.php
M includes/Model/Anchor.php
M includes/Model/PostRevision.php
M includes/Parsoid/Fixer/BaseHrefFixer.php
M includes/Search/Searcher.php
M includes/Specials/SpecialEnableFlow.php
M includes/Specials/SpecialFlow.php
M includes/SubmissionHandler.php
M maintenance/FlowFixInconsistentBoards.php
M tests/phpunit/Mock/MockImportSource.php
17 files changed, 46 insertions(+), 36 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Flow
refs/changes/39/351139/1
diff --git a/includes/Api/ApiFlow.php b/includes/Api/ApiFlow.php
index 6a10348..d55ccd9 100644
--- a/includes/Api/ApiFlow.php
+++ b/includes/Api/ApiFlow.php
@@ -11,7 +11,9 @@
class ApiFlow extends ApiBase {
- /** @var ApiModuleManager $moduleManager */
+ /**
+ * @var ApiModuleManager
+ */
private $moduleManager;
private static $alwaysEnabledModules = array(
diff --git a/includes/Api/ApiFlowBase.php b/includes/Api/ApiFlowBase.php
index 8ad1b9b..c9e58f1 100644
--- a/includes/Api/ApiFlowBase.php
+++ b/includes/Api/ApiFlowBase.php
@@ -14,13 +14,19 @@
abstract class ApiFlowBase extends ApiBase {
- /** @var WorkflowLoader $loader */
+ /**
+ * @var WorkflowLoader
+ */
protected $loader;
- /** @var Title $page */
+ /**
+ * @var Title
+ */
protected $page;
- /** @var ApiFlow $apiFlow */
+ /**
+ * @var ApiFlow
+ */
protected $apiFlow;
/**
diff --git a/includes/Block/Block.php b/includes/Block/Block.php
index c509030..8b8793e 100644
--- a/includes/Block/Block.php
+++ b/includes/Block/Block.php
@@ -139,8 +139,8 @@
abstract public function commit();
/**
- * @var IContextSource $context
- * @var string $action
+ * @param IContextSource $context
+ * @param string $action
*/
public function init( IContextSource $context, $action ) {
$this->context = $context;
diff --git a/includes/Data/Listener/WorkflowTopicListListener.php
b/includes/Data/Listener/WorkflowTopicListListener.php
index 18e0369..4cbfe53 100644
--- a/includes/Data/Listener/WorkflowTopicListListener.php
+++ b/includes/Data/Listener/WorkflowTopicListListener.php
@@ -34,7 +34,7 @@
}
/**
- * @var string
+ * @param string $workflowId
* @return TopicListEntry|false
*/
protected function getTopicListEntry( $workflowId ) {
diff --git a/includes/Data/ObjectManager.php b/includes/Data/ObjectManager.php
index 5ae955c..0e9d0c1 100644
--- a/includes/Data/ObjectManager.php
+++ b/includes/Data/ObjectManager.php
@@ -111,7 +111,7 @@
* Merge an object loaded from outside the object manager for update.
* Without merge using self::put will trigger an insert operation.
*
- * @var object $object
+ * @param object $object
*/
public function merge( $object ) {
if ( !isset( $this->loaded[$object] ) ) {
@@ -137,8 +137,8 @@
/**
* Persist a single object to storage.
*
- * @var object $object
- * @var array $metadata Additional information about the object for
+ * @param object $object
+ * @param array $metadata Additional information about the object for
* listeners to operate on.
*/
public function put( $object, array $metadata = array() ) {
@@ -148,8 +148,8 @@
/**
* Persist multiple objects to storage.
*
- * @var object[] $objects
- * @var array $metadata Additional information about the object for
+ * @param object[] $objects
+ * @param array $metadata Additional information about the object for
* listeners to operate on.
*/
public function multiPut( array $objects, array $metadata = array() ) {
@@ -176,8 +176,8 @@
/**
* Remove an object from persistent storage.
*
- * @var object $object
- * @var array $metadata Additional information about the object for
+ * @param object $object
+ * @param array $metadata Additional information about the object for
* listeners to operate on.
*/
public function remove( $object, array $metadata = array() ) {
@@ -196,8 +196,8 @@
/**
* Remove multiple objects from persistent storage.
*
- * @var object[] $objects
- * @var array $metadata
+ * @param object[] $objects
+ * @param array $metadata
*/
public function multiRemove( $objects, array $metadata ) {
foreach ( $objects as $obj ) {
diff --git a/includes/DbFactory.php b/includes/DbFactory.php
index 4ecebab..b452dca 100644
--- a/includes/DbFactory.php
+++ b/includes/DbFactory.php
@@ -31,8 +31,8 @@
protected $forceMaster = false;
/**
- * @var string|boolean $wiki Wiki ID, or false for the current wiki
- * @var string|boolean $cluster External storage cluster, or false for
core
+ * @param string|boolean $wiki Wiki ID, or false for the current wiki
+ * @param string|boolean $cluster External storage cluster, or false
for core
*/
public function __construct( $wiki = false, $cluster = false ) {
$this->wiki = $wiki;
diff --git a/includes/Import/Importer.php b/includes/Import/Importer.php
index 9eca6cc..fa221a7 100644
--- a/includes/Import/Importer.php
+++ b/includes/Import/Importer.php
@@ -349,8 +349,8 @@
}
/**
- * @var AbstractRevision $summary
- * @var string $timestamp
+ * @param AbstractRevision $revision
+ * @param string $timestamp
*/
public function setRevisionTimestamp( AbstractRevision $revision,
$timestamp ) {
$uid = $this->getTimestampId( $timestamp );
diff --git a/includes/Import/Wikitext/ConversionStrategy.php
b/includes/Import/Wikitext/ConversionStrategy.php
index ef9cf9d..2c1df17 100644
--- a/includes/Import/Wikitext/ConversionStrategy.php
+++ b/includes/Import/Wikitext/ConversionStrategy.php
@@ -46,12 +46,12 @@
protected $parser;
/**
- * @var array $archiveTitleSuggestions
+ * @var array
*/
protected $archiveTitleSuggestions;
/**
- * @var string $headerSuffix
+ * @var string
*/
protected $headerSuffix;
diff --git a/includes/Model/Anchor.php b/includes/Model/Anchor.php
index d64e26d..bb4187a 100644
--- a/includes/Model/Anchor.php
+++ b/includes/Model/Anchor.php
@@ -23,7 +23,7 @@
/**
* Message used for the HTML title attribute of the anchor
*
- * @var Message $titleMessage
+ * @var Message
*/
protected $titleMessage;
diff --git a/includes/Model/PostRevision.php b/includes/Model/PostRevision.php
index e555b4a..1b4caa1 100644
--- a/includes/Model/PostRevision.php
+++ b/includes/Model/PostRevision.php
@@ -112,8 +112,8 @@
}
/**
- * @var string[] $row
- * @var PostRevision|null $obj
+ * @param string[] $row
+ * @param PostRevision|null $obj
* @return PostRevision
* @throws DataModelException
*/
diff --git a/includes/Parsoid/Fixer/BaseHrefFixer.php
b/includes/Parsoid/Fixer/BaseHrefFixer.php
index 28cb3ff..536e9ad 100644
--- a/includes/Parsoid/Fixer/BaseHrefFixer.php
+++ b/includes/Parsoid/Fixer/BaseHrefFixer.php
@@ -15,7 +15,7 @@
*/
class BaseHrefFixer implements Fixer {
/**
- * @var string $baseHref
+ * @var string
*/
protected $baseHref;
diff --git a/includes/Search/Searcher.php b/includes/Search/Searcher.php
index e4ac2ea..98eb057 100644
--- a/includes/Search/Searcher.php
+++ b/includes/Search/Searcher.php
@@ -16,7 +16,7 @@
const HIGHLIGHT_POST = '</span>';
/**
- * @var string|false $type
+ * @var string|bool
*/
protected $type = false;
diff --git a/includes/Specials/SpecialEnableFlow.php
b/includes/Specials/SpecialEnableFlow.php
index c812c56..c133581 100644
--- a/includes/Specials/SpecialEnableFlow.php
+++ b/includes/Specials/SpecialEnableFlow.php
@@ -16,11 +16,13 @@
*/
class SpecialEnableFlow extends FormSpecialPage {
/**
- * @var \Flow\WorkflowLoaderFactory $loaderFactory
+ * @var \Flow\WorkflowLoaderFactory
*/
protected $loaderFactory;
- /** @var \Flow\TalkpageManager $controller */
+ /**
+ * @var \Flow\TalkpageManager
+ */
protected $occupationController;
/**
diff --git a/includes/Specials/SpecialFlow.php
b/includes/Specials/SpecialFlow.php
index ddba86a..bf6e147 100644
--- a/includes/Specials/SpecialFlow.php
+++ b/includes/Specials/SpecialFlow.php
@@ -20,13 +20,13 @@
/**
* The type of content, e.g. 'post', 'workflow'
- * @var string $type
+ * @var string
*/
protected $type;
/**
* Flow UUID
- * @var string $uuid
+ * @var string
*/
protected $uuid;
diff --git a/includes/SubmissionHandler.php b/includes/SubmissionHandler.php
index bf99ee2..a8e2970 100644
--- a/includes/SubmissionHandler.php
+++ b/includes/SubmissionHandler.php
@@ -16,12 +16,12 @@
class SubmissionHandler {
/**
- * @var ManagerGroup $storage
+ * @var ManagerGroup
*/
protected $storage;
/**
- * @var DbFactory $dbFactory
+ * @var DbFactory
*/
protected $dbFactory;
diff --git a/maintenance/FlowFixInconsistentBoards.php
b/maintenance/FlowFixInconsistentBoards.php
index c0062f8..bcf83b3 100644
--- a/maintenance/FlowFixInconsistentBoards.php
+++ b/maintenance/FlowFixInconsistentBoards.php
@@ -18,12 +18,12 @@
*/
class FlowFixInconsistentBoards extends LoggedUpdateMaintenance {
/**
- * @var Flow\DbFactory $dbFactory
+ * @var Flow\DbFactory
*/
protected $dbFactory;
/**
- * @var Flow\WorkflowLoaderFactory $workflowLoaderFactory
+ * @var Flow\WorkflowLoaderFactory
*/
protected $workflowLoaderFactory;
diff --git a/tests/phpunit/Mock/MockImportSource.php
b/tests/phpunit/Mock/MockImportSource.php
index c951467..afd79e3 100644
--- a/tests/phpunit/Mock/MockImportSource.php
+++ b/tests/phpunit/Mock/MockImportSource.php
@@ -13,7 +13,7 @@
protected $topics;
/**
- * @var IImportHeader|null $header
+ * @var IImportHeader|null
*/
protected $header;
--
To view, visit https://gerrit.wikimedia.org/r/351139
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I63cffd17228d8d2d6dac69afc6e0447b0a38e7d1
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Flow
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
