From 7ff005407edfb632b9683bae15745e237cd0e370 Mon Sep 17 00:00:00 2001 From: umherirrender Date: Thu, 24 Jul 2014 11:30:25 +0200 Subject: [PATCH] Remove colon after @deprecated/@param/@todo/@note Change-Id: I4e66dad85eecf7e8e03ac760af900395e1bc11b6 --- includes/Linker.php | 2 +- includes/PrefixSearch.php | 2 +- includes/Revision.php | 2 +- includes/Title.php | 4 ++-- includes/content/ContentHandler.php | 2 +- includes/content/TextContent.php | 4 ++-- includes/content/WikitextContent.php | 2 +- includes/deferred/DataUpdate.php | 6 +++--- includes/deferred/LinksUpdate.php | 6 +++--- includes/deferred/SqlDataUpdate.php | 8 ++++---- includes/page/Article.php | 2 +- includes/parser/ParserOutput.php | 2 +- includes/specials/SpecialCategories.php | 2 +- includes/specials/SpecialLinkSearch.php | 2 +- includes/specials/SpecialMergeHistory.php | 2 +- includes/specials/SpecialRunJobs.php | 2 +- includes/title/MediaWikiTitleCodec.php | 6 +++--- includes/title/TitleFormatter.php | 2 +- includes/title/TitleValue.php | 6 +++--- tests/phpunit/MediaWikiTestCase.php | 4 ++-- tests/phpunit/includes/TitleMethodsTest.php | 4 ++-- tests/phpunit/includes/TitleTest.php | 2 +- 22 files changed, 37 insertions(+), 37 deletions(-) diff --git a/includes/Linker.php b/includes/Linker.php index 1991694036..d900e425f7 100644 --- a/includes/Linker.php +++ b/includes/Linker.php @@ -25,7 +25,7 @@ * for primarily page content: links, embedded images, table of contents. Links * are also used in the skin. * - * @todo: turn this into a legacy interface for HtmlPageLinkRenderer and similar services. + * @todo turn this into a legacy interface for HtmlPageLinkRenderer and similar services. * * @ingroup Skins */ diff --git a/includes/PrefixSearch.php b/includes/PrefixSearch.php index f794b2aad4..35be2a9d87 100644 --- a/includes/PrefixSearch.php +++ b/includes/PrefixSearch.php @@ -29,7 +29,7 @@ abstract class PrefixSearch { /** * Do a prefix search of titles and return a list of matching page names. - * @deprecated: Since 1.23, use TitlePrefixSearch or StringPrefixSearch classes + * @deprecated Since 1.23, use TitlePrefixSearch or StringPrefixSearch classes * * @param string $search * @param int $limit diff --git a/includes/Revision.php b/includes/Revision.php index bcd3fd8d4f..836dbce3be 100644 --- a/includes/Revision.php +++ b/includes/Revision.php @@ -1569,7 +1569,7 @@ class Revision implements IDBAccessObject { * operations and other such meta-modifications. * * @param DatabaseBase $dbw - * @param int $pageId: ID number of the page to read from + * @param int $pageId ID number of the page to read from * @param string $summary Revision's summary * @param bool $minor Whether the revision should be considered as minor * @param User|null $user User object to use or null for $wgUser diff --git a/includes/Title.php b/includes/Title.php index b7c0a255a2..266273f2fd 100644 --- a/includes/Title.php +++ b/includes/Title.php @@ -608,7 +608,7 @@ class Title { * Note that this doesn't pick up many things that could be wrong with titles, but that * replacing this regex with something valid will make many titles valid. * - * @todo: move this into MediaWikiTitleCodec + * @todo move this into MediaWikiTitleCodec * * @return string Regex string */ @@ -853,7 +853,7 @@ class Title { /** * Get a TitleValue object representing this Title. * - * @note: Not all valid Titles have a corresponding valid TitleValue + * @note Not all valid Titles have a corresponding valid TitleValue * (e.g. TitleValues cannot represent page-local links that have a * fragment but no title text). * diff --git a/includes/content/ContentHandler.php b/includes/content/ContentHandler.php index 1343858c96..6be06c6094 100644 --- a/includes/content/ContentHandler.php +++ b/includes/content/ContentHandler.php @@ -709,7 +709,7 @@ abstract class ContentHandler { * typically based on the namespace or some other aspect of the title, such as a special suffix * (e.g. ".svg" for SVG content). * - * @note: this calls the ContentHandlerCanBeUsedOn hook which may be used to override which + * @note this calls the ContentHandlerCanBeUsedOn hook which may be used to override which * content model can be used where. * * @param Title $title The page's title. diff --git a/includes/content/TextContent.php b/includes/content/TextContent.php index c3daf83e36..d292880ba4 100644 --- a/includes/content/TextContent.php +++ b/includes/content/TextContent.php @@ -132,7 +132,7 @@ class TextContent extends AbstractContent { * Returns attempts to convert this content object to wikitext, * and then returns the text string. The conversion may be lossy. * - * @note: this allows any text-based content to be transcluded as if it was wikitext. + * @note this allows any text-based content to be transcluded as if it was wikitext. * * @return string|bool The raw text, or false if the conversion failed. */ @@ -257,7 +257,7 @@ class TextContent extends AbstractContent { * This default implementation returns an HTML-escaped version * of the raw text content. * - * @note: The functionality of this method should really be implemented + * @note The functionality of this method should really be implemented * in getHtml(), and subclasses should override getHtml() if needed. * getHighlightHtml() is kept around for backward compatibility with * extensions that already override it. diff --git a/includes/content/WikitextContent.php b/includes/content/WikitextContent.php index cdf59623fc..8163b737d7 100644 --- a/includes/content/WikitextContent.php +++ b/includes/content/WikitextContent.php @@ -170,7 +170,7 @@ class WikitextContent extends TextContent { /** * Extract the redirect target and the remaining text on the page. * - * @note: migrated here from Title::newFromRedirectInternal() + * @note migrated here from Title::newFromRedirectInternal() * * @since 1.23 * diff --git a/includes/deferred/DataUpdate.php b/includes/deferred/DataUpdate.php index 53990bf784..8d4ee84446 100644 --- a/includes/deferred/DataUpdate.php +++ b/includes/deferred/DataUpdate.php @@ -25,9 +25,9 @@ * Abstract base class for update jobs that do something with some secondary * data extracted from article. * - * @note: subclasses should NOT start or commit transactions in their doUpdate() method, - * a transaction will automatically be wrapped around the update. If need be, - * subclasses can override the beginTransaction() and commitTransaction() methods. + * @note subclasses should NOT start or commit transactions in their doUpdate() method, + * a transaction will automatically be wrapped around the update. If need be, + * subclasses can override the beginTransaction() and commitTransaction() methods. */ abstract class DataUpdate implements DeferrableUpdate { /** diff --git a/includes/deferred/LinksUpdate.php b/includes/deferred/LinksUpdate.php index 2c984f7443..631f7393fe 100644 --- a/includes/deferred/LinksUpdate.php +++ b/includes/deferred/LinksUpdate.php @@ -524,7 +524,7 @@ class LinksUpdate extends SqlDataUpdate { * is present in the database (as indicated by $wgPagePropsHaveSortkey). * The sortkey value is currently determined by getPropertySortKeyValue(). * - * @note: this assumes that $this->mProperties[$prop] is defined. + * @note this assumes that $this->mProperties[$prop] is defined. * * @param string $prop The name of the property. * @@ -553,8 +553,8 @@ class LinksUpdate extends SqlDataUpdate { * This will return $value if it is a float or int, * 1 or resp. 0 if it is a bool, and null otherwise. * - * @note: In the future, we may allow the sortkey to be specified explicitly - * in ParserOutput::setProperty. + * @note In the future, we may allow the sortkey to be specified explicitly + * in ParserOutput::setProperty. * * @param mixed $value * diff --git a/includes/deferred/SqlDataUpdate.php b/includes/deferred/SqlDataUpdate.php index 121af0418c..14bae235e5 100644 --- a/includes/deferred/SqlDataUpdate.php +++ b/includes/deferred/SqlDataUpdate.php @@ -25,10 +25,10 @@ * Abstract base class for update jobs that put some secondary data extracted * from article content into the database. * - * @note: subclasses should NOT start or commit transactions in their doUpdate() method, - * a transaction will automatically be wrapped around the update. Starting another - * one would break the outer transaction bracket. If need be, subclasses can override - * the beginTransaction() and commitTransaction() methods. + * @note subclasses should NOT start or commit transactions in their doUpdate() method, + * a transaction will automatically be wrapped around the update. Starting another + * one would break the outer transaction bracket. If need be, subclasses can override + * the beginTransaction() and commitTransaction() methods. */ abstract class SqlDataUpdate extends DataUpdate { /** @var DatabaseBase Database connection reference */ diff --git a/includes/page/Article.php b/includes/page/Article.php index 2f27826265..0b32478fbf 100644 --- a/includes/page/Article.php +++ b/includes/page/Article.php @@ -858,7 +858,7 @@ class Article implements Page { * @param string $action The action= GET parameter * @param ParserOutput|null $pOutput * @return array The policy that should be set - * @todo: actions other than 'view' + * @todo actions other than 'view' */ public function getRobotPolicy( $action, $pOutput = null ) { global $wgArticleRobotPolicies, $wgNamespaceRobotPolicies, $wgDefaultRobotPolicy; diff --git a/includes/parser/ParserOutput.php b/includes/parser/ParserOutput.php index 09f714f53c..1903fc4bbc 100644 --- a/includes/parser/ParserOutput.php +++ b/includes/parser/ParserOutput.php @@ -537,7 +537,7 @@ class ParserOutput extends CacheTime { * Wikimedia Commons. * This is not actually implemented, yet but would be pretty cool. * - * @note: Do not use setProperty() to set a property which is only used + * @note Do not use setProperty() to set a property which is only used * in a context where the ParserOutput object itself is already available, * for example a normal page view. There is no need to save such a property * in the database since the text is already parsed. You can just hook diff --git a/includes/specials/SpecialCategories.php b/includes/specials/SpecialCategories.php index 734544d408..3367bd4e12 100644 --- a/includes/specials/SpecialCategories.php +++ b/includes/specials/SpecialCategories.php @@ -43,7 +43,7 @@ class SpecialCategories extends SpecialPage { * Initialize or override the PageLinkRenderer SpecialCategories collaborates with. * Useful mainly for testing. * - * @todo: the pager should also be injected, and de-coupled from the rendering logic. + * @todo the pager should also be injected, and de-coupled from the rendering logic. * * @param PageLinkRenderer $linkRenderer */ diff --git a/includes/specials/SpecialLinkSearch.php b/includes/specials/SpecialLinkSearch.php index aec1257001..10d1957a13 100644 --- a/includes/specials/SpecialLinkSearch.php +++ b/includes/specials/SpecialLinkSearch.php @@ -51,7 +51,7 @@ class LinkSearchPage extends QueryPage { * Initialize or override the PageLinkRenderer LinkSearchPage collaborates with. * Useful mainly for testing. * - * @todo: query logic and rendering logic should be split and also injected + * @todo query logic and rendering logic should be split and also injected * * @param PageLinkRenderer $linkRenderer */ diff --git a/includes/specials/SpecialMergeHistory.php b/includes/specials/SpecialMergeHistory.php index 9347af7878..a6c40d7a3d 100644 --- a/includes/specials/SpecialMergeHistory.php +++ b/includes/specials/SpecialMergeHistory.php @@ -328,7 +328,7 @@ class SpecialMergeHistory extends SpecialPage { /** * Actually attempt the history move * - * @todo: if all versions of page A are moved to B and then a user + * @todo if all versions of page A are moved to B and then a user * tries to do a reverse-merge via the "unmerge" log link, then page * A will still be a redirect (as it was after the original merge), * though it will have the old revisions back from before (as expected). diff --git a/includes/specials/SpecialRunJobs.php b/includes/specials/SpecialRunJobs.php index 4c8c8f3081..b977292412 100644 --- a/includes/specials/SpecialRunJobs.php +++ b/includes/specials/SpecialRunJobs.php @@ -104,7 +104,7 @@ class SpecialRunJobs extends UnlistedSpecialPage { /** * Run jobs from the job queue * - * @note: also called from Wiki.php + * @note also called from Wiki.php * * @param int $maxJobs Maximum number of jobs to run * @return void diff --git a/includes/title/MediaWikiTitleCodec.php b/includes/title/MediaWikiTitleCodec.php index 8798de5eb0..3a9ab409a3 100644 --- a/includes/title/MediaWikiTitleCodec.php +++ b/includes/title/MediaWikiTitleCodec.php @@ -25,7 +25,7 @@ /** * A codec for %MediaWiki page titles. * - * @note: Normalization and validation is applied while parsing, not when formatting. + * @note Normalization and validation is applied while parsing, not when formatting. * It's possible to construct a TitleValue with an invalid title, and use MediaWikiTitleCodec * to generate an (invalid) title string from it. TitleValues should be constructed only * via parseTitle() or from a (semi)trusted source, such as the database. @@ -187,10 +187,10 @@ class MediaWikiTitleCodec implements TitleFormatter, TitleParser { * namespace prefixes, sets the other forms, and canonicalizes * everything. * - * @todo: this method is only exposed as a temporary measure to ease refactoring. + * @todo this method is only exposed as a temporary measure to ease refactoring. * It was copied with minimal changes from Title::secureAndSplit(). * - * @todo: This method should be split up and an appropriate interface + * @todo This method should be split up and an appropriate interface * defined for use by the Title class. * * @param string $text diff --git a/includes/title/TitleFormatter.php b/includes/title/TitleFormatter.php index ea58b1e329..cb28028ab3 100644 --- a/includes/title/TitleFormatter.php +++ b/includes/title/TitleFormatter.php @@ -48,7 +48,7 @@ interface TitleFormatter { /** * Returns the title text formatted for display, without namespace of fragment. * - * @note: Only minimal normalization is applied. Consider using TitleValue::getText() directly. + * @note Only minimal normalization is applied. Consider using TitleValue::getText() directly. * * @param TitleValue $title the title to format * diff --git a/includes/title/TitleValue.php b/includes/title/TitleValue.php index 73e1dc2063..402247c225 100644 --- a/includes/title/TitleValue.php +++ b/includes/title/TitleValue.php @@ -52,7 +52,7 @@ class TitleValue { /** * Constructs a TitleValue. * - * @note: TitleValue expects a valid DB key; typically, a TitleValue is constructed either + * @note TitleValue expects a valid DB key; typically, a TitleValue is constructed either * from a database entry, or by a TitleParser. We could apply "some" normalization here, * such as substituting spaces by underscores, but that would encourage the use of * un-normalized text when constructing TitleValues. For constructing a TitleValue from @@ -122,8 +122,8 @@ class TitleValue { * * This is computed from the DB key by replacing any underscores with spaces. * - * @note: To get a title string that includes the namespace and/or fragment, - * use a TitleFormatter. + * @note To get a title string that includes the namespace and/or fragment, + * use a TitleFormatter. * * @return string */ diff --git a/tests/phpunit/MediaWikiTestCase.php b/tests/phpunit/MediaWikiTestCase.php index 301589542c..02330a43c0 100644 --- a/tests/phpunit/MediaWikiTestCase.php +++ b/tests/phpunit/MediaWikiTestCase.php @@ -507,10 +507,10 @@ abstract class MediaWikiTestCase extends PHPUnit_Framework_TestCase { * * @since 1.21 * - * @note: the original table prefix is stored in self::$oldTablePrefix. This is used + * @note the original table prefix is stored in self::$oldTablePrefix. This is used * by teardownTestDB() to return the wiki to using the original table set. * - * @note: this method only works when first called. Subsequent calls have no effect, + * @note this method only works when first called. Subsequent calls have no effect, * even if using different parameters. * * @param DatabaseBase $db The database connection diff --git a/tests/phpunit/includes/TitleMethodsTest.php b/tests/phpunit/includes/TitleMethodsTest.php index 55a17ac3dd..5904facd07 100644 --- a/tests/phpunit/includes/TitleMethodsTest.php +++ b/tests/phpunit/includes/TitleMethodsTest.php @@ -4,8 +4,8 @@ * @group ContentHandler * @group Database * - * @note: We don't make assumptions about the main namespace. - * But we do expect the Help namespace to contain Wikitext. + * @note We don't make assumptions about the main namespace. + * But we do expect the Help namespace to contain Wikitext. */ class TitleMethodsTest extends MediaWikiTestCase { diff --git a/tests/phpunit/includes/TitleTest.php b/tests/phpunit/includes/TitleTest.php index 12dda8982d..53e8dc230b 100644 --- a/tests/phpunit/includes/TitleTest.php +++ b/tests/phpunit/includes/TitleTest.php @@ -59,7 +59,7 @@ class TitleTest extends MediaWikiTestCase { * See also mediawiki.Title.test.js * @covers Title::secureAndSplit * @todo This method should be split into 2 separate tests each with a provider - * @note: This mainly tests MediaWikiTitleCodec::parseTitle(). + * @note This mainly tests MediaWikiTitleCodec::parseTitle(). */ public function testSecureAndSplit() { $this->setMwGlobals( array( -- 2.20.1