Add missing @param to function docs
authorumherirrender <umherirrender_de.wp@web.de>
Thu, 14 Aug 2014 19:34:55 +0000 (21:34 +0200)
committerUmherirrender <umherirrender_de.wp@web.de>
Thu, 14 Aug 2014 19:38:57 +0000 (19:38 +0000)
Change-Id: Ib7ac94d05a04490f25dfd40b46b27973cbab582c

27 files changed:
includes/UserMailer.php
includes/media/SVG.php
includes/media/XCF.php
includes/resourceloader/ResourceLoader.php
includes/resourceloader/ResourceLoaderFileModule.php
includes/resourceloader/ResourceLoaderModule.php
includes/resourceloader/ResourceLoaderWikiModule.php
includes/revisiondelete/RevisionDeleteAbstracts.php
includes/search/SearchEngine.php
includes/search/SearchHighlighter.php
includes/search/SearchMssql.php
includes/search/SearchMySQL.php
includes/search/SearchOracle.php
includes/search/SearchSqlite.php
includes/skins/SkinTemplate.php
includes/specials/SpecialChangePassword.php
includes/specials/SpecialExpandTemplates.php
includes/specials/SpecialImport.php
includes/specials/SpecialListgrouprights.php
includes/specials/SpecialRedirect.php
includes/specials/SpecialResetTokens.php
includes/specials/SpecialRevisiondelete.php
includes/specials/SpecialUnwatchedpages.php
includes/specials/SpecialUserlogin.php
includes/specials/SpecialVersion.php
languages/Language.php
languages/utils/CLDRPluralRuleConverter.php

index 913b430..0ce9b5a 100644 (file)
@@ -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 = '' ) {
index a0ce806..74e5e04 100644 (file)
@@ -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;
index 503336e..aa77fa8 100644 (file)
@@ -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();
index e30047a..198420c 100644 (file)
@@ -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;
index 06f7146..8a223b0 100644 (file)
@@ -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 ) {
index ba37f42..45eb70f 100644 (file)
@@ -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 ) {
index d9ed91d..0472f1a 100644 (file)
@@ -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 ) {
index 086db3a..e92a533 100644 (file)
@@ -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 );
index 56bb0ac..0eb87e4 100644 (file)
@@ -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 ) {
index 57cdaf4..6953462 100644 (file)
@@ -447,6 +447,7 @@ class SearchHighlighter {
        /**
         * Basic wikitext removal
         * @protected
+        * @param string $text
         * @return mixed
         */
        function removeWiki( $text ) {
index 0d1663f..de701f7 100644 (file)
@@ -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 ) {
index 581d8bc..78eba2d 100644 (file)
@@ -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 ) {
index 4cfcec3..348da79 100644 (file)
@@ -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 ) {
index 05d5ca0..eee6930 100644 (file)
@@ -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 ) {
index d08da1b..b6077b3 100644 (file)
@@ -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();
index 867fd1b..24664ed 100644 (file)
@@ -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 ) {
index 60eec39..269dff6 100644 (file)
@@ -50,6 +50,7 @@ class SpecialExpandTemplates extends SpecialPage {
 
        /**
         * Show the special page
+        * @param string|null $subpage
         */
        function execute( $subpage ) {
                global $wgParser;
index 2d72d62..2a3ab64 100644 (file)
@@ -49,6 +49,7 @@ class SpecialImport extends SpecialPage {
 
        /**
         * Execute
+        * @param string|null $par
         */
        function execute( $par ) {
                $this->setHeaders();
index 582f743..b5818ea 100644 (file)
@@ -35,6 +35,7 @@ class SpecialListGroupRights extends SpecialPage {
 
        /**
         * Show the special page
+        * @param string|null $par
         */
        public function execute( $par ) {
                global $wgImplicitGroups;
index 774fd80..2022d74 100644 (file)
@@ -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
index bc1326b..6c5401a 100644 (file)
@@ -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() ) {
index 93df289..7eea71d 100644 (file)
@@ -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
index fe0638e..bb07c19 100644 (file)
@@ -72,6 +72,7 @@ class UnwatchedpagesPage extends QueryPage {
 
        /**
         * Add the JS
+        * @param string|null $par
         */
        public function execute( $par ) {
                parent::execute( $par );
index f4c1589..afa12a0 100644 (file)
@@ -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 ) {
index 318ceb1..87ab41c 100644 (file)
@@ -50,6 +50,7 @@ class SpecialVersion extends SpecialPage {
 
        /**
         * main()
+        * @param string|null $par
         */
        public function execute( $par ) {
                global $IP, $wgExtensionCredits;
index 5b10f0f..cd8df5d 100644 (file)
@@ -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 ) {
index c9ea0f9..2eabcab 100644 (file)
@@ -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 );