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

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

Change subject: Improve some parameter docs
..


Improve some parameter docs

Change-Id: I11cdca3812a6bb6d93ffbc916a632b6589ca70b9
---
M .phpcs.xml
M includes/AJAXPoll.class.php
2 files changed, 10 insertions(+), 7 deletions(-)

Approvals:
  Umherirrender: Looks good to me, approved
  jenkins-bot: Verified



diff --git a/.phpcs.xml b/.phpcs.xml
index bd7b626..3a6373b 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -2,9 +2,6 @@
 


-   
-   
-   



@@ -15,6 +12,5 @@

.

-   
-   vendor
+   
 
diff --git a/includes/AJAXPoll.class.php b/includes/AJAXPoll.class.php
index cc22178..8c8c2c6 100644
--- a/includes/AJAXPoll.class.php
+++ b/includes/AJAXPoll.class.php
@@ -18,7 +18,7 @@
/**
 * Register  tag with the parser
 *
-* @param parser Parser (not necessarily $wgParser
+* @param Parser $parser A parser instance, not necessarily $wgParser
 * @return bool true
 */
static function onParserInit( $parser ) {
@@ -27,7 +27,14 @@
return true;
}
 
-   # The callback function for converting the input text to HTML output
+   /**
+* The callback function for converting the input text to HTML output
+* @param string $input
+* @param array $args
+* @param Parser $parser
+* @param PPFrame $frame
+* @return string
+*/
static function AJAXPollRender( $input, $args = [], Parser $parser, 
$frame ) {
global $wgUser, $wgRequest, $wgUseAjax;
 

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

Gerrit-MessageType: merged
Gerrit-Change-Id: I11cdca3812a6bb6d93ffbc916a632b6589ca70b9
Gerrit-PatchSet: 2
Gerrit-Project: mediawiki/extensions/AJAXPoll
Gerrit-Branch: master
Gerrit-Owner: Umherirrender 
Gerrit-Reviewer: Umherirrender 
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...AJAXPoll[master]: Improve some parameter docs

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

Change subject: Improve some parameter docs
..

Improve some parameter docs

Change-Id: I11cdca3812a6bb6d93ffbc916a632b6589ca70b9
---
M .phpcs.xml
M includes/AJAXPoll.class.php
2 files changed, 10 insertions(+), 7 deletions(-)


  git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/AJAXPoll 
refs/changes/29/403729/1

diff --git a/.phpcs.xml b/.phpcs.xml
index bd7b626..3a6373b 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -2,9 +2,6 @@
 


-   
-   
-   



@@ -15,6 +12,5 @@

.

-   
-   vendor
+   
 
diff --git a/includes/AJAXPoll.class.php b/includes/AJAXPoll.class.php
index cc22178..a395a97 100644
--- a/includes/AJAXPoll.class.php
+++ b/includes/AJAXPoll.class.php
@@ -18,7 +18,7 @@
/**
 * Register  tag with the parser
 *
-* @param parser Parser (not necessarily $wgParser
+* @param Parser $parser (not necessarily $wgParser
 * @return bool true
 */
static function onParserInit( $parser ) {
@@ -27,7 +27,14 @@
return true;
}
 
-   # The callback function for converting the input text to HTML output
+   /**
+* The callback function for converting the input text to HTML output
+* @param string $input
+* @param array $args
+* @param Parser $parser
+* @param PPFrame $frame
+* @return string
+*/
static function AJAXPollRender( $input, $args = [], Parser $parser, 
$frame ) {
global $wgUser, $wgRequest, $wgUseAjax;
 

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

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

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