* 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
*/
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
* 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
* 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
*/
/**
* 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).
*
* 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.
* 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.
*/
* 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.
/**
* 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
*
* 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 {
/**
* 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.
*
* 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
*
* 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 */
* @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;
* 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
* 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
*/
* 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
*/
/**
* 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).
/**
* 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
/**
* 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.
* 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
/**
* 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
*
/**
* 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
*
* 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
*/
*
* @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
* @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 {
* 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(
dépôts / lhc / web / wiklou.git / commitdiff