More documentation!

diff --git a/languages/LanguageConverter.php b/languages/LanguageConverter.php
index 223336a..59fed23 100644 (file)
--- a/languages/LanguageConverter.php
+++ b/languages/LanguageConverter.php
@@ -766,6 +766,8 @@ class LanguageConverter {
 
        /**
         * Returns language specific hash options.
+        *
+        * @return string
         */
        public function getExtraHashOptions() {
                $variant = $this->getPreferredVariant();
@@ -870,6 +872,8 @@ class LanguageConverter {
         * @param $code String: language code
         * @param $subpage String: subpage name
         * @param $recursive Boolean: parse subpages recursively? Defaults to true.
+        *
+        * @return array
         */
        function parseCachedTable( $code, $subpage = '', $recursive = true ) {
                static $parsed = array();
@@ -1233,6 +1237,8 @@ class ConverterRule {
 
        /**
         * @private
+        *
+        * @return string
         */
        function getRulesDesc() {
                $codesep = $this->mConverter->mDescCodeSep;
@@ -1253,6 +1259,8 @@ class ConverterRule {
        /**
         * Parse rules conversion.
         * @private
+        *
+        * @return string
         */
        function getRuleConvertedStr( $variant ) {
                $bidtable = $this->mBidtable;
@@ -1462,6 +1470,7 @@ class ConverterRule {
 
        /**
         * Get display text on markup -{...}-
+        * @return string
         */
        public function getDisplay() {
                return $this->mRuleDisplay;
@@ -1469,6 +1478,7 @@ class ConverterRule {
 
        /**
         * Get converted title.
+        * @return string
         */
        public function getTitle() {
                return $this->mRuleTitle;

diff --git a/languages/classes/LanguageIu.php b/languages/classes/LanguageIu.php
index 94cccac..5251011 100644 (file)
--- a/languages/classes/LanguageIu.php
+++ b/languages/classes/LanguageIu.php
@@ -128,6 +128,8 @@ class IuConverter extends LanguageConverter {
        /**
         * We want our external link captions to be converted in variants,
         * so we return the original text instead -{$text}-, except for URLs
+        *
+        * @return string
         */
        function markNoConversion( $text, $noParse = false ) {
                if ( $noParse || preg_match( "/^https?:\/\/|ftp:\/\/|irc:\/\//", $text ) )
@@ -138,6 +140,8 @@ class IuConverter extends LanguageConverter {
        /**
         * An ugly function wrapper for parsing Image titles
         * (to prevent image name conversion)
+        *
+        * @return string
         */
        function autoConvert( $text, $toVariant = false ) {
                global $wgTitle;
@@ -149,7 +153,9 @@ class IuConverter extends LanguageConverter {
        }
 
        /**
-        *  It translates text into variant
+        * It translates text into variant
+        *
+        * @return string
         */
        function translate( $text, $toVariant ) {
                // If $text is empty or only includes spaces, do nothing

diff --git a/languages/classes/LanguageKaa.php b/languages/classes/LanguageKaa.php
index 538e620..2225d9e 100644 (file)
--- a/languages/classes/LanguageKaa.php
+++ b/languages/classes/LanguageKaa.php
@@ -10,6 +10,8 @@ class LanguageKaa extends Language {
        # Invoked with {{GRAMMAR:case|word}}
        /**
         * Cases: genitive, dative, accusative, locative, ablative, comitative + possessive forms
+        *
+        * @return string
         */
        function convertGrammar( $word, $case ) {
                global $wgGrammarForms;

diff --git a/languages/classes/LanguageKk.php b/languages/classes/LanguageKk.php
index 7984f58..48b57aa 100644 (file)
--- a/languages/classes/LanguageKk.php
+++ b/languages/classes/LanguageKk.php
@@ -234,6 +234,8 @@ class KkConverter extends LanguageConverter {
        /**
         * An ugly function wrapper for parsing Image titles
         * (to prevent image name conversion)
+        *
+        * @return string
         */
        function autoConvert( $text, $toVariant = false ) {
                global $wgTitle;
@@ -246,6 +248,8 @@ class KkConverter extends LanguageConverter {
 
        /**
         *  It translates text into variant
+        *
+        * @return string
         */
        function translate( $text, $toVariant ) {
                global $wgLanguageCode;
@@ -340,6 +344,8 @@ class KkConverter extends LanguageConverter {
        /**
         * We want our external link captions to be converted in variants,
         * so we return the original text instead -{$text}-, except for URLs
+        *
+        * @return string
         */
        function markNoConversion( $text, $noParse = false ) {
                if ( $noParse || preg_match( "/^https?:\/\/|ftp:\/\/|irc:\/\//", $text ) )

diff --git a/languages/classes/LanguageKu.php b/languages/classes/LanguageKu.php
index 1d41957..615c24e 100644 (file)
--- a/languages/classes/LanguageKu.php
+++ b/languages/classes/LanguageKu.php
@@ -155,6 +155,8 @@ class KuConverter extends LanguageConverter {
        /**
         * We want our external link captions to be converted in variants,
         * so we return the original text instead -{$text}-, except for URLs
+        *
+        * @return string
         */
        function markNoConversion( $text, $noParse = false ) {
                if ( $noParse || preg_match( "/^https?:\/\/|ftp:\/\/|irc:\/\//", $text ) )
@@ -165,6 +167,8 @@ class KuConverter extends LanguageConverter {
        /**
         * An ugly function wrapper for parsing Image titles
         * (to prevent image name conversion)
+        *
+        * @return string
         */
        function autoConvert( $text, $toVariant = false ) {
                global $wgTitle;
@@ -178,6 +182,8 @@ class KuConverter extends LanguageConverter {
        /**
         *  It translates text into variant, specials:
         *    - ommiting roman numbers
+        *
+        * @return string
         */
        function translate( $text, $toVariant ) {
                /* From Kazakh interface, maybe we need it later

diff --git a/languages/classes/LanguageMl.php b/languages/classes/LanguageMl.php
index 62747a8..aeca362 100644 (file)
--- a/languages/classes/LanguageMl.php
+++ b/languages/classes/LanguageMl.php
@@ -15,6 +15,10 @@ class LanguageMl extends Language {
         *
         * @todo FIXME: This is language-specific for now only to avoid the negative
         * performance impact of enabling it for all languages.
+        *
+        * @param $s string
+        *
+        * @return string
         */
        function normalize( $s ) {
                global $wgFixMalayalamUnicode;

diff --git a/languages/classes/LanguageRu.php b/languages/classes/LanguageRu.php
index d5c0d52..20d463e 100644 (file)
--- a/languages/classes/LanguageRu.php
+++ b/languages/classes/LanguageRu.php
@@ -99,6 +99,10 @@ class LanguageRu extends Language {
         * Four-digit number should be without group commas (spaces)
         * See manual of style at http://ru.wikipedia.org/wiki/Википедия:Оформление_статей
         * So "1 234 567", "12 345" but "1234"
+        *
+        * @param $_ string
+        *
+        * @return string
         */
        function commafy( $_ ) {
                if ( preg_match( '/^-?\d{1,4}(\.\d*)?$/', $_ ) ) {

diff --git a/languages/classes/LanguageSl.php b/languages/classes/LanguageSl.php
index 66477bb..3e2ca90 100644 (file)
--- a/languages/classes/LanguageSl.php
+++ b/languages/classes/LanguageSl.php
@@ -9,6 +9,11 @@ class LanguageSl extends Language {
        # Invoked with {{GRAMMAR:case|word}}
        /**
         * Cases: rodilnik, dajalnik, tožilnik, mestnik, orodnik
+        *
+        * @param $word string
+        * @param $case string
+        *
+        * @return string
         */
        function convertGrammar( $word, $case ) {
                global $wgGrammarForms;

diff --git a/languages/classes/LanguageSr.php b/languages/classes/LanguageSr.php
index a75b6a1..3993b0e 100644 (file)
--- a/languages/classes/LanguageSr.php
+++ b/languages/classes/LanguageSr.php
@@ -100,6 +100,8 @@ class SrConverter extends LanguageConverter {
        /**
         * We want our external link captions to be converted in variants,
         * so we return the original text instead -{$text}-, except for URLs
+        *
+        * @return string
         */
        function markNoConversion( $text, $noParse = false ) {
                if ( $noParse || preg_match( "/^https?:\/\/|ftp:\/\/|irc:\/\//", $text ) )
@@ -110,6 +112,8 @@ class SrConverter extends LanguageConverter {
        /**
         * An ugly function wrapper for parsing Image titles
         * (to prevent image name conversion)
+        *
+        * @return string
         */
        function autoConvert( $text, $toVariant = false ) {
                global $wgTitle;
@@ -123,6 +127,8 @@ class SrConverter extends LanguageConverter {
        /**
         *  It translates text into variant, specials:
         *    - ommiting roman numbers
+        *
+        * @return string
         */
        function translate( $text, $toVariant ) {
                $breaks = '[^\w\x80-\xff]';
@@ -154,6 +160,8 @@ class SrConverter extends LanguageConverter {
         *
         * @author Nikola Smolenski <smolensk@eunet.rs>
         * @since 1.18
+        *
+        * @return bool
         */
        public function guessVariant( $text, $variant ) {
                $numCyrillic = preg_match_all("/[шђчћжШЂЧЋЖ]/u", $text, $dummy);
@@ -166,9 +174,7 @@ class SrConverter extends LanguageConverter {
                } else {
                        return false;
                }
-
        }
-
 }
 
 /**

diff --git a/languages/classes/LanguageTi.php b/languages/classes/LanguageTi.php
index e37116b..46a776b 100644 (file)
--- a/languages/classes/LanguageTi.php
+++ b/languages/classes/LanguageTi.php
@@ -7,6 +7,11 @@
 class LanguageTi extends Language {
        /**
         * Use singular form for zero
+        *
+        * @param $count int
+        * @param $forms array
+        *
+        * @return string
         */
        function convertPlural( $count, $forms ) {
                if ( !count( $forms ) ) { return ''; }

diff --git a/languages/classes/LanguageTl.php b/languages/classes/LanguageTl.php
index 4495ddc..f976bed 100644 (file)
--- a/languages/classes/LanguageTl.php
+++ b/languages/classes/LanguageTl.php
@@ -7,6 +7,11 @@
 class LanguageTl extends Language {
        /**
         * Use singular form for zero
+        *
+        * @param $count int
+        * @param $forms array
+        *
+        * @return string
         */
        function convertPlural( $count, $forms ) {
                if ( !count( $forms ) ) { return ''; }

diff --git a/languages/classes/LanguageTr.php b/languages/classes/LanguageTr.php
index 916843c..0b69688 100644 (file)
--- a/languages/classes/LanguageTr.php
+++ b/languages/classes/LanguageTr.php
@@ -12,6 +12,10 @@
  */
 class LanguageTr extends Language {
 
+       /**
+        * @param $string string
+        * @return string
+        */
        function ucfirst ( $string ) {
                if ( !empty( $string ) && $string[0] == 'i' ) {
                        return 'İ' . substr( $string, 1 );
@@ -20,6 +24,10 @@ class LanguageTr extends Language {
                }
        }
 
+       /**
+        * @param $string string
+        * @return mixed|string
+        */
        function lcfirst ( $string ) {
                if ( !empty( $string ) && $string[0] == 'I' ) {
                        return 'ı' . substr( $string, 1 );
@@ -28,13 +36,27 @@ class LanguageTr extends Language {
                }
        }
 
-       /** @see bug 28040 */
+       /**
+        * @see bug 28040
+        *
+        * @param $string string
+        * @param $first string
+        *
+        * @return string
+        */
        function uc( $string, $first = false ) {
                $string = preg_replace( '/i/', 'İ', $string );
                return parent::uc( $string, $first );
        }
 
-       /** @see bug 28040 */
+       /**
+        * @see bug 28040
+        *
+        * @param $string string
+        * @param $first string
+        *
+        * @return string
+        */
        function lc( $string, $first = false ) {
                $string = preg_replace( '/I/', 'ı', $string );
                return parent::lc( $string, $first );

diff --git a/languages/classes/LanguageUk.php b/languages/classes/LanguageUk.php
index 06dfb57..00d8de6 100644 (file)
--- a/languages/classes/LanguageUk.php
+++ b/languages/classes/LanguageUk.php
@@ -86,6 +86,10 @@ class LanguageUk extends Language {
 
        /**
         * Ukrainian numeric format is "12 345,67" but "1234,56"
+        *
+        * @param $_ string
+        *
+        * @return string
         */
        function commafy( $_ ) {
                if ( !preg_match( '/^\-?\d{1,4}(\.\d+)?$/', $_ ) ) {