http://www.mediawiki.org/wiki/Special:Code/MediaWiki/89119
Revision: 89119
Author: reedy
Date: 2011-05-29 16:32:43 +0000 (Sun, 29 May 2011)
Log Message:
-----------
More documentation!
Modified Paths:
--------------
trunk/phase3/languages/Language.php
trunk/phase3/languages/LanguageConverter.php
Modified: trunk/phase3/languages/Language.php
===================================================================
--- trunk/phase3/languages/Language.php 2011-05-29 16:32:05 UTC (rev 89118)
+++ trunk/phase3/languages/Language.php 2011-05-29 16:32:43 UTC (rev 89119)
@@ -1721,7 +1721,7 @@
* @param $adj Bool: whether to adjust the time output according to the
* user configured offset ($timecorrection)
* @param $format Mixed: true to use user's date format preference
- * @param $timecorrection String: the time offset as returned by
+ * @param $timecorrection String|bool the time offset as returned by
* validateTimeZone() in Special:Preferences
* @return string
*/
@@ -1740,7 +1740,7 @@
* @param $adj Bool: whether to adjust the time output according to the
* user configured offset ($timecorrection)
* @param $format Mixed: true to use user's date format preference
- * @param $timecorrection String: the time offset as returned by
+ * @param $timecorrection String|bool the time offset as returned by
* validateTimeZone() in Special:Preferences
* @return string
*/
@@ -1760,7 +1760,7 @@
* user configured offset ($timecorrection)
* @param $format Mixed: what format to return, if it's false output the
* default one (default true)
- * @param $timecorrection String: the time offset as returned by
+ * @param $timecorrection String|bool the time offset as returned by
* validateTimeZone() in Special:Preferences
* @return string
*/
@@ -2756,7 +2756,7 @@
* @param string $text HTML string to truncate
* @param int $length (zero/positive) Maximum length (including
ellipses)
* @param string $ellipsis String to append to the truncated text
- * @returns string
+ * @return string
*/
function truncateHtml( $text, $length, $ellipsis = '...' ) {
# Use the localized ellipsis character
Modified: trunk/phase3/languages/LanguageConverter.php
===================================================================
--- trunk/phase3/languages/LanguageConverter.php 2011-05-29 16:32:05 UTC
(rev 89118)
+++ trunk/phase3/languages/LanguageConverter.php 2011-05-29 16:32:43 UTC
(rev 89119)
@@ -305,9 +305,9 @@
* If you want to parse rules, try to use convert() or
* convertTo().
*
- * @param $text String: the text to be converted
- * @param $toVariant String: the target language code
- * @return String: the converted text
+ * @param $text String the text to be converted
+ * @param $toVariant bool|string the target language code
+ * @return String the converted text
*/
public function autoConvert( $text, $toVariant = false ) {
wfProfileIn( __METHOD__ );
@@ -481,7 +481,7 @@
/**
* Apply manual conversion rules.
*
- * @param $convRule Object: Object of ConverterRule
+ * @param $convRule ConverterRule Object of ConverterRule
*/
protected function applyManualConv( $convRule ) {
// Use syntax -{T|zh-cn:TitleCN; zh-tw:TitleTw}- to custom
@@ -521,7 +521,7 @@
* Auto convert a Title object to a readable string in the
* preferred variant.
*
- * @param $title Object: a object of Title
+ * @param $title Title a object of Title
* @return String: converted title text
*/
public function convertTitle( $title ) {
@@ -622,7 +622,9 @@
*
* @param $text String: text to be converted
* @param $variant String: the target variant code
+ * @param $startPos int
* @param $depth Integer: depth of recursion
+ *
* @return String: converted text
*/
protected function recursiveConvertRule( $text, $variant, &$startPos,
$depth = 0 ) {
@@ -993,6 +995,10 @@
/**
* Convert the sorting key for category links. This should make
different
* keys that are variants of each other map to the same key.
+ *
+ * @param $key string
+ *
+ * @return string
*/
function convertCategoryKey( $key ) {
return $key;
@@ -1003,7 +1009,7 @@
* MediaWiki:Conversiontable* is updated.
* @private
*
- * @param $article Object: Article object
+ * @param $article Article object
* @param $user Object: User object for the current user
* @param $text String: article text (?)
* @param $summary String: edit summary of the edit
@@ -1260,6 +1266,8 @@
* Parse rules conversion.
* @private
*
+ * @param $variant
+ *
* @return string
*/
function getRuleConvertedStr( $variant ) {
@@ -1486,6 +1494,7 @@
/**
* Return how deal with conversion rules.
+ * @return string
*/
public function getRulesAction() {
return $this->mRulesAction;
@@ -1494,6 +1503,7 @@
/**
* Get conversion table. (bidirectional and unidirectional
* conversion table)
+ * @return array
*/
public function getConvTable() {
return $this->mConvTable;
@@ -1501,6 +1511,7 @@
/**
* Get conversion rules string.
+ * @return string
*/
public function getRules() {
return $this->mRules;
@@ -1508,6 +1519,7 @@
/**
* Get conversion flags.
+ * @return array
*/
public function getFlags() {
return $this->mFlags;
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
