From 23fab68274456f796563a5eac2ab70cb307afe1a Mon Sep 17 00:00:00 2001 From: umherirrender Date: Sat, 5 Apr 2014 21:54:24 +0200 Subject: [PATCH] Fix spacing after @param and friends in comments Searched for: \@(param|return|throws|since|deprecated|access|todo|var)[ \t]{2,} Change-Id: Icce22ba9fe0635455691ca58d9872d618151f346 --- includes/Block.php | 6 +- includes/HttpFunctions.php | 2 +- includes/Linker.php | 6 +- includes/MagicWord.php | 2 +- includes/OutputPage.php | 8 +-- includes/Skin.php | 6 +- includes/UserArrayFromResult.php | 2 +- includes/Xml.php | 4 +- includes/actions/FormAction.php | 2 +- includes/api/ApiBase.php | 6 +- includes/api/ApiHelp.php | 4 +- includes/api/ApiMove.php | 4 +- includes/api/ApiQueryRandom.php | 8 +-- includes/api/ApiQueryRecentChanges.php | 4 +- includes/db/DatabaseOracle.php | 4 +- includes/deferred/SqlDataUpdate.php | 2 +- includes/diff/DifferenceEngine.php | 6 +- .../filebackend/filejournal/FileJournal.php | 2 +- includes/htmlform/HTMLCheckField.php | 2 +- includes/htmlform/HTMLMultiSelectField.php | 2 +- includes/htmlform/HTMLSelectAndOtherField.php | 2 +- includes/htmlform/HTMLSelectOrOtherField.php | 2 +- includes/logging/LogPage.php | 8 +-- includes/media/Bitmap_ClientOnly.php | 2 +- includes/objectcache/MemcachedClient.php | 70 +++++++++---------- includes/parser/CacheTime.php | 2 +- includes/parser/CoreParserFunctions.php | 4 +- includes/parser/Parser.php | 8 +-- includes/parser/Preprocessor_Hash.php | 2 +- includes/parser/StripState.php | 2 +- .../revisiondelete/RevisionDeleteUser.php | 8 +-- includes/revisiondelete/RevisionDeleter.php | 2 +- includes/specialpage/FormSpecialPage.php | 2 +- includes/specials/SpecialBlock.php | 8 +-- includes/specials/SpecialImport.php | 4 +- includes/specials/SpecialUserrights.php | 2 +- languages/Language.php | 4 +- .../benchmarks/bench_delete_truncate.php | 6 +- .../phpunit/MediaWikiPHPUnitTestListener.php | 40 +++++------ 39 files changed, 130 insertions(+), 130 deletions(-) diff --git a/includes/Block.php b/includes/Block.php index 95a8386937..74ece4c13d 100644 --- a/includes/Block.php +++ b/includes/Block.php @@ -312,7 +312,7 @@ class Block { /** * Get the component of an IP address which is certain to be the same between an IP * address and a rangeblock containing that IP address. - * @param $hex String Hexadecimal IP representation + * @param $hex String Hexadecimal IP representation * @return String */ protected static function getIpFragment( $hex ) { @@ -362,7 +362,7 @@ class Block { /** * Create a new Block object from a database row - * @param $row ResultWrapper row from the ipblocks table + * @param $row ResultWrapper row from the ipblocks table * @return Block */ public static function newFromRow( $row ) { @@ -862,7 +862,7 @@ class Block { /** * Get/set whether the Block is a hardblock (affects logged-in users on a given IP/range * @param $x Bool - * @return Bool + * @return Bool */ public function isHardblock( $x = null ) { wfSetVar( $this->isHardblock, $x ); diff --git a/includes/HttpFunctions.php b/includes/HttpFunctions.php index 274d4a75f3..1fd437ed1d 100644 --- a/includes/HttpFunctions.php +++ b/includes/HttpFunctions.php @@ -205,7 +205,7 @@ class MWHttpRequest { protected $followRedirects = false; /** - * @var CookieJar + * @var CookieJar */ protected $cookieJar; diff --git a/includes/Linker.php b/includes/Linker.php index 033926ac2e..094a304b23 100644 --- a/includes/Linker.php +++ b/includes/Linker.php @@ -742,7 +742,7 @@ class Linker { /** * @param $title Title - * @param $file File + * @param $file File * @param array $frameParams * @param array $handlerParams * @param bool $time @@ -1467,8 +1467,8 @@ class Linker { /** * @param $contextTitle Title - * @param $target - * @param $text + * @param $target + * @param $text * @return string */ public static function normalizeSubpageLink( $contextTitle, $target, &$text ) { diff --git a/includes/MagicWord.php b/includes/MagicWord.php index 377d406494..e301ceadc9 100644 --- a/includes/MagicWord.php +++ b/includes/MagicWord.php @@ -512,7 +512,7 @@ class MagicWord { } /** - * @param $text + * @param $text * @return bool */ function matchStartAndRemove( &$text ) { diff --git a/includes/OutputPage.php b/includes/OutputPage.php index 3a6787f726..f469732de8 100644 --- a/includes/OutputPage.php +++ b/includes/OutputPage.php @@ -1315,8 +1315,8 @@ class OutputPage extends ContextSource { /** * Set the highest level of CSS/JS untrustworthiness allowed - * @param $type String ResourceLoaderModule TYPE_ constant - * @param $level Int ResourceLoaderModule class constant + * @param $type String ResourceLoaderModule TYPE_ constant + * @param $level Int ResourceLoaderModule class constant */ public function setAllowedModules( $type, $level ) { $this->mAllowedModules[$type] = $level; @@ -1324,8 +1324,8 @@ class OutputPage extends ContextSource { /** * As for setAllowedModules(), but don't inadvertently make the page more accessible - * @param $type String - * @param $level Int ResourceLoaderModule class constant + * @param $type String + * @param $level Int ResourceLoaderModule class constant */ public function reduceAllowedModules( $type, $level ) { $this->mAllowedModules[$type] = min( $this->getAllowedModules( $type ), $level ); diff --git a/includes/Skin.php b/includes/Skin.php index 38c3623ad9..9ec7c31022 100644 --- a/includes/Skin.php +++ b/includes/Skin.php @@ -1573,14 +1573,14 @@ abstract class Skin extends ContextSource { * Create a section edit link. This supersedes editSectionLink() and * editSectionLinkForOther(). * - * @param $nt Title The title being linked to (may not be the same as + * @param $nt Title The title being linked to (may not be the same as * the current page, if the section is included from a template) * @param string $section The designation of the section being pointed to, * to be included in the link, like "§ion=$section" * @param string $tooltip The tooltip to use for the link: will be escaped * and wrapped in the 'editsectionhint' message - * @param $lang string Language code - * @return string HTML to use for edit link + * @param $lang string Language code + * @return string HTML to use for edit link */ public function doEditSectionLink( Title $nt, $section, $tooltip = null, $lang = false ) { // HTML generated here should probably have userlangattributes diff --git a/includes/UserArrayFromResult.php b/includes/UserArrayFromResult.php index 5d5859d674..00366e450e 100644 --- a/includes/UserArrayFromResult.php +++ b/includes/UserArrayFromResult.php @@ -38,7 +38,7 @@ class UserArrayFromResult extends UserArray implements Countable { } /** - * @param $row + * @param $row * @return void */ protected function setCurrent( $row ) { diff --git a/includes/Xml.php b/includes/Xml.php index 45441fd623..3b82c64551 100644 --- a/includes/Xml.php +++ b/includes/Xml.php @@ -901,7 +901,7 @@ class XmlSelect { * label => value * label => ( label => value, label => value ) * - * @param $options + * @param $options */ public function addOptions( $options ) { $this->options[] = $options; @@ -912,7 +912,7 @@ class XmlSelect { * label => value * label => ( label => value, label => value ) * - * @param $options + * @param $options * @param bool $default * @return string */ diff --git a/includes/actions/FormAction.php b/includes/actions/FormAction.php index 974ee94f52..73bf187c4d 100644 --- a/includes/actions/FormAction.php +++ b/includes/actions/FormAction.php @@ -91,7 +91,7 @@ abstract class FormAction extends Action { * Process the form on POST submission. If you return false from getFormFields(), * this will obviously never be reached. If you don't want to do anything with the * form, just return false here - * @param $data Array + * @param $data Array * @return Bool|Array true for success, false for didn't-try, array of errors on failure */ abstract public function onSubmit( $data ); diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php index 72b1f888bf..fc1bfd1177 100644 --- a/includes/api/ApiBase.php +++ b/includes/api/ApiBase.php @@ -896,7 +896,7 @@ abstract class ApiBase extends ContextSource { /** * Callback function used in requireOnlyOneParameter to check whether required parameters are set * - * @param $x object Parameter to check is not null/false + * @param $x object Parameter to check is not null/false * @return bool */ private function parameterNotEmpty( $x ) { @@ -1322,8 +1322,8 @@ abstract class ApiBase extends ContextSource { /** * Adds a warning to the output, else dies * - * @param $msg String Message to show as a warning, or error message if dying - * @param $enforceLimits Boolean Whether this is an enforce (die) + * @param $msg String Message to show as a warning, or error message if dying + * @param $enforceLimits Boolean Whether this is an enforce (die) */ private function warnOrDie( $msg, $enforceLimits = false ) { if ( $enforceLimits ) { diff --git a/includes/api/ApiHelp.php b/includes/api/ApiHelp.php index e584d0dff4..ed64cd5ba0 100644 --- a/includes/api/ApiHelp.php +++ b/includes/api/ApiHelp.php @@ -107,8 +107,8 @@ class ApiHelp extends ApiBase { } /** - * @param $module ApiBase - * @param $type String What type of request is this? e.g. action, query, list, prop, meta, format + * @param $module ApiBase + * @param $type String What type of request is this? e.g. action, query, list, prop, meta, format * @return string */ private function buildModuleHelp( $module, $type ) { diff --git a/includes/api/ApiMove.php b/includes/api/ApiMove.php index 10b655fb45..11907818c1 100644 --- a/includes/api/ApiMove.php +++ b/includes/api/ApiMove.php @@ -148,8 +148,8 @@ class ApiMove extends ApiBase { /** * @param Title $fromTitle * @param Title $toTitle - * @param $reason - * @param $noredirect + * @param $reason + * @param $noredirect * @return array */ public function moveSubpages( $fromTitle, $toTitle, $reason, $noredirect ) { diff --git a/includes/api/ApiQueryRandom.php b/includes/api/ApiQueryRandom.php index 5f85e0e9f2..ad26ccef0e 100644 --- a/includes/api/ApiQueryRandom.php +++ b/includes/api/ApiQueryRandom.php @@ -46,11 +46,11 @@ class ApiQueryRandom extends ApiQueryGeneratorBase { } /** - * @param $randstr - * @param $limit - * @param $namespace + * @param $randstr + * @param $limit + * @param $namespace * @param $resultPageSet ApiPageSet - * @param $redirect + * @param $redirect * @return void */ protected function prepareQuery( $randstr, $limit, $namespace, &$resultPageSet, $redirect ) { diff --git a/includes/api/ApiQueryRecentChanges.php b/includes/api/ApiQueryRecentChanges.php index 0284916ead..79a8dc96f9 100644 --- a/includes/api/ApiQueryRecentChanges.php +++ b/includes/api/ApiQueryRecentChanges.php @@ -69,8 +69,8 @@ class ApiQueryRecentChanges extends ApiQueryGeneratorBase { } /** - * @param $pageid - * @param $title + * @param $pageid + * @param $title * @param $rc RecentChange (optional) * @return bool|string */ diff --git a/includes/db/DatabaseOracle.php b/includes/db/DatabaseOracle.php index 6e0490d110..0d13433f99 100644 --- a/includes/db/DatabaseOracle.php +++ b/includes/db/DatabaseOracle.php @@ -1133,8 +1133,8 @@ class DatabaseOracle extends DatabaseBase { /** * @throws DBUnexpectedError - * @param string $table - * @param string $field + * @param string $table + * @param string $field * @return ORAField */ function fieldInfo( $table, $field ) { diff --git a/includes/deferred/SqlDataUpdate.php b/includes/deferred/SqlDataUpdate.php index 09d18c49a2..121af0418c 100644 --- a/includes/deferred/SqlDataUpdate.php +++ b/includes/deferred/SqlDataUpdate.php @@ -40,7 +40,7 @@ abstract class SqlDataUpdate extends DataUpdate { /** @var bool Whether a transaction is open on this object (internal use only!) */ private $mHasTransaction; - /** @var bool Whether this update should be wrapped in a transaction */ + /** @var bool Whether this update should be wrapped in a transaction */ protected $mUseTransaction; /** diff --git a/includes/diff/DifferenceEngine.php b/includes/diff/DifferenceEngine.php index 414b9f80e3..f77a4ebf75 100644 --- a/includes/diff/DifferenceEngine.php +++ b/includes/diff/DifferenceEngine.php @@ -53,16 +53,16 @@ class DifferenceEngine extends ContextSource { /** @var Language */ protected $mDiffLang; - /** @var Title */ + /** @var Title */ public $mOldPage; - /** @var Title */ + /** @var Title */ public $mNewPage; /** @var Revision */ public $mOldRev; - /** @var Revision */ + /** @var Revision */ public $mNewRev; /** @var bool Have the revisions IDs been loaded */ diff --git a/includes/filebackend/filejournal/FileJournal.php b/includes/filebackend/filejournal/FileJournal.php index 3ab9f5d172..0464e03804 100644 --- a/includes/filebackend/filejournal/FileJournal.php +++ b/includes/filebackend/filejournal/FileJournal.php @@ -36,7 +36,7 @@ * @since 1.20 */ abstract class FileJournal { - /** @var string */ + /** @var string */ protected $backend; /** @var int */ diff --git a/includes/htmlform/HTMLCheckField.php b/includes/htmlform/HTMLCheckField.php index 237fa320de..7baab66f07 100644 --- a/includes/htmlform/HTMLCheckField.php +++ b/includes/htmlform/HTMLCheckField.php @@ -50,7 +50,7 @@ class HTMLCheckField extends HTMLFormField { } /** - * @param $request WebRequest + * @param $request WebRequest * * @return String */ diff --git a/includes/htmlform/HTMLMultiSelectField.php b/includes/htmlform/HTMLMultiSelectField.php index 3cf31885f3..f80277107e 100644 --- a/includes/htmlform/HTMLMultiSelectField.php +++ b/includes/htmlform/HTMLMultiSelectField.php @@ -70,7 +70,7 @@ class HTMLMultiSelectField extends HTMLFormField implements HTMLNestedFilterable } /** - * @param $request WebRequest + * @param $request WebRequest * * @return String */ diff --git a/includes/htmlform/HTMLSelectAndOtherField.php b/includes/htmlform/HTMLSelectAndOtherField.php index 564927f7dd..4f501f7f97 100644 --- a/includes/htmlform/HTMLSelectAndOtherField.php +++ b/includes/htmlform/HTMLSelectAndOtherField.php @@ -60,7 +60,7 @@ class HTMLSelectAndOtherField extends HTMLSelectField { } /** - * @param $request WebRequest + * @param $request WebRequest * * @return Array("","