jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/384238 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: Ie22b3de368199e77decb118150e7bde516b74bef
---
M RSSData.php
M RSSHooks.php
M RSSParser.php
M phpcs.xml
4 files changed, 34 insertions(+), 31 deletions(-)
Approvals:
jenkins-bot: Verified
Jforrester: Looks good to me, approved
diff --git a/RSSData.php b/RSSData.php
index f91ac66..00fefae 100644
--- a/RSSData.php
+++ b/RSSData.php
@@ -6,7 +6,7 @@
/**
* Constructor, takes a DOMDocument and returns an array of parsed
items.
- * @param $xml DOMDocument: the pre-parsed XML Document
+ * @param DOMDocument $xml the pre-parsed XML Document
* @return RSSData object with a member items that is an array of
parsed items,
*/
function __construct( $xml ) {
@@ -55,8 +55,8 @@
* probably needs a way to concert dc:date format dates to be the
* same as pubDate.
*
- * @param $n String: name of the element we have
- * @return String Name to map it to
+ * @param string $name name of the element we have
+ * @return string Name to map it to
*/
protected function rssTokenToName( $name ) {
$tokenNames = [
diff --git a/RSSHooks.php b/RSSHooks.php
index 4697c63..3968257 100644
--- a/RSSHooks.php
+++ b/RSSHooks.php
@@ -4,7 +4,7 @@
/**
* Tell the parser how to handle <rss> elements
- * @param $parser Parser Object
+ * @param Parser $parser Parser Object
* @return bool
*/
static function onParserFirstCallInit( $parser ) {
@@ -15,11 +15,11 @@
/**
* Static function wrapping RSSParser to handle rendering of RSS
elements
- * @param $input String: text inside the tags.
- * @param $args Array: value associative list of the element attributes
and
+ * @param string $input text inside the tags.
+ * @param array $args value associative list of the element attributes
and
* their values.
- * @param $parser Parser
- * @param $frame PPFrame parser context
+ * @param Parser $parser
+ * @param PPFrame $frame parser context
* @return string
*/
static function renderRss( $input, array $args, Parser $parser, PPFrame
$frame ) {
diff --git a/RSSParser.php b/RSSParser.php
index a1c7159..f668a97 100644
--- a/RSSParser.php
+++ b/RSSParser.php
@@ -30,8 +30,8 @@
/**
* Convenience function that takes a space-separated string and returns
an array of words
- * @param $str String: list of words
- * @return Array words found
+ * @param string $str list of words
+ * @return array words found
*/
private static function explodeOnSpaces( $str ) {
$found = preg_split( '# +#', $str );
@@ -42,6 +42,8 @@
* Take a bit of WikiText that looks like
* <rss max=5>http://example.com/</rss>
* and return an object that can produce rendered output.
+ * @param string $url
+ * @param array $args
*/
function __construct( $url, $args ) {
global $wgRSSDateDefaultFormat,$wgRSSItemMaxLength;
@@ -181,7 +183,7 @@
/**
* Retrieve the URL from the cache
- * @param $key String: lookup key to associate with this item
+ * @param string $key lookup key to associate with this item
* @return bool
*/
protected function loadFromCache( $key ) {
@@ -217,7 +219,7 @@
/**
* Store these objects (i.e. etag, lastModified, and RSS) in the cache.
- * @param $key String: lookup key to associate with this item
+ * @param string $key lookup key to associate with this item
* @return bool
*/
protected function storeInCache( $key ) {
@@ -236,8 +238,8 @@
/**
* Retrieve a feed.
- * @param $key String:
- * @param $headers Array: headers to send along with the request
+ * @param string $key
+ * @param array $headers headers to send along with the request
* @return Status object
*/
protected function fetchRemote( $key, array $headers = [] ) {
@@ -375,7 +377,8 @@
/**
* Render each item, filtering it out if necessary, applying any
highlighting.
*
- * @param $item Array: an array produced by RSSData where keys are the
names of the RSS elements
+ * @param array $item an array produced by RSSData where keys are the
names of the RSS elements
+ * @param Parser $parser
* @return mixed
*/
protected function renderItem( $item, $parser ) {
@@ -431,6 +434,8 @@
* a special meaning in wikitext, replacing them with URL escape codes,
so
* that arbitrary input can be included as a free or bracketed external
* link and both work and be safe.
+ * @param string $url
+ * @return string
*/
protected function sanitizeUrl( $url ) {
# Remove control characters
@@ -462,7 +467,8 @@
*
* If you want to allow images (HTML <img> tag) in RSS feeds:
* $wgRSSAllowImageTag = true;
- *
+ * @param string $text
+ * @return string
*/
protected function escapeTemplateParameter( $text ) {
global $wgRSSAllowLinkTag, $wgRSSAllowImageTag;
@@ -528,7 +534,7 @@
/**
* Parse an HTTP response object into an array of relevant RSS data
*
- * @param $key String: the key to use to store the parsed response in
the cache
+ * @param string $key the key to use to store the parsed response in
the cache
* @return string|bool parsed RSS object (see RSSParse) or false
*/
protected function responseToXML( $key ) {
@@ -574,7 +580,7 @@
/**
* Determine if a given item should or should not be displayed
*
- * @param $item Array: associative array that RSSData produced for an
<item>
+ * @param array $item associative array that RSSData produced for an
<item>
* @return bool
*/
protected function canDisplay( array $item ) {
@@ -599,9 +605,9 @@
/**
* Filters items in or out if the match a string we're looking for.
*
- * @param $text String: the text to examine
- * @param $filterType String: "filterOut" to check for matches in the
filterOut member list.
- * Otherwise, uses the filter member list.
+ * @param string $text the text to examine
+ * @param string $filterType "filterOut" to check for matches in the
filterOut member list.
+ * Otherwise, uses the filter member list.
* @return bool Decision to filter or not.
*/
protected function filter( $text, $filterType ) {
@@ -627,8 +633,8 @@
/**
* Highlight the words we're supposed to be looking for
*
- * @param $text String: the text to look in.
- * @return String with matched text highlighted in a <span> element
+ * @param string $text the text to look in.
+ * @return string with matched text highlighted in a <span> element
*/
protected function highlightTerms( $text ) {
if ( count( $this->highlight ) === 0 ) {
@@ -661,11 +667,11 @@
class RSSUtils {
/**
- * Output an error message, all wraped up nicely.
- * @param String $errorMessageName The system message that this error is
- * @param String|Array $param Error parameter (or parameters)
- * @return String Html that is the error.
- */
+ * Output an error message, all wraped up nicely.
+ * @param String $errorMessageName The system message that this error is
+ * @param String|Array $param Error parameter (or parameters)
+ * @return String Html that is the error.
+ */
public static function RSSError( $errorMessageName, $param = false ) {
// Anything from a parser tag should use Content lang for
message,
// since the cache doesn't vary by user language: use
->inContentLanguage()
diff --git a/phpcs.xml b/phpcs.xml
index 1866d45..a181996 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -2,9 +2,6 @@
<ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamName" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingReturn" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<exclude name="MediaWiki.Files.OneClassPerFile.MultipleFound" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
--
To view, visit https://gerrit.wikimedia.org/r/384238
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Ie22b3de368199e77decb118150e7bde516b74bef
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/RSS
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>
Gerrit-Reviewer: Jforrester <jforres...@wikimedia.org>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
