Cleanup some docs (languages)

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

Change-Id: Ie05436c1ef886cb23c62ccde95384f253f83694c

diff --git a/languages/Language.php b/languages/Language.php
index 8b41b4e..99dc184 100644 (file)
--- a/languages/Language.php
+++ b/languages/Language.php
@@ -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 );

diff --git a/languages/LanguageConverter.php b/languages/LanguageConverter.php
index b3a4c1a..abca495 100644 (file)
--- a/languages/LanguageConverter.php
+++ b/languages/LanguageConverter.php
@@ -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

diff --git a/languages/classes/LanguageIu.php b/languages/classes/LanguageIu.php
index 1d279d6..db3a22c 100644 (file)
--- a/languages/classes/LanguageIu.php
+++ b/languages/classes/LanguageIu.php
@@ -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 ) {

diff --git a/languages/classes/LanguageKk.php b/languages/classes/LanguageKk.php
index 3d05b81..1a09818 100644 (file)
--- a/languages/classes/LanguageKk.php
+++ b/languages/classes/LanguageKk.php
@@ -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 ) {

diff --git a/languages/classes/LanguageKu.php b/languages/classes/LanguageKu.php
index f74be05..1fdebc2 100644 (file)
--- a/languages/classes/LanguageKu.php
+++ b/languages/classes/LanguageKu.php
@@ -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 ) {

diff --git a/languages/classes/LanguageShi.php b/languages/classes/LanguageShi.php
index a22730c..105a3af 100644 (file)
--- a/languages/classes/LanguageShi.php
+++ b/languages/classes/LanguageShi.php
@@ -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 ) {

diff --git a/languages/classes/LanguageSr.php b/languages/classes/LanguageSr.php
index 80099ac..bdf1ec4 100644 (file)
--- a/languages/classes/LanguageSr.php
+++ b/languages/classes/LanguageSr.php
@@ -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 ) {

diff --git a/languages/classes/LanguageZh.php b/languages/classes/LanguageZh.php
index dfdc6b1..67f8769 100644 (file)
--- a/languages/classes/LanguageZh.php
+++ b/languages/classes/LanguageZh.php
@@ -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' ) {