From c2de24efcd77e48a84d4e7f959d2efd93043cc4d Mon Sep 17 00:00:00 2001 From: umherirrender Date: Thu, 14 Aug 2014 21:34:55 +0200 Subject: [PATCH] Add missing @param to function docs Change-Id: Ib7ac94d05a04490f25dfd40b46b27973cbab582c --- includes/UserMailer.php | 2 ++ includes/media/SVG.php | 3 +++ includes/media/XCF.php | 2 ++ includes/resourceloader/ResourceLoader.php | 1 + includes/resourceloader/ResourceLoaderFileModule.php | 1 + includes/resourceloader/ResourceLoaderModule.php | 2 ++ includes/resourceloader/ResourceLoaderWikiModule.php | 1 + includes/revisiondelete/RevisionDeleteAbstracts.php | 2 ++ includes/search/SearchEngine.php | 3 +++ includes/search/SearchHighlighter.php | 1 + includes/search/SearchMssql.php | 4 ++++ includes/search/SearchMySQL.php | 4 ++++ includes/search/SearchOracle.php | 4 ++++ includes/search/SearchSqlite.php | 2 ++ includes/skins/SkinTemplate.php | 3 ++- includes/specials/SpecialChangePassword.php | 4 ++++ includes/specials/SpecialExpandTemplates.php | 1 + includes/specials/SpecialImport.php | 1 + includes/specials/SpecialListgrouprights.php | 1 + includes/specials/SpecialRedirect.php | 1 + includes/specials/SpecialResetTokens.php | 1 + includes/specials/SpecialRevisiondelete.php | 1 + includes/specials/SpecialUnwatchedpages.php | 1 + includes/specials/SpecialUserlogin.php | 4 ++++ includes/specials/SpecialVersion.php | 1 + languages/Language.php | 2 ++ languages/utils/CLDRPluralRuleConverter.php | 2 ++ 27 files changed, 54 insertions(+), 1 deletion(-) diff --git a/includes/UserMailer.php b/includes/UserMailer.php index 913b430742..0ce9b5aaa5 100644 --- a/includes/UserMailer.php +++ b/includes/UserMailer.php @@ -448,6 +448,8 @@ class UserMailer { * This method is doing Q encoding inside encoded-words as defined by RFC 2047 * This is for email headers. * The built in quoted_printable_encode() is for email bodies + * @param string $string + * @param string $charset * @return string */ public static function quotedPrintable( $string, $charset = '' ) { diff --git a/includes/media/SVG.php b/includes/media/SVG.php index a0ce8061df..74e5e048a6 100644 --- a/includes/media/SVG.php +++ b/includes/media/SVG.php @@ -107,6 +107,7 @@ class SvgHandler extends ImageHandler { /** * What language to render file in if none selected. * + * @param File $file * @return string Language code. */ public function getDefaultRenderLanguage( File $file ) { @@ -115,6 +116,8 @@ class SvgHandler extends ImageHandler { /** * We do not support making animated svg thumbnails + * @param File $file + * @return bool */ function canAnimateThumbnail( $file ) { return false; diff --git a/includes/media/XCF.php b/includes/media/XCF.php index 503336efab..aa77fa819f 100644 --- a/includes/media/XCF.php +++ b/includes/media/XCF.php @@ -218,6 +218,8 @@ class XCFHandler extends BitmapHandler { * * Image magick doesn't support indexed xcf files as of current * writing (as of 6.8.9-3) + * @param File $file + * @return bool */ public function canRender( $file ) { wfSuppressWarnings(); diff --git a/includes/resourceloader/ResourceLoader.php b/includes/resourceloader/ResourceLoader.php index e30047ab31..198420ca87 100644 --- a/includes/resourceloader/ResourceLoader.php +++ b/includes/resourceloader/ResourceLoader.php @@ -216,6 +216,7 @@ class ResourceLoader { /** * Register core modules and runs registration hooks. + * @param Config|null $config */ public function __construct( Config $config = null ) { global $IP; diff --git a/includes/resourceloader/ResourceLoaderFileModule.php b/includes/resourceloader/ResourceLoaderFileModule.php index 06f7146d78..8a223b05f5 100644 --- a/includes/resourceloader/ResourceLoaderFileModule.php +++ b/includes/resourceloader/ResourceLoaderFileModule.php @@ -569,6 +569,7 @@ class ResourceLoaderFileModule extends ResourceLoaderModule { /** * Get the definition summary for this module. * + * @param ResourceLoaderContext $context * @return array */ public function getDefinitionSummary( ResourceLoaderContext $context ) { diff --git a/includes/resourceloader/ResourceLoaderModule.php b/includes/resourceloader/ResourceLoaderModule.php index ba37f42171..45eb70f86b 100644 --- a/includes/resourceloader/ResourceLoaderModule.php +++ b/includes/resourceloader/ResourceLoaderModule.php @@ -486,6 +486,7 @@ abstract class ResourceLoaderModule { * * @since 1.23 * + * @param ResourceLoaderContext $context * @return int UNIX timestamp or 0 if no definition summary was provided * by getDefinitionSummary() */ @@ -553,6 +554,7 @@ abstract class ResourceLoaderModule { * * @since 1.23 * + * @param ResourceLoaderContext $context * @return array|null */ public function getDefinitionSummary( ResourceLoaderContext $context ) { diff --git a/includes/resourceloader/ResourceLoaderWikiModule.php b/includes/resourceloader/ResourceLoaderWikiModule.php index d9ed91df72..0472f1a798 100644 --- a/includes/resourceloader/ResourceLoaderWikiModule.php +++ b/includes/resourceloader/ResourceLoaderWikiModule.php @@ -184,6 +184,7 @@ abstract class ResourceLoaderWikiModule extends ResourceLoaderModule { /** * Get the definition summary for this module. * + * @param ResourceLoaderContext $context * @return array */ public function getDefinitionSummary( ResourceLoaderContext $context ) { diff --git a/includes/revisiondelete/RevisionDeleteAbstracts.php b/includes/revisiondelete/RevisionDeleteAbstracts.php index 086db3a721..e92a53329f 100644 --- a/includes/revisiondelete/RevisionDeleteAbstracts.php +++ b/includes/revisiondelete/RevisionDeleteAbstracts.php @@ -322,6 +322,7 @@ abstract class RevDelItem extends RevisionItemBase { * Returns true if the item is "current", and the operation to set the given * bits can't be executed for that reason * STUB + * @param int $newBits * @return bool */ public function isHideCurrentOp( $newBits ) { @@ -341,6 +342,7 @@ abstract class RevDelItem extends RevisionItemBase { * If the update fails because it did not match, the function should return * false. This prevents concurrency problems. * + * @param int $newBits * @return bool Success */ abstract public function setBits( $newBits ); diff --git a/includes/search/SearchEngine.php b/includes/search/SearchEngine.php index 56bb0ac9ae..0eb87e4a13 100644 --- a/includes/search/SearchEngine.php +++ b/includes/search/SearchEngine.php @@ -120,6 +120,8 @@ class SearchEngine { * Transform search term in cases when parts of the query came as different * GET params (when supported), e.g. for prefix queries: * search=test&prefix=Main_Page/Archive -> test prefix:Main Page/Archive + * @param string $term + * @return string */ function transformSearchTerm( $term ) { return $term; @@ -152,6 +154,7 @@ class SearchEngine { /** * Really find the title match. + * @param string $searchterm * @return null|Title */ private static function getNearMatchInternal( $searchterm ) { diff --git a/includes/search/SearchHighlighter.php b/includes/search/SearchHighlighter.php index 57cdaf4723..69534624c8 100644 --- a/includes/search/SearchHighlighter.php +++ b/includes/search/SearchHighlighter.php @@ -447,6 +447,7 @@ class SearchHighlighter { /** * Basic wikitext removal * @protected + * @param string $text * @return mixed */ function removeWiki( $text ) { diff --git a/includes/search/SearchMssql.php b/includes/search/SearchMssql.php index 0d1663f1f4..de701f7355 100644 --- a/includes/search/SearchMssql.php +++ b/includes/search/SearchMssql.php @@ -85,6 +85,8 @@ class SearchMssql extends SearchDatabase { * Does not do anything for generic search engine * subclasses may define this though * + * @param string $filteredTerm + * @param bool $fulltext * @return string */ function queryRanking( $filteredTerm, $fulltext ) { @@ -134,6 +136,8 @@ class SearchMssql extends SearchDatabase { } /** @todo document + * @param string $filteredText + * @param bool $fulltext * @return string */ function parseQuery( $filteredText, $fulltext ) { diff --git a/includes/search/SearchMySQL.php b/includes/search/SearchMySQL.php index 581d8bcaa4..78eba2d0cf 100644 --- a/includes/search/SearchMySQL.php +++ b/includes/search/SearchMySQL.php @@ -303,6 +303,8 @@ class SearchMySQL extends SearchDatabase { /** * @since 1.18 (changed) + * @param string $filteredTerm + * @param bool $fulltext * @return array */ function getCountQuery( $filteredTerm, $fulltext ) { @@ -374,6 +376,7 @@ class SearchMySQL extends SearchDatabase { /** * Converts some characters for MySQL's indexing to grok it correctly, * and pads short words to overcome limitations. + * @param string $string * @return mixed|string */ function normalizeText( $string ) { @@ -422,6 +425,7 @@ class SearchMySQL extends SearchDatabase { * Armor a case-folded UTF-8 string to get through MySQL's * fulltext search without being mucked up by funny charset * settings or anything else of the sort. + * @param array $matches * @return string */ protected function stripForSearchCallback( $matches ) { diff --git a/includes/search/SearchOracle.php b/includes/search/SearchOracle.php index 4cfcec3988..348da79a9f 100644 --- a/includes/search/SearchOracle.php +++ b/includes/search/SearchOracle.php @@ -125,6 +125,8 @@ class SearchOracle extends SearchDatabase { * Does not do anything for generic search engine * subclasses may define this though * + * @param string $filteredTerm + * @param bool $fulltext * @return string */ function queryRanking( $filteredTerm, $fulltext ) { @@ -172,6 +174,8 @@ class SearchOracle extends SearchDatabase { /** * Parse a user input search string, and return an SQL fragment to be used * as part of a WHERE clause + * @param string $filteredText + * @param bool $fulltext * @return string */ function parseQuery( $filteredText, $fulltext ) { diff --git a/includes/search/SearchSqlite.php b/includes/search/SearchSqlite.php index 05d5ca0f0d..eee69307fc 100644 --- a/includes/search/SearchSqlite.php +++ b/includes/search/SearchSqlite.php @@ -38,6 +38,8 @@ class SearchSqlite extends SearchDatabase { * Parse the user's query and transform it into an SQL fragment which will * become part of a WHERE clause * + * @param string $filteredText + * @param bool $fulltext * @return string */ function parseQuery( $filteredText, $fulltext ) { diff --git a/includes/skins/SkinTemplate.php b/includes/skins/SkinTemplate.php index d08da1b9f6..b6077b3395 100644 --- a/includes/skins/SkinTemplate.php +++ b/includes/skins/SkinTemplate.php @@ -1375,8 +1375,9 @@ abstract class QuickTemplate { /** @var Config $config */ protected $config; + /** - * @var Config $config + * @param Config $config */ function __construct( Config $config = null ) { $this->data = array(); diff --git a/includes/specials/SpecialChangePassword.php b/includes/specials/SpecialChangePassword.php index 867fd1bcf5..24664edb7c 100644 --- a/includes/specials/SpecialChangePassword.php +++ b/includes/specials/SpecialChangePassword.php @@ -43,6 +43,7 @@ class SpecialChangePassword extends FormSpecialPage { /** * Main execution point + * @param string|null $par */ function execute( $par ) { $this->getOutput()->disallowUserJs(); @@ -229,6 +230,9 @@ class SpecialChangePassword extends FormSpecialPage { } /** + * @param string $oldpass + * @param string $newpass + * @param string $retype * @throws PasswordError When cannot set the new password because requirements not met. */ protected function attemptReset( $oldpass, $newpass, $retype ) { diff --git a/includes/specials/SpecialExpandTemplates.php b/includes/specials/SpecialExpandTemplates.php index 60eec39214..269dff6891 100644 --- a/includes/specials/SpecialExpandTemplates.php +++ b/includes/specials/SpecialExpandTemplates.php @@ -50,6 +50,7 @@ class SpecialExpandTemplates extends SpecialPage { /** * Show the special page + * @param string|null $subpage */ function execute( $subpage ) { global $wgParser; diff --git a/includes/specials/SpecialImport.php b/includes/specials/SpecialImport.php index 2d72d6241d..2a3ab6450f 100644 --- a/includes/specials/SpecialImport.php +++ b/includes/specials/SpecialImport.php @@ -49,6 +49,7 @@ class SpecialImport extends SpecialPage { /** * Execute + * @param string|null $par */ function execute( $par ) { $this->setHeaders(); diff --git a/includes/specials/SpecialListgrouprights.php b/includes/specials/SpecialListgrouprights.php index 582f743841..b5818eab45 100644 --- a/includes/specials/SpecialListgrouprights.php +++ b/includes/specials/SpecialListgrouprights.php @@ -35,6 +35,7 @@ class SpecialListGroupRights extends SpecialPage { /** * Show the special page + * @param string|null $par */ public function execute( $par ) { global $wgImplicitGroups; diff --git a/includes/specials/SpecialRedirect.php b/includes/specials/SpecialRedirect.php index 774fd80ca2..2022d748a2 100644 --- a/includes/specials/SpecialRedirect.php +++ b/includes/specials/SpecialRedirect.php @@ -55,6 +55,7 @@ class SpecialRedirect extends FormSpecialPage { /** * Set $mType and $mValue based on parsed value of $subpage. + * @param string $subpage */ function setParameter( $subpage ) { // parse $subpage to pull out the parts diff --git a/includes/specials/SpecialResetTokens.php b/includes/specials/SpecialResetTokens.php index bc1326bd5b..6c5401ac23 100644 --- a/includes/specials/SpecialResetTokens.php +++ b/includes/specials/SpecialResetTokens.php @@ -112,6 +112,7 @@ class SpecialResetTokens extends FormSpecialPage { /** * Suppress the submit button if there's nothing to do; * provide additional message on it otherwise. + * @param HTMLForm $form */ protected function alterForm( HTMLForm $form ) { if ( $this->getTokensList() ) { diff --git a/includes/specials/SpecialRevisiondelete.php b/includes/specials/SpecialRevisiondelete.php index 93df28905b..7eea71da51 100644 --- a/includes/specials/SpecialRevisiondelete.php +++ b/includes/specials/SpecialRevisiondelete.php @@ -622,6 +622,7 @@ class SpecialRevisionDelete extends UnlistedSpecialPage { /** * Report that the submit operation failed + * @param Status $status */ protected function failure( $status ) { // Messages: revdelete-failure, logdelete-failure diff --git a/includes/specials/SpecialUnwatchedpages.php b/includes/specials/SpecialUnwatchedpages.php index fe0638e15d..bb07c19759 100644 --- a/includes/specials/SpecialUnwatchedpages.php +++ b/includes/specials/SpecialUnwatchedpages.php @@ -72,6 +72,7 @@ class UnwatchedpagesPage extends QueryPage { /** * Add the JS + * @param string|null $par */ public function execute( $par ) { parent::execute( $par ); diff --git a/includes/specials/SpecialUserlogin.php b/includes/specials/SpecialUserlogin.php index f4c158982e..afa12a018e 100644 --- a/includes/specials/SpecialUserlogin.php +++ b/includes/specials/SpecialUserlogin.php @@ -1237,6 +1237,8 @@ class LoginForm extends SpecialPage { } /** + * @param string $msg + * @param string $msgtype * @private */ function mainLoginForm( $msg, $msgtype = 'error' ) { @@ -1523,6 +1525,7 @@ class LoginForm extends SpecialPage { } /** + * @param string $type * @private */ function cookieRedirectCheck( $type ) { @@ -1538,6 +1541,7 @@ class LoginForm extends SpecialPage { } /** + * @param string $type * @private */ function onCookieRedirectCheck( $type ) { diff --git a/includes/specials/SpecialVersion.php b/includes/specials/SpecialVersion.php index 318ceb148e..87ab41cca7 100644 --- a/includes/specials/SpecialVersion.php +++ b/includes/specials/SpecialVersion.php @@ -50,6 +50,7 @@ class SpecialVersion extends SpecialPage { /** * main() + * @param string|null $par */ public function execute( $par ) { global $IP, $wgExtensionCredits; diff --git a/languages/Language.php b/languages/Language.php index 5b10f0f047..cd8df5d480 100644 --- a/languages/Language.php +++ b/languages/Language.php @@ -4740,6 +4740,7 @@ class Language { /** * Find the index number of the plural rule appropriate for the given number + * @param int $number * @return int The index number of the plural rule */ public function getPluralRuleIndexNumber( $number ) { @@ -4753,6 +4754,7 @@ class Language { * For example, if the language is set to Arabic, getPluralType(5) should * return 'few'. * @since 1.22 + * @param int $number * @return string The name of the plural rule type, e.g. one, two, few, many */ public function getPluralRuleType( $number ) { diff --git a/languages/utils/CLDRPluralRuleConverter.php b/languages/utils/CLDRPluralRuleConverter.php index c9ea0f96eb..2eabcab14b 100644 --- a/languages/utils/CLDRPluralRuleConverter.php +++ b/languages/utils/CLDRPluralRuleConverter.php @@ -102,6 +102,7 @@ class CLDRPluralRuleConverter { /** * Private constructor. + * @param string $rule */ protected function __construct( $rule ) { $this->rule = $rule; @@ -313,6 +314,7 @@ class CLDRPluralRuleConverter { /** * Throw an error + * @param string $message */ protected function error( $message ) { throw new CLDRPluralRuleError( $message ); -- 2.20.1