From 2664eeb6325b7c662faa813c99487b1a479299e5 Mon Sep 17 00:00:00 2001 From: Umherirrender Date: Mon, 5 Aug 2019 19:00:00 +0200 Subject: [PATCH] Clean up spacing of doc comments Align the doc stars and normalize start and end tokens Change-Id: Ib0d92e128e7b882bb5b838bd00c74fc16ef14303 --- includes/CategoryFinder.php | 2 +- includes/DefaultSettings.php | 10 +-- includes/Defines.php | 78 +++++++++---------- includes/FormOptions.php | 6 +- includes/MagicWord.php | 4 +- includes/MagicWordFactory.php | 4 +- includes/OutputPage.php | 3 +- includes/Revision/RevisionRecord.php | 2 +- .../Revision/RevisionStoreCacheRecord.php | 2 +- includes/Title.php | 3 +- includes/api/ApiBase.php | 14 ++-- includes/api/ApiQueryBase.php | 8 +- includes/api/ApiQueryRevisionsBase.php | 2 +- includes/api/ApiResult.php | 6 +- includes/auth/AuthManager.php | 21 ++--- includes/auth/AuthenticationRequest.php | 9 ++- includes/block/BlockManager.php | 2 +- includes/changes/ChangesList.php | 3 +- includes/changes/FeedItem.php | 2 +- includes/deferred/SearchUpdate.php | 2 +- includes/diff/DifferenceEngine.php | 2 +- includes/filerepo/FileRepo.php | 6 +- includes/libs/CSSMin.php | 2 +- includes/libs/MWMessagePack.php | 2 +- .../libs/ParamValidator/ParamValidator.php | 2 +- .../libs/filebackend/fileop/DeleteFileOp.php | 40 +++++----- includes/libs/mime/defines.php | 4 +- includes/libs/rdbms/defines.php | 8 +- includes/logging/LogPage.php | 3 +- includes/media/Exif.php | 8 +- includes/page/Article.php | 2 +- includes/page/WikiPage.php | 2 +- .../resourceloader/ResourceLoaderFilePath.php | 3 +- includes/session/Session.php | 2 +- includes/session/SessionManager.php | 2 +- includes/session/Token.php | 3 +- .../specialpage/AuthManagerSpecialPage.php | 3 +- .../specialpage/LoginSignupSpecialPage.php | 3 +- includes/specialpage/SpecialPageFactory.php | 2 +- includes/specials/SpecialBlock.php | 3 +- includes/specials/SpecialUpload.php | 16 ++-- includes/specials/formfields/Licenses.php | 4 +- languages/messages/MessagesInh.php | 14 ++-- .../includes/api/query/ApiQueryBasicTest.php | 2 +- .../api/query/ApiQueryContinue2Test.php | 2 +- .../api/query/ApiQueryContinueTest.php | 2 +- tests/phpunit/includes/libs/CSSMinTest.php | 2 +- tests/phpunit/includes/libs/XhprofTest.php | 2 +- .../languages/classes/LanguageSrTest.php | 4 +- .../languages/classes/LanguageUzTest.php | 2 +- .../maintenance/categoryChangesAsRdfTest.php | 2 +- 51 files changed, 178 insertions(+), 159 deletions(-) diff --git a/includes/CategoryFinder.php b/includes/CategoryFinder.php index 720abc3b46..01427a24ea 100644 --- a/includes/CategoryFinder.php +++ b/includes/CategoryFinder.php @@ -58,7 +58,7 @@ class CategoryFinder { /** @var array Array of article/category IDs */ protected $next = []; - /** @var int Max layer depth **/ + /** @var int Max layer depth */ protected $maxdepth = -1; /** @var array Array of DBKEY category names */ diff --git a/includes/DefaultSettings.php b/includes/DefaultSettings.php index a3772b9040..7d3802cc60 100644 --- a/includes/DefaultSettings.php +++ b/includes/DefaultSettings.php @@ -158,7 +158,7 @@ $wgUsePathInfo = ( strpos( PHP_SAPI, 'cgi' ) === false ) && ( strpos( PHP_SAPI, 'apache2filter' ) === false ) && ( strpos( PHP_SAPI, 'isapi' ) === false ); -/**@}*/ +/** @} */ /************************************************************************//** * @name URLs and file paths @@ -377,7 +377,7 @@ $wgUploadStashScalerBaseUrl = false; */ $wgActionPaths = []; -/**@}*/ +/** @} */ /************************************************************************//** * @name Files and file uploads @@ -1563,7 +1563,7 @@ $wgUseTinyRGBForJPGThumbnails = false; * - captionLength: Length to truncate filename to in caption when using "showfilename". * A value of 'true' will truncate the filename to one line using CSS * and will be the behaviour after deprecation. - * @deprecated since 1.28 + * @deprecated since 1.28 * - showBytes: Show the filesize in bytes in categories * - showDimensions: Show the dimensions (width x height) in categories * - mode: Gallery mode @@ -2169,7 +2169,7 @@ $wgSlaveLagCritical = 30; */ $wgDBWindowsAuthentication = false; -/**@}*/ # End of DB settings } +/** @} */ # End of DB settings } /************************************************************************//** * @name Text storage @@ -8941,7 +8941,7 @@ $wgExperiencedUserMemberSince = 30; # days * @code * $wgInterwikiPrefixDisplayTypes = [ * 'iwprefix' => 'definition' - *]; + * ]; * @endcode */ $wgInterwikiPrefixDisplayTypes = []; diff --git a/includes/Defines.php b/includes/Defines.php index d818226974..0269ab6029 100644 --- a/includes/Defines.php +++ b/includes/Defines.php @@ -31,7 +31,7 @@ use Wikimedia\Rdbms\IDatabase; # Obsolete aliases -/**@{ +/** @{ * Obsolete IDatabase::makeList() constants * These are also available as Database class constants */ @@ -40,16 +40,16 @@ define( 'LIST_AND', IDatabase::LIST_AND ); define( 'LIST_SET', IDatabase::LIST_SET ); define( 'LIST_NAMES', IDatabase::LIST_NAMES ); define( 'LIST_OR', IDatabase::LIST_OR ); -/**@}*/ +/** @} */ -/**@{ +/** @{ * Virtual namespaces; don't appear in the page database */ define( 'NS_MEDIA', -2 ); define( 'NS_SPECIAL', -1 ); -/**@}*/ +/** @} */ -/**@{ +/** @{ * Real namespaces * * Number 100 and beyond are reserved for custom namespaces; @@ -73,9 +73,9 @@ define( 'NS_HELP', 12 ); define( 'NS_HELP_TALK', 13 ); define( 'NS_CATEGORY', 14 ); define( 'NS_CATEGORY_TALK', 15 ); -/**@}*/ +/** @} */ -/**@{ +/** @{ * Cache type */ define( 'CACHE_ANYTHING', -1 ); // Use anything, as long as it works @@ -83,18 +83,18 @@ define( 'CACHE_NONE', 0 ); // Do not cache define( 'CACHE_DB', 1 ); // Store cache objects in the DB define( 'CACHE_MEMCACHED', 2 ); // MemCached, must specify servers in $wgMemCacheServers define( 'CACHE_ACCEL', 3 ); // APC or WinCache -/**@}*/ +/** @} */ -/**@{ +/** @{ * Antivirus result codes, for use in $wgAntivirusSetup. */ define( 'AV_NO_VIRUS', 0 ); # scan ok, no virus found define( 'AV_VIRUS_FOUND', 1 ); # virus found! define( 'AV_SCAN_ABORTED', -1 ); # scan aborted, the file is probably immune define( 'AV_SCAN_FAILED', false ); # scan failed (scanner not found or error in scanner) -/**@}*/ +/** @} */ -/**@{ +/** @{ * Anti-lock flags * Was used by $wgAntiLockFlags, which was removed with 1.25 * Constants kept to not have warnings when used in LocalSettings @@ -103,9 +103,9 @@ define( 'ALF_PRELOAD_LINKS', 1 ); // unused define( 'ALF_PRELOAD_EXISTENCE', 2 ); // unused define( 'ALF_NO_LINK_LOCK', 4 ); // unused define( 'ALF_NO_BLOCK_LOCK', 8 ); // unused -/**@}*/ +/** @} */ -/**@{ +/** @{ * Date format selectors; used in user preference storage and by * Language::date() and co. */ @@ -114,9 +114,9 @@ define( 'MW_DATE_MDY', 'mdy' ); define( 'MW_DATE_DMY', 'dmy' ); define( 'MW_DATE_YMD', 'ymd' ); define( 'MW_DATE_ISO', 'ISO 8601' ); -/**@}*/ +/** @} */ -/**@{ +/** @{ * RecentChange type identifiers */ define( 'RC_EDIT', 0 ); @@ -124,9 +124,9 @@ define( 'RC_NEW', 1 ); define( 'RC_LOG', 3 ); define( 'RC_EXTERNAL', 5 ); define( 'RC_CATEGORIZE', 6 ); -/**@}*/ +/** @} */ -/**@{ +/** @{ * Article edit flags */ define( 'EDIT_NEW', 1 ); @@ -137,21 +137,21 @@ define( 'EDIT_FORCE_BOT', 16 ); define( 'EDIT_DEFER_UPDATES', 32 ); // Unused since 1.27 define( 'EDIT_AUTOSUMMARY', 64 ); define( 'EDIT_INTERNAL', 128 ); -/**@}*/ +/** @} */ -/**@{ +/** @{ * Hook support constants */ define( 'MW_SUPPORTS_PARSERFIRSTCALLINIT', 1 ); define( 'MW_SUPPORTS_LOCALISATIONCACHE', 1 ); define( 'MW_SUPPORTS_CONTENTHANDLER', 1 ); define( 'MW_EDITFILTERMERGED_SUPPORTS_API', 1 ); -/**@}*/ +/** @} */ /** Support for $wgResourceModules */ define( 'MW_SUPPORTS_RESOURCE_MODULES', 1 ); -/**@{ +/** @{ * Allowed values for Parser::$mOutputType * Parameter to Parser::startExternalParse(). * Use of Parser consts is preferred: @@ -166,9 +166,9 @@ define( 'OT_WIKI', 2 ); define( 'OT_PREPROCESS', 3 ); define( 'OT_MSG', 3 ); // b/c alias for OT_PREPROCESS define( 'OT_PLAIN', 4 ); -/**@}*/ +/** @} */ -/**@{ +/** @{ * Flags for Parser::setFunctionHook * Use of Parser consts is preferred: * - Parser::SFH_NO_HASH @@ -176,9 +176,9 @@ define( 'OT_PLAIN', 4 ); */ define( 'SFH_NO_HASH', 1 ); define( 'SFH_OBJECT_ARGS', 2 ); -/**@}*/ +/** @} */ -/**@{ +/** @{ * Autopromote conditions (must be here and not in Autopromote.php, so that * they're loaded for DefaultSettings.php before AutoLoader.php) */ @@ -191,7 +191,7 @@ define( 'APCOND_IPINRANGE', 6 ); define( 'APCOND_AGE_FROM_EDIT', 7 ); define( 'APCOND_BLOCKED', 8 ); define( 'APCOND_ISBOT', 9 ); -/**@}*/ +/** @} */ /** @{ * Protocol constants for wfExpandUrl() @@ -202,9 +202,9 @@ define( 'PROTO_RELATIVE', '//' ); define( 'PROTO_CURRENT', null ); define( 'PROTO_CANONICAL', 1 ); define( 'PROTO_INTERNAL', 2 ); -/**@}*/ +/** @} */ -/**@{ +/** @{ * Content model ids, used by Content and ContentHandler. * These IDs will be exposed in the API and XML dumps. * @@ -217,9 +217,9 @@ define( 'CONTENT_MODEL_JAVASCRIPT', 'javascript' ); define( 'CONTENT_MODEL_CSS', 'css' ); define( 'CONTENT_MODEL_TEXT', 'text' ); define( 'CONTENT_MODEL_JSON', 'json' ); -/**@}*/ +/** @} */ -/**@{ +/** @{ * Content formats, used by Content and ContentHandler. * These should be MIME types, and will be exposed in the API and XML dumps. * @@ -242,15 +242,15 @@ define( 'CONTENT_FORMAT_SERIALIZED', 'application/vnd.php.serialized' ); define( 'CONTENT_FORMAT_JSON', 'application/json' ); // for future use with the api, and for use by extensions define( 'CONTENT_FORMAT_XML', 'application/xml' ); -/**@}*/ +/** @} */ -/**@{ +/** @{ * Max string length for shell invocations; based on binfmts.h */ define( 'SHELL_MAX_ARG_STRLEN', '100000' ); -/**@}*/ +/** @} */ -/**@{ +/** @{ * Schema compatibility flags. * * Used as flags in a bit field that indicates whether the old or new schema (or both) @@ -269,9 +269,9 @@ define( 'SCHEMA_COMPAT_WRITE_BOTH', SCHEMA_COMPAT_WRITE_OLD | SCHEMA_COMPAT_WRIT define( 'SCHEMA_COMPAT_READ_BOTH', SCHEMA_COMPAT_READ_OLD | SCHEMA_COMPAT_READ_NEW ); define( 'SCHEMA_COMPAT_OLD', SCHEMA_COMPAT_WRITE_OLD | SCHEMA_COMPAT_READ_OLD ); define( 'SCHEMA_COMPAT_NEW', SCHEMA_COMPAT_WRITE_NEW | SCHEMA_COMPAT_READ_NEW ); -/**@}*/ +/** @} */ -/**@{ +/** @{ * Schema change migration flags. * * Used as values of a feature flag for an orderly transition from an old @@ -296,9 +296,9 @@ define( 'MIGRATION_OLD', 0x00000000 | SCHEMA_COMPAT_OLD ); define( 'MIGRATION_WRITE_BOTH', 0x10000000 | SCHEMA_COMPAT_READ_BOTH | SCHEMA_COMPAT_WRITE_BOTH ); define( 'MIGRATION_WRITE_NEW', 0x20000000 | SCHEMA_COMPAT_READ_BOTH | SCHEMA_COMPAT_WRITE_NEW ); define( 'MIGRATION_NEW', 0x30000000 | SCHEMA_COMPAT_NEW ); -/**@}*/ +/** @} */ -/**@{ +/** @{ * XML dump schema versions, for use with XmlDumpWriter. * See also the corresponding export-nnnn.xsd files in the docs directory, * which are also listed at . @@ -307,4 +307,4 @@ define( 'MIGRATION_NEW', 0x30000000 | SCHEMA_COMPAT_NEW ); */ define( 'XML_DUMP_SCHEMA_VERSION_10', '0.10' ); define( 'XML_DUMP_SCHEMA_VERSION_11', '0.11' ); -/**@}*/ +/** @} */ diff --git a/includes/FormOptions.php b/includes/FormOptions.php index 0131855498..f0a48d290e 100644 --- a/includes/FormOptions.php +++ b/includes/FormOptions.php @@ -44,7 +44,8 @@ class FormOptions implements ArrayAccess { /** Integer type, maps guessType() to WebRequest::getInt() */ const INT = 1; /** Float type, maps guessType() to WebRequest::getFloat() - * @since 1.23 */ + * @since 1.23 + */ const FLOAT = 4; /** Boolean type, maps guessType() to WebRequest::getBool() */ const BOOL = 2; @@ -53,7 +54,8 @@ class FormOptions implements ArrayAccess { */ const INTNULL = 3; /** Array type, maps guessType() to WebRequest::getArray() - * @since 1.29 */ + * @since 1.29 + */ const ARR = 5; /* @} */ diff --git a/includes/MagicWord.php b/includes/MagicWord.php index 0984786d79..cb58e629c1 100644 --- a/includes/MagicWord.php +++ b/includes/MagicWord.php @@ -55,7 +55,7 @@ use MediaWiki\MediaWikiServices; * @ingroup Parser */ class MagicWord { - /**#@-*/ + /** #@- */ /** @var string */ public $mId; @@ -93,7 +93,7 @@ class MagicWord { /** @var Language */ private $contLang; - /**#@-*/ + /** #@- */ /** * Create a new MagicWord object diff --git a/includes/MagicWordFactory.php b/includes/MagicWordFactory.php index 4e9bfaf1f7..4c66854ef0 100644 --- a/includes/MagicWordFactory.php +++ b/includes/MagicWordFactory.php @@ -32,7 +32,7 @@ * @ingroup Parser */ class MagicWordFactory { - /**#@-*/ + /** #@- */ /** @var bool */ private $mVariableIDsInitialised = false; @@ -196,7 +196,7 @@ class MagicWordFactory { /** @var Language */ private $contLang; - /**#@-*/ + /** #@- */ /** * @param Language $contLang Content language diff --git a/includes/OutputPage.php b/includes/OutputPage.php index e78cd7bd12..c79618e3ce 100644 --- a/includes/OutputPage.php +++ b/includes/OutputPage.php @@ -54,7 +54,8 @@ class OutputPage extends ContextSource { protected $mCanonicalUrl = false; /** - * @var string The contents of

*/ + * @var string The contents of

+ */ private $mPageTitle = ''; /** diff --git a/includes/Revision/RevisionRecord.php b/includes/Revision/RevisionRecord.php index 0dcc35c2e5..ff9ac579e8 100644 --- a/includes/Revision/RevisionRecord.php +++ b/includes/Revision/RevisionRecord.php @@ -82,7 +82,7 @@ abstract class RevisionRecord { /** @var CommentStoreComment|null */ protected $mComment; - /** @var Title */ + /** @var Title */ protected $mTitle; // TODO: we only need the title for permission checks! /** @var RevisionSlots */ diff --git a/includes/Revision/RevisionStoreCacheRecord.php b/includes/Revision/RevisionStoreCacheRecord.php index 0420d34d89..1258f1521f 100644 --- a/includes/Revision/RevisionStoreCacheRecord.php +++ b/includes/Revision/RevisionStoreCacheRecord.php @@ -97,7 +97,7 @@ class RevisionStoreCacheRecord extends RevisionStoreRecord { /** * Load a fresh row from the database to ensure we return updated information - + * * @throws RevisionAccessException if the row could not be loaded */ private function loadFreshRow() { diff --git a/includes/Title.php b/includes/Title.php index 12d66415ac..281f75bac1 100644 --- a/includes/Title.php +++ b/includes/Title.php @@ -182,7 +182,8 @@ class Title implements LinkTarget, IDBAccessObject { private $mPageLanguage = false; /** @var string|bool|null The page language code from the database, null if not saved in - * the database or false if not loaded, yet. */ + * the database or false if not loaded, yet. + */ private $mDbPageLanguage = false; /** @var TitleValue|null A corresponding TitleValue object */ diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php index 63d8b18eb8..a7b872ce15 100644 --- a/includes/api/ApiBase.php +++ b/includes/api/ApiBase.php @@ -251,7 +251,7 @@ abstract class ApiBase extends ContextSource { */ const PARAM_TEMPLATE_VARS = 25; - /**@}*/ + /** @} */ const ALL_DEFAULT_STRING = '*'; @@ -506,7 +506,7 @@ abstract class ApiBase extends ContextSource { return null; } - /**@}*/ + /** @} */ /************************************************************************//** * @name Data access methods @@ -711,7 +711,7 @@ abstract class ApiBase extends ContextSource { return MediaWikiServices::getInstance()->getPermissionManager(); } - /**@}*/ + /** @} */ /************************************************************************//** * @name Parameter handling @@ -1729,7 +1729,7 @@ abstract class ApiBase extends ContextSource { ); } - /**@}*/ + /** @} */ /************************************************************************//** * @name Utility methods @@ -1904,7 +1904,7 @@ abstract class ApiBase extends ContextSource { } ); } - /**@}*/ + /** @} */ /************************************************************************//** * @name Warning and error reporting @@ -2249,7 +2249,7 @@ abstract class ApiBase extends ContextSource { wfDebugLog( 'api-feature-usage', $s, 'private', $ctx ); } - /**@}*/ + /** @} */ /************************************************************************//** * @name Help message generation @@ -2629,7 +2629,7 @@ abstract class ApiBase extends ContextSource { public function modifyHelp( array &$help, array $options, array &$tocData ) { } - /**@}*/ + /** @} */ } /** diff --git a/includes/api/ApiQueryBase.php b/includes/api/ApiQueryBase.php index ec432d8f11..50ca99a45d 100644 --- a/includes/api/ApiQueryBase.php +++ b/includes/api/ApiQueryBase.php @@ -78,7 +78,7 @@ abstract class ApiQueryBase extends ApiBase { public function requestExtraData( $pageSet ) { } - /**@}*/ + /** @} */ /************************************************************************//** * @name Data access @@ -131,7 +131,7 @@ abstract class ApiQueryBase extends ApiBase { return $this->getQuery()->getPageSet(); } - /**@}*/ + /** @} */ /************************************************************************//** * @name Querying @@ -465,7 +465,7 @@ abstract class ApiQueryBase extends ApiBase { } } - /**@}*/ + /** @} */ /************************************************************************//** * @name Utility methods @@ -608,5 +608,5 @@ abstract class ApiQueryBase extends ApiBase { ); } - /**@}*/ + /** @} */ } diff --git a/includes/api/ApiQueryRevisionsBase.php b/includes/api/ApiQueryRevisionsBase.php index d0b152edb1..0d284c0c01 100644 --- a/includes/api/ApiQueryRevisionsBase.php +++ b/includes/api/ApiQueryRevisionsBase.php @@ -43,7 +43,7 @@ abstract class ApiQueryRevisionsBase extends ApiQueryGeneratorBase { const IS_DELETED = 1; // Whether the field is revision-deleted const CANNOT_VIEW = 2; // Whether the user cannot view the field due to revdel - /**@}*/ + /** @} */ protected $limit, $diffto, $difftotext, $difftotextpst, $expandTemplates, $generateXML, $section, $parseContent, $fetchContent, $contentFormat, $setParsedLimit = true, diff --git a/includes/api/ApiResult.php b/includes/api/ApiResult.php index c27b10e344..7224f07a23 100644 --- a/includes/api/ApiResult.php +++ b/includes/api/ApiResult.php @@ -514,7 +514,7 @@ class ApiResult implements ApiSerializable { self::OVERRIDE | self::NO_SIZE_CHECK ); } - /**@}*/ + /** @} */ /************************************************************************//** * @name Metadata @@ -777,7 +777,7 @@ class ApiResult implements ApiSerializable { self::setArrayTypeRecursive( $arr, $tag, $kvpKeyName ); } - /**@}*/ + /** @} */ /************************************************************************//** * @name Utility @@ -1217,7 +1217,7 @@ class ApiResult implements ApiSerializable { } } - /**@}*/ + /** @} */ } diff --git a/includes/auth/AuthManager.php b/includes/auth/AuthManager.php index e03c5901bf..c871ce1cb3 100644 --- a/includes/auth/AuthManager.php +++ b/includes/auth/AuthManager.php @@ -86,17 +86,20 @@ class AuthManager implements LoggerAwareInterface { /** Log in with an existing (not necessarily local) user */ const ACTION_LOGIN = 'login'; /** Continue a login process that was interrupted by the need for user input or communication - * with an external provider */ + * with an external provider + */ const ACTION_LOGIN_CONTINUE = 'login-continue'; /** Create a new user */ const ACTION_CREATE = 'create'; /** Continue a user creation process that was interrupted by the need for user input or - * communication with an external provider */ + * communication with an external provider + */ const ACTION_CREATE_CONTINUE = 'create-continue'; /** Link an existing user to a third-party account */ const ACTION_LINK = 'link'; /** Continue a user linking process that was interrupted by the need for user input or - * communication with an external provider */ + * communication with an external provider + */ const ACTION_LINK_CONTINUE = 'link-continue'; /** Change a user's credentials */ const ACTION_CHANGE = 'change'; @@ -827,7 +830,7 @@ class AuthManager implements LoggerAwareInterface { return array_keys( $ret ); } - /**@}*/ + /** @} */ /** * @name Authentication data changing @@ -908,7 +911,7 @@ class AuthManager implements LoggerAwareInterface { } } - /**@}*/ + /** @} */ /** * @name Account creation @@ -1777,7 +1780,7 @@ class AuthManager implements LoggerAwareInterface { return Status::newGood(); } - /**@}*/ + /** @} */ /** * @name Account linking @@ -2002,7 +2005,7 @@ class AuthManager implements LoggerAwareInterface { } } - /**@}*/ + /** @} */ /** * @name Information methods @@ -2235,7 +2238,7 @@ class AuthManager implements LoggerAwareInterface { return null; } - /**@}*/ + /** @} */ /** * @name Internal methods @@ -2463,7 +2466,7 @@ class AuthManager implements LoggerAwareInterface { self::$instance = null; } - /**@}*/ + /** @} */ } diff --git a/includes/auth/AuthenticationRequest.php b/includes/auth/AuthenticationRequest.php index 4744c4d4b9..420034191e 100644 --- a/includes/auth/AuthenticationRequest.php +++ b/includes/auth/AuthenticationRequest.php @@ -47,7 +47,8 @@ abstract class AuthenticationRequest { /** Indicates that the request is required by a primary authentication * provider. Since the user can choose which primary to authenticate with, - * the request might or might not end up being actually required. */ + * the request might or might not end up being actually required. + */ const PRIMARY_REQUIRED = 2; /** @var string|null The AuthManager::ACTION_* constant this request was @@ -57,14 +58,16 @@ abstract class AuthenticationRequest { public $action = null; /** @var int For login, continue, and link actions, one of self::OPTIONAL, - * self::REQUIRED, or self::PRIMARY_REQUIRED */ + * self::REQUIRED, or self::PRIMARY_REQUIRED + */ public $required = self::REQUIRED; /** @var string|null Return-to URL, in case of redirect */ public $returnToUrl = null; /** @var string|null Username. See AuthenticationProvider::getAuthenticationRequests() - * for details of what this means and how it behaves. */ + * for details of what this means and how it behaves. + */ public $username = null; /** diff --git a/includes/block/BlockManager.php b/includes/block/BlockManager.php index c82ed1c258..b67703cab1 100644 --- a/includes/block/BlockManager.php +++ b/includes/block/BlockManager.php @@ -50,7 +50,7 @@ class BlockManager { * * @var array * @since 1.34 - * */ + */ public static $constructorOptions = [ 'ApplyIpBlocksToXff', 'CookieSetOnAutoblock', diff --git a/includes/changes/ChangesList.php b/includes/changes/ChangesList.php index 31b44430e8..03bb5e1ac5 100644 --- a/includes/changes/ChangesList.php +++ b/includes/changes/ChangesList.php @@ -705,7 +705,8 @@ class ChangesList extends ContextSource { ) { $title = $rc->getTitle(); /** Check for rollback permissions, disallow special pages, and only - * show a link on the top-most revision */ + * show a link on the top-most revision + */ if ( $title->quickUserCan( 'rollback', $this->getUser() ) ) { $rev = new Revision( [ 'title' => $title, diff --git a/includes/changes/FeedItem.php b/includes/changes/FeedItem.php index a6a26152b7..5f4badac72 100644 --- a/includes/changes/FeedItem.php +++ b/includes/changes/FeedItem.php @@ -218,5 +218,5 @@ class FeedItem { public static function stripComment( $text ) { return preg_replace( '/\[\[([^]]*\|)?([^]]+)\]\]/', '\2', $text ); } - /**#@-*/ + /** #@- */ } diff --git a/includes/deferred/SearchUpdate.php b/includes/deferred/SearchUpdate.php index 611469c79c..a508746c55 100644 --- a/includes/deferred/SearchUpdate.php +++ b/includes/deferred/SearchUpdate.php @@ -40,7 +40,7 @@ class SearchUpdate implements DeferrableUpdate { /** @var Content|null Content of the page (not text) */ private $content; - /** @var WikiPage **/ + /** @var WikiPage */ private $page; /** diff --git a/includes/diff/DifferenceEngine.php b/includes/diff/DifferenceEngine.php index 37ec39aa36..841daea195 100644 --- a/includes/diff/DifferenceEngine.php +++ b/includes/diff/DifferenceEngine.php @@ -198,7 +198,7 @@ class DifferenceEngine extends ContextSource { */ protected $isSlotDiffRenderer = false; - /**#@-*/ + /** #@- */ /** * @param IContextSource|null $context Context to use, anything else will be ignored diff --git a/includes/filerepo/FileRepo.php b/includes/filerepo/FileRepo.php index cbbffe4512..60f1607c7e 100644 --- a/includes/filerepo/FileRepo.php +++ b/includes/filerepo/FileRepo.php @@ -45,7 +45,8 @@ class FileRepo { const NAME_AND_TIME_ONLY = 1; /** @var bool Whether to fetch commons image description pages and display - * them on the local wiki */ + * them on the local wiki + */ public $fetchDescription; /** @var int */ @@ -67,7 +68,8 @@ class FileRepo { protected $thumbScriptUrl; /** @var bool Whether to skip media file transformation on parse and rely - * on a 404 handler instead. */ + * on a 404 handler instead. + */ protected $transformVia404; /** @var string URL of image description pages, e.g. diff --git a/includes/libs/CSSMin.php b/includes/libs/CSSMin.php index 7a90082b18..d3a02f7e56 100644 --- a/includes/libs/CSSMin.php +++ b/includes/libs/CSSMin.php @@ -29,7 +29,7 @@ */ class CSSMin { - /** @var string Strip marker for comments. **/ + /** @var string Strip marker for comments. */ const PLACEHOLDER = "\x7fPLACEHOLDER\x7f"; /** diff --git a/includes/libs/MWMessagePack.php b/includes/libs/MWMessagePack.php index 84b7b3e102..107672e361 100644 --- a/includes/libs/MWMessagePack.php +++ b/includes/libs/MWMessagePack.php @@ -34,7 +34,7 @@ * @deprecated since 1.34, no longer used */ class MWMessagePack { - /** @var bool|null Whether current system is bigendian. **/ + /** @var bool|null Whether current system is bigendian. */ public static $bigendian = null; /** diff --git a/includes/libs/ParamValidator/ParamValidator.php b/includes/libs/ParamValidator/ParamValidator.php index 1085375de3..02746ecd3e 100644 --- a/includes/libs/ParamValidator/ParamValidator.php +++ b/includes/libs/ParamValidator/ParamValidator.php @@ -166,7 +166,7 @@ class ParamValidator { */ const PARAM_IGNORE_INVALID_VALUES = 'param-ignore-invalid-values'; - /**@}*/ + /** @} */ /** Magic "all values" value when PARAM_ALL is true. */ const ALL_DEFAULT_STRING = '*'; diff --git a/includes/libs/filebackend/fileop/DeleteFileOp.php b/includes/libs/filebackend/fileop/DeleteFileOp.php index 01f7df46a8..1047a985ec 100644 --- a/includes/libs/filebackend/fileop/DeleteFileOp.php +++ b/includes/libs/filebackend/fileop/DeleteFileOp.php @@ -1,25 +1,25 @@ mFilteredExifData; } - /**#@-*/ + /** #@- */ /** * The version of the output format @@ -721,7 +721,7 @@ class Exif { } } - /**#@-*/ + /** #@- */ /** * Validates if a tag has a legal value according to the Exif spec diff --git a/includes/page/Article.php b/includes/page/Article.php index f158e4df0b..fcfb83de69 100644 --- a/includes/page/Article.php +++ b/includes/page/Article.php @@ -2168,7 +2168,7 @@ class Article implements Page { return $cacheable; } - /**#@-*/ + /** #@- */ /** * Lightweight method to get the parser output for a page, checking the parser cache diff --git a/includes/page/WikiPage.php b/includes/page/WikiPage.php index 173fdc6e97..3bc9f7c0f8 100644 --- a/includes/page/WikiPage.php +++ b/includes/page/WikiPage.php @@ -3503,7 +3503,7 @@ class WikiPage implements Page, IDBAccessObject { self::purgeInterwikiCheckKey( $title ); } - /**#@-*/ + /** #@- */ /** * Purge the check key for cross-wiki cache entries referencing this page diff --git a/includes/resourceloader/ResourceLoaderFilePath.php b/includes/resourceloader/ResourceLoaderFilePath.php index c01e507455..dff9a39999 100644 --- a/includes/resourceloader/ResourceLoaderFilePath.php +++ b/includes/resourceloader/ResourceLoaderFilePath.php @@ -34,7 +34,8 @@ class ResourceLoaderFilePath { protected $remoteBasePath; /** - * @var string Path to the file */ + * @var string Path to the file + */ protected $path; /** diff --git a/includes/session/Session.php b/includes/session/Session.php index 328958cf1b..681d6cf33e 100644 --- a/includes/session/Session.php +++ b/includes/session/Session.php @@ -694,6 +694,6 @@ final class Session implements \Countable, \Iterator, \ArrayAccess { $this->remove( $offset ); } - /**@}*/ + /** @} */ } diff --git a/includes/session/SessionManager.php b/includes/session/SessionManager.php index 3810565bcb..c635b97141 100644 --- a/includes/session/SessionManager.php +++ b/includes/session/SessionManager.php @@ -939,6 +939,6 @@ final class SessionManager implements SessionManagerInterface { self::$globalSessionRequest = null; } - /**@}*/ + /** @} */ } diff --git a/includes/session/Token.php b/includes/session/Token.php index 5165506ded..782ac16915 100644 --- a/includes/session/Token.php +++ b/includes/session/Token.php @@ -31,7 +31,8 @@ namespace MediaWiki\Session; */ class Token { /** CSRF token suffix. Plus and terminal backslash are included to stop - * editing from certain broken proxies. */ + * editing from certain broken proxies. + */ const SUFFIX = '+\\'; /** @var string */ diff --git a/includes/specialpage/AuthManagerSpecialPage.php b/includes/specialpage/AuthManagerSpecialPage.php index 65cd2d2e72..ba7785cc4b 100644 --- a/includes/specialpage/AuthManagerSpecialPage.php +++ b/includes/specialpage/AuthManagerSpecialPage.php @@ -13,7 +13,8 @@ use MediaWiki\Session\Token; */ abstract class AuthManagerSpecialPage extends SpecialPage { /** @var string[] The list of actions this special page deals with. Subclasses should override - * this. */ + * this. + */ protected static $allowedActions = [ AuthManager::ACTION_LOGIN, AuthManager::ACTION_LOGIN_CONTINUE, AuthManager::ACTION_CREATE, AuthManager::ACTION_CREATE_CONTINUE, diff --git a/includes/specialpage/LoginSignupSpecialPage.php b/includes/specialpage/LoginSignupSpecialPage.php index 743a5a5df0..d609d2294d 100644 --- a/includes/specialpage/LoginSignupSpecialPage.php +++ b/includes/specialpage/LoginSignupSpecialPage.php @@ -54,7 +54,8 @@ abstract class LoginSignupSpecialPage extends AuthManagerSpecialPage { protected $securityLevel; /** @var bool True if the user if creating an account for someone else. Flag used for internal - * communication, only set at the very end. */ + * communication, only set at the very end. + */ protected $proxyAccountCreation; /** @var User FIXME another flag for passing data. */ protected $targetUser; diff --git a/includes/specialpage/SpecialPageFactory.php b/includes/specialpage/SpecialPageFactory.php index 40172ab693..84d2f3e969 100644 --- a/includes/specialpage/SpecialPageFactory.php +++ b/includes/specialpage/SpecialPageFactory.php @@ -225,7 +225,7 @@ class SpecialPageFactory { * * @var array * @since 1.33 - * */ + */ public static $constructorOptions = [ 'ContentHandlerUseDB', 'DisableInternalSearch', diff --git a/includes/specials/SpecialBlock.php b/includes/specials/SpecialBlock.php index b2161dbaef..f65345463d 100644 --- a/includes/specials/SpecialBlock.php +++ b/includes/specials/SpecialBlock.php @@ -34,7 +34,8 @@ use MediaWiki\MediaWikiServices; */ class SpecialBlock extends FormSpecialPage { /** @var User|string|null User to be blocked, as passed either by parameter (url?wpTarget=Foo) - * or as subpage (Special:Block/Foo) */ + * or as subpage (Special:Block/Foo) + */ protected $target; /** @var int DatabaseBlock::TYPE_ constant */ diff --git a/includes/specials/SpecialUpload.php b/includes/specials/SpecialUpload.php index 68fda497b7..81c9d567f1 100644 --- a/includes/specials/SpecialUpload.php +++ b/includes/specials/SpecialUpload.php @@ -43,7 +43,7 @@ class SpecialUpload extends SpecialPage { return true; } - /** Misc variables **/ + /** Misc variables */ /** @var WebRequest|FauxRequest The request this form is supposed to handle */ public $mRequest; @@ -56,21 +56,21 @@ class SpecialUpload extends SpecialPage { public $mLocalFile; public $mUploadClicked; - /** User input variables from the "description" section **/ + /** User input variables from the "description" section */ /** @var string The requested target file name */ public $mDesiredDestName; public $mComment; public $mLicense; - /** User input variables from the root section **/ + /** User input variables from the root section */ public $mIgnoreWarning; public $mWatchthis; public $mCopyrightStatus; public $mCopyrightSource; - /** Hidden variables **/ + /** Hidden variables */ public $mDestWarningAck; @@ -84,7 +84,7 @@ class SpecialUpload extends SpecialPage { /** @var bool Subclasses can use this to determine whether a file was uploaded */ public $mUploadSuccessful = false; - /** Text injection points for hooks not using HTMLForm **/ + /** Text injection points for hooks not using HTMLForm */ public $uploadFormTextTop; public $uploadFormTextAfterSummary; @@ -690,7 +690,7 @@ class SpecialUpload extends SpecialPage { */ protected function processVerificationError( $details ) { switch ( $details['status'] ) { - /** Statuses that only require name changing **/ + /** Statuses that only require name changing */ case UploadBase::MIN_LENGTH_PARTNAME: $this->showRecoverableUploadError( $this->msg( 'minlength1' )->escaped() ); break; @@ -708,7 +708,7 @@ class SpecialUpload extends SpecialPage { $this->showRecoverableUploadError( $this->msg( 'windows-nonascii-filename' )->parse() ); break; - /** Statuses that require reuploading **/ + /** Statuses that require reuploading */ case UploadBase::EMPTY_FILE: $this->showUploadError( $this->msg( 'emptyfile' )->escaped() ); break; @@ -781,7 +781,7 @@ class SpecialUpload extends SpecialPage { } } - /*** Functions for formatting warnings ***/ + /** Functions for formatting warnings */ /** * Formats a result of UploadBase::getExistsWarning as HTML diff --git a/includes/specials/formfields/Licenses.php b/includes/specials/formfields/Licenses.php index 204b0338da..c78913ca53 100644 --- a/includes/specials/formfields/Licenses.php +++ b/includes/specials/formfields/Licenses.php @@ -40,7 +40,7 @@ class Licenses extends HTMLFormField { /** @var string|null */ protected $selected; - /**#@-*/ + /** #@- */ /** * @param array $params @@ -191,7 +191,7 @@ class Licenses extends HTMLFormField { return str_repeat( "\t", $depth ) . Xml::element( 'option', $attribs, $val ) . "\n"; } - /**#@-*/ + /** #@- */ /** * Accessor for $this->lines diff --git a/languages/messages/MessagesInh.php b/languages/messages/MessagesInh.php index a40241cb04..c3a2a7d1c9 100644 --- a/languages/messages/MessagesInh.php +++ b/languages/messages/MessagesInh.php @@ -1,12 +1,12 @@ assertConverted( $text, 'sr-ec', $msg ); } - /** Wrapper for converter::convertTo() method*/ + /** Wrapper for converter::convertTo() method */ protected function convertTo( $text, $variant ) { return $this->getLang() ->mConverter diff --git a/tests/phpunit/languages/classes/LanguageUzTest.php b/tests/phpunit/languages/classes/LanguageUzTest.php index abc63ee4e3..09054da91a 100644 --- a/tests/phpunit/languages/classes/LanguageUzTest.php +++ b/tests/phpunit/languages/classes/LanguageUzTest.php @@ -113,7 +113,7 @@ class LanguageUzTest extends LanguageClassesTestCase { $this->assertConverted( $text, 'uz-cyrl', $msg ); } - /** Wrapper for converter::convertTo() method*/ + /** Wrapper for converter::convertTo() method */ protected function convertTo( $text, $variant ) { return $this->getLang()->mConverter->convertTo( $text, $variant ); } diff --git a/tests/phpunit/maintenance/categoryChangesAsRdfTest.php b/tests/phpunit/maintenance/categoryChangesAsRdfTest.php index 521705e16e..8925b1f786 100644 --- a/tests/phpunit/maintenance/categoryChangesAsRdfTest.php +++ b/tests/phpunit/maintenance/categoryChangesAsRdfTest.php @@ -4,7 +4,7 @@ use Wikimedia\Rdbms\IDatabase; /** * Tests for CategoryChangesAsRdf recent changes exporter. - * @covers CategoryChangesAsRdf + * @covers CategoryChangesAsRdf */ class CategoryChangesAsRdfTest extends MediaWikiLangTestCase { -- 2.20.1