From: Sam Reed Date: Sun, 29 May 2011 15:53:18 +0000 (+0000) Subject: More documentation! X-Git-Tag: 1.31.0-rc.0~29856 X-Git-Url: http://git.cyclocoop.org//%27%40script%40/%27?a=commitdiff_plain;h=f54cfa10015e8f9abc8aa7a3a6f4ba4f78cae982;p=lhc%2Fweb%2Fwiklou.git More documentation! --- diff --git a/languages/classes/LanguageBe_tarask.php b/languages/classes/LanguageBe_tarask.php index c7920e5ecc..25c3f7007d 100644 --- a/languages/classes/LanguageBe_tarask.php +++ b/languages/classes/LanguageBe_tarask.php @@ -52,6 +52,10 @@ class LanguageBe_tarask extends Language { * but the characters used for this could be both U+0027 and U+2019. * This function unifies apostrophe sign in search index values * to enable seach using both apostrophe signs. + * + * @param $string string + * + * @return string */ function normalizeForSearch( $string ) { wfProfileIn( __METHOD__ ); @@ -71,6 +75,10 @@ class LanguageBe_tarask extends Language { /** * Four-digit number should be without group commas (spaces) * 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/LanguageBg.php b/languages/classes/LanguageBg.php index d6d34090d0..9ccb9a85bb 100644 --- a/languages/classes/LanguageBg.php +++ b/languages/classes/LanguageBg.php @@ -8,6 +8,10 @@ class LanguageBg extends Language { /** * ISO number formatting: 123 456 789,99. * Avoid tripple grouping by numbers with whole part up to 4 digits. + * + * @param $_ string + * + * @return string */ function commafy( $_ ) { if ( !preg_match( '/^\d{1,4}$/', $_ ) ) { diff --git a/languages/classes/LanguageBh.php b/languages/classes/LanguageBh.php index 3272e2f33c..46e4418c16 100644 --- a/languages/classes/LanguageBh.php +++ b/languages/classes/LanguageBh.php @@ -7,6 +7,11 @@ class LanguageBh 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/LanguageBs.php b/languages/classes/LanguageBs.php index 927082eef3..c501b35a1c 100644 --- a/languages/classes/LanguageBs.php +++ b/languages/classes/LanguageBs.php @@ -34,6 +34,11 @@ class LanguageBs extends Language { # Invoked with {{GRAMMAR:case|word}} /** * Cases: genitiv, dativ, akuzativ, vokativ, instrumental, lokativ + * + * @param $word string + * @param $case string + * + * @return string */ function convertGrammar( $word, $case ) { global $wgGrammarForms; diff --git a/languages/classes/LanguageEt.php b/languages/classes/LanguageEt.php index 226c2d7306..b469dec91a 100644 --- a/languages/classes/LanguageEt.php +++ b/languages/classes/LanguageEt.php @@ -8,6 +8,10 @@ class LanguageEt extends Language { /** * Avoid grouping whole numbers between 0 to 9999 + * + * @param $_ string + * + * @return string */ function commafy( $_ ) { if ( !preg_match( '/^\d{1,4}$/', $_ ) ) { diff --git a/languages/classes/LanguageHi.php b/languages/classes/LanguageHi.php index fc9d0de82e..53a0fc1860 100644 --- a/languages/classes/LanguageHi.php +++ b/languages/classes/LanguageHi.php @@ -7,6 +7,11 @@ class LanguageHi 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/LanguageHy.php b/languages/classes/LanguageHy.php index 714d9cef7e..0da090c058 100644 --- a/languages/classes/LanguageHy.php +++ b/languages/classes/LanguageHy.php @@ -63,6 +63,10 @@ class LanguageHy extends Language { /** * Armenian numeric format is "12 345,67" but "1234,56" + * + * @param $_ string + * + * @return string */ function commafy( $_ ) { if ( !preg_match( '/^\d{1,4}$/', $_ ) ) { diff --git a/languages/classes/LanguageKaa.php b/languages/classes/LanguageKaa.php index 5b6e76db82..538e620939 100644 --- a/languages/classes/LanguageKaa.php +++ b/languages/classes/LanguageKaa.php @@ -35,6 +35,10 @@ class LanguageKaa extends Language { /** * It fixes issue with lcfirst for transforming 'I' to 'ı' + * + * @param $string string + * + * @return string */ function lcfirst ( $string ) { if ( substr( $string, 0, 1 ) === 'I' ) { @@ -46,6 +50,10 @@ class LanguageKaa extends Language { /** * Avoid grouping whole numbers between 0 to 9999 + * + * @param $_ string + * + * @return string */ function commafy( $_ ) { if ( !preg_match( '/^\d{1,4}$/', $_ ) ) { diff --git a/languages/classes/LanguageKk.php b/languages/classes/LanguageKk.php index f7d2d6d85d..7984f58fbf 100644 --- a/languages/classes/LanguageKk.php +++ b/languages/classes/LanguageKk.php @@ -347,6 +347,10 @@ class KkConverter extends LanguageConverter { return $text; } + /** + * @param $key string + * @return String + */ function convertCategoryKey( $key ) { return $this->autoConvert( $key, 'kk' ); } @@ -397,6 +401,10 @@ class LanguageKk extends LanguageKk_cyrl { /** * It fixes issue with ucfirst for transforming 'i' to 'İ' + * + * @param $string string + * + * @return string */ function ucfirst ( $string ) { $variant = $this->getPreferredVariant(); @@ -410,6 +418,10 @@ class LanguageKk extends LanguageKk_cyrl { /** * It fixes issue with lcfirst for transforming 'I' to 'ı' + * + * @param $string string + * + * @return string */ function lcfirst ( $string ) { $variant = $this->getPreferredVariant(); @@ -421,6 +433,11 @@ class LanguageKk extends LanguageKk_cyrl { return $string; } + /** + * @param $word string + * @param $case string + * @return string + */ function convertGrammar( $word, $case ) { wfProfileIn( __METHOD__ ); diff --git a/languages/classes/LanguageKk_cyrl.php b/languages/classes/LanguageKk_cyrl.php index 3b65efacf1..a26322523b 100644 --- a/languages/classes/LanguageKk_cyrl.php +++ b/languages/classes/LanguageKk_cyrl.php @@ -10,6 +10,11 @@ class LanguageKk_cyrl extends Language { # Invoked with {{GRAMMAR:case|word}} /** * Cases: genitive, dative, accusative, locative, ablative, comitative + possessive forms + * + * @param $word string + * @param $case stirng + * + * @return string */ function convertGrammarKk_cyrl( $word, $case ) { global $wgGrammarForms; @@ -707,6 +712,10 @@ class LanguageKk_cyrl extends Language { /** * Avoid grouping whole numbers between 0 to 9999 + * + * @param $_ string + * + * @return string */ function commafy( $_ ) { if ( !preg_match( '/^\d{1,4}$/', $_ ) ) { diff --git a/languages/classes/LanguageKsh.php b/languages/classes/LanguageKsh.php index 026bdfec1b..dc37656cc5 100644 --- a/languages/classes/LanguageKsh.php +++ b/languages/classes/LanguageKsh.php @@ -64,6 +64,8 @@ class LanguageKsh extends Language { * * @param $word String * @param $case String + * + * @return string */ function convertGrammar( $word, $case ) { $lord = strtolower( $word ); @@ -144,6 +146,10 @@ class LanguageKsh extends Language { /** * Avoid grouping whole numbers between 0 to 9999 + * + * @param $_ string + * + * @return string */ public function commafy( $_ ) { if ( !preg_match( '/^\d{1,4}$/', $_ ) ) { diff --git a/languages/classes/LanguageKu_ku.php b/languages/classes/LanguageKu_ku.php index a9ec64e61f..e43329283b 100644 --- a/languages/classes/LanguageKu_ku.php +++ b/languages/classes/LanguageKu_ku.php @@ -8,6 +8,10 @@ class LanguageKu_ku extends Language { /** * Avoid grouping whole numbers between 0 to 9999 + * + * @param $_ string + * + * @return string */ function commafy( $_ ) { diff --git a/languages/classes/LanguageLa.php b/languages/classes/LanguageLa.php index 81fc30cfd0..657ac6e46a 100644 --- a/languages/classes/LanguageLa.php +++ b/languages/classes/LanguageLa.php @@ -12,6 +12,11 @@ class LanguageLa extends Language { * Rules are far from complete. * * Cases: genitive, accusative, ablative + * + * @param $word string + * @param $case string + * + * @return string */ function convertGrammar( $word, $case ) { global $wgGrammarForms; diff --git a/languages/classes/LanguageLn.php b/languages/classes/LanguageLn.php index 11d276d85c..b96cf6196b 100644 --- a/languages/classes/LanguageLn.php +++ b/languages/classes/LanguageLn.php @@ -8,7 +8,11 @@ class LanguageLn extends Language { /** * Use singular form for zero * http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html#ln - + * + * @param $count int + * @param $forms array + * + * @return string */ function convertPlural( $count, $forms ) { if ( !count( $forms ) ) { return ''; } diff --git a/languages/classes/LanguageMk.php b/languages/classes/LanguageMk.php index 9dc8a56009..4ae7f412a5 100644 --- a/languages/classes/LanguageMk.php +++ b/languages/classes/LanguageMk.php @@ -8,6 +8,11 @@ class LanguageMk extends Language { /** * Plural forms per * http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html#mk + * + * @param $count int + * @param $forms array + * + * @return string */ function convertPlural( $count, $forms ) { if ( !count( $forms ) ) { return ''; }