From 27d83878c01af1981a5ab1cf8fa143722623f6da Mon Sep 17 00:00:00 2001 From: Yuri Astrakhan Date: Sun, 10 Mar 2013 23:16:28 -0400 Subject: [PATCH] Lots of spelling mistakes and phpdoc attributes @throw->@throws @returns->@return @seealso->@see @cover->@covers etc Change-Id: I9ae6bc3034e9790e2d66cd96473b923fe9ee7953 --- RELEASE-NOTES-1.21 | 10 ++-- api.php | 2 +- api.php5 | 2 +- img_auth.php5 | 2 +- includes/DefaultSettings.php | 60 +++++++++++----------- includes/content/ContentHandler.php | 2 +- includes/db/DatabasePostgres.php | 4 +- includes/db/IORMTable.php | 4 +- includes/job/jobs/HTMLCacheUpdateJob.php | 2 +- includes/logging/LogPage.php | 2 +- index.php5 | 2 +- load.php5 | 2 +- mw-config/index.php5 | 2 +- opensearch_desc.php5 | 2 +- redirect.php5 | 2 +- tests/phpunit/MediaWikiTestCase.php | 4 +- tests/phpunit/includes/HtmlTest.php | 2 +- tests/phpunit/includes/LinkerTest.php | 2 +- tests/phpunit/includes/SanitizerTest.php | 8 +-- tests/phpunit/includes/StringUtilsTest.php | 4 +- thumb.php5 | 2 +- thumb_handler.php5 | 2 +- 22 files changed, 62 insertions(+), 62 deletions(-) diff --git a/RELEASE-NOTES-1.21 b/RELEASE-NOTES-1.21 index 883fb8ba58..de81f9ed0d 100644 --- a/RELEASE-NOTES-1.21 +++ b/RELEASE-NOTES-1.21 @@ -20,12 +20,12 @@ production. disabled. === New features in 1.21 === -* (bug 38110) Schema changes (adding or dropping tables, indicies and +* (bug 38110) Schema changes (adding or dropping tables, indices and fields) can be now be done separately from from other changes that update.php makes. This is useful in environments that use database permissions to restrict schema changes but allow the DB user that MediaWiki normally runs as to perform other changes that update.php - makes. Schema changes can be run seperately. See the file UPGRADE + makes. Schema changes can be run separately. See the file UPGRADE for more information. * (bug 34876) jquery.makeCollapsible has been improved in performance. * Added ContentHandler facility to allow extensions to support other content @@ -96,7 +96,7 @@ production. * (bug 5346) Categories that are redirects will be displayed italic in the category links section at the bottom of a page. * (bug 43915) New maintenance script deleteEqualMessages.php. -* You can now create checkbox option matrixes through the HTMLCheckMatrix +* You can now create checkbox option matrices through the HTMLCheckMatrix subclass in HTMLForm. * WikiText now permits the use of WAI-ARIA's role="presentation" inside of html elements and tables. This allows presentational markup, especially @@ -230,7 +230,7 @@ production. * (bug 43849) ApiQueryImageInfo no longer throws exceptions with ForeignDBRepo redirects. * On error, any warnings generated before that error will be shown in the result. -* action=help suports generalized submodules (modules=query+value), querymodules obsolete +* action=help supports generalized submodules (modules=query+value), querymodules obsolete * ApiQueryImageInfo continuation is more reliable. The only major change is that the imagerepository property will no longer be set on page objects not processed in the current query (i.e. non-images or those skipped due to @@ -241,7 +241,7 @@ production. * ApiQueryImageInfo will now limit the number of calls to File::transform made in any one query. If there are too many, iicontinue will be returned. * action=query&meta=siteinfo&siprop=general will now return the regexes used for - link trails and link prefices. Added for Parsoid support. + link trails and link prefixes. Added for Parsoid support. * Added an API query module list=pageswithprop, which lists pages using a particular page property. * Added an API query module list=pagepropnames, which lists all page prop names diff --git a/api.php b/api.php index abf601fb48..bc9022979e 100644 --- a/api.php +++ b/api.php @@ -8,7 +8,7 @@ * as an argument in the URL ('?action=') and with write-enabled set to the * value of $wgEnableWriteAPI as specified in LocalSettings.php. * It then invokes "execute()" on the ApiMain object instance, which - * produces output in the format sepecified in the URL. + * produces output in the format specified in the URL. * * Copyright © 2006 Yuri Astrakhan @gmail.com * diff --git a/api.php5 b/api.php5 index bb515c5c15..1828b7b4d1 100644 --- a/api.php5 +++ b/api.php5 @@ -1,7 +1,7 @@ array( "0" => AV_NO_VIRUS, # no virus "1" => AV_VIRUS_FOUND, # virus found - "52" => AV_SCAN_ABORTED, # unsupported file format (probably imune) + "52" => AV_SCAN_ABORTED, # unsupported file format (probably immune) "*" => AV_SCAN_FAILED, # else scan failed ), 'messagepattern' => '/.*?:(.*)/sim', @@ -1250,7 +1250,7 @@ $wgEnableUserEmail = true; * instead of From. ($wgEmergencyContact will be used as From.) * * Some mailers (eg sSMTP) set the SMTP envelope sender to the From value, - * which can cause problems with SPF validation and leak recipient addressses + * which can cause problems with SPF validation and leak recipient addresses * when bounces are sent to the sender. */ $wgUserEmailUseReplyTo = false; @@ -1449,7 +1449,7 @@ $wgAllDBsAreLocalhost = false; * preferences shared (preferences were stored in the user table prior to 1.16) * * $wgSharedTables may be customized with a list of tables to share in the shared - * datbase. However it is advised to limit what tables you do share as many of + * database. However it is advised to limit what tables you do share as many of * MediaWiki's tables may have side effects if you try to share them. * * $wgSharedPrefix is the table prefix for the shared database. It defaults to @@ -1537,7 +1537,7 @@ $wgDBerrorLog = false; * Timezone to use in the error log. * Defaults to the wiki timezone ($wgLocaltimezone). * - * A list of useable timezones can found at: + * A list of usable timezones can found at: * http://php.net/manual/en/timezones.php * * @par Examples: @@ -2211,14 +2211,14 @@ $wgUsePrivateIPs = false; * change it in their preferences. * * This also defines the language of pages in the wiki. The content is wrapped - * in a html element with lang=XX attribute. This behavior can be overriden + * in a html element with lang=XX attribute. This behavior can be overridden * via hooks, see Title::getPageLanguage. */ $wgLanguageCode = 'en'; /** * Language cache size, or really how many languages can we handle - * simultanously without degrading to crawl speed. + * simultaneously without degrading to crawl speed. */ $wgLangObjCacheSize = 10; @@ -2244,7 +2244,7 @@ $wgExtraLanguageNames = array(); /** * List of language codes that don't correspond to an actual language. - * These codes are mostly leftoffs from renames, or other legacy things. + * These codes are mostly left-offs from renames, or other legacy things. * This array makes them not appear as a selectable language on the installer, * and excludes them when running the transstat.php script. */ @@ -2484,7 +2484,7 @@ $wgForceUIMsgAsContentMsg = array(); * Timezones can be translated by editing MediaWiki messages of type * timezone-nameinlowercase like timezone-utc. * - * A list of useable timezones can found at: + * A list of usable timezones can found at: * http://php.net/manual/en/timezones.php * * @par Examples: @@ -2503,7 +2503,7 @@ $wgLocaltimezone = null; * for anonymous users and new user accounts. * * This setting is used for most date/time displays in the software, and is - * overrideable in user preferences. It is *not* used for signature timestamps. + * overridable in user preferences. It is *not* used for signature timestamps. * * By default, this will be set to match $wgLocaltimezone. */ @@ -2602,7 +2602,7 @@ $wgWellFormedXml = true; * @par Example: * @code * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg'; - * @endCode + * @endcode * Normally we wouldn't have to define this in the root "" * element, but IE needs it there in some circumstances. * @@ -2787,7 +2787,7 @@ $wgExperimentalHtmlIds = false; * for the icon, the following keys are used: * - src: An absolute url to the image to use for the icon, this is recommended * but not required, however some skins will ignore icons without an image - * - url: The url to use in the a element arround the text or icon, if not set an a element will not be outputted + * - url: The url to use in the a element around the text or icon, if not set an a element will not be outputted * - alt: This is the text form of the icon, it will be displayed without an image in * skins like Modern or if src is not set, and will otherwise be used as * the alt="" for the image. This key is required. @@ -2859,7 +2859,7 @@ $wgSend404Code = true; /** * The $wgShowRollbackEditCount variable is used to show how many edits will be - * rollback. The numeric value of the varible are the limit up to are counted. + * rollback. The numeric value of the variable are the limit up to are counted. * If the value is false or 0, the edits are not counted. Disabling this will * furthermore prevent MediaWiki from hiding some useless rollback links. * @@ -3207,7 +3207,7 @@ $wgInterwikiFallbackSite = 'wiki'; /** @} */ # end of Interwiki caching settings. /** - * If local interwikis are set up which allow redirects, + * If local interwikies are set up which allow redirects, * set this regexp to restrict URLs which will be displayed * as 'redirected from' links. * @@ -3307,7 +3307,7 @@ $wgInvalidRedirectTargets = array( 'Filepath', 'Mypage', 'Mytalk' ); * class The class name * * preprocessorClass The preprocessor class. Two classes are currently available: - * Preprocessor_Hash, which uses plain PHP arrays for tempoarary + * Preprocessor_Hash, which uses plain PHP arrays for temporary * storage, and Preprocessor_DOM, which uses the DOM module for * temporary storage. Preprocessor_DOM generally uses less memory; * the speed of the two is roughly the same. @@ -4106,7 +4106,7 @@ $wgNamespaceProtection = array(); * namespaces constants (NS_USER, NS_MAIN...). * * Among other things, this may be useful to enforce read-restrictions - * which may otherwise be bypassed by using the template machanism. + * which may otherwise be bypassed by using the template mechanism. */ $wgNonincludableNamespaces = array(); @@ -4815,7 +4815,7 @@ $wgDebugToolbar = false; $wgDisableTextSearch = false; /** - * Set to true to have nicer highligted text in search results, + * Set to true to have nicer highlighted text in search results, * by default off due to execution overhead */ $wgAdvancedSearchHighlighting = false; @@ -4841,7 +4841,7 @@ $wgCountTotalSearchHits = false; /** * Template for OpenSearch suggestions, defaults to API action=opensearch * - * Sites with heavy load would tipically have these point to a custom + * Sites with heavy load would typically have these point to a custom * PHP wrapper to avoid firing up mediawiki for every keystroke * * Placeholders: {searchTerms} @@ -4933,14 +4933,14 @@ $wgUseTwoButtonsSearchForm = true; /** * Array of namespaces to generate a Google sitemap for when the - * maintenance/generateSitemap.php script is run, or false if one is to be ge- - * nerated for all namespaces. + * maintenance/generateSitemap.php script is run, or false if one is to be + * generated for all namespaces. */ $wgSitemapNamespaces = false; /** * Custom namespace priorities for sitemaps. Setting this will allow you to - * set custom priorities to namsepaces when sitemaps are generated using the + * set custom priorities to namespaces when sitemaps are generated using the * maintenance/generateSitemap.php script. * * This should be a map of namespace IDs to priority @@ -4981,7 +4981,7 @@ $wgDiff = '/usr/bin/diff'; /** * Which namespaces have special treatment where they should be preview-on-open - * Internaly only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki) + * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki) * can specify namespaces of pages they have special treatment for */ $wgPreviewOnOpenNamespaces = array( @@ -5461,7 +5461,7 @@ $wgAutoloadClasses = array(); * 'version' => 1.9, * 'path' => __FILE__, * 'author' => 'Foo Barstein', - * 'url' => 'http://wwww.example.com/Example%20Extension/', + * 'url' => 'http://www.example.com/Example%20Extension/', * 'description' => 'An example extension', * 'descriptionmsg' => 'exampleextension-desc', * ); @@ -5918,8 +5918,8 @@ $wgNamespaceRobotPolicies = array(); /** * Robot policies per article. These override the per-namespace robot policies. - * Must be in the form of an array where the key part is a properly canonical- - * ised text form title and the value is a robot policy. + * Must be in the form of an array where the key part is a properly canonicalised + * text form title and the value is a robot policy. * * @par Example: * @code diff --git a/includes/content/ContentHandler.php b/includes/content/ContentHandler.php index ae549da100..3399160880 100644 --- a/includes/content/ContentHandler.php +++ b/includes/content/ContentHandler.php @@ -141,7 +141,7 @@ abstract class ContentHandler { * @throws MWException * @return Content a Content object representing $text * - * @throw MWException if $model or $format is not supported or if $text can + * @throws MWException if $model or $format is not supported or if $text can * not be unserialized using $format. */ public static function makeContent( $text, Title $title = null, diff --git a/includes/db/DatabasePostgres.php b/includes/db/DatabasePostgres.php index 6f7d1fa9aa..49da2497a2 100644 --- a/includes/db/DatabasePostgres.php +++ b/includes/db/DatabasePostgres.php @@ -1078,8 +1078,8 @@ __INDEXATTR__; * This is list does not contain magic keywords like "$user" * Needs transaction * - * @seealso getSearchPath() - * @seealso setSearchPath() + * @see getSearchPath() + * @see setSearchPath() * @since 1.19 * @return array list of actual schemas for the current sesson */ diff --git a/includes/db/IORMTable.php b/includes/db/IORMTable.php index d8e7130f3f..7db4b1fc1e 100644 --- a/includes/db/IORMTable.php +++ b/includes/db/IORMTable.php @@ -107,7 +107,7 @@ interface IORMTable { * @param string|null $functionName * * @return ORMResult The result set - * @throw DBQueryError if the query failed (even if the database was in ignoreErrors mode) + * @throws DBQueryError if the query failed (even if the database was in ignoreErrors mode) */ public function select( $fields = null, array $conditions = array(), array $options = array(), $functionName = null ); @@ -139,7 +139,7 @@ interface IORMTable { * @param null|string $functionName * * @return ResultWrapper - * @throw DBQueryError if the query failed (even if the database was in ignoreErrors mode) + * @throws DBQueryError if the query failed (even if the database was in ignoreErrors mode) */ public function rawSelect( $fields = null, array $conditions = array(), array $options = array(), $functionName = null ); diff --git a/includes/job/jobs/HTMLCacheUpdateJob.php b/includes/job/jobs/HTMLCacheUpdateJob.php index ae3e7bb70d..5c871e325e 100644 --- a/includes/job/jobs/HTMLCacheUpdateJob.php +++ b/includes/job/jobs/HTMLCacheUpdateJob.php @@ -124,7 +124,7 @@ class HTMLCacheUpdateJob extends Job { * * @param $titleArray array * @param $rootJobParams array - * @rerturn void + * @return void */ protected function insertJobsFromTitles( $titleArray, $rootJobParams = array() ) { // Carry over any "root job" information diff --git a/includes/logging/LogPage.php b/includes/logging/LogPage.php index 37787ec36c..4910b7b407 100644 --- a/includes/logging/LogPage.php +++ b/includes/logging/LogPage.php @@ -50,7 +50,7 @@ class LogPage { */ var $target; - /* @acess public */ + /* @access public */ var $updateRecentChanges, $sendToUDP; /** diff --git a/index.php5 b/index.php5 index 2c3dc07f8f..b3e40b67d3 100644 --- a/index.php5 +++ b/index.php5 @@ -1,7 +1,7 @@ setMwGlobals( array( diff --git a/tests/phpunit/includes/SanitizerTest.php b/tests/phpunit/includes/SanitizerTest.php index 9707f4968e..c0ed4a5951 100644 --- a/tests/phpunit/includes/SanitizerTest.php +++ b/tests/phpunit/includes/SanitizerTest.php @@ -63,7 +63,7 @@ class SanitizerTest extends MediaWikiTestCase { } /** - * @cover Sanitizer::removeHTMLtags + * @covers Sanitizer::removeHTMLtags * @dataProvider provideHtml5Tags * * @param String $tag Name of an HTML5 element (ie: 'video') @@ -116,7 +116,7 @@ class SanitizerTest extends MediaWikiTestCase { /** * @dataProvider provideTagAttributesToDecode - * @cover Sanitizer::decodeTagAttributes + * @covers Sanitizer::decodeTagAttributes */ function testDecodeTagAttributes( $expected, $attributes, $message = '' ) { $this->assertEquals( $expected, @@ -165,7 +165,7 @@ class SanitizerTest extends MediaWikiTestCase { /** * @dataProvider provideDeprecatedAttributes - * @cover Sanitizer::fixTagAttributes + * @covers Sanitizer::fixTagAttributes */ function testDeprecatedAttributesUnaltered( $inputAttr, $inputEl, $message = '' ) { $this->assertEquals( " $inputAttr", @@ -193,7 +193,7 @@ class SanitizerTest extends MediaWikiTestCase { /** * @dataProvider provideCssCommentsFixtures - * @cover Sanitizer::checkCss + * @covers Sanitizer::checkCss */ function testCssCommentsChecking( $expected, $css, $message = '' ) { $this->assertEquals( $expected, diff --git a/tests/phpunit/includes/StringUtilsTest.php b/tests/phpunit/includes/StringUtilsTest.php index 31216b380e..db3d265520 100644 --- a/tests/phpunit/includes/StringUtilsTest.php +++ b/tests/phpunit/includes/StringUtilsTest.php @@ -6,7 +6,7 @@ class StringUtilsTest extends MediaWikiTestCase { * This test StringUtils::isUtf8 whenever we have mbstring extension * loaded. * - * @cover StringUtils::isUtf8 + * @covers StringUtils::isUtf8 * @dataProvider provideStringsForIsUtf8Check */ function testIsUtf8WithMbstring( $expected, $string ) { @@ -24,7 +24,7 @@ class StringUtilsTest extends MediaWikiTestCase { * implementation used as a fallback when mb_check_encoding() is * not available. * - * @cover StringUtils::isUtf8 + * @covers StringUtils::isUtf8 * @dataProvider provideStringsForIsUtf8Check */ function testIsUtf8WithPhpFallbackImplementation( $expected, $string ) { diff --git a/thumb.php5 b/thumb.php5 index db388d2b1e..2a57d4aa05 100644 --- a/thumb.php5 +++ b/thumb.php5 @@ -1,7 +1,7 @@