Cleanup some docs (languages)

- Makes beginning of @param in capital
- Removed return void

Change-Id: Ie05436c1ef886cb23c62ccde95384f253f83694c
This commit is contained in:
umherirrender 2014-07-24 14:55:43 +02:00
parent 4c413f2ae7
commit ae3c883150
8 changed files with 21 additions and 21 deletions

View file

@ -2351,7 +2351,7 @@ class Language {
* Get the formatted date and time for the given timestamp and formatted for
* the given user.
*
* @param mixed $ts the time format which needs to be turned into a
* @param mixed $ts The time format which needs to be turned into a
* date('YmdHis') format with wfTimestamp(TS_MW,$ts)
* @param User $user User object used to get preferences for timezone and format
* @param array $options Array, can contain the following keys:
@ -3786,8 +3786,8 @@ class Language {
*
* @since 1.23
*
* @param int $count non-localized number
* @param array $forms different plural forms
* @param int $count Non-localized number
* @param array $forms Different plural forms
*
* @return array|string
*/
@ -4024,12 +4024,12 @@ class Language {
* possible that non-existing link in one variant
* actually exists in another variant. this function
* tries to find it. See e.g. LanguageZh.php
* The input parameters may be modified upon return
*
* @param string $link The name of the link
* @param Title $nt The title object of the link
* @param string &$link The name of the link
* @param Title &$nt The title object of the link
* @param bool $ignoreOtherCond To disable other conditions when
* we need to transclude a template or update a category's link
* @return null the input parameters may be modified upon return
*/
public function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {
$this->mConverter->findVariantLink( $link, $nt, $ignoreOtherCond );

View file

@ -54,7 +54,7 @@ class LanguageConverter {
public $mManualLevel;
/**
* @var string memcached key name
* @var string Memcached key name
*/
public $mCacheKey;
@ -737,12 +737,12 @@ class LanguageConverter {
* If a language supports multiple variants, it is possible that
* non-existing link in one variant actually exists in another variant.
* This function tries to find it. See e.g. LanguageZh.php
* The input parameters may be modified upon return
*
* @param string $link The name of the link
* @param mixed $nt The title object of the link
* @param string &$link The name of the link
* @param Title &$nt The title object of the link
* @param bool $ignoreOtherCond To disable other conditions when
* we need to transclude a template or update a category's link
* @return void Null, the input parameters may be modified upon return
*/
public function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {
# If the article has already existed, there is no need to

View file

@ -142,8 +142,8 @@ class IuConverter extends LanguageConverter {
* names as they were
* - do not try to find variants for usernames
*
* @param string $link
* @param Title $nt
* @param string &$link
* @param Title &$nt
* @param bool $ignoreOtherCond
*/
function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {

View file

@ -250,8 +250,8 @@ class KkConverter extends LanguageConverter {
* names as they were
* - do not try to find variants for usernames
*
* @param string $link
* @param Title $nt
* @param string &$link
* @param Title &$nt
* @param bool $ignoreOtherCond
*/
function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {

View file

@ -160,8 +160,8 @@ class KuConverter extends LanguageConverter {
* names as they were
* - do not try to find variants for usernames
*
* @param string $link
* @param Title $nt
* @param string &$link
* @param Title &$nt
* @param bool $ignoreOtherCond
*/
function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {

View file

@ -118,8 +118,8 @@ class ShiConverter extends LanguageConverter {
* names as they were
* - do not try to find variants for usernames
*
* @param string $link
* @param Title $nt
* @param string &$link
* @param Title &$nt
* @param bool $ignoreOtherCond
*/
function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {

View file

@ -108,8 +108,8 @@ class SrConverter extends LanguageConverter {
* names as they were
* - do not try to find variants for usernames
*
* @param string $link
* @param Title $nt
* @param string &$link
* @param Title &$nt
* @param bool $ignoreOtherCond
*/
function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {

View file

@ -166,7 +166,7 @@ class LanguageZh extends LanguageZh_hans {
* auto convert to zh-hans and normalize special characters.
*
* @param string $string
* @param string $autoVariant default to 'zh-hans'
* @param string $autoVariant Defaults to 'zh-hans'
* @return string
*/
function normalizeForSearch( $string, $autoVariant = 'zh-hans' ) {