More return type documentation
authorSam Reed <reedy@users.mediawiki.org>
Tue, 8 Feb 2011 23:18:13 +0000 (23:18 +0000)
committerSam Reed <reedy@users.mediawiki.org>
Tue, 8 Feb 2011 23:18:13 +0000 (23:18 +0000)
includes/MagicWord.php
includes/parser/CoreParserFunctions.php
includes/parser/CoreTagHooks.php
includes/parser/LinkHolderArray.php
includes/parser/Parser_DiffTest.php

index 4698960..9988232 100644 (file)
@@ -192,6 +192,7 @@ class MagicWord {
        /**
         * Factory: creates an object representing an ID
         * @static
+        * @return MagicWord
         */
        static function &get( $id ) {
                wfProfileIn( __METHOD__ );
index 88349b6..d1ebc15 100644 (file)
  * @ingroup Parser
  */
 class CoreParserFunctions {
+       /**
+        * @static
+        * @param $parser Parser
+        * @return void
+        */
        static function register( $parser ) {
                global $wgAllowDisplayTitle, $wgAllowSlowParserFunctions;
 
@@ -507,6 +512,7 @@ class CoreParserFunctions {
         *   to the link cache, so the local cache here should be unnecessary, but
         *   in fact calling getLength() repeatedly for the same $page does seem to
         *   run one query for each call?
+        * @param $parser Parser
         */
        static function pagesize( $parser, $page = '', $raw = null ) {
                static $cache = array();
@@ -584,6 +590,12 @@ class CoreParserFunctions {
                return self::pad( $string, $length, $padding );
        }
 
+       /**
+        * @static
+        * @param $parser Parser
+        * @param  $text
+        * @return string
+        */
        static function anchorencode( $parser, $text ) {
                return substr( $parser->guessSectionNameFromWikiText( $text ), 1);
        }
@@ -598,6 +610,12 @@ class CoreParserFunctions {
                }
        }
 
+       /**
+        * @static
+        * @param $parser Parser
+        * @param  $text
+        * @return string
+        */
        public static function defaultsort( $parser, $text ) {
                $text = trim( $text );
                if( strlen( $text ) == 0 )
index 33f3c82..5718b06 100644 (file)
  * @ingroup Parser
  */
 class CoreTagHooks {
+       /**
+        * @static
+        * @param $parser Parser
+        * @return void
+        */
        static function register( $parser ) {
                global $wgRawHtml, $wgUseTeX;
                $parser->setHook( 'pre', array( __CLASS__, 'pre' ) );
@@ -52,6 +57,13 @@ class CoreTagHooks {
                return $wgContLang->armourMath( MathRenderer::renderMath( $content, $attributes, $parser->getOptions() ) );
        }
 
+       /**
+        * @static
+        * @param  $content
+        * @param  $attributes
+        * @param $parser Parser
+        * @return
+        */
        static function gallery( $content, $attributes, $parser ) {
                return $parser->renderImageGallery( $content, $attributes );
        }
index 133655e..3ad417b 100644 (file)
@@ -28,6 +28,7 @@ class LinkHolderArray {
 
        /**
         * Merge another LinkHolderArray into this one
+        * @param $other LinkHolderArray
         */
        function merge( $other ) {
                foreach ( $other->internals as $ns => $entries ) {
index c6dd76e..efad33f 100644 (file)
@@ -111,6 +111,10 @@ class Parser_DiffTest
                }
        }
 
+       /**
+        * @param $parser Parser
+        * @return bool
+        */
        function onClearState( &$parser ) {
                // hack marker prefixes to get identical output
                if ( !isset( $this->dtUniqPrefix ) ) {