Umherirrender has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/403447 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: Ic85f74fc8dcefe86a3620e2d12f0b2ad2386ee23
---
M .phpcs.xml
M engines/LuaCommon/LanguageLibrary.php
M engines/LuaCommon/LuaCommon.php
M engines/LuaCommon/TitleLibrary.php
M tests/phpunit/engines/LuaCommon/LuaEngineTestBase.php
5 files changed, 69 insertions(+), 8 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Scribunto
refs/changes/47/403447/1
diff --git a/.phpcs.xml b/.phpcs.xml
index 0765bc8..f46e3ef 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -5,9 +5,6 @@
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingReturn" />
- <exclude name="MediaWiki.Commenting.FunctionComment.WrongStyle"
/>
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<exclude
name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment" />
<exclude name="Squiz.Scope.MethodScope.Missing" />
@@ -15,6 +12,4 @@
<file>.</file>
<arg name="extensions" value="php" />
<arg name="encoding" value="UTF-8" />
- <exclude-pattern>node_modules/</exclude-pattern>
- <exclude-pattern>vendor/</exclude-pattern>
</ruleset>
diff --git a/engines/LuaCommon/LanguageLibrary.php
b/engines/LuaCommon/LanguageLibrary.php
index 4c5faad..62af385 100644
--- a/engines/LuaCommon/LanguageLibrary.php
+++ b/engines/LuaCommon/LanguageLibrary.php
@@ -106,6 +106,10 @@
/**
* Language object method handler
+ * @param string $name
+ * @param array $args
+ * @return string
+ * @throws Scribunto_LuaError
*/
function languageMethod( $name, $args ) {
$name = strval( $name );
@@ -153,6 +157,9 @@
/**
* convertPlural handler
+ * @param Language $lang
+ * @param array $args
+ * @return array
*/
function convertPlural( $lang, $args ) {
$number = array_shift( $args );
@@ -166,6 +173,9 @@
/**
* convertGrammar handler
+ * @param Language $lang
+ * @param array $args
+ * @return array
*/
function convertGrammar( $lang, $args ) {
$this->checkType( 'convertGrammar', 1, $args[0], 'string' );
@@ -175,6 +185,9 @@
/**
* gender handler
+ * @param Language $lang
+ * @param array $args
+ * @return array
*/
function gender( $lang, $args ) {
$this->checkType( 'gender', 1, $args[0], 'string' );
@@ -220,6 +233,9 @@
/**
* formatNum handler
+ * @param Language $lang
+ * @param array $args
+ * @return array
*/
function formatNum( $lang, $args ) {
$num = $args[0];
@@ -236,6 +252,10 @@
/**
* formatDate handler
+ * @param Language $lang
+ * @param array $args
+ * @return array
+ * @throws Scribunto_LuaError
*/
function formatDate( $lang, $args ) {
$this->checkType( 'formatDate', 1, $args[0], 'string' );
@@ -308,6 +328,9 @@
/**
* formatDuration handler
+ * @param Language $lang
+ * @param array $args
+ * @return array
*/
function formatDuration( $lang, $args ) {
$this->checkType( 'formatDuration', 1, $args[0], 'number' );
@@ -323,6 +346,9 @@
/**
* getDurationIntervals handler
+ * @param Language $lang
+ * @param array $args
+ * @return array
*/
function getDurationIntervals( $lang, $args ) {
$this->checkType( 'getDurationIntervals', 1, $args[0], 'number'
);
diff --git a/engines/LuaCommon/LuaCommon.php b/engines/LuaCommon/LuaCommon.php
index b59a61e..6269dd3 100644
--- a/engines/LuaCommon/LuaCommon.php
+++ b/engines/LuaCommon/LuaCommon.php
@@ -253,6 +253,11 @@
/**
* Execute a module chunk in a new isolated environment, and return the
specified function
+ * @param string $chunk
+ * @param string $functionName
+ * @param string $frame
+ * @return mixed
+ * @throws ScribuntoException
*/
public function executeModule( $chunk, $functionName, $frame ) {
$resetFrames = null;
@@ -278,6 +283,9 @@
/**
* Execute a module function chunk
+ * @param string $chunk
+ * @param PPFrame|null $frame
+ * @return array
*/
public function executeFunctionChunk( $chunk, $frame ) {
// $resetFrames is a ScopedCallback, so it has a purpose even
though it appears unused.
@@ -599,6 +607,10 @@
/**
* Handler for newChildFrame()
*
+ * @param string $frameId
+ * @param string $title
+ * @param array $args
+ * @return array
* @throws Scribunto_LuaError
*/
function newChildFrame( $frameId, $title, array $args ) {
@@ -636,6 +648,7 @@
/**
* Handler for setTTL()
+ * @param int $ttl
*/
function setTTL( $ttl ) {
$args = func_get_args();
@@ -647,6 +660,9 @@
/**
* Handler for getExpandedArgument()
+ * @param string $frameId
+ * @param string $name
+ * @return array
*/
function getExpandedArgument( $frameId, $name ) {
$args = func_get_args();
@@ -664,6 +680,8 @@
/**
* Handler for getAllExpandedArguments()
+ * @param string $frameId
+ * @return array
*/
function getAllExpandedArguments( $frameId ) {
$frame = $this->getFrameById( $frameId );
@@ -673,6 +691,11 @@
/**
* Handler for expandTemplate()
+ * @param string $frameId
+ * @param string $titleText
+ * @param array $args
+ * @return array
+ * @throws Scribunto_LuaError
*/
function expandTemplate( $frameId, $titleText, $args ) {
$frame = $this->getFrameById( $frameId );
@@ -794,6 +817,10 @@
/**
* Handler for preprocess()
+ * @param string $frameId
+ * @param string $text
+ * @return array
+ * @throws Scribunto_LuaError
*/
function preprocess( $frameId, $text ) {
$args = func_get_args();
@@ -904,6 +931,7 @@
/**
* Get the chunk which, when called, will return the export table.
+ * @return string
*/
public function getInitChunk() {
if ( !$this->initChunk ) {
diff --git a/engines/LuaCommon/TitleLibrary.php
b/engines/LuaCommon/TitleLibrary.php
index 3527bb6..2e48ea8 100644
--- a/engines/LuaCommon/TitleLibrary.php
+++ b/engines/LuaCommon/TitleLibrary.php
@@ -208,8 +208,15 @@
return [ $this->getInexpensiveTitleData( $title ) ];
}
- // May call the following Title methods:
- // getFullUrl, getLocalUrl, getCanonicalUrl
+ /**
+ * May call the following Title methods:
+ * getFullUrl, getLocalUrl, getCanonicalUrl
+ * @param string $text
+ * @param string $which
+ * @param array $query
+ * @param string $proto
+ * @return array
+ */
function getUrl( $text, $which, $query = null, $proto = null ) {
static $protoMap = [
'http' => PROTO_HTTP,
diff --git a/tests/phpunit/engines/LuaCommon/LuaEngineTestBase.php
b/tests/phpunit/engines/LuaCommon/LuaEngineTestBase.php
index 0cf3cb9..6b147cb 100644
--- a/tests/phpunit/engines/LuaCommon/LuaEngineTestBase.php
+++ b/tests/phpunit/engines/LuaCommon/LuaEngineTestBase.php
@@ -239,7 +239,12 @@
return $this->luaDataProvider;
}
- /** @dataProvider provideLuaData */
+ /**
+ * @dataProvider provideLuaData
+ * @param string $key
+ * @param string $testName
+ * @param mixed $expected
+ */
public function testLua( $key, $testName, $expected ) {
$this->luaTestName = static::$moduleName."[$key]: $testName";
if ( isset( $this->skipTests[$testName] ) ) {
--
To view, visit https://gerrit.wikimedia.org/r/403447
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ic85f74fc8dcefe86a3620e2d12f0b2ad2386ee23
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Scribunto
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
