From: Sam Reed <reedy@users.mediawiki.org>
Date: Sun, 29 May 2011 15:59:47 +0000 (+0000)
Subject: More documentation!
X-Git-Tag: 1.31.0-rc.0~29855
X-Git-Url: http://git.cyclocoop.org/%24href?a=commitdiff_plain;h=6869bd5893120b1b8ecf215064dfacb686fc84b5;p=lhc%2Fweb%2Fwiklou.git

More documentation!
---

diff --git a/languages/LanguageConverter.php b/languages/LanguageConverter.php
index 223336ac2c..59fed23695 100644
--- 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 94cccace3c..5251011650 100644
--- 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 538e620939..2225d9e5d7 100644
--- 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 7984f58fbf..48b57aa293 100644
--- 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 1d4195740f..615c24e1b6 100644
--- 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 62747a8340..aeca362183 100644
--- 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 d5c0d524a3..20d463e9d0 100644
--- 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 66477bb331..3e2ca90e2d 100644
--- 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 a75b6a1861..3993b0ed2c 100644
--- 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 e37116b1cd..46a776bfdf 100644
--- 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 4495ddcce0..f976bed121 100644
--- 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 916843c074..0b69688d9c 100644
--- 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 06dfb57d35..00d8de62dd 100644
--- 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+)?$/', $_ ) ) {