From 4bd5471ca3d1da1b3e9aa351323efb73cc4a8c44 Mon Sep 17 00:00:00 2001 From: Timo Tijhof Date: Wed, 15 May 2013 03:12:35 +0200 Subject: [PATCH] docs: Remove odd colons after @todo Most were this way already: https://doc.wikimedia.org/mediawiki-core/master/php/html/todo.html Ran a find/replace on the odd ones. Also made them all lower case. Change-Id: I70c6a69344ddebc603e9a1c1d87e3cc4f4f4c560 --- includes/Article.php | 7 ++++--- includes/Block.php | 2 +- includes/DefaultSettings.php | 2 +- includes/EditPage.php | 2 +- includes/Export.php | 4 ++-- includes/LinksUpdate.php | 2 +- includes/Revision.php | 4 ++-- includes/SiteStats.php | 2 +- includes/SqlDataUpdate.php | 2 +- includes/Status.php | 2 +- includes/Title.php | 2 +- includes/WikiPage.php | 20 +++++++++---------- includes/actions/HistoryAction.php | 2 +- includes/api/ApiEditPage.php | 2 +- includes/cache/FileCacheBase.php | 2 +- includes/cache/HTMLFileCache.php | 2 +- includes/cache/ResourceFileCache.php | 2 +- includes/content/Content.php | 14 ++++++------- includes/content/CssContent.php | 2 +- includes/content/JavaScriptContent.php | 2 +- includes/content/TextContent.php | 2 +- includes/db/DatabaseSqlite.php | 2 +- includes/diff/DifferenceEngine.php | 2 +- includes/filebackend/FileOp.php | 2 +- includes/job/jobs/PublishStashedFileJob.php | 2 +- includes/media/SVG.php | 2 +- includes/resourceloader/ResourceLoader.php | 2 +- includes/search/SearchSqlite.php | 2 +- includes/site/MediaWikiSite.php | 4 ++-- includes/specials/SpecialPasswordReset.php | 2 +- includes/specials/SpecialWatchlist.php | 2 +- includes/upload/UploadBase.php | 2 +- languages/LanguageConverter.php | 2 +- maintenance/fuzz-tester.php | 2 +- maintenance/namespaceDupes.php | 2 +- resources/Resources.php | 2 +- .../mediawiki.page.watch.ajax.js | 2 +- tests/phpunit/MediaWikiTestCase.php | 4 ++-- tests/phpunit/includes/LinksUpdateTest.php | 2 +- tests/phpunit/includes/RecentChangeTest.php | 2 +- .../phpunit/includes/RevisionStorageTest.php | 4 ++-- ...evisionStorageTest_ContentHandlerUseDB.php | 2 +- .../phpunit/includes/TitlePermissionTest.php | 2 +- tests/phpunit/includes/WikiPageTest.php | 4 ++-- .../content/JavaScriptContentTest.php | 4 ++-- .../includes/content/TextContentTest.php | 4 ++-- .../includes/content/WikitextContentTest.php | 6 +++--- .../includes/db/DatabaseSqliteTest.php | 2 +- .../includes/filebackend/FileBackendTest.php | 2 +- .../includes/jobqueue/JobQueueTest.php | 4 +++- .../phpunit/includes/parser/NewParserTest.php | 2 +- .../includes/search/SearchEngineTest.php | 2 +- .../maintenance/backupTextPassTest.php | 2 +- tests/phpunit/maintenance/backup_PageTest.php | 2 +- thumb.php | 2 +- 55 files changed, 85 insertions(+), 82 deletions(-) diff --git a/includes/Article.php b/includes/Article.php index 87b94ae975..d23bebf073 100644 --- a/includes/Article.php +++ b/includes/Article.php @@ -25,7 +25,7 @@ * * This maintains WikiPage functions for backwards compatibility. * - * @todo move and rewrite code to an Action class + * @todo Move and rewrite code to an Action class * * See design.txt for an overview. * Note: edit user interface and cache support functions have been @@ -385,7 +385,8 @@ class Article implements Page { $content = $this->fetchContentObject(); - $this->mContent = ContentHandler::getContentText( $content ); #@todo: get rid of mContent everywhere! + // @todo Get rid of mContent everywhere! + $this->mContent = ContentHandler::getContentText( $content ); ContentHandler::runLegacyHooks( 'ArticleAfterFetchContent', array( &$this, &$this->mContent ) ); wfProfileOut( __METHOD__ ); @@ -787,7 +788,7 @@ class Article implements Page { * Show a diff page according to current request variables. For use within * Article::view() only, other callers should use the DifferenceEngine class. * - * @todo: make protected + * @todo Make protected */ public function showDiffPage() { $request = $this->getContext()->getRequest(); diff --git a/includes/Block.php b/includes/Block.php index 47ddc7d8f2..d2f430ed8b 100644 --- a/includes/Block.php +++ b/includes/Block.php @@ -683,7 +683,7 @@ class Block { if ( $ipblock ) { # Check if the block is an autoblock and would exceed the user block # if renewed. If so, do nothing, otherwise prolong the block time... - if ( $ipblock->mAuto && // @TODO: why not compare $ipblock->mExpiry? + if ( $ipblock->mAuto && // @todo Why not compare $ipblock->mExpiry? $this->mExpiry > Block::getAutoblockExpiry( $ipblock->mTimestamp ) ) { # Reset block timestamp to now and its expiry to diff --git a/includes/DefaultSettings.php b/includes/DefaultSettings.php index 4e19642dff..296b71d1a2 100644 --- a/includes/DefaultSettings.php +++ b/includes/DefaultSettings.php @@ -6331,7 +6331,7 @@ $wgContentHandlerUseDB = true; * of texts are also rendered as wikitext, it only means that links, magic words, etc will have * the effect on the database they would have on a wikitext page. * - * @todo: On the long run, it would be nice to put categories etc into a separate structure, + * @todo On the long run, it would be nice to put categories etc into a separate structure, * or at least parse only the contents of comments in the scripts. * * @since 1.21 diff --git a/includes/EditPage.php b/includes/EditPage.php index c97431a0d8..27f4556bf7 100644 --- a/includes/EditPage.php +++ b/includes/EditPage.php @@ -2138,7 +2138,7 @@ class EditPage { } } - //@todo: add EditForm plugin interface and use it here! + // @todo add EditForm plugin interface and use it here! // search for textarea1 and textares2, and allow EditForm to override all uses. $wgOut->addHTML( Html::openElement( 'form', array( 'id' => self::EDITFORM_ID, 'name' => self::EDITFORM_ID, 'method' => 'post', 'action' => $this->getActionURL( $this->getContextTitle() ), diff --git a/includes/Export.php b/includes/Export.php index e533dbc732..a26e853eff 100644 --- a/includes/Export.php +++ b/includes/Export.php @@ -689,7 +689,7 @@ class XmlDumpWriter { $content_model = strval( $row->rev_content_model ); } else { // probably using $wgContentHandlerUseDB = false; - // @todo: test! + // @todo test! $title = Title::makeTitle( $row->page_namespace, $row->page_title ); $content_model = ContentHandler::getDefaultModelFor( $title ); } @@ -700,7 +700,7 @@ class XmlDumpWriter { $content_format = strval( $row->rev_content_format ); } else { // probably using $wgContentHandlerUseDB = false; - // @todo: test! + // @todo test! $content_handler = ContentHandler::getForModelID( $content_model ); $content_format = $content_handler->getDefaultFormat(); } diff --git a/includes/LinksUpdate.php b/includes/LinksUpdate.php index 8c6d762341..4b1b5b888c 100644 --- a/includes/LinksUpdate.php +++ b/includes/LinksUpdate.php @@ -27,7 +27,7 @@ */ class LinksUpdate extends SqlDataUpdate { - // @todo: make members protected, but make sure extensions don't break + // @todo make members protected, but make sure extensions don't break public $mId, //!< Page ID of the article linked from $mTitle, //!< Title object of the article linked from diff --git a/includes/Revision.php b/includes/Revision.php index 1a7d825003..47626a22b3 100644 --- a/includes/Revision.php +++ b/includes/Revision.php @@ -560,7 +560,7 @@ class Revision implements IDBAccessObject { # if we have a content object, use it to set the model and type if ( !empty( $row['content'] ) ) { - //@todo: when is that set? test with external store setup! check out insertOn() [dk] + // @todo when is that set? test with external store setup! check out insertOn() [dk] if ( !empty( $row['text_id'] ) ) { throw new MWException( "Text already stored in external store (id {$row['text_id']}), " . "can't serialize content object" ); @@ -918,7 +918,7 @@ class Revision implements IDBAccessObject { * to the $audience parameter * * @deprecated in 1.21, use getContent() instead - * @todo: replace usage in core + * @todo Replace usage in core * @return String */ public function getText( $audience = self::FOR_PUBLIC, User $user = null ) { diff --git a/includes/SiteStats.php b/includes/SiteStats.php index 66bc9eeedf..02e1911d6d 100644 --- a/includes/SiteStats.php +++ b/includes/SiteStats.php @@ -258,7 +258,7 @@ class SiteStatsUpdate implements DeferrableUpdate { protected $users = 0; protected $images = 0; - // @TODO: deprecate this constructor + // @todo deprecate this constructor function __construct( $views, $edits, $good, $pages = 0, $users = 0 ) { $this->views = $views; $this->edits = $edits; diff --git a/includes/SqlDataUpdate.php b/includes/SqlDataUpdate.php index 79dcdc5918..51188d85c9 100644 --- a/includes/SqlDataUpdate.php +++ b/includes/SqlDataUpdate.php @@ -56,7 +56,7 @@ abstract class SqlDataUpdate extends DataUpdate { $this->mOptions = array( 'FOR UPDATE' ); } - // @todo: get connection only when it's needed? make sure that doesn't break anything, especially transactions! + // @todo get connection only when it's needed? make sure that doesn't break anything, especially transactions! $this->mDb = wfGetDB( DB_MASTER ); $this->mWithTransaction = $withTransaction; diff --git a/includes/Status.php b/includes/Status.php index 64a3c60f26..f0253df483 100644 --- a/includes/Status.php +++ b/includes/Status.php @@ -234,7 +234,7 @@ class Status { * * @note: this does not perform a full wikitext to HTML conversion, it merely applies * a message transformation. - * @todo: figure out whether that is actually The Right Thing. + * @todo figure out whether that is actually The Right Thing. */ public function getHTML( $shortContext = false, $longContext = false ) { $text = $this->getWikiText( $shortContext, $longContext ); diff --git a/includes/Title.php b/includes/Title.php index c97056f7ca..14915e58ed 100644 --- a/includes/Title.php +++ b/includes/Title.php @@ -944,7 +944,7 @@ class Title { * @return Bool */ public function isConversionTable() { - //@todo: ConversionTable should become a separate content model. + // @todo ConversionTable should become a separate content model. return $this->getNamespace() == NS_MEDIAWIKI && strpos( $this->getText(), 'Conversiontable/' ) === 0; diff --git a/includes/WikiPage.php b/includes/WikiPage.php index da6fff370e..b8f4911a6f 100644 --- a/includes/WikiPage.php +++ b/includes/WikiPage.php @@ -187,7 +187,7 @@ class WikiPage implements Page, IDBAccessObject { * (and only when) $wgActions[$action] === true. This allows subclasses * to override the default behavior. * - * @todo: move this UI stuff somewhere else + * @todo Move this UI stuff somewhere else * * @return Array */ @@ -648,7 +648,7 @@ class WikiPage implements Page, IDBAccessObject { * @return String|false The text of the current revision * @deprecated as of 1.21, getContent() should be used instead. */ - public function getText( $audience = Revision::FOR_PUBLIC, User $user = null ) { // @todo: deprecated, replace usage! + public function getText( $audience = Revision::FOR_PUBLIC, User $user = null ) { // @todo deprecated, replace usage! ContentHandler::deprecated( __METHOD__, '1.21' ); $this->loadLastEdit(); @@ -1175,7 +1175,7 @@ class WikiPage implements Page, IDBAccessObject { } if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) { - // @todo: move this logic to MessageCache + // @todo move this logic to MessageCache if ( $this->exists() ) { // NOTE: use transclusion text for messages. @@ -1459,8 +1459,8 @@ class WikiPage implements Page, IDBAccessObject { * * @return boolean whether sections are supported. * - * @todo: the skin should check this and not offer section functionality if sections are not supported. - * @todo: the EditPage should check this and not offer section functionality if sections are not supported. + * @todo The skin should check this and not offer section functionality if sections are not supported. + * @todo The EditPage should check this and not offer section functionality if sections are not supported. */ public function supportsSections() { return $this->getContentHandler()->supportsSections(); @@ -1956,7 +1956,7 @@ class WikiPage implements Page, IDBAccessObject { $options = $this->getContentHandler()->makeParserOptions( $context ); if ( $this->getTitle()->isConversionTable() ) { - //@todo: ConversionTable should become a separate content model, so we don't need special cases like this one. + // @todo ConversionTable should become a separate content model, so we don't need special cases like this one. $options->disableContentConversion(); } @@ -2110,7 +2110,7 @@ class WikiPage implements Page, IDBAccessObject { DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, 1, $good, $total ) ); DeferredUpdates::addUpdate( new SearchUpdate( $id, $title, $content->getTextForSearchIndex() ) ); - // @TODO: let the search engine decide what to do with the content object + // @todo let the search engine decide what to do with the content object // If this is another user's talk page, update newtalk. // Don't do this if $options['changed'] = false (null-edits) nor if @@ -2673,7 +2673,7 @@ class WikiPage implements Page, IDBAccessObject { * performs permissions checks on $user, then calls commitRollback() * to do the dirty work * - * @todo: separate the business/permission stuff out from backend code + * @todo Separate the business/permission stuff out from backend code * * @param string $fromP Name of the user whose edits to rollback. * @param string $summary Custom summary. Set to default summary if empty. @@ -2941,7 +2941,7 @@ class WikiPage implements Page, IDBAccessObject { * Purge caches on page update etc * * @param $title Title object - * @todo: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title + * @todo Verify that $title is always a Title object (and never false or null), add Title hint to parameter $title */ public static function onArticleEdit( $title ) { // Invalidate caches of articles which include this page @@ -3403,7 +3403,7 @@ class PoolWorkArticleView extends PoolCounterWork { function doWork() { global $wgUseFileCache; - // @todo: several of the methods called on $this->page are not declared in Page, but present + // @todo several of the methods called on $this->page are not declared in Page, but present // in WikiPage and delegated by Article. $isCurrent = $this->revid === $this->page->getLatest(); diff --git a/includes/actions/HistoryAction.php b/includes/actions/HistoryAction.php index 911fd58a62..f43736bea5 100644 --- a/includes/actions/HistoryAction.php +++ b/includes/actions/HistoryAction.php @@ -789,7 +789,7 @@ class HistoryPager extends ReverseChronologicalPager { if ( $this->getNumRows() > 1 ) { $id = $rev->getId(); $radio = array( 'type' => 'radio', 'value' => $id ); - /** @todo: move title texts to javascript */ + /** @todo Move title texts to javascript */ if ( $firstInList ) { $first = Xml::element( 'input', array_merge( $radio, array( diff --git a/includes/api/ApiEditPage.php b/includes/api/ApiEditPage.php index e7e5e1d49a..3d0b42503f 100644 --- a/includes/api/ApiEditPage.php +++ b/includes/api/ApiEditPage.php @@ -146,7 +146,7 @@ class ApiEditPage extends ApiBase { } } - // @todo: Add support for appending/prepending to the Content interface + // @todo Add support for appending/prepending to the Content interface if ( !( $content instanceof TextContent ) ) { $mode = $contentHandler->getModelID(); diff --git a/includes/cache/FileCacheBase.php b/includes/cache/FileCacheBase.php index 7310f61518..d4bf5ee638 100644 --- a/includes/cache/FileCacheBase.php +++ b/includes/cache/FileCacheBase.php @@ -35,7 +35,7 @@ abstract class FileCacheBase { /* lazy loaded */ protected $mCached; - /* @TODO: configurable? */ + /* @todo configurable? */ const MISS_FACTOR = 15; // log 1 every MISS_FACTOR cache misses const MISS_TTL_SEC = 3600; // how many seconds ago is "recent" diff --git a/includes/cache/HTMLFileCache.php b/includes/cache/HTMLFileCache.php index 82334817a9..ab379116e5 100644 --- a/includes/cache/HTMLFileCache.php +++ b/includes/cache/HTMLFileCache.php @@ -182,7 +182,7 @@ class HTMLFileCache extends FileCacheBase { // gzip output to buffer as needed and set headers... if ( $this->useGzip() ) { - // @TODO: ugly wfClientAcceptsGzip() function - use context! + // @todo Ugly wfClientAcceptsGzip() function - use context! if ( wfClientAcceptsGzip() ) { header( 'Content-Encoding: gzip' ); return $compressed; diff --git a/includes/cache/ResourceFileCache.php b/includes/cache/ResourceFileCache.php index 61f1e8c337..2ad7b853cf 100644 --- a/includes/cache/ResourceFileCache.php +++ b/includes/cache/ResourceFileCache.php @@ -29,7 +29,7 @@ class ResourceFileCache extends FileCacheBase { protected $mCacheWorthy; - /* @TODO: configurable? */ + /* @todo configurable? */ const MISS_THRESHOLD = 360; // 6/min * 60 min /** diff --git a/includes/content/Content.php b/includes/content/Content.php index 72729b09b8..5a90e09247 100644 --- a/includes/content/Content.php +++ b/includes/content/Content.php @@ -40,8 +40,8 @@ interface Content { * building a full text search index. If no useful representation exists, * this method returns an empty string. * - * @todo: test that this actually works - * @todo: make sure this also works with LuceneSearch / WikiSearch + * @todo Test that this actually works + * @todo Make sure this also works with LuceneSearch / WikiSearch */ public function getTextForSearchIndex(); @@ -51,11 +51,11 @@ interface Content { * @return string|false The wikitext to include when another page includes this * content, or false if the content is not includable in a wikitext page. * - * @todo allow native handling, bypassing wikitext representation, like - * for includable special pages. - * @todo allow transclusion into other content models than Wikitext! - * @todo used in WikiPage and MessageCache to get message text. Not so - * nice. What should we use instead?! + * @todo Allow native handling, bypassing wikitext representation, like + * for includable special pages. + * @todo Allow transclusion into other content models than Wikitext! + * @todo Used in WikiPage and MessageCache to get message text. Not so + * nice. What should we use instead?! */ public function getWikitextForTransclusion(); diff --git a/includes/content/CssContent.php b/includes/content/CssContent.php index 569d122dc7..03cc2d005c 100644 --- a/includes/content/CssContent.php +++ b/includes/content/CssContent.php @@ -46,7 +46,7 @@ class CssContent extends TextContent { */ public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) { global $wgParser; - // @todo: make pre-save transformation optional for script pages + // @todo Make pre-save transformation optional for script pages $text = $this->getNativeData(); $pst = $wgParser->preSaveTransform( $text, $title, $user, $popts ); diff --git a/includes/content/JavaScriptContent.php b/includes/content/JavaScriptContent.php index 9cd947f9f4..2ae572bec0 100644 --- a/includes/content/JavaScriptContent.php +++ b/includes/content/JavaScriptContent.php @@ -46,7 +46,7 @@ class JavaScriptContent extends TextContent { */ public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) { global $wgParser; - // @todo: make pre-save transformation optional for script pages + // @todo Make pre-save transformation optional for script pages // See bug #32858 $text = $this->getNativeData(); diff --git a/includes/content/TextContent.php b/includes/content/TextContent.php index 8fafcb63b6..f66dacd7c1 100644 --- a/includes/content/TextContent.php +++ b/includes/content/TextContent.php @@ -171,7 +171,7 @@ class TextContent extends AbstractContent { $this->checkModelID( $that->getModel() ); - # @todo: could implement this in DifferenceEngine and just delegate here? + // @todo could implement this in DifferenceEngine and just delegate here? if ( !$lang ) { $lang = $wgContLang; diff --git a/includes/db/DatabaseSqlite.php b/includes/db/DatabaseSqlite.php index 53a4dcfb91..32c7789878 100644 --- a/includes/db/DatabaseSqlite.php +++ b/includes/db/DatabaseSqlite.php @@ -68,7 +68,7 @@ class DatabaseSqlite extends DatabaseBase { } /** - * @todo: check if it should be true like parent class + * @todo Check if it should be true like parent class * * @return bool */ diff --git a/includes/diff/DifferenceEngine.php b/includes/diff/DifferenceEngine.php index 8ee2b82483..4ee5014093 100644 --- a/includes/diff/DifferenceEngine.php +++ b/includes/diff/DifferenceEngine.php @@ -505,7 +505,7 @@ class DifferenceEngine extends ContextSource { if ( $this->mNewPage->isCssJsSubpage() || $this->mNewPage->isCssOrJsPage() ) { // Stolen from Article::view --AG 2007-10-11 // Give hooks a chance to customise the output - // @TODO: standardize this crap into one function + // @todo standardize this crap into one function if ( ContentHandler::runLegacyHooks( 'ShowRawCssJs', array( $this->mNewContent, $this->mNewPage, $out ) ) ) { // NOTE: deprecated hook, B/C only // use the content object's own rendering diff --git a/includes/filebackend/FileOp.php b/includes/filebackend/FileOp.php index 80afcf226e..e4059d7a90 100644 --- a/includes/filebackend/FileOp.php +++ b/includes/filebackend/FileOp.php @@ -64,7 +64,7 @@ abstract class FileOp { final public function __construct( FileBackendStore $backend, array $params ) { $this->backend = $backend; list( $required, $optional ) = $this->allowedParams(); - // @TODO: normalizeAnyStoragePaths() calls are overzealous, use a parameter list + // @todo normalizeAnyStoragePaths() calls are overzealous, use a parameter list foreach ( $required as $name ) { if ( isset( $params[$name] ) ) { // Normalize paths so the paths to the same file have the same string diff --git a/includes/job/jobs/PublishStashedFileJob.php b/includes/job/jobs/PublishStashedFileJob.php index 625e8aa088..5114dc0ea2 100644 --- a/includes/job/jobs/PublishStashedFileJob.php +++ b/includes/job/jobs/PublishStashedFileJob.php @@ -48,7 +48,7 @@ class PublishStashedFileJob extends Job { ); $upload = new UploadFromStash( $user ); - // @TODO: initialize() causes a GET, ideally we could frontload the antivirus + // @todo initialize() causes a GET, ideally we could frontload the antivirus // checks and anything else to the stash stage (which includes concatenation and // the local file is thus already there). That way, instead of GET+PUT, there could // just be a COPY operation from the stash to the public zone. diff --git a/includes/media/SVG.php b/includes/media/SVG.php index 2987588ed9..a133f6f856 100644 --- a/includes/media/SVG.php +++ b/includes/media/SVG.php @@ -263,7 +263,7 @@ class SvgHandler extends ImageHandler { $metadata = array( 'version' => self::SVG_METADATA_VERSION ); try { $metadata += SVGMetadataExtractor::getMetadata( $filename ); - } catch ( MWException $e ) { // @TODO: SVG specific exceptions + } catch ( MWException $e ) { // @todo SVG specific exceptions // File not found, broken, etc. $metadata['error'] = array( 'message' => $e->getMessage(), diff --git a/includes/resourceloader/ResourceLoader.php b/includes/resourceloader/ResourceLoader.php index fcca5a108d..a3c3b10251 100644 --- a/includes/resourceloader/ResourceLoader.php +++ b/includes/resourceloader/ResourceLoader.php @@ -364,7 +364,7 @@ class ResourceLoader { * @return Array */ public function getTestModuleNames( $framework = 'all' ) { - /// @TODO: api siteinfo prop testmodulenames modulenames + /// @todo api siteinfo prop testmodulenames modulenames if ( $framework == 'all' ) { return $this->testModuleNames; } elseif ( isset( $this->testModuleNames[$framework] ) && is_array( $this->testModuleNames[$framework] ) ) { diff --git a/includes/search/SearchSqlite.php b/includes/search/SearchSqlite.php index 71fd021fc1..554181f6e9 100644 --- a/includes/search/SearchSqlite.php +++ b/includes/search/SearchSqlite.php @@ -298,7 +298,7 @@ class SearchSqlite extends SearchEngine { if ( !$this->fulltextSearchSupported() ) { return; } - // @todo: find a method to do it in a single request, + // @todo find a method to do it in a single request, // couldn't do it so far due to typelessness of FTS3 tables. $dbw = wfGetDB( DB_MASTER ); diff --git a/includes/site/MediaWikiSite.php b/includes/site/MediaWikiSite.php index 98004a2967..f3b8a0c7a6 100644 --- a/includes/site/MediaWikiSite.php +++ b/includes/site/MediaWikiSite.php @@ -123,7 +123,7 @@ class MediaWikiSite extends Site { 'converttitles' => true, 'format' => 'json', 'titles' => $pageName, - //@todo: options for maxlag and maxage + // @todo options for maxlag and maxage // Note that maxlag will lead to a long delay before a reply is made, // but that maxage can avoid the extreme delay. On the other hand // maxage could be nice to use anyhow as it stops unnecessary requests. @@ -133,7 +133,7 @@ class MediaWikiSite extends Site { $url = wfAppendQuery( $this->getFileUrl( 'api.php' ), $args ); // Go on call the external site - //@todo: we need a good way to specify a timeout here. + // @todo we need a good way to specify a timeout here. $ret = Http::get( $url ); } diff --git a/includes/specials/SpecialPasswordReset.php b/includes/specials/SpecialPasswordReset.php index df9ed575d4..d1f813696d 100644 --- a/includes/specials/SpecialPasswordReset.php +++ b/includes/specials/SpecialPasswordReset.php @@ -284,7 +284,7 @@ class SpecialPasswordReset extends FormSpecialPage { public function onSuccess() { if ( $this->getUser()->isAllowed( 'passwordreset' ) && $this->email != null ) { - // @todo: Logging + // @todo Logging if ( $this->result->isGood() ) { $this->getOutput()->addWikiMsg( 'passwordreset-emailsent-capture' ); diff --git a/includes/specials/SpecialWatchlist.php b/includes/specials/SpecialWatchlist.php index 0296a63208..a5e2e63bcf 100644 --- a/includes/specials/SpecialWatchlist.php +++ b/includes/specials/SpecialWatchlist.php @@ -99,7 +99,7 @@ class SpecialWatchlist extends SpecialPage { return; } - // @TODO: use FormOptions! + // @todo use FormOptions! $defaults = array( /* float */ 'days' => floatval( $user->getOption( 'watchlistdays' ) ), /* 3.0 or 0.5, watch further below */ /* bool */ 'hideMinor' => (int)$user->getBoolOption( 'watchlisthideminor' ), diff --git a/includes/upload/UploadBase.php b/includes/upload/UploadBase.php index fa62a99d4a..17da80e07a 100644 --- a/includes/upload/UploadBase.php +++ b/includes/upload/UploadBase.php @@ -256,7 +256,7 @@ abstract class UploadBase { wfProfileIn( __METHOD__ ); $repo = RepoGroup::singleton()->getLocalRepo(); if ( $repo->isVirtualUrl( $srcPath ) ) { - // @TODO: just make uploads work with storage paths + // @todo just make uploads work with storage paths // UploadFromStash loads files via virtual URLs $tmpFile = $repo->getLocalCopy( $srcPath ); $tmpFile->bind( $this ); // keep alive with $this diff --git a/languages/LanguageConverter.php b/languages/LanguageConverter.php index 3770b9b1bb..0186ccfe45 100644 --- a/languages/LanguageConverter.php +++ b/languages/LanguageConverter.php @@ -952,7 +952,7 @@ class LanguageConverter { $txt = $revision->getContent( Revision::RAW )->getNativeData(); } - //@todo: in the future, use a specialized content model, perhaps based on json! + // @todo in the future, use a specialized content model, perhaps based on json! } } } diff --git a/maintenance/fuzz-tester.php b/maintenance/fuzz-tester.php index b3d817491b..ca15d74ccb 100644 --- a/maintenance/fuzz-tester.php +++ b/maintenance/fuzz-tester.php @@ -1973,7 +1973,7 @@ class specialChemicalsourcesTest extends pageTest { ** returns the help screen - so currently a lot of the tests aren't actually doing much ** because something wasn't right in the query. ** - ** @todo: Incomplete / unfinished; Runs too fast (suggests not much testing going on). + ** @todo Incomplete / unfinished; Runs too fast (suggests not much testing going on). */ class api extends pageTest { diff --git a/maintenance/namespaceDupes.php b/maintenance/namespaceDupes.php index 61ebe62b94..555feaae07 100644 --- a/maintenance/namespaceDupes.php +++ b/maintenance/namespaceDupes.php @@ -185,7 +185,7 @@ class NamespaceConflictChecker extends Maintenance { } /** - * @todo: do this for reals + * @todo Do this for real * @param $key * @param $prefix * @param $fix diff --git a/resources/Resources.php b/resources/Resources.php index 5bf4061041..ddcefda5c7 100644 --- a/resources/Resources.php +++ b/resources/Resources.php @@ -930,7 +930,7 @@ return array( 'scripts' => 'resources/mediawiki.special/mediawiki.special.undelete.js', ), 'mediawiki.special.upload' => array( - // @TODO: merge in remainder of mediawiki.legacy.upload + // @todo merge in remainder of mediawiki.legacy.upload 'scripts' => 'resources/mediawiki.special/mediawiki.special.upload.js', 'messages' => array( 'widthheight', diff --git a/resources/mediawiki.page/mediawiki.page.watch.ajax.js b/resources/mediawiki.page/mediawiki.page.watch.ajax.js index f945fa9d81..5ba77a14b7 100644 --- a/resources/mediawiki.page/mediawiki.page.watch.ajax.js +++ b/resources/mediawiki.page/mediawiki.page.watch.ajax.js @@ -71,7 +71,7 @@ actionPaths = mw.config.get( 'wgActionPaths' ); - // @todo: Does MediaWiki give action path or query param + // @todo Does MediaWiki give action path or query param // precedence ? If the former, move this to the bottom action = mw.util.getParamValue( 'action', url ); if ( action !== null ) { diff --git a/tests/phpunit/MediaWikiTestCase.php b/tests/phpunit/MediaWikiTestCase.php index 440f866bf2..25ba29efe2 100644 --- a/tests/phpunit/MediaWikiTestCase.php +++ b/tests/phpunit/MediaWikiTestCase.php @@ -173,7 +173,7 @@ abstract class MediaWikiTestCase extends PHPUnit_Framework_TestCase { $this->called['setUp'] = 1; /* - //@todo: global variables to restore for *every* test + // @todo global variables to restore for *every* test array( 'wgLang', 'wgContLang', @@ -847,7 +847,7 @@ abstract class MediaWikiTestCase extends PHPUnit_Framework_TestCase { } // give up - // @todo: Inside a test, we could skip the test as incomplete. + // @todo Inside a test, we could skip the test as incomplete. // But frequently, this is used in fixture setup. throw new MWException( "No namespace defaults to wikitext!" ); } diff --git a/tests/phpunit/includes/LinksUpdateTest.php b/tests/phpunit/includes/LinksUpdateTest.php index ae551c00e5..4e6d3eab6b 100644 --- a/tests/phpunit/includes/LinksUpdateTest.php +++ b/tests/phpunit/includes/LinksUpdateTest.php @@ -147,7 +147,7 @@ class LinksUpdateTest extends MediaWikiTestCase { ) ); } - #@todo: test recursive, too! + // @todo test recursive, too! protected function assertLinksUpdate( Title $title, ParserOutput $parserOutput, $table, $fields, $condition, array $expectedRows ) { $update = new LinksUpdate( $title, $parserOutput ); diff --git a/tests/phpunit/includes/RecentChangeTest.php b/tests/phpunit/includes/RecentChangeTest.php index 56967de947..8e476b31b0 100644 --- a/tests/phpunit/includes/RecentChangeTest.php +++ b/tests/phpunit/includes/RecentChangeTest.php @@ -225,7 +225,7 @@ class RecentChangeTest extends MediaWikiTestCase { } /** - * @todo: Emulate these edits somehow and extract + * @todo Emulate these edits somehow and extract * raw edit summary from RecentChange object * -- */ diff --git a/tests/phpunit/includes/RevisionStorageTest.php b/tests/phpunit/includes/RevisionStorageTest.php index 3b8e5cf84e..00b1f29b87 100644 --- a/tests/phpunit/includes/RevisionStorageTest.php +++ b/tests/phpunit/includes/RevisionStorageTest.php @@ -365,7 +365,7 @@ class RevisionStorageTest extends MediaWikiTestCase { $page = $this->createPage( 'RevisionStorageTest_testIsCurrent', 'Lorem Ipsum', CONTENT_MODEL_WIKITEXT ); $rev1 = $page->getRevision(); - # @todo: find out if this should be true + # @todo find out if this should be true # $this->assertTrue( $rev1->isCurrent() ); $rev1x = Revision::newFromId( $rev1->getId() ); @@ -374,7 +374,7 @@ class RevisionStorageTest extends MediaWikiTestCase { $page->doEditContent( ContentHandler::makeContent( 'Bla bla', $page->getTitle(), CONTENT_MODEL_WIKITEXT ), 'second rev' ); $rev2 = $page->getRevision(); - # @todo: find out if this should be true + # @todo find out if this should be true # $this->assertTrue( $rev2->isCurrent() ); $rev1x = Revision::newFromId( $rev1->getId() ); diff --git a/tests/phpunit/includes/RevisionStorageTest_ContentHandlerUseDB.php b/tests/phpunit/includes/RevisionStorageTest_ContentHandlerUseDB.php index 968aabae97..f35a05f71c 100644 --- a/tests/phpunit/includes/RevisionStorageTest_ContentHandlerUseDB.php +++ b/tests/phpunit/includes/RevisionStorageTest_ContentHandlerUseDB.php @@ -63,7 +63,7 @@ class RevisionTest_ContentHandlerUseDB extends RevisionStorageTest { */ public function testGetContentFormat() { try { - //@todo: change this to test failure on using a non-standard (but supported) format + // @todo change this to test failure on using a non-standard (but supported) format // for a content model supported in the given location. As of 1.21, there are // no alternative formats for any of the standard content models that could be // used for this though. diff --git a/tests/phpunit/includes/TitlePermissionTest.php b/tests/phpunit/includes/TitlePermissionTest.php index b8b0391f86..f0eb76f2da 100644 --- a/tests/phpunit/includes/TitlePermissionTest.php +++ b/tests/phpunit/includes/TitlePermissionTest.php @@ -233,7 +233,7 @@ class TitlePermissionTest extends MediaWikiLangTestCase { if ( $this->isWikitextNS( NS_MAIN ) ) { //NOTE: some content models don't allow moving - //@todo: find a Wikitext namespace for testing + // @todo find a Wikitext namespace for testing $this->setTitle( NS_MAIN ); $this->setUser( 'anon' ); diff --git a/tests/phpunit/includes/WikiPageTest.php b/tests/phpunit/includes/WikiPageTest.php index f829509f77..bf8cd37e93 100644 --- a/tests/phpunit/includes/WikiPageTest.php +++ b/tests/phpunit/includes/WikiPageTest.php @@ -569,7 +569,7 @@ class WikiPageTest extends MediaWikiLangTestCase { public static function provideGetParserOutput() { return array( array( CONTENT_MODEL_WIKITEXT, "hello ''world''\n", "

hello world

" ), - // @todo: more...? + // @todo more...? ); } @@ -609,7 +609,7 @@ class WikiPageTest extends MediaWikiLangTestCase { $opt = new ParserOptions(); $po = $page->getParserOutput( $opt, $page->getLatest() + 1234 ); - //@todo: would be neat to also test deleted revision + // @todo would be neat to also test deleted revision $this->assertFalse( $po, "getParserOutput() shall return false for non-existing revisions." ); } diff --git a/tests/phpunit/includes/content/JavaScriptContentTest.php b/tests/phpunit/includes/content/JavaScriptContentTest.php index 6632edd57a..5c1ff8fb99 100644 --- a/tests/phpunit/includes/content/JavaScriptContentTest.php +++ b/tests/phpunit/includes/content/JavaScriptContentTest.php @@ -137,7 +137,7 @@ class JavaScriptContentTest extends TextContentTest { } /** - * @todo: test needs database! + * @todo Test needs database! */ /* public function getRedirectChain() { @@ -147,7 +147,7 @@ class JavaScriptContentTest extends TextContentTest { */ /** - * @todo: test needs database! + * @todo Test needs database! */ /* public function getUltimateRedirectTarget() { diff --git a/tests/phpunit/includes/content/TextContentTest.php b/tests/phpunit/includes/content/TextContentTest.php index 28c006cc3e..c7138b7dde 100644 --- a/tests/phpunit/includes/content/TextContentTest.php +++ b/tests/phpunit/includes/content/TextContentTest.php @@ -162,7 +162,7 @@ class TextContentTest extends MediaWikiLangTestCase { } /** - * @todo: test needs database! Should be done by a test class in the Database group. + * @todo Test needs database! Should be done by a test class in the Database group. */ /* public function getRedirectChain() { @@ -172,7 +172,7 @@ class TextContentTest extends MediaWikiLangTestCase { */ /** - * @todo: test needs database! Should be done by a test class in the Database group. + * @todo Test needs database! Should be done by a test class in the Database group. */ /* public function getUltimateRedirectTarget() { diff --git a/tests/phpunit/includes/content/WikitextContentTest.php b/tests/phpunit/includes/content/WikitextContentTest.php index c9eecf7f64..37b01fdeaf 100644 --- a/tests/phpunit/includes/content/WikitextContentTest.php +++ b/tests/phpunit/includes/content/WikitextContentTest.php @@ -240,7 +240,7 @@ just a test" } /** - * @todo: test needs database! Should be done by a test class in the Database group. + * @todo Test needs database! Should be done by a test class in the Database group. */ /* public function getRedirectChain() { @@ -250,7 +250,7 @@ just a test" */ /** - * @todo: test needs database! Should be done by a test class in the Database group. + * @todo Test needs database! Should be done by a test class in the Database group. */ /* public function getUltimateRedirectTarget() { @@ -380,7 +380,7 @@ just a test" CONTENT_MODEL_WIKITEXT, "hello [[world test 21344]]\n", array( 'LinksDeletionUpdate' => array() ) ), - // @todo: more...? + // @todo more...? ); } } diff --git a/tests/phpunit/includes/db/DatabaseSqliteTest.php b/tests/phpunit/includes/db/DatabaseSqliteTest.php index b272d73e23..91ab33a722 100644 --- a/tests/phpunit/includes/db/DatabaseSqliteTest.php +++ b/tests/phpunit/includes/db/DatabaseSqliteTest.php @@ -233,7 +233,7 @@ class DatabaseSqliteTest extends MediaWikiTestCase { /** * Runs upgrades of older databases and compares results with current schema - * @todo: currently only checks list of tables + * @todo Currently only checks list of tables */ public function testUpgrades() { global $IP, $wgVersion, $wgProfileToDatabase; diff --git a/tests/phpunit/includes/filebackend/FileBackendTest.php b/tests/phpunit/includes/filebackend/FileBackendTest.php index 529d8cb379..013bbe256b 100644 --- a/tests/phpunit/includes/filebackend/FileBackendTest.php +++ b/tests/phpunit/includes/filebackend/FileBackendTest.php @@ -1460,7 +1460,7 @@ class FileBackendTest extends MediaWikiTestCase { } } - // @TODO: testSecure + // @todo testSecure public function testDoOperations() { $this->backend = $this->singleBackend; diff --git a/tests/phpunit/includes/jobqueue/JobQueueTest.php b/tests/phpunit/includes/jobqueue/JobQueueTest.php index 787b43109f..7b3d0eadc4 100644 --- a/tests/phpunit/includes/jobqueue/JobQueueTest.php +++ b/tests/phpunit/includes/jobqueue/JobQueueTest.php @@ -47,7 +47,9 @@ class JobQueueTest extends MediaWikiTestCase { $this->$q->setTestingPrefix( 'unittests-' . wfRandomString( 32 ) ); } } catch ( MWException $e ) { - }; // unsupported? (@TODO: what if it was another error?) + // unsupported? + // @todo What if it was another error? + }; } } diff --git a/tests/phpunit/includes/parser/NewParserTest.php b/tests/phpunit/includes/parser/NewParserTest.php index f41c71cc76..e0158a2861 100644 --- a/tests/phpunit/includes/parser/NewParserTest.php +++ b/tests/phpunit/includes/parser/NewParserTest.php @@ -554,7 +554,7 @@ class NewParserTest extends MediaWikiTestCase { if ( !$this->isWikitextNS( NS_MAIN ) ) { // parser tests frequently assume that the main namespace contains wikitext. - // @todo: When setting up pages, force the content model. Only skip if + // @todo When setting up pages, force the content model. Only skip if // $wgtContentModelUseDB is false. $this->markTestSkipped( "Main namespace does not support wikitext," . "skipping parser test: $desc" ); diff --git a/tests/phpunit/includes/search/SearchEngineTest.php b/tests/phpunit/includes/search/SearchEngineTest.php index 47c47f646b..8957a2f38e 100644 --- a/tests/phpunit/includes/search/SearchEngineTest.php +++ b/tests/phpunit/includes/search/SearchEngineTest.php @@ -45,7 +45,7 @@ class SearchEngineTest extends MediaWikiLangTestCase { } if ( !$this->isWikitextNS( NS_MAIN ) ) { - //@todo: cover the case of non-wikitext content in the main namespace + // @todo cover the case of non-wikitext content in the main namespace return; } diff --git a/tests/phpunit/maintenance/backupTextPassTest.php b/tests/phpunit/maintenance/backupTextPassTest.php index 7fe48dd947..653a11456a 100644 --- a/tests/phpunit/maintenance/backupTextPassTest.php +++ b/tests/phpunit/maintenance/backupTextPassTest.php @@ -63,7 +63,7 @@ class TextPassDumperTest extends DumpTestCase { // Page from non-default namespace if ( $ns === NS_TALK ) { - //@todo: work around this. + // @todo work around this. throw new MWException( "The default wikitext namespace is the talk namespace. " . " We can't currently deal with that." ); } diff --git a/tests/phpunit/maintenance/backup_PageTest.php b/tests/phpunit/maintenance/backup_PageTest.php index 535e61ecb7..99bd2700be 100644 --- a/tests/phpunit/maintenance/backup_PageTest.php +++ b/tests/phpunit/maintenance/backup_PageTest.php @@ -34,7 +34,7 @@ class BackupDumperPageTest extends DumpTestCase { $this->talk_namespace = NS_TALK; if ( $this->namespace === $this->talk_namespace ) { - //@todo: work around this. + // @todo work around this. throw new MWException( "The default wikitext namespace is the talk namespace. " . " We can't currently deal with that." ); } diff --git a/thumb.php b/thumb.php index 04ba29cc6a..4a0c9fb3d3 100644 --- a/thumb.php +++ b/thumb.php @@ -122,7 +122,7 @@ function wfStreamThumb( array $params ) { $img = new UnregisteredLocalFile( null, $repo, # Temp files are hashed based on the name without the timestamp. # The thumbnails will be hashed based on the entire name however. - # @TODO: fix this convention to actually be reasonable. + # @todo fix this convention to actually be reasonable. $repo->getZonePath( 'public' ) . '/' . $repo->getTempHashPath( $fileName ) . $fileName ); } elseif ( $isOld ) { -- 2.20.1