http://www.mediawiki.org/wiki/Special:Code/MediaWiki/89117
Revision: 89117
Author: reedy
Date: 2011-05-29 15:59:47 +0000 (Sun, 29 May 2011)
Log Message:
-----------
More documentation!
Modified Paths:
--------------
trunk/phase3/languages/LanguageConverter.php
trunk/phase3/languages/classes/LanguageIu.php
trunk/phase3/languages/classes/LanguageKaa.php
trunk/phase3/languages/classes/LanguageKk.php
trunk/phase3/languages/classes/LanguageKu.php
trunk/phase3/languages/classes/LanguageMl.php
trunk/phase3/languages/classes/LanguageRu.php
trunk/phase3/languages/classes/LanguageSl.php
trunk/phase3/languages/classes/LanguageSr.php
trunk/phase3/languages/classes/LanguageTi.php
trunk/phase3/languages/classes/LanguageTl.php
trunk/phase3/languages/classes/LanguageTr.php
trunk/phase3/languages/classes/LanguageUk.php
Modified: trunk/phase3/languages/LanguageConverter.php
===================================================================
--- trunk/phase3/languages/LanguageConverter.php 2011-05-29 15:53:18 UTC
(rev 89116)
+++ trunk/phase3/languages/LanguageConverter.php 2011-05-29 15:59:47 UTC
(rev 89117)
@@ -766,6 +766,8 @@
/**
* Returns language specific hash options.
+ *
+ * @return string
*/
public function getExtraHashOptions() {
$variant = $this->getPreferredVariant();
@@ -870,6 +872,8 @@
* @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 @@
/**
* @private
+ *
+ * @return string
*/
function getRulesDesc() {
$codesep = $this->mConverter->mDescCodeSep;
@@ -1253,6 +1259,8 @@
/**
* Parse rules conversion.
* @private
+ *
+ * @return string
*/
function getRuleConvertedStr( $variant ) {
$bidtable = $this->mBidtable;
@@ -1462,6 +1470,7 @@
/**
* Get display text on markup -{...}-
+ * @return string
*/
public function getDisplay() {
return $this->mRuleDisplay;
@@ -1469,6 +1478,7 @@
/**
* Get converted title.
+ * @return string
*/
public function getTitle() {
return $this->mRuleTitle;
Modified: trunk/phase3/languages/classes/LanguageIu.php
===================================================================
--- trunk/phase3/languages/classes/LanguageIu.php 2011-05-29 15:53:18 UTC
(rev 89116)
+++ trunk/phase3/languages/classes/LanguageIu.php 2011-05-29 15:59:47 UTC
(rev 89117)
@@ -128,6 +128,8 @@
/**
* 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 @@
/**
* 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 @@
}
/**
- * 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
Modified: trunk/phase3/languages/classes/LanguageKaa.php
===================================================================
--- trunk/phase3/languages/classes/LanguageKaa.php 2011-05-29 15:53:18 UTC
(rev 89116)
+++ trunk/phase3/languages/classes/LanguageKaa.php 2011-05-29 15:59:47 UTC
(rev 89117)
@@ -10,6 +10,8 @@
# Invoked with {{GRAMMAR:case|word}}
/**
* Cases: genitive, dative, accusative, locative, ablative, comitative
+ possessive forms
+ *
+ * @return string
*/
function convertGrammar( $word, $case ) {
global $wgGrammarForms;
Modified: trunk/phase3/languages/classes/LanguageKk.php
===================================================================
--- trunk/phase3/languages/classes/LanguageKk.php 2011-05-29 15:53:18 UTC
(rev 89116)
+++ trunk/phase3/languages/classes/LanguageKk.php 2011-05-29 15:59:47 UTC
(rev 89117)
@@ -234,6 +234,8 @@
/**
* 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 @@
/**
* It translates text into variant
+ *
+ * @return string
*/
function translate( $text, $toVariant ) {
global $wgLanguageCode;
@@ -340,6 +344,8 @@
/**
* 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 ) )
Modified: trunk/phase3/languages/classes/LanguageKu.php
===================================================================
--- trunk/phase3/languages/classes/LanguageKu.php 2011-05-29 15:53:18 UTC
(rev 89116)
+++ trunk/phase3/languages/classes/LanguageKu.php 2011-05-29 15:59:47 UTC
(rev 89117)
@@ -155,6 +155,8 @@
/**
* 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 @@
/**
* 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 @@
/**
* It translates text into variant, specials:
* - ommiting roman numbers
+ *
+ * @return string
*/
function translate( $text, $toVariant ) {
/* From Kazakh interface, maybe we need it later
Modified: trunk/phase3/languages/classes/LanguageMl.php
===================================================================
--- trunk/phase3/languages/classes/LanguageMl.php 2011-05-29 15:53:18 UTC
(rev 89116)
+++ trunk/phase3/languages/classes/LanguageMl.php 2011-05-29 15:59:47 UTC
(rev 89117)
@@ -15,6 +15,10 @@
*
* @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;
Modified: trunk/phase3/languages/classes/LanguageRu.php
===================================================================
--- trunk/phase3/languages/classes/LanguageRu.php 2011-05-29 15:53:18 UTC
(rev 89116)
+++ trunk/phase3/languages/classes/LanguageRu.php 2011-05-29 15:59:47 UTC
(rev 89117)
@@ -99,6 +99,10 @@
* 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*)?$/', $_ ) ) {
Modified: trunk/phase3/languages/classes/LanguageSl.php
===================================================================
--- trunk/phase3/languages/classes/LanguageSl.php 2011-05-29 15:53:18 UTC
(rev 89116)
+++ trunk/phase3/languages/classes/LanguageSl.php 2011-05-29 15:59:47 UTC
(rev 89117)
@@ -9,6 +9,11 @@
# 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;
Modified: trunk/phase3/languages/classes/LanguageSr.php
===================================================================
--- trunk/phase3/languages/classes/LanguageSr.php 2011-05-29 15:53:18 UTC
(rev 89116)
+++ trunk/phase3/languages/classes/LanguageSr.php 2011-05-29 15:59:47 UTC
(rev 89117)
@@ -100,6 +100,8 @@
/**
* 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 @@
/**
* 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 @@
/**
* It translates text into variant, specials:
* - ommiting roman numbers
+ *
+ * @return string
*/
function translate( $text, $toVariant ) {
$breaks = '[^\w\x80-\xff]';
@@ -154,6 +160,8 @@
*
* @author Nikola Smolenski <[email protected]>
* @since 1.18
+ *
+ * @return bool
*/
public function guessVariant( $text, $variant ) {
$numCyrillic = preg_match_all("/[шђчћжШЂЧЋЖ]/u", $text, $dummy);
@@ -166,9 +174,7 @@
} else {
return false;
}
-
}
-
}
/**
Modified: trunk/phase3/languages/classes/LanguageTi.php
===================================================================
--- trunk/phase3/languages/classes/LanguageTi.php 2011-05-29 15:53:18 UTC
(rev 89116)
+++ trunk/phase3/languages/classes/LanguageTi.php 2011-05-29 15:59:47 UTC
(rev 89117)
@@ -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 ''; }
Modified: trunk/phase3/languages/classes/LanguageTl.php
===================================================================
--- trunk/phase3/languages/classes/LanguageTl.php 2011-05-29 15:53:18 UTC
(rev 89116)
+++ trunk/phase3/languages/classes/LanguageTl.php 2011-05-29 15:59:47 UTC
(rev 89117)
@@ -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 ''; }
Modified: trunk/phase3/languages/classes/LanguageTr.php
===================================================================
--- trunk/phase3/languages/classes/LanguageTr.php 2011-05-29 15:53:18 UTC
(rev 89116)
+++ trunk/phase3/languages/classes/LanguageTr.php 2011-05-29 15:59:47 UTC
(rev 89117)
@@ -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 @@
}
}
+ /**
+ * @param $string string
+ * @return mixed|string
+ */
function lcfirst ( $string ) {
if ( !empty( $string ) && $string[0] == 'I' ) {
return 'ı' . substr( $string, 1 );
@@ -28,13 +36,27 @@
}
}
- /** @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 );
Modified: trunk/phase3/languages/classes/LanguageUk.php
===================================================================
--- trunk/phase3/languages/classes/LanguageUk.php 2011-05-29 15:53:18 UTC
(rev 89116)
+++ trunk/phase3/languages/classes/LanguageUk.php 2011-05-29 15:59:47 UTC
(rev 89117)
@@ -86,6 +86,10 @@
/**
* Ukrainian numeric format is "12 345,67" but "1234,56"
+ *
+ * @param $_ string
+ *
+ * @return string
*/
function commafy( $_ ) {
if ( !preg_match( '/^\-?\d{1,4}(\.\d+)?$/', $_ ) ) {
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
