[MediaWiki-commits] [Gerrit] mediawiki...TopTenPages[master]: Improve some parameter docs

2018-01-08 Thread jenkins-bot (Code Review) 
jenkins-bot has submitted this change and it was merged. ( 
https://gerrit.wikimedia.org/r/402640 )

Change subject: Improve some parameter docs
..


Improve some parameter docs

Change-Id: I9c25b7fd492753415dcd546f345e6f740b416c62
---
M .phpcs.xml
M SpecialTopTenPages.php
M TopTenPages.hooks.php
3 files changed, 23 insertions(+), 6 deletions(-)

Approvals:
  jenkins-bot: Verified
  Thiemo Kreuz (WMDE): Looks good to me, approved



diff --git a/.phpcs.xml b/.phpcs.xml
index d883e25..0bcff2b 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -1,15 +1,11 @@
 
 

-   
-   
+   


-   
-   

.

-   
-   vendor
+   
 
diff --git a/SpecialTopTenPages.php b/SpecialTopTenPages.php
index c7bb473..10dc71f 100644
--- a/SpecialTopTenPages.php
+++ b/SpecialTopTenPages.php
@@ -2,19 +2,27 @@
 use HitCounters\SpecialPopularPages;
 
 class SpecialTopTenPages extends SpecialPopularPages {
+   /**
+* @param string $name
+*/
public function __construct( $name = 'TopTenPages' ) {
parent::__construct( $name );
$inc = $this->including();
}
 
+   /** @inheritDoc */
public function isIncludable() {
return true;
}
 
+   /** @inheritDoc */
function isListed() {
return false;
}
 
+   /**
+* @param string|null $par
+*/
function execute( $par ) {
$inc = $this->including();
 
@@ -28,6 +36,10 @@
parent::execute( $par );
}
 
+   /**
+* @param int $offset
+* @return string
+*/
function openList( $offset ) {
global $wgTopTenPagesStartAtOne;
if ( $wgTopTenPagesStartAtOne ) {
@@ -36,6 +48,7 @@
return parent::openList( $offset );
}
 
+   /** @inheritDoc */
protected function getGroupName() {
return 'other';
}
diff --git a/TopTenPages.hooks.php b/TopTenPages.hooks.php
index 546cd88..a7e2573 100644
--- a/TopTenPages.hooks.php
+++ b/TopTenPages.hooks.php
@@ -1,12 +1,20 @@
 setHook( 'TopTenPages', 'TopTenPagesHooks::renderTag' 
);
}
 
/**
 * The callback function for converting the input text to HTML output.
+* @param string $text
+* @param array $args
+* @param Parser $parser
+* @param PPFrame $frame
+* @return string
 */
public static function renderTag( $text, array $args, Parser $parser, 
PPFrame $frame ) {
if ( array_key_exists( 'offset', $args ) ) {

-- 
To view, visit https://gerrit.wikimedia.org/r/402640
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I9c25b7fd492753415dcd546f345e6f740b416c62
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/TopTenPages
Gerrit-Branch: master
Gerrit-Owner: Umherirrender 
Gerrit-Reviewer: Thiemo Kreuz (WMDE) 
Gerrit-Reviewer: jenkins-bot <>

___
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

[MediaWiki-commits] [Gerrit] mediawiki...TopTenPages[master]: Improve some parameter docs

2018-01-07 Thread Umherirrender (Code Review) 
Umherirrender has uploaded a new change for review. ( 
https://gerrit.wikimedia.org/r/402640 )

Change subject: Improve some parameter docs
..

Improve some parameter docs

Change-Id: I9c25b7fd492753415dcd546f345e6f740b416c62
---
M .phpcs.xml
M SpecialTopTenPages.php
M TopTenPages.hooks.php
3 files changed, 23 insertions(+), 6 deletions(-)


  git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/TopTenPages 
refs/changes/40/402640/1

diff --git a/.phpcs.xml b/.phpcs.xml
index d883e25..0bcff2b 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -1,15 +1,11 @@
 
 

-   
-   
+   


-   
-   

.

-   
-   vendor
+   
 
diff --git a/SpecialTopTenPages.php b/SpecialTopTenPages.php
index c7bb473..10dc71f 100644
--- a/SpecialTopTenPages.php
+++ b/SpecialTopTenPages.php
@@ -2,19 +2,27 @@
 use HitCounters\SpecialPopularPages;
 
 class SpecialTopTenPages extends SpecialPopularPages {
+   /**
+* @param string $name
+*/
public function __construct( $name = 'TopTenPages' ) {
parent::__construct( $name );
$inc = $this->including();
}
 
+   /** @inheritDoc */
public function isIncludable() {
return true;
}
 
+   /** @inheritDoc */
function isListed() {
return false;
}
 
+   /**
+* @param string|null $par
+*/
function execute( $par ) {
$inc = $this->including();
 
@@ -28,6 +36,10 @@
parent::execute( $par );
}
 
+   /**
+* @param int $offset
+* @return string
+*/
function openList( $offset ) {
global $wgTopTenPagesStartAtOne;
if ( $wgTopTenPagesStartAtOne ) {
@@ -36,6 +48,7 @@
return parent::openList( $offset );
}
 
+   /** @inheritDoc */
protected function getGroupName() {
return 'other';
}
diff --git a/TopTenPages.hooks.php b/TopTenPages.hooks.php
index 546cd88..a7e2573 100644
--- a/TopTenPages.hooks.php
+++ b/TopTenPages.hooks.php
@@ -1,12 +1,20 @@
 setHook( 'TopTenPages', 'TopTenPagesHooks::renderTag' 
);
}
 
/**
 * The callback function for converting the input text to HTML output.
+* @param string $text
+* @param array $args
+* @param Parser $parser
+* @param PPFrame $frame
+* @return string
 */
public static function renderTag( $text, array $args, Parser $parser, 
PPFrame $frame ) {
if ( array_key_exists( 'offset', $args ) ) {

-- 
To view, visit https://gerrit.wikimedia.org/r/402640
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I9c25b7fd492753415dcd546f345e6f740b416c62
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/TopTenPages
Gerrit-Branch: master
Gerrit-Owner: Umherirrender 

___
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits