More documentation improvements
authorSam Reed <reedy@users.mediawiki.org>
Thu, 9 Feb 2012 21:17:18 +0000 (21:17 +0000)
committerSam Reed <reedy@users.mediawiki.org>
Thu, 9 Feb 2012 21:17:18 +0000 (21:17 +0000)
languages/Language.php
languages/LanguageConverter.php

index bb9abf1..40dcda3 100644 (file)
@@ -29,6 +29,10 @@ if ( function_exists( 'mb_strtoupper' ) ) {
  * @ingroup Language
  */
 class FakeConverter {
+
+       /**
+        * @var Language
+        */
        var $mLang;
        function __construct( $langobj ) { $this->mLang = $langobj; }
        function autoConvertToAllVariants( $text ) { return array( $this->mLang->getCode() => $text ); }
@@ -3131,7 +3135,7 @@ class Language {
         * (b) clear $tag value
         * @param &$tag string Current HTML tag name we are looking at
         * @param $tagType int (0-open tag, 1-close tag)
-        * @param $lastCh char|string Character before the '>' that ended this tag
+        * @param $lastCh string Character before the '>' that ended this tag
         * @param &$openTags array Open tag stack (not accounting for $tag)
         */
        private function truncate_endBracket( &$tag, $tagType, $lastCh, &$openTags ) {
@@ -3244,7 +3248,7 @@ class Language {
         * match up with it.
         *
         * @param $str String: the validated block duration in English
-        * @return Somehow translated block duration
+        * @return string Somehow translated block duration
         * @see LanguageFi.php for example implementation
         */
        function translateBlockExpiry( $str ) {
@@ -3583,7 +3587,7 @@ class Language {
         *
         * @param $code string
         *
-        * @return false|string
+        * @return bool|string
         */
        public static function getFallbackFor( $code ) {
                if ( $code === 'en' || !Language::isValidBuiltInCode( $code ) ) {
index 5e4bce8..0aaa931 100644 (file)
@@ -1015,8 +1015,8 @@ class LanguageConverter {
         * @param $summary String: edit summary of the edit
         * @param $isMinor Boolean: was the edit marked as minor?
         * @param $isWatch Boolean: did the user watch this page or not?
-        * @param $section Unused
-        * @param $flags Bitfield
+        * @param $section
+        * @param $flags int Bitfield
         * @param $revision Object: new Revision object or null
         * @return Boolean: true
         */