[MediaWiki-CVS] SVN: [79855] trunk/extensions/RSS

[reedy]

http://www.mediawiki.org/wiki/Special:Code/MediaWiki/79855

Revision: 79855
Author:   reedy
Date:     2011-01-08 01:33:42 +0000 (Sat, 08 Jan 2011)
Log Message:
-----------
Fixup a few bits of documentation

Modified Paths:
--------------
    trunk/extensions/RSS/RSSHooks.php
    trunk/extensions/RSS/RSSParser.php

Modified: trunk/extensions/RSS/RSSHooks.php
===================================================================
--- trunk/extensions/RSS/RSSHooks.php   2011-01-08 01:10:42 UTC (rev 79854)
+++ trunk/extensions/RSS/RSSHooks.php   2011-01-08 01:33:42 UTC (rev 79855)
@@ -3,7 +3,7 @@
 class RSSHooks {
        /**
         * Tell the parser how to handle <rss> elements
-        * @param Parser Object
+        * @param $parser Parser Object
         */
        static function parserInit( $parser ) {
                # Install parser hook for <rss> tags
@@ -16,6 +16,7 @@
         * @param $input String: text inside the tags.
         * @param $args Array: value associative list of the element attributes 
and
         *                                              their values.
+        * @param $parser Parser
         * @param $frame Frame parser context
         */
        static function renderRss( $input, $args, $parser, $frame ) {

Modified: trunk/extensions/RSS/RSSParser.php
===================================================================
--- trunk/extensions/RSS/RSSParser.php  2011-01-08 01:10:42 UTC (rev 79854)
+++ trunk/extensions/RSS/RSSParser.php  2011-01-08 01:33:42 UTC (rev 79855)
@@ -84,7 +84,7 @@
         * If there is an HTTP error while fetching an RSS object, the cached 
version
         * will be returned, if it exists.
         *
-        * @return boolean Status object
+        * @return Status object
         */
        function fetch() {
                if ( !isset( $this->url ) ) {
@@ -238,7 +238,7 @@
         *
         * @param $item Array: an array produced by RSSData where keys are the
         *                                              names of the RSS 
elements
-        * @param $parser the parser param to pass to recursiveTagParse()
+        * @param $parser Parser the parser param to pass to recursiveTagParse()
         * @param $frame the frame param to pass to recursiveTagParse()
         */
        protected function renderItem( $item, $parser, $frame ) {
@@ -296,14 +296,13 @@
         * invocation.
         */
        protected function escapeTemplateParameter( $text ) {
-               $text = str_replace(
+               return str_replace(
                        array( '[',     '|',      ']',     '\'',    'ISBN ',    
 
                                'RFC ',     '://',     "\n=",     '{{',         
  '}}' ),
                        array( '&#91;', '&#124;', '&#93;', '&#39;', 
'ISBN&#32;', 
                                'RFC&#32;', '&#58;//', "\n&#61;", 
'&#123;&#123;', '&#125;&#125;' ),
                        htmlspecialchars( $text )
                );
-               return $text;
        }
 
        /**


_______________________________________________
MediaWiki-CVS mailing list
MediaWiki-CVS@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs