Umherirrender has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/402635 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: Ia3e62f7935db45350a6ff7d60befa1d0072b4b30
---
M .phpcs.xml
M Citoid.hooks.php
M CitoidDataModule.php
3 files changed, 26 insertions(+), 11 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Citoid
refs/changes/35/402635/1
diff --git a/.phpcs.xml b/.phpcs.xml
index c4c4501..90e8108 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -1,15 +1,10 @@
<?xml version="1.0"?>
<ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingReturn" />
- <exclude name="MediaWiki.Commenting.FunctionComment.WrongStyle"
/>
+ <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
</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>
diff --git a/Citoid.hooks.php b/Citoid.hooks.php
index 7a27a36..b057134 100644
--- a/Citoid.hooks.php
+++ b/Citoid.hooks.php
@@ -10,6 +10,8 @@
/**
* Adds extra variables to the global config
+ * @param array &$vars
+ * @return true
*/
public static function onResourceLoaderGetConfigVars( array &$vars ) {
global $wgCitoidServiceUrl;
@@ -23,6 +25,9 @@
/**
* Register qunit unit tests
+ * @param array &$testModules
+ * @param ResourceLoader &$resourceLoader
+ * @return true
*/
public static function onResourceLoaderTestModules(
array &$testModules,
@@ -47,6 +52,11 @@
return true;
}
+ /**
+ * @param User $user
+ * @param array &$preferences
+ * @return true
+ */
public static function onGetPreferences( User $user, array
&$preferences ) {
$preferences['citoid-mode'] = [
'type' => 'api'
diff --git a/CitoidDataModule.php b/CitoidDataModule.php
index c32e077..480a2cd 100644
--- a/CitoidDataModule.php
+++ b/CitoidDataModule.php
@@ -12,13 +12,16 @@
class CitoidDataModule extends ResourceLoaderModule {
- /* Protected Members */
-
+ /** @var string $origin */
protected $origin = self::ORIGIN_USER_SITEWIDE;
+
+ /** @var array $targets */
protected $targets = [ 'desktop', 'mobile' ];
- /* Methods */
-
+ /**
+ * @param ResourceLoaderContext $context
+ * @return string
+ */
public function getScript( ResourceLoaderContext $context ) {
return 've.init.platform.addMessages(' . FormatJson::encode(
[
@@ -31,6 +34,10 @@
) . ');';
}
+ /**
+ * @param ResourceLoaderContext|null $context
+ * @return array
+ */
public function getDependencies( ResourceLoaderContext $context = null
) {
return [
'ext.visualEditor.base',
@@ -38,6 +45,9 @@
];
}
+ /**
+ * @return bool
+ */
public function enableModuleContentVersion() {
return true;
}
--
To view, visit https://gerrit.wikimedia.org/r/402635
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ia3e62f7935db45350a6ff7d60befa1d0072b4b30
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Citoid
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
