will be allowed in files with + * crap files as images. When this directive is on, "<title>" will be allowed in files with * an "image/svg+xml" MIME type. You should leave this disabled if your web server is misconfigured * and doesn't send appropriate MIME types for SVG images. */ @@ -820,7 +820,7 @@ $wgMaxAnimatedGifArea = 1.25e7; $wgThumbnailEpoch = '20030516000000'; /** - * If set, inline scaled images will still produce <img> tags ready for + * If set, inline scaled images will still produce "<img>" tags ready for * output instead of showing an error message. * * This may be useful if errors are transitory, especially if the site @@ -998,7 +998,7 @@ $wgThumbLimits = array( ); /** - * Default parameters for the <gallery> tag + * Default parameters for the "<gallery>" tag */ $wgGalleryOptions = array ( 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize @@ -2360,7 +2360,7 @@ $wgWellFormedXml = true; * Use the prefix for the key and the namespace for the value. For * example: * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg'; - * Normally we wouldn't have to define this in the root <html> + * Normally we wouldn't have to define this in the root "<html>" * element, but IE needs it there in some circumstances. * * This is ignored if $wgHtml5 is true, for the same reason as @@ -2748,7 +2748,7 @@ $wgResourceLoaderValidateJS = true; $wgResourceLoaderValidateStaticJS = false; /** - * If set to true, asynchronous loading of bottom-queue scripts in the <head> + * If set to true, asynchronous loading of bottom-queue scripts in the "<head>" * will be enabled. This is an experimental feature that's supposed to make * JavaScript load faster. */ @@ -3063,7 +3063,7 @@ $wgAllowExternalImagesFrom = ''; $wgEnableImageWhitelist = true; /** - * A different approach to the above: simply allow the <img> tag to be used. + * A different approach to the above: simply allow the "<img>" tag to be used. * This allows you to specify alt text and other attributes, copy-paste HTML to * your wiki more easily, etc. However, allowing external images in any manner * will allow anyone with editing rights to snoop on your visitors' IP @@ -3105,7 +3105,7 @@ $wgTidyInternal = extension_loaded( 'tidy' ); */ $wgDebugTidy = false; -/** Allow raw, unchecked HTML in <html>...</html> sections. +/** Allow raw, unchecked HTML in "<html>...</html>" sections. * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions * TO RESTRICT EDITING to only those that you trust */ @@ -3373,7 +3373,7 @@ $wgInvalidUsernameCharacters = '@'; /** * Character used as a delimiter when testing for interwiki userrights * (In Special:UserRights, it is possible to modify users on different - * databases if the delimiter is used, e.g. Someuser@enwiki). + * databases if the delimiter is used, e.g. "Someuser@enwiki"). * * It is recommended that you have this delimiter in * $wgInvalidUsernameCharacters above, or you will not be able to @@ -5184,7 +5184,7 @@ $wgLogRestrictions = array( * hidden by default unless the link is clicked. Import logs will be shown by * default, and hidden when the link is clicked. * - * A message of the form log-show-hide-<type> should be added, and will be used + * A message of the form log-show-hide-[type] should be added, and will be used * for the link text. */ $wgFilterLogTypes = array( @@ -5434,7 +5434,7 @@ $wgMaxRedirectLinksRetrieved = 500; */ /** - * Array of allowed values for the title=foo&action=<action> parameter. Syntax is: + * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is: * 'foo' => 'ClassName' Load the specified class which subclasses Action * 'foo' => true Load the class FooAction which subclasses Action * If something is specified in the getActionOverrides() diff --git a/includes/EditPage.php b/includes/EditPage.php index 1f526cce3e..1376d579e4 100644 --- a/includes/EditPage.php +++ b/includes/EditPage.php @@ -2992,8 +2992,8 @@ HTML * failure, etc). * * @todo This doesn't include category or interlanguage links. - * Would need to enhance it a bit, <s>maybe wrap them in XML - * or something...</s> that might also require more skin + * Would need to enhance it a bit, "<s>maybe wrap them in XML + * or something...</s>" that might also require more skin * initialization, so check whether that's a problem. */ function livePreview() { diff --git a/includes/Export.php b/includes/Export.php index 36d98d681b..92cfa1e4ee 100644 --- a/includes/Export.php +++ b/includes/Export.php @@ -472,7 +472,7 @@ class XmlDumpWriter { } /** - * Opens the XML output stream's root <mediawiki> element. + * Opens the XML output stream's root "<mediawiki>" element. * This does not include an xml directive, so is safe to include * as a subelement in a larger XML stream. Namespace and XML Schema * references are included. @@ -572,7 +572,7 @@ class XmlDumpWriter { } /** - * Opens a <page> section on the output stream, with data + * Opens a "<page>" section on the output stream, with data * from the given database row. * * @param $row object @@ -604,7 +604,7 @@ class XmlDumpWriter { } /** - * Closes a <page> section on the output stream. + * Closes a "<page>" section on the output stream. * * @access private * @return string @@ -614,7 +614,7 @@ class XmlDumpWriter { } /** - * Dumps a <revision> section on the output stream, with + * Dumps a "<revision>" section on the output stream, with * data filled in from the given database row. * * @param $row object @@ -678,7 +678,7 @@ class XmlDumpWriter { } /** - * Dumps a <logitem> section on the output stream, with + * Dumps a "<logitem>" section on the output stream, with * data filled in from the given database row. * * @param $row object @@ -815,7 +815,7 @@ class XmlDumpWriter { * Return prefixed text form of title, but using the content language's * canonical namespace. This skips any special-casing such as gendered * user namespaces -- which while useful, are not yet listed in the - * XML <siteinfo> data so are unsafe in export. + * XML "<siteinfo>" data so are unsafe in export. * * @param Title $title * @return string diff --git a/includes/GlobalFunctions.php b/includes/GlobalFunctions.php index 7e759580de..1a21e205bb 100644 --- a/includes/GlobalFunctions.php +++ b/includes/GlobalFunctions.php @@ -2063,7 +2063,7 @@ function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) { * Escapes the given text so that it may be output using addWikiText() * without any linking, formatting, etc. making its way through. This * is achieved by substituting certain characters with HTML entities. - * As required by the callers, <nowiki> is not used. + * As required by the callers, "<nowiki>" is not used. * * @param $text String: text to be escaped * @return String @@ -3192,7 +3192,7 @@ function wfUseMW( $req_ver ) { /** * Return the final portion of a pathname. - * Reimplemented because PHP5's basename() is buggy with multibyte text. + * Reimplemented because PHP5's "basename()" is buggy with multibyte text. * http://bugs.php.net/bug.php?id=33898 * * PHP's basename() only considers '\' a pathchar on Windows and Netware. diff --git a/includes/HTMLForm.php b/includes/HTMLForm.php index 36008fb337..9ced19e993 100644 --- a/includes/HTMLForm.php +++ b/includes/HTMLForm.php @@ -546,7 +546,7 @@ class HTMLForm extends ContextSource { } /** - * Wrap the form innards in an actual <form> element + * Wrap the form innards in an actual "<form>" element * @param $html String HTML contents to wrap. * @return String wrapped HTML. */ @@ -761,16 +761,16 @@ class HTMLForm extends ContextSource { $this->mId = $id; } /** - * Prompt the whole form to be wrapped in a <fieldset>, with - * this text as its <legend> element. - * @param $legend String HTML to go inside the <legend> element. + * Prompt the whole form to be wrapped in a "<fieldset>", with + * this text as its "<legend>" element. + * @param $legend String HTML to go inside the "<legend>" element. * Will be escaped */ public function setWrapperLegend( $legend ) { $this->mWrapperLegend = $legend; } /** - * Prompt the whole form to be wrapped in a <fieldset>, with - * this message as its <legend> element. + * Prompt the whole form to be wrapped in a "<fieldset>", with + * this message as its "<legend>" element. * @since 1.19 * @param $msg String message key */ @@ -780,7 +780,7 @@ class HTMLForm extends ContextSource { /** * Set the prefix for various default messages - * TODO: currently only used for the <fieldset> legend on forms + * @todo currently only used for the "<fieldset>" legend on forms * with multiple sections; should be used elsewhre? * @param $p String */ @@ -819,10 +819,10 @@ class HTMLForm extends ContextSource { } /** - * TODO: Document + * @todo Document * @param $fields array[]|HTMLFormField[] array of fields (either arrays or objects) - * @param $sectionName string ID attribute of the <table> tag for this section, ignored if empty - * @param $fieldsetIDPrefix string ID prefix for the <fieldset> tag of each subsection, ignored if empty + * @param $sectionName string ID attribute of the "<table>" tag for this section, ignored if empty + * @param $fieldsetIDPrefix string ID prefix for the "<fieldset>" tag of each subsection, ignored if empty * @return String */ public function displaySection( $fields, $sectionName = '', $fieldsetIDPrefix = '' ) { @@ -938,8 +938,8 @@ class HTMLForm extends ContextSource { } /** - * Get a string to go in the <legend> of a section fieldset. Override this if you - * want something more complicated + * Get a string to go in the "<legend>" of a section fieldset. + * Override this if you want something more complicated. * @param $key String * @return String */ @@ -1350,7 +1350,7 @@ abstract class HTMLFormField { /** * flatten an array of options to a single array, for instance, - * a set of <options> inside <optgroups>. + * a set of "<options>" inside "<optgroups>". * @param $options array Associative Array with values either Strings * or Arrays * @return Array flattened input @@ -1889,7 +1889,7 @@ class HTMLMultiSelectField extends HTMLFormField { * ** <option value> * * New Optgroup header * Plus a text field underneath for an additional reason. The 'value' of the field is - * ""<select>: <extra reason>"", or "<extra reason>" if nothing has been selected in the + * "<select>: <extra reason>", or "<extra reason>" if nothing has been selected in the * select dropdown. * @todo FIXME: If made 'required', only the text field should be compulsory. */ diff --git a/includes/Html.php b/includes/Html.php index 3986a7b100..7fa98e1290 100644 --- a/includes/Html.php +++ b/includes/Html.php @@ -548,9 +548,10 @@ class Html { } /** - * Output a <script> tag with the given contents. TODO: do some useful - * escaping as well, like if $contents contains literal '</script>' or (for - * XML) literal "]]>". + * Output a "<script>" tag with the given contents. + * + * @todo do some useful escaping as well, like if $contents contains + * literal "</script>" or (for XML) literal "]]>". * * @param $contents string JavaScript * @return string Raw HTML @@ -572,8 +573,8 @@ class Html { } /** - * Output a <script> tag linking to the given URL, e.g., - * <script src=foo.js></script>. + * Output a "<script>" tag linking to the given URL, e.g., + * "<script src=foo.js></script>". * * @param $url string * @return string Raw HTML @@ -591,9 +592,9 @@ class Html { } /** - * Output a <style> tag with the given contents for the given media type + * Output a "<style>" tag with the given contents for the given media type * (if any). TODO: do some useful escaping as well, like if $contents - * contains literal '</style>' (admittedly unlikely). + * contains literal "</style>" (admittedly unlikely). * * @param $contents string CSS * @param $media mixed A media type string, like 'screen' @@ -613,7 +614,7 @@ class Html { } /** - * Output a <link rel=stylesheet> linking to the given URL for the given + * Output a "<link rel=stylesheet>" linking to the given URL for the given * media type (if any). * * @param $url string @@ -630,7 +631,7 @@ class Html { } /** - * Convenience function to produce an <input> element. This supports the + * Convenience function to produce an "<input>" element. This supports the * new HTML5 input types and attributes, and will silently strip them if * $wgHtml5 is false. * @@ -663,11 +664,12 @@ class Html { } /** - * Convenience function to produce an <input> element. This supports leaving - * out the cols= and rows= which Xml requires and are required by HTML4/XHTML - * but not required by HTML5 and will silently set cols="" and rows="" if - * $wgHtml5 is false and cols and rows are omitted (HTML4 validates present - * but empty cols="" and rows="" as valid). + * Convenience function to produce an "<input>" element. + * + * This supports leaving out the cols= and rows= which Xml requires and are + * required by HTML4/XHTML but not required by HTML5 and will silently set + * cols="" and rows="" if $wgHtml5 is false and cols and rows are omitted + * (HTML4 validates present but empty cols="" and rows="" as valid). * * @param $name string name attribute * @param $value string value attribute @@ -706,7 +708,7 @@ class Html { * * @param $params array: * - selected: [optional] Id of namespace which should be pre-selected - * - all: [optional] Value of item for "all namespaces". If null or unset, no <option> is generated to select all namespaces + * - all: [optional] Value of item for "all namespaces". If null or unset, no "<option>" is generated to select all namespaces * - label: text for label to add before the field * - exclude: [optional] Array of namespace ids to exclude * - disable: [optional] Array of namespace ids for which the option should be disabled in the selector diff --git a/includes/Import.php b/includes/Import.php index 9ebc34c91b..491ec0936e 100644 --- a/includes/Import.php +++ b/includes/Import.php @@ -1,6 +1,6 @@ <?php /** - * MediaWiki page data importer + * MediaWiki page data importer. * * Copyright Â© 2003,2005 Brion Vibber <brion@pobox.com> * http://www.mediawiki.org/ @@ -275,7 +275,7 @@ class WikiImporter { } /** - * Notify the callback function when a new <page> is reached. + * Notify the callback function when a new "<page>" is reached. * @param $title Title */ function pageCallback( $title ) { @@ -285,7 +285,7 @@ class WikiImporter { } /** - * Notify the callback function when a </page> is closed. + * Notify the callback function when a "</page>" is closed. * @param $title Title * @param $origTitle Title * @param $revCount Integer diff --git a/includes/MagicWord.php b/includes/MagicWord.php index 9745b9ada2..997034cf46 100644 --- a/includes/MagicWord.php +++ b/includes/MagicWord.php @@ -24,7 +24,7 @@ */ /** - * This class encapsulates "magic words" such as #redirect, __NOTOC__, etc. + * This class encapsulates "magic words" such as "#redirect", __NOTOC__, etc. * * @par Usage: * @code @@ -42,7 +42,7 @@ * * To add magic words in an extension, use $magicWords in a file listed in * $wgExtensionMessagesFiles[]. - * + * * @par Example: * @code * $magicWords = array(); diff --git a/includes/OutputPage.php b/includes/OutputPage.php index c00cfbe2b0..a2023f50a9 100644 --- a/includes/OutputPage.php +++ b/includes/OutputPage.php @@ -36,10 +36,10 @@ * @todo document */ class OutputPage extends ContextSource { - /// Should be private. Used with addMeta() which adds <meta> + /// Should be private. Used with addMeta() which adds "<meta>" var $mMetatags = array(); - /// <meta keywords="stuff"> most of the time the first 10 links to an article + /// "<meta keywords='stuff'>" most of the time the first 10 links to an article var $mKeywords = array(); var $mLinktags = array(); @@ -50,7 +50,7 @@ class OutputPage extends ContextSource { /// Should be private - has getter and setter. Contains the HTML title var $mPagetitle = ''; - /// Contains all of the <body> content. Should be private we got set/get accessors and the append() method. + /// Contains all of the "<body>" content. Should be private we got set/get accessors and the append() method. var $mBodytext = ''; /** @@ -60,7 +60,7 @@ class OutputPage extends ContextSource { */ public $mDebugtext = ''; // TODO: we might want to replace it by wfDebug() wfDebugLog() - /// Should be private. Stores contents of <title> tag + /// Should be private. Stores contents of "<title>" tag var $mHTMLtitle = ''; /// Should be private. Is the displayed content related to the source of the corresponding wiki article. @@ -116,8 +116,8 @@ class OutputPage extends ContextSource { /** * Should be private. Used for JavaScript (pre resource loader) * We should split js / css. - * mScripts content is inserted as is in <head> by Skin. This might contains - * either a link to a stylesheet or inline css. + * mScripts content is inserted as is in "<head>" by Skin. This might + * contains either a link to a stylesheet or inline css. */ var $mScripts = ''; @@ -135,7 +135,7 @@ class OutputPage extends ContextSource { */ var $mPageLinkTitle = ''; - /// Array of elements in <head>. Parser might add its own headers! + /// Array of elements in "<head>". Parser might add its own headers! var $mHeadItems = array(); // @todo FIXME: Next variables probably comes from the resource loader @@ -197,7 +197,7 @@ class OutputPage extends ContextSource { /** * Comes from the parser. This was probably made to load CSS/JS only - * if we had <gallery>. Used directly in CategoryPage.php + * if we had "<gallery>". Used directly in CategoryPage.php * Looks like resource loader can replace this. */ var $mNoGallery = false; @@ -292,7 +292,7 @@ class OutputPage extends ContextSource { } /** - * Add a new <meta> tag + * Add a new "<meta>" tag * To add an http-equiv meta tag, precede the name with "http:" * * @param $name String tag name @@ -405,7 +405,7 @@ class OutputPage extends ContextSource { /** * Add a self-contained script tag with the given contents * - * @param $script String: JavaScript text, no <script> tags + * @param $script String: JavaScript text, no "<script>" tags */ public function addInlineScript( $script ) { $this->mScripts .= Html::inlineScript( "\n$script\n" ) . "\n"; @@ -779,7 +779,7 @@ class OutputPage extends ContextSource { } /** - * "HTML title" means the contents of <title>. + * "HTML title" means the contents of "<title>". * It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file. * * @param $name string @@ -793,7 +793,7 @@ class OutputPage extends ContextSource { } /** - * Return the "HTML title", i.e. the content of the <title> tag. + * Return the "HTML title", i.e. the content of the "<title>" tag. * * @return String */ @@ -2023,11 +2023,11 @@ class OutputPage extends ContextSource { /** * Prepare this object to display an error page; disable caching and * indexing, clear the current text and redirect, set the page's title - * and optionally an custom HTML title (content of the <title> tag). + * and optionally an custom HTML title (content of the "<title>" tag). * * @param $pageTitle String|Message will be passed directly to setPageTitle() * @param $htmlTitle String|Message will be passed directly to setHTMLTitle(); - * optional, if not passed the <title> attribute will be + * optional, if not passed the "<title>" attribute will be * based on $pageTitle */ public function prepareErrorPage( $pageTitle, $htmlTitle = false ) { @@ -2391,7 +2391,7 @@ $templates /** * @param $sk Skin The given Skin * @param $includeStyle Boolean: unused - * @return String: The doctype, opening <html>, and head element. + * @return String: The doctype, opening "<html>", and head element. */ public function headElement( Skin $sk, $includeStyle = true ) { global $wgContLang; @@ -2516,8 +2516,8 @@ $templates * @param $only String ResourceLoaderModule TYPE_ class constant * @param $useESI boolean * @param $extraQuery Array with extra query parameters to add to each request. array( param => value ) - * @param $loadCall boolean If true, output an (asynchronous) mw.loader.load() call rather than a <script src="..."> tag - * @return string html <script> and <style> tags + * @param $loadCall boolean If true, output an (asynchronous) mw.loader.load() call rather than a "<script src='...'>" tag + * @return string html "<script>" and "<style>" tags */ protected function makeResourceLoaderLink( $modules, $only, $useESI = false, array $extraQuery = array(), $loadCall = false ) { global $wgResourceLoaderUseESI; @@ -2696,7 +2696,7 @@ $templates } /** - * JS stuff to put in the <head>. This is the startup module, config + * JS stuff to put in the "<head>". This is the startup module, config * vars and modules marked with position 'top' * * @return String: HTML fragment @@ -2744,12 +2744,12 @@ $templates } /** - * JS stuff to put at the 'bottom', which can either be the bottom of the <body> - * or the bottom of the <head> depending on $wgResourceLoaderExperimentalAsyncLoading: + * JS stuff to put at the 'bottom', which can either be the bottom of the "<body>" + * or the bottom of the "<head>" depending on $wgResourceLoaderExperimentalAsyncLoading: * modules marked with position 'bottom', legacy scripts ($this->mScripts), * user preferences, site JS and user JS * - * @param $inHead boolean If true, this HTML goes into the <head>, if false it goes into the <body> + * @param $inHead boolean If true, this HTML goes into the "<head>", if false it goes into the "<body>" * @return string */ function getScriptsForBottomQueue( $inHead ) { @@ -2865,7 +2865,7 @@ $templates } /** - * JS stuff to put at the bottom of the <body> + * JS stuff to put at the bottom of the "<body>" * @return string */ function getBottomScripts() { @@ -3016,7 +3016,7 @@ $templates } /** - * @param $addContentType bool: Whether <meta> specifying content type should be returned + * @param $addContentType bool: Whether "<meta>" specifying content type should be returned * * @return array in format "link name or number => 'link html'". */ @@ -3250,7 +3250,7 @@ $templates /** * @param $unused - * @param $addContentType bool: Whether <meta> specifying content type should be returned + * @param $addContentType bool: Whether "<meta>" specifying content type should be returned * * @return string HTML tag links to be put in the header. */ @@ -3259,7 +3259,7 @@ $templates } /** - * Generate a <link rel/> for a feed. + * Generate a "<link rel/>" for a feed. * * @param $type String: feed type * @param $url String: URL to the feed @@ -3314,7 +3314,7 @@ $templates } /** - * Build a set of <link>s for the stylesheets specified in the $this->styles array. + * Build a set of "<link>" elements for the stylesheets specified in the $this->styles array. * These will be applied to various media & IE conditionals. * * @return string diff --git a/includes/Pager.php b/includes/Pager.php index 750636d0bb..f80e05d0ad 100644 --- a/includes/Pager.php +++ b/includes/Pager.php @@ -993,7 +993,7 @@ abstract class TablePager extends IndexPager { * @protected * * @param $row Object: the database result row - * @return Array of <attr> => <value> + * @return Array of attribute => value */ function getRowAttrs( $row ) { $class = $this->getRowClass( $row ); @@ -1108,7 +1108,7 @@ abstract class TablePager extends IndexPager { } /** - * Get a <select> element which has options for each of the allowed limits + * Get a "<select>" element which has options for each of the allowed limits * * @return String: HTML fragment */ @@ -1138,7 +1138,7 @@ abstract class TablePager extends IndexPager { } /** - * Get <input type="hidden"> elements for use in a method="get" form. + * Get \<input type="hidden"\> elements for use in a method="get" form. * Resubmits all defined elements of the query string, except for a * blacklist, passed in the $blacklist parameter. * diff --git a/includes/Preferences.php b/includes/Preferences.php index bf63d652d4..e798d3d90e 100644 --- a/includes/Preferences.php +++ b/includes/Preferences.php @@ -1587,7 +1587,7 @@ class PreferencesForm extends HTMLForm { } /** - * Get the <legend> for a given section key. Normally this is the + * Get the "<legend>" for a given section key. Normally this is the * prefs-$key message but we'll allow extensions to override it. * @param $key string * @return string diff --git a/includes/RevisionList.php b/includes/RevisionList.php index fc777b5b04..3c5cfa8ea2 100644 --- a/includes/RevisionList.php +++ b/includes/RevisionList.php @@ -245,7 +245,7 @@ abstract class RevisionItemBase { abstract public function canViewContent(); /** - * Get the HTML of the list item. Should be include <li></li> tags. + * Get the HTML of the list item. Should be include "<li></li>" tags. * This is used to show the list in HTML form, by the special page. */ abstract public function getHTML(); diff --git a/includes/Sanitizer.php b/includes/Sanitizer.php index fed5762c00..a0c77da758 100644 --- a/includes/Sanitizer.php +++ b/includes/Sanitizer.php @@ -1253,7 +1253,7 @@ class Sanitizer { * a. named char refs can only be < > & ", others are * numericized (this way we're well-formed even without a DTD) * b. any numeric char refs must be legal chars, not invalid or forbidden - * c. use &#x, not &#X + * c. use lower cased "&#x", not "&#X" * d. fix or reject non-valid attributes * * @param $text String @@ -1421,7 +1421,7 @@ class Sanitizer { /** * If the named entity is defined in the HTML 4.0/XHTML 1.0 DTD, * return the UTF-8 encoding of that character. Otherwise, returns - * pseudo-entity source (eg &foo;) + * pseudo-entity source (eg "&foo;") * * @param $name String * @return String diff --git a/includes/Skin.php b/includes/Skin.php index 8d47b83d0f..ac9da93862 100644 --- a/includes/Skin.php +++ b/includes/Skin.php @@ -326,7 +326,7 @@ abstract class Skin extends ContextSource { } /** - * Make a <script> tag containing global variables + * Make a "<script>" tag containing global variables * * @deprecated in 1.19 * @param $unused @@ -397,7 +397,7 @@ abstract class Skin extends ContextSource { /** * This will be called by OutputPage::headElement when it is creating the - * <body> tag, skins can override it if they have a need to add in any + * "<body>" tag, skins can override it if they have a need to add in any * body attributes or classes of their own. * @param $out OutputPage * @param $bodyAttrs Array @@ -636,9 +636,9 @@ abstract class Skin extends ContextSource { } /** - * This gets called shortly before the </body> tag. + * This gets called shortly before the "</body>" tag. * - * @return String HTML-wrapped JS code to be put before </body> + * @return String HTML-wrapped JS code to be put before "</body>" */ function bottomScripts() { // TODO and the suckage continues. This function is really just a wrapper around diff --git a/includes/SkinLegacy.php b/includes/SkinLegacy.php index 18bc29f3e2..63852505f5 100644 --- a/includes/SkinLegacy.php +++ b/includes/SkinLegacy.php @@ -95,7 +95,7 @@ class LegacyTemplate extends BaseTemplate { } /** - * This will be called immediately after the <body> tag. Split into + * This will be called immediately after the "<body>" tag. Split into * two functions to make it easier to subclass. * @return string */ @@ -159,8 +159,8 @@ class LegacyTemplate extends BaseTemplate { } /** - * This gets called shortly before the </body> tag. - * @return String HTML to be put before </body> + * This gets called shortly before the "</body>" tag. + * @return String HTML to be put before "</body>" */ function afterContent() { return $this->doAfterContent(); diff --git a/includes/SkinTemplate.php b/includes/SkinTemplate.php index 4028e78b70..9fe2ccf317 100644 --- a/includes/SkinTemplate.php +++ b/includes/SkinTemplate.php @@ -91,7 +91,7 @@ class SkinTemplate extends Skin { var $template = 'QuickTemplate'; /** - * Whether this skin use OutputPage::headElement() to generate the <head> + * Whether this skin use OutputPage::headElement() to generate the "<head>" * tag */ var $useHeadElement = false; diff --git a/includes/User.php b/includes/User.php index 5fc0773d6e..51877f8178 100644 --- a/includes/User.php +++ b/includes/User.php @@ -527,7 +527,7 @@ class User { * as 300.300.300.300 will return true because it looks like an IP * address, despite not being strictly valid. * - * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP + * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP * address because the usemod software would "cloak" anonymous IP * addresses like this, if we allowed accounts like this to be created * new users could get the old edits of these anonymous users. diff --git a/includes/WebRequest.php b/includes/WebRequest.php index 87526fcc03..766db461c2 100644 --- a/includes/WebRequest.php +++ b/includes/WebRequest.php @@ -504,9 +504,9 @@ class WebRequest { * Fetch a text string from the given array or return $default if it's not * set. Carriage returns are stripped from the text, and with some language * modules there is an input transliteration applied. This should generally - * be used for form <textarea> and <input> fields. Used for user-supplied - * freeform text input (for which input transformations may be required - e.g. - * Esperanto x-coding). + * be used for form "<textarea>" and "<input>" fields. Used for + * user-supplied freeform text input (for which input transformations may + * be required - e.g. Esperanto x-coding). * * @param $name String * @param $default String: optional diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php index a6e33639e9..77c0fc29dd 100644 --- a/includes/api/ApiBase.php +++ b/includes/api/ApiBase.php @@ -1184,7 +1184,7 @@ abstract class ApiBase extends ContextSource { * @param $errorCode string Brief, arbitrary, stable string to allow easy * automated identification of the error, e.g., 'unknown_action' * @param $httpRespCode int HTTP response code - * @param $extradata array Data to add to the <error> element; array in ApiResult format + * @param $extradata array Data to add to the "<error>" element; array in ApiResult format */ public function dieUsage( $description, $errorCode, $httpRespCode = 0, $extradata = null ) { Profiler::instance()->close(); diff --git a/includes/api/ApiPageSet.php b/includes/api/ApiPageSet.php index b7db4f0b4b..e5146ebc6d 100644 --- a/includes/api/ApiPageSet.php +++ b/includes/api/ApiPageSet.php @@ -266,8 +266,8 @@ class ApiPageSet extends ApiQueryBase { } /** - * Returns the number of revisions (requested with revids= parameter)\ - * @return int + * Returns the number of revisions (requested with revids= parameter). + * @return int Number of revisions. */ public function getRevisionCount() { return count( $this->getRevisionIDs() ); diff --git a/includes/api/ApiQueryCategoryInfo.php b/includes/api/ApiQueryCategoryInfo.php index e5eca85481..48a4a078a3 100644 --- a/includes/api/ApiQueryCategoryInfo.php +++ b/includes/api/ApiQueryCategoryInfo.php @@ -25,7 +25,8 @@ */ /** - * This query adds the <categories> subelement to all pages with the list of categories the page is in + * This query adds the "<categories>" subelement to all pages with the list of + * categories the page is in. * * @ingroup API */ diff --git a/includes/api/ApiQueryImages.php b/includes/api/ApiQueryImages.php index 147ab6725f..3779123991 100644 --- a/includes/api/ApiQueryImages.php +++ b/includes/api/ApiQueryImages.php @@ -25,7 +25,8 @@ */ /** - * This query adds an <images> subelement to all pages with the list of images embedded into those pages. + * This query adds an "<images>" subelement to all pages with the list of + * images embedded into those pages. * * @ingroup API */ diff --git a/includes/api/ApiResult.php b/includes/api/ApiResult.php index 798b227567..7d01fa05cd 100644 --- a/includes/api/ApiResult.php +++ b/includes/api/ApiResult.php @@ -165,7 +165,7 @@ class ApiResult extends ApiBase { * @param $value Mixed * @param $subElemName string when present, content element is created * as a sub item of $arr. Use this parameter to create elements in - * format <elem>text</elem> without attributes + * format "<elem>text</elem>" without attributes. */ public static function setContent( &$arr, $value, $subElemName = null ) { if ( is_array( $value ) ) { diff --git a/includes/db/Database.php b/includes/db/Database.php index 0a1f988cbf..a3faebf974 100644 --- a/includes/db/Database.php +++ b/includes/db/Database.php @@ -1873,7 +1873,7 @@ abstract class DatabaseBase implements DatabaseType { * The keys on each level may be either integers or strings. * * @param $data Array: organized as 2-d - * array(baseKeyVal => array(subKeyVal => <ignored>, ...), ...) + * array(baseKeyVal => array(subKeyVal => [ignored], ...), ...) * @param $baseKey String: field name to match the base-level keys to (eg 'pl_namespace') * @param $subKey String: field name to match the sub-level keys to (eg 'pl_title') * @return Mixed: string SQL fragment, or false if no items in array. diff --git a/includes/filerepo/backend/FileBackend.php b/includes/filerepo/backend/FileBackend.php index 3cc9021945..b71302a2a7 100644 --- a/includes/filerepo/backend/FileBackend.php +++ b/includes/filerepo/backend/FileBackend.php @@ -37,8 +37,9 @@ * Outside callers can assume that all backends will have these functions. * * All "storage paths" are of the format "mwstore://<backend>/<container>/<path>". - * The <path> portion is a relative path that uses UNIX file system (FS) notation, - * though any particular backend may not actually be using a local filesystem. + * The "<path>" portion is a relative path that uses UNIX file system (FS) + * notation, though any particular backend may not actually be using a local + * filesystem. * Therefore, the relative paths are only virtual. * * Backend contents are stored under wiki-specific container names by default. diff --git a/includes/filerepo/backend/lockmanager/MemcLockManager.php b/includes/filerepo/backend/lockmanager/MemcLockManager.php index add1f2c9e6..79696b2f8c 100644 --- a/includes/filerepo/backend/lockmanager/MemcLockManager.php +++ b/includes/filerepo/backend/lockmanager/MemcLockManager.php @@ -56,12 +56,12 @@ class MemcLockManager extends QuorumLockManager { * Construct a new instance from configuration. * * $config paramaters include: - * 'lockServers' : Associative array of server names to <IP>:<port> strings. - * 'srvsByBucket' : Array of 1-16 consecutive integer keys, starting from 0, + * - 'lockServers' : Associative array of server names to "<IP>:<port>" strings. + * - 'srvsByBucket' : Array of 1-16 consecutive integer keys, starting from 0, * each having an odd-numbered list of server names (peers) as values. - * 'memcConfig' : Configuration array for ObjectCache::newFromParams. [optional] + * - 'memcConfig' : Configuration array for ObjectCache::newFromParams. [optional] * If set, this must use one of the memcached classes. - * 'wikiId' : Wiki ID string that all resources are relative to. [optional] + * - 'wikiId' : Wiki ID string that all resources are relative to. [optional] * * @param Array $config */ diff --git a/includes/filerepo/file/File.php b/includes/filerepo/file/File.php index 065679a87a..81536b5cab 100644 --- a/includes/filerepo/file/File.php +++ b/includes/filerepo/file/File.php @@ -1606,7 +1606,7 @@ abstract class File { } /** - * Get the deletion archive key, <sha1>.<ext> + * Get the deletion archive key, "<sha1>.<ext>" * * @return string */ diff --git a/includes/installer/WebInstallerOutput.php b/includes/installer/WebInstallerOutput.php index aabc1f36db..84d115b51d 100644 --- a/includes/installer/WebInstallerOutput.php +++ b/includes/installer/WebInstallerOutput.php @@ -153,7 +153,7 @@ class WebInstallerOutput { } /** - * <link> to index.php?css=foobar for the <head> + * "<link>" to index.php?css=foobar for the "<head>" * @return String */ private function getCssUrl( ) { diff --git a/includes/installer/WebInstallerPage.php b/includes/installer/WebInstallerPage.php index b6e7717821..c10fe88bab 100644 --- a/includes/installer/WebInstallerPage.php +++ b/includes/installer/WebInstallerPage.php @@ -232,7 +232,7 @@ class WebInstaller_Language extends WebInstallerPage { } /** - * Get a <select> for selecting languages. + * Get a "<select>" for selecting languages. * * @param $name * @param $label diff --git a/includes/job/DoubleRedirectJob.php b/includes/job/DoubleRedirectJob.php index 4e022586c9..b6f54ea551 100644 --- a/includes/job/DoubleRedirectJob.php +++ b/includes/job/DoubleRedirectJob.php @@ -36,7 +36,7 @@ class DoubleRedirectJob extends Job { /** * Insert jobs into the job queue to fix redirects to the given title - * @param $reason String: the reason for the fix, see message double-redirect-fixed-<reason> + * @param $reason String: the reason for the fix, see message "double-redirect-fixed-<reason>" * @param $redirTitle Title: the title which has changed, redirects pointing to this title are fixed * @param $destTitle bool Not used */ diff --git a/includes/json/FormatJson.php b/includes/json/FormatJson.php index cae3f12a5e..d3cc55011a 100644 --- a/includes/json/FormatJson.php +++ b/includes/json/FormatJson.php @@ -60,7 +60,7 @@ class FormatJson { * * @return Mixed: the value encoded in json in appropriate PHP type. * Values true, false and null (case-insensitive) are returned as true, false - * and &null; respectively. &null; is returned if the json cannot be + * and "&null;" respectively. "&null;" is returned if the json cannot be * decoded or if the encoded data is deeper than the recursion limit. */ public static function decode( $value, $assoc = false ) { diff --git a/includes/media/MediaTransformOutput.php b/includes/media/MediaTransformOutput.php index bf08de61cd..fc1f834a3d 100644 --- a/includes/media/MediaTransformOutput.php +++ b/includes/media/MediaTransformOutput.php @@ -84,7 +84,7 @@ abstract class MediaTransformOutput { * custom-url-link Custom URL to link to * custom-title-link Custom Title object to link to * valign vertical-align property, if the output is an inline element - * img-class Class applied to the <img> tag, if there is such a tag + * img-class Class applied to the "<img>" tag, if there is such a tag * * For images, desc-link and file-link are implemented as a click-through. For * sounds and videos, they may be displayed in other ways. diff --git a/includes/media/SVGMetadataExtractor.php b/includes/media/SVGMetadataExtractor.php index da7d428654..83f531c135 100644 --- a/includes/media/SVGMetadataExtractor.php +++ b/includes/media/SVGMetadataExtractor.php @@ -19,7 +19,7 @@ * * @file * @ingroup Media - * @author Derk-Jan Hartman <hartman _at_ videolan d0t org> + * @author "Derk-Jan Hartman <hartman _at_ videolan d0t org>" * @author Brion Vibber * @copyright Copyright Â© 2010-2010 Brion Vibber, Derk-Jan Hartman * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License @@ -255,7 +255,7 @@ class SVGReader { /** * Parse the attributes of an SVG element * - * The parser has to be in the start element of <svg> + * The parser has to be in the start element of "<svg>" */ private function handleSVGAttribs( ) { $defaultWidth = self::DEFAULT_WIDTH; diff --git a/includes/media/XMP.php b/includes/media/XMP.php index adb85df884..75fdd96dff 100644 --- a/includes/media/XMP.php +++ b/includes/media/XMP.php @@ -461,13 +461,15 @@ class XMPReader { * generally means we've finished processing a nested structure. * resets some internal variables to indicate that. * - * Note this means we hit the </closing element> not the </rdf:Seq>. + * Note this means we hit the closing element not the "</rdf:Seq>". * - * For example, when processing: + * @par For example, when processing: + * @code{,xml} * <exif:ISOSpeedRatings> <rdf:Seq> <rdf:li>64</rdf:li> * </rdf:Seq> </exif:ISOSpeedRatings> + * @endcode * - * This method is called when we hit the </exif:ISOSpeedRatings> tag. + * This method is called when we hit the "</exif:ISOSpeedRatings>" tag. * * @param $elm String namespace . space . tag name. */ @@ -523,15 +525,17 @@ class XMPReader { * Hit a closing element in MODE_LI (either rdf:Seq, or rdf:Bag ) * Add information about what type of element this is. * - * Note we still have to hit the outer </property> + * Note we still have to hit the outer "</property>" * - * For example, when processing: + * @par For example, when processing: + * @code{,xml} * <exif:ISOSpeedRatings> <rdf:Seq> <rdf:li>64</rdf:li> * </rdf:Seq> </exif:ISOSpeedRatings> + * @endcode * - * This method is called when we hit the </rdf:Seq>. + * This method is called when we hit the "</rdf:Seq>". * (For comparison, we call endElementModeSimple when we - * hit the </rdf:li>) + * hit the "</rdf:li>") * * @param $elm String namespace . ' ' . element name */ @@ -1010,7 +1014,7 @@ class XMPReader { * Also does some initial set up for the wrapper element * * @param $parser XMLParser - * @param $elm String namespace <space> element + * @param $elm String namespace "<space>" element * @param $attribs Array attribute name => value */ function startElement( $parser, $elm, $attribs ) { @@ -1093,11 +1097,13 @@ class XMPReader { * Process attributes. * Simple values can be stored as either a tag or attribute * - * Often the initial <rdf:Description> tag just has all the simple + * Often the initial "<rdf:Description>" tag just has all the simple * properties as attributes. * - * Example: + * @par Example: + * @code * <rdf:Description rdf:about="" xmlns:exif="http://ns.adobe.com/exif/1.0/" exif:DigitalZoomRatio="0/10"> + * @endcode * * @param $attribs Array attribute=>value array. */ diff --git a/includes/objectcache/MemcachedClient.php b/includes/objectcache/MemcachedClient.php index 9602ffec91..ec67a3955f 100644 --- a/includes/objectcache/MemcachedClient.php +++ b/includes/objectcache/MemcachedClient.php @@ -573,10 +573,10 @@ class MWMemcached { * output as an array (null array if no output) * * NOTE: due to a possible bug in how PHP reads while using fgets(), each - * line may not be terminated by a \r\n. More specifically, my testing + * line may not be terminated by a "\r\n". More specifically, my testing * has shown that, on FreeBSD at least, each line is terminated only - * with a \n. This is with the PHP flag auto_detect_line_endings set - * to falase (the default). + * with a "\n". This is with the PHP flag auto_detect_line_endings set + * to false (the default). * * @param $sock Resource: socket to send command on * @param $cmd String: command to run diff --git a/includes/parser/Parser.php b/includes/parser/Parser.php index 7991ca602a..23352fab4b 100644 --- a/includes/parser/Parser.php +++ b/includes/parser/Parser.php @@ -557,10 +557,11 @@ class Parser { } /** - * Process the wikitext for the ?preload= feature. (bug 5210) + * Process the wikitext for the "?preload=" feature. (bug 5210) * - * <noinclude>, <includeonly> etc. are parsed as for template transclusion, - * comments, templates, arguments, tags hooks and parser functions are untouched. + * "<noinclude>", "<includeonly>" etc. are parsed as for template + * transclusion, comments, templates, arguments, tags hooks and parser + * functions are untouched. * * @param $text String * @param $title Title @@ -788,11 +789,14 @@ class Parser { * in the text with a random marker and returns the next text. The output * parameter $matches will be an associative array filled with data in * the form: + * + * @code * 'UNIQ-xxxxx' => array( * 'element', * 'tag content', * array( 'param' => 'x' ), * '<element param="x">tag content</element>' ) ) + * @endcode * * @param $elements array list of element names. Comments are always extracted. * @param $text string Source text string. @@ -2940,7 +2944,7 @@ class Parser { * * @param $text String: The text to parse * @param $flags Integer: bitwise combination of: - * self::PTD_FOR_INCLUSION Handle <noinclude>/<includeonly> as if the text is being + * self::PTD_FOR_INCLUSION Handle "<noinclude>" and "<includeonly>" as if the text is being * included. Default is to assume a direct page view. * * The generated DOM tree must depend only on the input text and the flags. @@ -4324,7 +4328,7 @@ class Parser { } /** - * Transform wiki markup when saving a page by doing \r\n -> \n + * Transform wiki markup when saving a page by doing "\r\n" -> "\n" * conversion, substitting signatures, {{subst:}} templates, etc. * * @param $text String: the text to transform @@ -4620,7 +4624,7 @@ class Parser { } /** - * Create an HTML-style tag, e.g. <yourtag>special text</yourtag> + * Create an HTML-style tag, e.g. "<yourtag>special text</yourtag>" * The callback should have the following form: * function myParserHook( $text, $params, $parser, $frame ) { ... } * @@ -4638,7 +4642,7 @@ class Parser { * this interface, as it is not documented and injudicious use could smash * private variables.** * - * @param $tag Mixed: the tag to use, e.g. 'hook' for <hook> + * @param $tag Mixed: the tag to use, e.g. 'hook' for "<hook>" * @param $callback Mixed: the callback function (and object) to use for the tag * @return Mixed|null The old value of the mTagHooks array associated with the hook */ @@ -4668,7 +4672,7 @@ class Parser { * @since 1.10 * @todo better document or deprecate this * - * @param $tag Mixed: the tag to use, e.g. 'hook' for <hook> + * @param $tag Mixed: the tag to use, e.g. 'hook' for "<hook>" * @param $callback Mixed: the callback function (and object) to use for the tag * @return Mixed|null The old value of the mTagHooks array associated with the hook */ @@ -4776,7 +4780,7 @@ class Parser { } /** - * Create a tag function, e.g. <test>some stuff</test>. + * Create a tag function, e.g. "<test>some stuff</test>". * Unlike tag hooks, tag functions are parsed at preprocessor level. * Unlike parser functions, their content is not preprocessed. * @return null @@ -4797,7 +4801,7 @@ class Parser { /** * @todo FIXME: Update documentation. makeLinkObj() is deprecated. - * Replace  link placeholders with actual links, in the buffer + * Replace "" link placeholders with actual links, in the buffer * Placeholders created in Skin::makeLinkObj() * * @param $text string @@ -4810,7 +4814,7 @@ class Parser { } /** - * Replace  link placeholders with plain text of links + * Replace "" link placeholders with plain text of links * (not HTML-formatted). * * @param $text String @@ -5282,13 +5286,13 @@ class Parser { * * @param $text String: Page wikitext * @param $section String: a section identifier string of the form: - * <flag1> - <flag2> - ... - <section number> + * "<flag1> - <flag2> - ... - <section number>" * * Currently the only recognised flag is "T", which means the target section number * was derived during a template inclusion parse, in other words this is a template * section edit link. If no flags are given, it was an ordinary section edit link. * This flag is required to avoid a section numbering mismatch when a section is - * enclosed by <includeonly> (bug 6563). + * enclosed by "<includeonly>" (bug 6563). * * The section number 0 pulls the text before the first heading; other numbers will * pull the given section along with its lower-level subsections. If the section is diff --git a/includes/parser/ParserOutput.php b/includes/parser/ParserOutput.php index d929f1a532..62d3bfdc4f 100644 --- a/includes/parser/ParserOutput.php +++ b/includes/parser/ParserOutput.php @@ -348,7 +348,7 @@ class ParserOutput extends CacheTime { } /** - * Add some text to the <head>. + * Add some text to the "<head>". * If $tag is set, the section with that tag will only be included once * in a given page. */ diff --git a/includes/parser/Preprocessor.php b/includes/parser/Preprocessor.php index 19bcbf238c..bd13f9ae97 100644 --- a/includes/parser/Preprocessor.php +++ b/includes/parser/Preprocessor.php @@ -231,7 +231,7 @@ interface PPNode { function getName(); /** - * Split a <part> node into an associative array containing: + * Split a "<part>" node into an associative array containing: * name PPNode name * index String index * value PPNode value @@ -239,13 +239,13 @@ interface PPNode { function splitArg(); /** - * Split an <ext> node into an associative array containing name, attr, inner and close + * Split an "<ext>" node into an associative array containing name, attr, inner and close * All values in the resulting array are PPNodes. Inner and close are optional. */ function splitExt(); /** - * Split an <h> node + * Split an "<h>" node */ function splitHeading(); } diff --git a/includes/parser/Preprocessor_DOM.php b/includes/parser/Preprocessor_DOM.php index f991df2a2f..7fe420d8e6 100644 --- a/includes/parser/Preprocessor_DOM.php +++ b/includes/parser/Preprocessor_DOM.php @@ -112,7 +112,7 @@ class Preprocessor_DOM implements Preprocessor { * * @param $text String: the text to parse * @param $flags Integer: bitwise combination of: - * Parser::PTD_FOR_INCLUSION Handle <noinclude>/<includeonly> as if the text is being + * Parser::PTD_FOR_INCLUSION Handle "<noinclude>" and "<includeonly>" as if the text is being * included. Default is to assume a direct page view. * * The generated DOM tree must depend only on the input text and the flags. @@ -1658,10 +1658,10 @@ class PPNode_DOM implements PPNode { } /** - * Split a <part> node into an associative array containing: - * name PPNode name - * index String index - * value PPNode value + * Split a "<part>" node into an associative array containing: + * - name PPNode name + * - index String index + * - value PPNode value * * @return array */ @@ -1681,7 +1681,7 @@ class PPNode_DOM implements PPNode { } /** - * Split an <ext> node into an associative array containing name, attr, inner and close + * Split an "<ext>" node into an associative array containing name, attr, inner and close * All values in the resulting array are PPNodes. Inner and close are optional. * * @return array @@ -1708,7 +1708,7 @@ class PPNode_DOM implements PPNode { } /** - * Split a <h> node + * Split a "<h>" node * @return array */ function splitHeading() { diff --git a/includes/parser/Preprocessor_Hash.php b/includes/parser/Preprocessor_Hash.php index f455a1db7e..0e202fd61b 100644 --- a/includes/parser/Preprocessor_Hash.php +++ b/includes/parser/Preprocessor_Hash.php @@ -24,7 +24,7 @@ /** * Differences from DOM schema: * * attribute nodes are children - * * <h> nodes that aren't at the top are replaced with <possible-h> + * * "<h>" nodes that aren't at the top are replaced with <possible-h> * @ingroup Parser */ class Preprocessor_Hash implements Preprocessor { @@ -91,7 +91,7 @@ class Preprocessor_Hash implements Preprocessor { * * @param $text String: the text to parse * @param $flags Integer: bitwise combination of: - * Parser::PTD_FOR_INCLUSION Handle <noinclude>/<includeonly> as if the text is being + * Parser::PTD_FOR_INCLUSION Handle "<noinclude>" and "<includeonly>" as if the text is being * included. Default is to assume a direct page view. * * The generated DOM tree must depend only on the input text and the flags. @@ -1603,10 +1603,10 @@ class PPNode_Hash_Tree implements PPNode { } /** - * Split a <part> node into an associative array containing: - * name PPNode name - * index String index - * value PPNode value + * Split a "<part>" node into an associative array containing: + * - name PPNode name + * - index String index + * - value PPNode value * * @return array */ @@ -1638,7 +1638,7 @@ class PPNode_Hash_Tree implements PPNode { } /** - * Split an <ext> node into an associative array containing name, attr, inner and close + * Split an "<ext>" node into an associative array containing name, attr, inner and close * All values in the resulting array are PPNodes. Inner and close are optional. * * @return array @@ -1666,7 +1666,7 @@ class PPNode_Hash_Tree implements PPNode { } /** - * Split an <h> node + * Split an "<h>" node * * @return array */ @@ -1692,7 +1692,7 @@ class PPNode_Hash_Tree implements PPNode { } /** - * Split a <template> or <tplarg> node + * Split a "<template>" or "<tplarg>" node * * @return array */ diff --git a/includes/resourceloader/ResourceLoader.php b/includes/resourceloader/ResourceLoader.php index 8b1452edfb..99fe7ed5eb 100644 --- a/includes/resourceloader/ResourceLoader.php +++ b/includes/resourceloader/ResourceLoader.php @@ -858,7 +858,7 @@ class ResourceLoader { /** * Combines an associative array mapping media type to CSS into a - * single stylesheet with @media blocks. + * single stylesheet with "@media" blocks. * * @param $styles Array: List of CSS strings keyed by media type * diff --git a/includes/resourceloader/ResourceLoaderModule.php b/includes/resourceloader/ResourceLoaderModule.php index 035ff0975f..1e19d0fa4e 100644 --- a/includes/resourceloader/ResourceLoaderModule.php +++ b/includes/resourceloader/ResourceLoaderModule.php @@ -237,8 +237,8 @@ abstract class ResourceLoaderModule { /** * Where on the HTML page should this module's JS be loaded? - * 'top': in the <head> - * 'bottom': at the bottom of the <body> + * - 'top': in the "<head>" + * - 'bottom': at the bottom of the "<body>" * * @return string */ -- 2.20.1

From aab43dd49523476f3ec28c695e43006446a7be7a Mon Sep 17 00:00:00 2001 From: Antoine Musso Date: Tue, 10 Jul 2012 14:48:06 +0200 Subject: [PATCH] escape tags and entity in doxygen comments When inserting XML elements inline , doxygen chokes about it not being known. Simply enclosing the tag in double quotes prevents doxygen from emitting a warning. Also enclosed a few invalid functions calls such as \. and double quoted the HTML entities such as &foobar; Change-Id: I4019637145e683c2bec3d17b2fd98b0c50a932f1 --- includes/ChangesList.php | 4 +- includes/DefaultSettings.php | 28 +++++----- includes/EditPage.php | 4 +- includes/Export.php | 12 ++--- includes/GlobalFunctions.php | 4 +- includes/HTMLForm.php | 28 +++++----- includes/Html.php | 32 ++++++------ includes/Import.php | 6 +-- includes/MagicWord.php | 4 +- includes/OutputPage.php | 52 +++++++++---------- includes/Pager.php | 6 +-- includes/Preferences.php | 2 +- includes/RevisionList.php | 2 +- includes/Sanitizer.php | 4 +- includes/Skin.php | 8 +-- includes/SkinLegacy.php | 6 +-- includes/SkinTemplate.php | 2 +- includes/User.php | 2 +- includes/WebRequest.php | 6 +-- includes/api/ApiBase.php | 2 +- includes/api/ApiPageSet.php | 4 +- includes/api/ApiQueryCategoryInfo.php | 3 +- includes/api/ApiQueryImages.php | 3 +- includes/api/ApiResult.php | 2 +- includes/db/Database.php | 2 +- includes/filerepo/backend/FileBackend.php | 5 +- .../backend/lockmanager/MemcLockManager.php | 8 +-- includes/filerepo/file/File.php | 2 +- includes/installer/WebInstallerOutput.php | 2 +- includes/installer/WebInstallerPage.php | 2 +- includes/job/DoubleRedirectJob.php | 2 +- includes/json/FormatJson.php | 2 +- includes/media/MediaTransformOutput.php | 2 +- includes/media/SVGMetadataExtractor.php | 4 +- includes/media/XMP.php | 26 ++++++---- includes/objectcache/MemcachedClient.php | 6 +-- includes/parser/Parser.php | 30 ++++++----- includes/parser/ParserOutput.php | 2 +- includes/parser/Preprocessor.php | 6 +-- includes/parser/Preprocessor_DOM.php | 14 ++--- includes/parser/Preprocessor_Hash.php | 18 +++---- includes/resourceloader/ResourceLoader.php | 2 +- .../resourceloader/ResourceLoaderModule.php | 4 +- 43 files changed, 190 insertions(+), 175 deletions(-) diff --git a/includes/ChangesList.php b/includes/ChangesList.php index fe0db10672..b37612f6b4 100644 --- a/includes/ChangesList.php +++ b/includes/ChangesList.php @@ -108,7 +108,7 @@ class ChangesList extends ContextSource { } /** - * Sets the list to use a

tag + * Sets the list to use a "

" tag * @param $value Boolean */ public function setWatchlistDivs( $value = true ) { @@ -145,7 +145,7 @@ class ChangesList extends ContextSource { } /** - * Provide the element appropriate to a given abbreviated flag, + * Provide the "" element appropriate to a given abbreviated flag, * namely the flag indicating a new page, a minor edit, a bot edit, or an * unpatrolled edit. By default in English it will contain "N", "m", "b", * "!" respectively, plus it will have an appropriate title and class. diff --git a/includes/DefaultSettings.php b/includes/DefaultSettings.php index 7441932c37..eed7d58e1b 100644 --- a/includes/DefaultSettings.php +++ b/includes/DefaultSettings.php @@ -347,7 +347,7 @@ $wgImgAuthPublicTest = true; * container : backend container name the zone is in * directory : root path within container for the zone * url : base URL to the root of the zone - * Zones default to using - as the container name + * Zones default to using "-" as the container name * and default to using the container root as the zone's root directory. * Nesting of zone locations within other zones should be avoided. * - url Public zone URL. The 'zones' settings take precedence. @@ -367,8 +367,8 @@ $wgImgAuthPublicTest = true; * is 0644. * - directory The local filesystem directory where public files are stored. Not used for * some remote repos. - * - thumbDir The base thumbnail directory. Defaults to /thumb. - * - thumbUrl The base thumbnail URL. Defaults to /thumb. + * - thumbDir The base thumbnail directory. Defaults to "/thumb". + * - thumbUrl The base thumbnail URL. Defaults to "/thumb". * * * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored @@ -533,7 +533,7 @@ $wgUploadNavigationUrl = false; /** * Point the upload link for missing files to an external URL, as with - * $wgUploadNavigationUrl. The URL will get (?|&)wpDestFile= + * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=" * appended to it as appropriate. */ $wgUploadMissingFileUrl = false; @@ -769,7 +769,7 @@ $wgSVGMetadataCutoff = 262144; /** * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic browsers which can't * perform basic stuff like MIME detection and which are vulnerable to further idiots uploading - * crap files as images. When this directive is on, will be allowed in files with + * crap files as images. When this directive is on, "<title>" will be allowed in files with * an "image/svg+xml" MIME type. You should leave this disabled if your web server is misconfigured * and doesn't send appropriate MIME types for SVG images. */ @@ -820,7 +820,7 @@ $wgMaxAnimatedGifArea = 1.25e7; $wgThumbnailEpoch = '20030516000000'; /** - * If set, inline scaled images will still produce <img> tags ready for + * If set, inline scaled images will still produce "<img>" tags ready for * output instead of showing an error message. * * This may be useful if errors are transitory, especially if the site @@ -998,7 +998,7 @@ $wgThumbLimits = array( ); /** - * Default parameters for the <gallery> tag + * Default parameters for the "<gallery>" tag */ $wgGalleryOptions = array ( 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize @@ -2360,7 +2360,7 @@ $wgWellFormedXml = true; * Use the prefix for the key and the namespace for the value. For * example: * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg'; - * Normally we wouldn't have to define this in the root <html> + * Normally we wouldn't have to define this in the root "<html>" * element, but IE needs it there in some circumstances. * * This is ignored if $wgHtml5 is true, for the same reason as @@ -2748,7 +2748,7 @@ $wgResourceLoaderValidateJS = true; $wgResourceLoaderValidateStaticJS = false; /** - * If set to true, asynchronous loading of bottom-queue scripts in the <head> + * If set to true, asynchronous loading of bottom-queue scripts in the "<head>" * will be enabled. This is an experimental feature that's supposed to make * JavaScript load faster. */ @@ -3063,7 +3063,7 @@ $wgAllowExternalImagesFrom = ''; $wgEnableImageWhitelist = true; /** - * A different approach to the above: simply allow the <img> tag to be used. + * A different approach to the above: simply allow the "<img>" tag to be used. * This allows you to specify alt text and other attributes, copy-paste HTML to * your wiki more easily, etc. However, allowing external images in any manner * will allow anyone with editing rights to snoop on your visitors' IP @@ -3105,7 +3105,7 @@ $wgTidyInternal = extension_loaded( 'tidy' ); */ $wgDebugTidy = false; -/** Allow raw, unchecked HTML in <html>...</html> sections. +/** Allow raw, unchecked HTML in "<html>...</html>" sections. * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions * TO RESTRICT EDITING to only those that you trust */ @@ -3373,7 +3373,7 @@ $wgInvalidUsernameCharacters = '@'; /** * Character used as a delimiter when testing for interwiki userrights * (In Special:UserRights, it is possible to modify users on different - * databases if the delimiter is used, e.g. Someuser@enwiki). + * databases if the delimiter is used, e.g. "Someuser@enwiki"). * * It is recommended that you have this delimiter in * $wgInvalidUsernameCharacters above, or you will not be able to @@ -5184,7 +5184,7 @@ $wgLogRestrictions = array( * hidden by default unless the link is clicked. Import logs will be shown by * default, and hidden when the link is clicked. * - * A message of the form log-show-hide-<type> should be added, and will be used + * A message of the form log-show-hide-[type] should be added, and will be used * for the link text. */ $wgFilterLogTypes = array( @@ -5434,7 +5434,7 @@ $wgMaxRedirectLinksRetrieved = 500; */ /** - * Array of allowed values for the title=foo&action=<action> parameter. Syntax is: + * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is: * 'foo' => 'ClassName' Load the specified class which subclasses Action * 'foo' => true Load the class FooAction which subclasses Action * If something is specified in the getActionOverrides() diff --git a/includes/EditPage.php b/includes/EditPage.php index 1f526cce3e..1376d579e4 100644 --- a/includes/EditPage.php +++ b/includes/EditPage.php @@ -2992,8 +2992,8 @@ HTML * failure, etc). * * @todo This doesn't include category or interlanguage links. - * Would need to enhance it a bit, <s>maybe wrap them in XML - * or something...</s> that might also require more skin + * Would need to enhance it a bit, "<s>maybe wrap them in XML + * or something...</s>" that might also require more skin * initialization, so check whether that's a problem. */ function livePreview() { diff --git a/includes/Export.php b/includes/Export.php index 36d98d681b..92cfa1e4ee 100644 --- a/includes/Export.php +++ b/includes/Export.php @@ -472,7 +472,7 @@ class XmlDumpWriter { } /** - * Opens the XML output stream's root <mediawiki> element. + * Opens the XML output stream's root "<mediawiki>" element. * This does not include an xml directive, so is safe to include * as a subelement in a larger XML stream. Namespace and XML Schema * references are included. @@ -572,7 +572,7 @@ class XmlDumpWriter { } /** - * Opens a <page> section on the output stream, with data + * Opens a "<page>" section on the output stream, with data * from the given database row. * * @param $row object @@ -604,7 +604,7 @@ class XmlDumpWriter { } /** - * Closes a <page> section on the output stream. + * Closes a "<page>" section on the output stream. * * @access private * @return string @@ -614,7 +614,7 @@ class XmlDumpWriter { } /** - * Dumps a <revision> section on the output stream, with + * Dumps a "<revision>" section on the output stream, with * data filled in from the given database row. * * @param $row object @@ -678,7 +678,7 @@ class XmlDumpWriter { } /** - * Dumps a <logitem> section on the output stream, with + * Dumps a "<logitem>" section on the output stream, with * data filled in from the given database row. * * @param $row object @@ -815,7 +815,7 @@ class XmlDumpWriter { * Return prefixed text form of title, but using the content language's * canonical namespace. This skips any special-casing such as gendered * user namespaces -- which while useful, are not yet listed in the - * XML <siteinfo> data so are unsafe in export. + * XML "<siteinfo>" data so are unsafe in export. * * @param Title $title * @return string diff --git a/includes/GlobalFunctions.php b/includes/GlobalFunctions.php index 7e759580de..1a21e205bb 100644 --- a/includes/GlobalFunctions.php +++ b/includes/GlobalFunctions.php @@ -2063,7 +2063,7 @@ function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) { * Escapes the given text so that it may be output using addWikiText() * without any linking, formatting, etc. making its way through. This * is achieved by substituting certain characters with HTML entities. - * As required by the callers, <nowiki> is not used. + * As required by the callers, "<nowiki>" is not used. * * @param $text String: text to be escaped * @return String @@ -3192,7 +3192,7 @@ function wfUseMW( $req_ver ) { /** * Return the final portion of a pathname. - * Reimplemented because PHP5's basename() is buggy with multibyte text. + * Reimplemented because PHP5's "basename()" is buggy with multibyte text. * http://bugs.php.net/bug.php?id=33898 * * PHP's basename() only considers '\' a pathchar on Windows and Netware. diff --git a/includes/HTMLForm.php b/includes/HTMLForm.php index 36008fb337..9ced19e993 100644 --- a/includes/HTMLForm.php +++ b/includes/HTMLForm.php @@ -546,7 +546,7 @@ class HTMLForm extends ContextSource { } /** - * Wrap the form innards in an actual <form> element + * Wrap the form innards in an actual "<form>" element * @param $html String HTML contents to wrap. * @return String wrapped HTML. */ @@ -761,16 +761,16 @@ class HTMLForm extends ContextSource { $this->mId = $id; } /** - * Prompt the whole form to be wrapped in a <fieldset>, with - * this text as its <legend> element. - * @param $legend String HTML to go inside the <legend> element. + * Prompt the whole form to be wrapped in a "<fieldset>", with + * this text as its "<legend>" element. + * @param $legend String HTML to go inside the "<legend>" element. * Will be escaped */ public function setWrapperLegend( $legend ) { $this->mWrapperLegend = $legend; } /** - * Prompt the whole form to be wrapped in a <fieldset>, with - * this message as its <legend> element. + * Prompt the whole form to be wrapped in a "<fieldset>", with + * this message as its "<legend>" element. * @since 1.19 * @param $msg String message key */ @@ -780,7 +780,7 @@ class HTMLForm extends ContextSource { /** * Set the prefix for various default messages - * TODO: currently only used for the <fieldset> legend on forms + * @todo currently only used for the "<fieldset>" legend on forms * with multiple sections; should be used elsewhre? * @param $p String */ @@ -819,10 +819,10 @@ class HTMLForm extends ContextSource { } /** - * TODO: Document + * @todo Document * @param $fields array[]|HTMLFormField[] array of fields (either arrays or objects) - * @param $sectionName string ID attribute of the <table> tag for this section, ignored if empty - * @param $fieldsetIDPrefix string ID prefix for the <fieldset> tag of each subsection, ignored if empty + * @param $sectionName string ID attribute of the "<table>" tag for this section, ignored if empty + * @param $fieldsetIDPrefix string ID prefix for the "<fieldset>" tag of each subsection, ignored if empty * @return String */ public function displaySection( $fields, $sectionName = '', $fieldsetIDPrefix = '' ) { @@ -938,8 +938,8 @@ class HTMLForm extends ContextSource { } /** - * Get a string to go in the <legend> of a section fieldset. Override this if you - * want something more complicated + * Get a string to go in the "<legend>" of a section fieldset. + * Override this if you want something more complicated. * @param $key String * @return String */ @@ -1350,7 +1350,7 @@ abstract class HTMLFormField { /** * flatten an array of options to a single array, for instance, - * a set of <options> inside <optgroups>. + * a set of "<options>" inside "<optgroups>". * @param $options array Associative Array with values either Strings * or Arrays * @return Array flattened input @@ -1889,7 +1889,7 @@ class HTMLMultiSelectField extends HTMLFormField { * ** <option value> * * New Optgroup header * Plus a text field underneath for an additional reason. The 'value' of the field is - * ""<select>: <extra reason>"", or "<extra reason>" if nothing has been selected in the + * "<select>: <extra reason>", or "<extra reason>" if nothing has been selected in the * select dropdown. * @todo FIXME: If made 'required', only the text field should be compulsory. */ diff --git a/includes/Html.php b/includes/Html.php index 3986a7b100..7fa98e1290 100644 --- a/includes/Html.php +++ b/includes/Html.php @@ -548,9 +548,10 @@ class Html { } /** - * Output a <script> tag with the given contents. TODO: do some useful - * escaping as well, like if $contents contains literal '</script>' or (for - * XML) literal "]]>". + * Output a "<script>" tag with the given contents. + * + * @todo do some useful escaping as well, like if $contents contains + * literal "</script>" or (for XML) literal "]]>". * * @param $contents string JavaScript * @return string Raw HTML @@ -572,8 +573,8 @@ class Html { } /** - * Output a <script> tag linking to the given URL, e.g., - * <script src=foo.js></script>. + * Output a "<script>" tag linking to the given URL, e.g., + * "<script src=foo.js></script>". * * @param $url string * @return string Raw HTML @@ -591,9 +592,9 @@ class Html { } /** - * Output a <style> tag with the given contents for the given media type + * Output a "<style>" tag with the given contents for the given media type * (if any). TODO: do some useful escaping as well, like if $contents - * contains literal '</style>' (admittedly unlikely). + * contains literal "</style>" (admittedly unlikely). * * @param $contents string CSS * @param $media mixed A media type string, like 'screen' @@ -613,7 +614,7 @@ class Html { } /** - * Output a <link rel=stylesheet> linking to the given URL for the given + * Output a "<link rel=stylesheet>" linking to the given URL for the given * media type (if any). * * @param $url string @@ -630,7 +631,7 @@ class Html { } /** - * Convenience function to produce an <input> element. This supports the + * Convenience function to produce an "<input>" element. This supports the * new HTML5 input types and attributes, and will silently strip them if * $wgHtml5 is false. * @@ -663,11 +664,12 @@ class Html { } /** - * Convenience function to produce an <input> element. This supports leaving - * out the cols= and rows= which Xml requires and are required by HTML4/XHTML - * but not required by HTML5 and will silently set cols="" and rows="" if - * $wgHtml5 is false and cols and rows are omitted (HTML4 validates present - * but empty cols="" and rows="" as valid). + * Convenience function to produce an "<input>" element. + * + * This supports leaving out the cols= and rows= which Xml requires and are + * required by HTML4/XHTML but not required by HTML5 and will silently set + * cols="" and rows="" if $wgHtml5 is false and cols and rows are omitted + * (HTML4 validates present but empty cols="" and rows="" as valid). * * @param $name string name attribute * @param $value string value attribute @@ -706,7 +708,7 @@ class Html { * * @param $params array: * - selected: [optional] Id of namespace which should be pre-selected - * - all: [optional] Value of item for "all namespaces". If null or unset, no <option> is generated to select all namespaces + * - all: [optional] Value of item for "all namespaces". If null or unset, no "<option>" is generated to select all namespaces * - label: text for label to add before the field * - exclude: [optional] Array of namespace ids to exclude * - disable: [optional] Array of namespace ids for which the option should be disabled in the selector diff --git a/includes/Import.php b/includes/Import.php index 9ebc34c91b..491ec0936e 100644 --- a/includes/Import.php +++ b/includes/Import.php @@ -1,6 +1,6 @@ <?php /** - * MediaWiki page data importer + * MediaWiki page data importer. * * Copyright Â© 2003,2005 Brion Vibber <brion@pobox.com> * http://www.mediawiki.org/ @@ -275,7 +275,7 @@ class WikiImporter { } /** - * Notify the callback function when a new <page> is reached. + * Notify the callback function when a new "<page>" is reached. * @param $title Title */ function pageCallback( $title ) { @@ -285,7 +285,7 @@ class WikiImporter { } /** - * Notify the callback function when a </page> is closed. + * Notify the callback function when a "</page>" is closed. * @param $title Title * @param $origTitle Title * @param $revCount Integer diff --git a/includes/MagicWord.php b/includes/MagicWord.php index 9745b9ada2..997034cf46 100644 --- a/includes/MagicWord.php +++ b/includes/MagicWord.php @@ -24,7 +24,7 @@ */ /** - * This class encapsulates "magic words" such as #redirect, __NOTOC__, etc. + * This class encapsulates "magic words" such as "#redirect", __NOTOC__, etc. * * @par Usage: * @code @@ -42,7 +42,7 @@ * * To add magic words in an extension, use $magicWords in a file listed in * $wgExtensionMessagesFiles[]. - * + * * @par Example: * @code * $magicWords = array(); diff --git a/includes/OutputPage.php b/includes/OutputPage.php index c00cfbe2b0..a2023f50a9 100644 --- a/includes/OutputPage.php +++ b/includes/OutputPage.php @@ -36,10 +36,10 @@ * @todo document */ class OutputPage extends ContextSource { - /// Should be private. Used with addMeta() which adds <meta> + /// Should be private. Used with addMeta() which adds "<meta>" var $mMetatags = array(); - /// <meta keywords="stuff"> most of the time the first 10 links to an article + /// "<meta keywords='stuff'>" most of the time the first 10 links to an article var $mKeywords = array(); var $mLinktags = array(); @@ -50,7 +50,7 @@ class OutputPage extends ContextSource { /// Should be private - has getter and setter. Contains the HTML title var $mPagetitle = ''; - /// Contains all of the <body> content. Should be private we got set/get accessors and the append() method. + /// Contains all of the "<body>" content. Should be private we got set/get accessors and the append() method. var $mBodytext = ''; /** @@ -60,7 +60,7 @@ class OutputPage extends ContextSource { */ public $mDebugtext = ''; // TODO: we might want to replace it by wfDebug() wfDebugLog() - /// Should be private. Stores contents of <title> tag + /// Should be private. Stores contents of "<title>" tag var $mHTMLtitle = ''; /// Should be private. Is the displayed content related to the source of the corresponding wiki article. @@ -116,8 +116,8 @@ class OutputPage extends ContextSource { /** * Should be private. Used for JavaScript (pre resource loader) * We should split js / css. - * mScripts content is inserted as is in <head> by Skin. This might contains - * either a link to a stylesheet or inline css. + * mScripts content is inserted as is in "<head>" by Skin. This might + * contains either a link to a stylesheet or inline css. */ var $mScripts = ''; @@ -135,7 +135,7 @@ class OutputPage extends ContextSource { */ var $mPageLinkTitle = ''; - /// Array of elements in <head>. Parser might add its own headers! + /// Array of elements in "<head>". Parser might add its own headers! var $mHeadItems = array(); // @todo FIXME: Next variables probably comes from the resource loader @@ -197,7 +197,7 @@ class OutputPage extends ContextSource { /** * Comes from the parser. This was probably made to load CSS/JS only - * if we had <gallery>. Used directly in CategoryPage.php + * if we had "<gallery>". Used directly in CategoryPage.php * Looks like resource loader can replace this. */ var $mNoGallery = false; @@ -292,7 +292,7 @@ class OutputPage extends ContextSource { } /** - * Add a new <meta> tag + * Add a new "<meta>" tag * To add an http-equiv meta tag, precede the name with "http:" * * @param $name String tag name @@ -405,7 +405,7 @@ class OutputPage extends ContextSource { /** * Add a self-contained script tag with the given contents * - * @param $script String: JavaScript text, no <script> tags + * @param $script String: JavaScript text, no "<script>" tags */ public function addInlineScript( $script ) { $this->mScripts .= Html::inlineScript( "\n$script\n" ) . "\n"; @@ -779,7 +779,7 @@ class OutputPage extends ContextSource { } /** - * "HTML title" means the contents of <title>. + * "HTML title" means the contents of "<title>". * It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file. * * @param $name string @@ -793,7 +793,7 @@ class OutputPage extends ContextSource { } /** - * Return the "HTML title", i.e. the content of the <title> tag. + * Return the "HTML title", i.e. the content of the "<title>" tag. * * @return String */ @@ -2023,11 +2023,11 @@ class OutputPage extends ContextSource { /** * Prepare this object to display an error page; disable caching and * indexing, clear the current text and redirect, set the page's title - * and optionally an custom HTML title (content of the <title> tag). + * and optionally an custom HTML title (content of the "<title>" tag). * * @param $pageTitle String|Message will be passed directly to setPageTitle() * @param $htmlTitle String|Message will be passed directly to setHTMLTitle(); - * optional, if not passed the <title> attribute will be + * optional, if not passed the "<title>" attribute will be * based on $pageTitle */ public function prepareErrorPage( $pageTitle, $htmlTitle = false ) { @@ -2391,7 +2391,7 @@ $templates /** * @param $sk Skin The given Skin * @param $includeStyle Boolean: unused - * @return String: The doctype, opening <html>, and head element. + * @return String: The doctype, opening "<html>", and head element. */ public function headElement( Skin $sk, $includeStyle = true ) { global $wgContLang; @@ -2516,8 +2516,8 @@ $templates * @param $only String ResourceLoaderModule TYPE_ class constant * @param $useESI boolean * @param $extraQuery Array with extra query parameters to add to each request. array( param => value ) - * @param $loadCall boolean If true, output an (asynchronous) mw.loader.load() call rather than a <script src="..."> tag - * @return string html <script> and <style> tags + * @param $loadCall boolean If true, output an (asynchronous) mw.loader.load() call rather than a "<script src='...'>" tag + * @return string html "<script>" and "<style>" tags */ protected function makeResourceLoaderLink( $modules, $only, $useESI = false, array $extraQuery = array(), $loadCall = false ) { global $wgResourceLoaderUseESI; @@ -2696,7 +2696,7 @@ $templates } /** - * JS stuff to put in the <head>. This is the startup module, config + * JS stuff to put in the "<head>". This is the startup module, config * vars and modules marked with position 'top' * * @return String: HTML fragment @@ -2744,12 +2744,12 @@ $templates } /** - * JS stuff to put at the 'bottom', which can either be the bottom of the <body> - * or the bottom of the <head> depending on $wgResourceLoaderExperimentalAsyncLoading: + * JS stuff to put at the 'bottom', which can either be the bottom of the "<body>" + * or the bottom of the "<head>" depending on $wgResourceLoaderExperimentalAsyncLoading: * modules marked with position 'bottom', legacy scripts ($this->mScripts), * user preferences, site JS and user JS * - * @param $inHead boolean If true, this HTML goes into the <head>, if false it goes into the <body> + * @param $inHead boolean If true, this HTML goes into the "<head>", if false it goes into the "<body>" * @return string */ function getScriptsForBottomQueue( $inHead ) { @@ -2865,7 +2865,7 @@ $templates } /** - * JS stuff to put at the bottom of the <body> + * JS stuff to put at the bottom of the "<body>" * @return string */ function getBottomScripts() { @@ -3016,7 +3016,7 @@ $templates } /** - * @param $addContentType bool: Whether <meta> specifying content type should be returned + * @param $addContentType bool: Whether "<meta>" specifying content type should be returned * * @return array in format "link name or number => 'link html'". */ @@ -3250,7 +3250,7 @@ $templates /** * @param $unused - * @param $addContentType bool: Whether <meta> specifying content type should be returned + * @param $addContentType bool: Whether "<meta>" specifying content type should be returned * * @return string HTML tag links to be put in the header. */ @@ -3259,7 +3259,7 @@ $templates } /** - * Generate a <link rel/> for a feed. + * Generate a "<link rel/>" for a feed. * * @param $type String: feed type * @param $url String: URL to the feed @@ -3314,7 +3314,7 @@ $templates } /** - * Build a set of <link>s for the stylesheets specified in the $this->styles array. + * Build a set of "<link>" elements for the stylesheets specified in the $this->styles array. * These will be applied to various media & IE conditionals. * * @return string diff --git a/includes/Pager.php b/includes/Pager.php index 750636d0bb..f80e05d0ad 100644 --- a/includes/Pager.php +++ b/includes/Pager.php @@ -993,7 +993,7 @@ abstract class TablePager extends IndexPager { * @protected * * @param $row Object: the database result row - * @return Array of <attr> => <value> + * @return Array of attribute => value */ function getRowAttrs( $row ) { $class = $this->getRowClass( $row ); @@ -1108,7 +1108,7 @@ abstract class TablePager extends IndexPager { } /** - * Get a <select> element which has options for each of the allowed limits + * Get a "<select>" element which has options for each of the allowed limits * * @return String: HTML fragment */ @@ -1138,7 +1138,7 @@ abstract class TablePager extends IndexPager { } /** - * Get <input type="hidden"> elements for use in a method="get" form. + * Get \<input type="hidden"\> elements for use in a method="get" form. * Resubmits all defined elements of the query string, except for a * blacklist, passed in the $blacklist parameter. * diff --git a/includes/Preferences.php b/includes/Preferences.php index bf63d652d4..e798d3d90e 100644 --- a/includes/Preferences.php +++ b/includes/Preferences.php @@ -1587,7 +1587,7 @@ class PreferencesForm extends HTMLForm { } /** - * Get the <legend> for a given section key. Normally this is the + * Get the "<legend>" for a given section key. Normally this is the * prefs-$key message but we'll allow extensions to override it. * @param $key string * @return string diff --git a/includes/RevisionList.php b/includes/RevisionList.php index fc777b5b04..3c5cfa8ea2 100644 --- a/includes/RevisionList.php +++ b/includes/RevisionList.php @@ -245,7 +245,7 @@ abstract class RevisionItemBase { abstract public function canViewContent(); /** - * Get the HTML of the list item. Should be include <li></li> tags. + * Get the HTML of the list item. Should be include "<li></li>" tags. * This is used to show the list in HTML form, by the special page. */ abstract public function getHTML(); diff --git a/includes/Sanitizer.php b/includes/Sanitizer.php index fed5762c00..a0c77da758 100644 --- a/includes/Sanitizer.php +++ b/includes/Sanitizer.php @@ -1253,7 +1253,7 @@ class Sanitizer { * a. named char refs can only be < > & ", others are * numericized (this way we're well-formed even without a DTD) * b. any numeric char refs must be legal chars, not invalid or forbidden - * c. use &#x, not &#X + * c. use lower cased "&#x", not "&#X" * d. fix or reject non-valid attributes * * @param $text String @@ -1421,7 +1421,7 @@ class Sanitizer { /** * If the named entity is defined in the HTML 4.0/XHTML 1.0 DTD, * return the UTF-8 encoding of that character. Otherwise, returns - * pseudo-entity source (eg &foo;) + * pseudo-entity source (eg "&foo;") * * @param $name String * @return String diff --git a/includes/Skin.php b/includes/Skin.php index 8d47b83d0f..ac9da93862 100644 --- a/includes/Skin.php +++ b/includes/Skin.php @@ -326,7 +326,7 @@ abstract class Skin extends ContextSource { } /** - * Make a <script> tag containing global variables + * Make a "<script>" tag containing global variables * * @deprecated in 1.19 * @param $unused @@ -397,7 +397,7 @@ abstract class Skin extends ContextSource { /** * This will be called by OutputPage::headElement when it is creating the - * <body> tag, skins can override it if they have a need to add in any + * "<body>" tag, skins can override it if they have a need to add in any * body attributes or classes of their own. * @param $out OutputPage * @param $bodyAttrs Array @@ -636,9 +636,9 @@ abstract class Skin extends ContextSource { } /** - * This gets called shortly before the </body> tag. + * This gets called shortly before the "</body>" tag. * - * @return String HTML-wrapped JS code to be put before </body> + * @return String HTML-wrapped JS code to be put before "</body>" */ function bottomScripts() { // TODO and the suckage continues. This function is really just a wrapper around diff --git a/includes/SkinLegacy.php b/includes/SkinLegacy.php index 18bc29f3e2..63852505f5 100644 --- a/includes/SkinLegacy.php +++ b/includes/SkinLegacy.php @@ -95,7 +95,7 @@ class LegacyTemplate extends BaseTemplate { } /** - * This will be called immediately after the <body> tag. Split into + * This will be called immediately after the "<body>" tag. Split into * two functions to make it easier to subclass. * @return string */ @@ -159,8 +159,8 @@ class LegacyTemplate extends BaseTemplate { } /** - * This gets called shortly before the </body> tag. - * @return String HTML to be put before </body> + * This gets called shortly before the "</body>" tag. + * @return String HTML to be put before "</body>" */ function afterContent() { return $this->doAfterContent(); diff --git a/includes/SkinTemplate.php b/includes/SkinTemplate.php index 4028e78b70..9fe2ccf317 100644 --- a/includes/SkinTemplate.php +++ b/includes/SkinTemplate.php @@ -91,7 +91,7 @@ class SkinTemplate extends Skin { var $template = 'QuickTemplate'; /** - * Whether this skin use OutputPage::headElement() to generate the <head> + * Whether this skin use OutputPage::headElement() to generate the "<head>" * tag */ var $useHeadElement = false; diff --git a/includes/User.php b/includes/User.php index 5fc0773d6e..51877f8178 100644 --- a/includes/User.php +++ b/includes/User.php @@ -527,7 +527,7 @@ class User { * as 300.300.300.300 will return true because it looks like an IP * address, despite not being strictly valid. * - * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP + * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP * address because the usemod software would "cloak" anonymous IP * addresses like this, if we allowed accounts like this to be created * new users could get the old edits of these anonymous users. diff --git a/includes/WebRequest.php b/includes/WebRequest.php index 87526fcc03..766db461c2 100644 --- a/includes/WebRequest.php +++ b/includes/WebRequest.php @@ -504,9 +504,9 @@ class WebRequest { * Fetch a text string from the given array or return $default if it's not * set. Carriage returns are stripped from the text, and with some language * modules there is an input transliteration applied. This should generally - * be used for form <textarea> and <input> fields. Used for user-supplied - * freeform text input (for which input transformations may be required - e.g. - * Esperanto x-coding). + * be used for form "<textarea>" and "<input>" fields. Used for + * user-supplied freeform text input (for which input transformations may + * be required - e.g. Esperanto x-coding). * * @param $name String * @param $default String: optional diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php index a6e33639e9..77c0fc29dd 100644 --- a/includes/api/ApiBase.php +++ b/includes/api/ApiBase.php @@ -1184,7 +1184,7 @@ abstract class ApiBase extends ContextSource { * @param $errorCode string Brief, arbitrary, stable string to allow easy * automated identification of the error, e.g., 'unknown_action' * @param $httpRespCode int HTTP response code - * @param $extradata array Data to add to the <error> element; array in ApiResult format + * @param $extradata array Data to add to the "<error>" element; array in ApiResult format */ public function dieUsage( $description, $errorCode, $httpRespCode = 0, $extradata = null ) { Profiler::instance()->close(); diff --git a/includes/api/ApiPageSet.php b/includes/api/ApiPageSet.php index b7db4f0b4b..e5146ebc6d 100644 --- a/includes/api/ApiPageSet.php +++ b/includes/api/ApiPageSet.php @@ -266,8 +266,8 @@ class ApiPageSet extends ApiQueryBase { } /** - * Returns the number of revisions (requested with revids= parameter)\ - * @return int + * Returns the number of revisions (requested with revids= parameter). + * @return int Number of revisions. */ public function getRevisionCount() { return count( $this->getRevisionIDs() ); diff --git a/includes/api/ApiQueryCategoryInfo.php b/includes/api/ApiQueryCategoryInfo.php index e5eca85481..48a4a078a3 100644 --- a/includes/api/ApiQueryCategoryInfo.php +++ b/includes/api/ApiQueryCategoryInfo.php @@ -25,7 +25,8 @@ */ /** - * This query adds the <categories> subelement to all pages with the list of categories the page is in + * This query adds the "<categories>" subelement to all pages with the list of + * categories the page is in. * * @ingroup API */ diff --git a/includes/api/ApiQueryImages.php b/includes/api/ApiQueryImages.php index 147ab6725f..3779123991 100644 --- a/includes/api/ApiQueryImages.php +++ b/includes/api/ApiQueryImages.php @@ -25,7 +25,8 @@ */ /** - * This query adds an <images> subelement to all pages with the list of images embedded into those pages. + * This query adds an "<images>" subelement to all pages with the list of + * images embedded into those pages. * * @ingroup API */ diff --git a/includes/api/ApiResult.php b/includes/api/ApiResult.php index 798b227567..7d01fa05cd 100644 --- a/includes/api/ApiResult.php +++ b/includes/api/ApiResult.php @@ -165,7 +165,7 @@ class ApiResult extends ApiBase { * @param $value Mixed * @param $subElemName string when present, content element is created * as a sub item of $arr. Use this parameter to create elements in - * format <elem>text</elem> without attributes + * format "<elem>text</elem>" without attributes. */ public static function setContent( &$arr, $value, $subElemName = null ) { if ( is_array( $value ) ) { diff --git a/includes/db/Database.php b/includes/db/Database.php index 0a1f988cbf..a3faebf974 100644 --- a/includes/db/Database.php +++ b/includes/db/Database.php @@ -1873,7 +1873,7 @@ abstract class DatabaseBase implements DatabaseType { * The keys on each level may be either integers or strings. * * @param $data Array: organized as 2-d - * array(baseKeyVal => array(subKeyVal => <ignored>, ...), ...) + * array(baseKeyVal => array(subKeyVal => [ignored], ...), ...) * @param $baseKey String: field name to match the base-level keys to (eg 'pl_namespace') * @param $subKey String: field name to match the sub-level keys to (eg 'pl_title') * @return Mixed: string SQL fragment, or false if no items in array. diff --git a/includes/filerepo/backend/FileBackend.php b/includes/filerepo/backend/FileBackend.php index 3cc9021945..b71302a2a7 100644 --- a/includes/filerepo/backend/FileBackend.php +++ b/includes/filerepo/backend/FileBackend.php @@ -37,8 +37,9 @@ * Outside callers can assume that all backends will have these functions. * * All "storage paths" are of the format "mwstore://<backend>/<container>/<path>". - * The <path> portion is a relative path that uses UNIX file system (FS) notation, - * though any particular backend may not actually be using a local filesystem. + * The "<path>" portion is a relative path that uses UNIX file system (FS) + * notation, though any particular backend may not actually be using a local + * filesystem. * Therefore, the relative paths are only virtual. * * Backend contents are stored under wiki-specific container names by default. diff --git a/includes/filerepo/backend/lockmanager/MemcLockManager.php b/includes/filerepo/backend/lockmanager/MemcLockManager.php index add1f2c9e6..79696b2f8c 100644 --- a/includes/filerepo/backend/lockmanager/MemcLockManager.php +++ b/includes/filerepo/backend/lockmanager/MemcLockManager.php @@ -56,12 +56,12 @@ class MemcLockManager extends QuorumLockManager { * Construct a new instance from configuration. * * $config paramaters include: - * 'lockServers' : Associative array of server names to <IP>:<port> strings. - * 'srvsByBucket' : Array of 1-16 consecutive integer keys, starting from 0, + * - 'lockServers' : Associative array of server names to "<IP>:<port>" strings. + * - 'srvsByBucket' : Array of 1-16 consecutive integer keys, starting from 0, * each having an odd-numbered list of server names (peers) as values. - * 'memcConfig' : Configuration array for ObjectCache::newFromParams. [optional] + * - 'memcConfig' : Configuration array for ObjectCache::newFromParams. [optional] * If set, this must use one of the memcached classes. - * 'wikiId' : Wiki ID string that all resources are relative to. [optional] + * - 'wikiId' : Wiki ID string that all resources are relative to. [optional] * * @param Array $config */ diff --git a/includes/filerepo/file/File.php b/includes/filerepo/file/File.php index 065679a87a..81536b5cab 100644 --- a/includes/filerepo/file/File.php +++ b/includes/filerepo/file/File.php @@ -1606,7 +1606,7 @@ abstract class File { } /** - * Get the deletion archive key, <sha1>.<ext> + * Get the deletion archive key, "<sha1>.<ext>" * * @return string */ diff --git a/includes/installer/WebInstallerOutput.php b/includes/installer/WebInstallerOutput.php index aabc1f36db..84d115b51d 100644 --- a/includes/installer/WebInstallerOutput.php +++ b/includes/installer/WebInstallerOutput.php @@ -153,7 +153,7 @@ class WebInstallerOutput { } /** - * <link> to index.php?css=foobar for the <head> + * "<link>" to index.php?css=foobar for the "<head>" * @return String */ private function getCssUrl( ) { diff --git a/includes/installer/WebInstallerPage.php b/includes/installer/WebInstallerPage.php index b6e7717821..c10fe88bab 100644 --- a/includes/installer/WebInstallerPage.php +++ b/includes/installer/WebInstallerPage.php @@ -232,7 +232,7 @@ class WebInstaller_Language extends WebInstallerPage { } /** - * Get a <select> for selecting languages. + * Get a "<select>" for selecting languages. * * @param $name * @param $label diff --git a/includes/job/DoubleRedirectJob.php b/includes/job/DoubleRedirectJob.php index 4e022586c9..b6f54ea551 100644 --- a/includes/job/DoubleRedirectJob.php +++ b/includes/job/DoubleRedirectJob.php @@ -36,7 +36,7 @@ class DoubleRedirectJob extends Job { /** * Insert jobs into the job queue to fix redirects to the given title - * @param $reason String: the reason for the fix, see message double-redirect-fixed-<reason> + * @param $reason String: the reason for the fix, see message "double-redirect-fixed-<reason>" * @param $redirTitle Title: the title which has changed, redirects pointing to this title are fixed * @param $destTitle bool Not used */ diff --git a/includes/json/FormatJson.php b/includes/json/FormatJson.php index cae3f12a5e..d3cc55011a 100644 --- a/includes/json/FormatJson.php +++ b/includes/json/FormatJson.php @@ -60,7 +60,7 @@ class FormatJson { * * @return Mixed: the value encoded in json in appropriate PHP type. * Values true, false and null (case-insensitive) are returned as true, false - * and &null; respectively. &null; is returned if the json cannot be + * and "&null;" respectively. "&null;" is returned if the json cannot be * decoded or if the encoded data is deeper than the recursion limit. */ public static function decode( $value, $assoc = false ) { diff --git a/includes/media/MediaTransformOutput.php b/includes/media/MediaTransformOutput.php index bf08de61cd..fc1f834a3d 100644 --- a/includes/media/MediaTransformOutput.php +++ b/includes/media/MediaTransformOutput.php @@ -84,7 +84,7 @@ abstract class MediaTransformOutput { * custom-url-link Custom URL to link to * custom-title-link Custom Title object to link to * valign vertical-align property, if the output is an inline element - * img-class Class applied to the <img> tag, if there is such a tag + * img-class Class applied to the "<img>" tag, if there is such a tag * * For images, desc-link and file-link are implemented as a click-through. For * sounds and videos, they may be displayed in other ways. diff --git a/includes/media/SVGMetadataExtractor.php b/includes/media/SVGMetadataExtractor.php index da7d428654..83f531c135 100644 --- a/includes/media/SVGMetadataExtractor.php +++ b/includes/media/SVGMetadataExtractor.php @@ -19,7 +19,7 @@ * * @file * @ingroup Media - * @author Derk-Jan Hartman <hartman _at_ videolan d0t org> + * @author "Derk-Jan Hartman <hartman _at_ videolan d0t org>" * @author Brion Vibber * @copyright Copyright Â© 2010-2010 Brion Vibber, Derk-Jan Hartman * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License @@ -255,7 +255,7 @@ class SVGReader { /** * Parse the attributes of an SVG element * - * The parser has to be in the start element of <svg> + * The parser has to be in the start element of "<svg>" */ private function handleSVGAttribs( ) { $defaultWidth = self::DEFAULT_WIDTH; diff --git a/includes/media/XMP.php b/includes/media/XMP.php index adb85df884..75fdd96dff 100644 --- a/includes/media/XMP.php +++ b/includes/media/XMP.php @@ -461,13 +461,15 @@ class XMPReader { * generally means we've finished processing a nested structure. * resets some internal variables to indicate that. * - * Note this means we hit the </closing element> not the </rdf:Seq>. + * Note this means we hit the closing element not the "</rdf:Seq>". * - * For example, when processing: + * @par For example, when processing: + * @code{,xml} * <exif:ISOSpeedRatings> <rdf:Seq> <rdf:li>64</rdf:li> * </rdf:Seq> </exif:ISOSpeedRatings> + * @endcode * - * This method is called when we hit the </exif:ISOSpeedRatings> tag. + * This method is called when we hit the "</exif:ISOSpeedRatings>" tag. * * @param $elm String namespace . space . tag name. */ @@ -523,15 +525,17 @@ class XMPReader { * Hit a closing element in MODE_LI (either rdf:Seq, or rdf:Bag ) * Add information about what type of element this is. * - * Note we still have to hit the outer </property> + * Note we still have to hit the outer "</property>" * - * For example, when processing: + * @par For example, when processing: + * @code{,xml} * <exif:ISOSpeedRatings> <rdf:Seq> <rdf:li>64</rdf:li> * </rdf:Seq> </exif:ISOSpeedRatings> + * @endcode * - * This method is called when we hit the </rdf:Seq>. + * This method is called when we hit the "</rdf:Seq>". * (For comparison, we call endElementModeSimple when we - * hit the </rdf:li>) + * hit the "</rdf:li>") * * @param $elm String namespace . ' ' . element name */ @@ -1010,7 +1014,7 @@ class XMPReader { * Also does some initial set up for the wrapper element * * @param $parser XMLParser - * @param $elm String namespace <space> element + * @param $elm String namespace "<space>" element * @param $attribs Array attribute name => value */ function startElement( $parser, $elm, $attribs ) { @@ -1093,11 +1097,13 @@ class XMPReader { * Process attributes. * Simple values can be stored as either a tag or attribute * - * Often the initial <rdf:Description> tag just has all the simple + * Often the initial "<rdf:Description>" tag just has all the simple * properties as attributes. * - * Example: + * @par Example: + * @code * <rdf:Description rdf:about="" xmlns:exif="http://ns.adobe.com/exif/1.0/" exif:DigitalZoomRatio="0/10"> + * @endcode * * @param $attribs Array attribute=>value array. */ diff --git a/includes/objectcache/MemcachedClient.php b/includes/objectcache/MemcachedClient.php index 9602ffec91..ec67a3955f 100644 --- a/includes/objectcache/MemcachedClient.php +++ b/includes/objectcache/MemcachedClient.php @@ -573,10 +573,10 @@ class MWMemcached { * output as an array (null array if no output) * * NOTE: due to a possible bug in how PHP reads while using fgets(), each - * line may not be terminated by a \r\n. More specifically, my testing + * line may not be terminated by a "\r\n". More specifically, my testing * has shown that, on FreeBSD at least, each line is terminated only - * with a \n. This is with the PHP flag auto_detect_line_endings set - * to falase (the default). + * with a "\n". This is with the PHP flag auto_detect_line_endings set + * to false (the default). * * @param $sock Resource: socket to send command on * @param $cmd String: command to run diff --git a/includes/parser/Parser.php b/includes/parser/Parser.php index 7991ca602a..23352fab4b 100644 --- a/includes/parser/Parser.php +++ b/includes/parser/Parser.php @@ -557,10 +557,11 @@ class Parser { } /** - * Process the wikitext for the ?preload= feature. (bug 5210) + * Process the wikitext for the "?preload=" feature. (bug 5210) * - * <noinclude>, <includeonly> etc. are parsed as for template transclusion, - * comments, templates, arguments, tags hooks and parser functions are untouched. + * "<noinclude>", "<includeonly>" etc. are parsed as for template + * transclusion, comments, templates, arguments, tags hooks and parser + * functions are untouched. * * @param $text String * @param $title Title @@ -788,11 +789,14 @@ class Parser { * in the text with a random marker and returns the next text. The output * parameter $matches will be an associative array filled with data in * the form: + * + * @code * 'UNIQ-xxxxx' => array( * 'element', * 'tag content', * array( 'param' => 'x' ), * '<element param="x">tag content</element>' ) ) + * @endcode * * @param $elements array list of element names. Comments are always extracted. * @param $text string Source text string. @@ -2940,7 +2944,7 @@ class Parser { * * @param $text String: The text to parse * @param $flags Integer: bitwise combination of: - * self::PTD_FOR_INCLUSION Handle <noinclude>/<includeonly> as if the text is being + * self::PTD_FOR_INCLUSION Handle "<noinclude>" and "<includeonly>" as if the text is being * included. Default is to assume a direct page view. * * The generated DOM tree must depend only on the input text and the flags. @@ -4324,7 +4328,7 @@ class Parser { } /** - * Transform wiki markup when saving a page by doing \r\n -> \n + * Transform wiki markup when saving a page by doing "\r\n" -> "\n" * conversion, substitting signatures, {{subst:}} templates, etc. * * @param $text String: the text to transform @@ -4620,7 +4624,7 @@ class Parser { } /** - * Create an HTML-style tag, e.g. <yourtag>special text</yourtag> + * Create an HTML-style tag, e.g. "<yourtag>special text</yourtag>" * The callback should have the following form: * function myParserHook( $text, $params, $parser, $frame ) { ... } * @@ -4638,7 +4642,7 @@ class Parser { * this interface, as it is not documented and injudicious use could smash * private variables.** * - * @param $tag Mixed: the tag to use, e.g. 'hook' for <hook> + * @param $tag Mixed: the tag to use, e.g. 'hook' for "<hook>" * @param $callback Mixed: the callback function (and object) to use for the tag * @return Mixed|null The old value of the mTagHooks array associated with the hook */ @@ -4668,7 +4672,7 @@ class Parser { * @since 1.10 * @todo better document or deprecate this * - * @param $tag Mixed: the tag to use, e.g. 'hook' for <hook> + * @param $tag Mixed: the tag to use, e.g. 'hook' for "<hook>" * @param $callback Mixed: the callback function (and object) to use for the tag * @return Mixed|null The old value of the mTagHooks array associated with the hook */ @@ -4776,7 +4780,7 @@ class Parser { } /** - * Create a tag function, e.g. <test>some stuff</test>. + * Create a tag function, e.g. "<test>some stuff</test>". * Unlike tag hooks, tag functions are parsed at preprocessor level. * Unlike parser functions, their content is not preprocessed. * @return null @@ -4797,7 +4801,7 @@ class Parser { /** * @todo FIXME: Update documentation. makeLinkObj() is deprecated. - * Replace  link placeholders with actual links, in the buffer + * Replace "" link placeholders with actual links, in the buffer * Placeholders created in Skin::makeLinkObj() * * @param $text string @@ -4810,7 +4814,7 @@ class Parser { } /** - * Replace  link placeholders with plain text of links + * Replace "" link placeholders with plain text of links * (not HTML-formatted). * * @param $text String @@ -5282,13 +5286,13 @@ class Parser { * * @param $text String: Page wikitext * @param $section String: a section identifier string of the form: - * <flag1> - <flag2> - ... - <section number> + * "<flag1> - <flag2> - ... - <section number>" * * Currently the only recognised flag is "T", which means the target section number * was derived during a template inclusion parse, in other words this is a template * section edit link. If no flags are given, it was an ordinary section edit link. * This flag is required to avoid a section numbering mismatch when a section is - * enclosed by <includeonly> (bug 6563). + * enclosed by "<includeonly>" (bug 6563). * * The section number 0 pulls the text before the first heading; other numbers will * pull the given section along with its lower-level subsections. If the section is diff --git a/includes/parser/ParserOutput.php b/includes/parser/ParserOutput.php index d929f1a532..62d3bfdc4f 100644 --- a/includes/parser/ParserOutput.php +++ b/includes/parser/ParserOutput.php @@ -348,7 +348,7 @@ class ParserOutput extends CacheTime { } /** - * Add some text to the <head>. + * Add some text to the "<head>". * If $tag is set, the section with that tag will only be included once * in a given page. */ diff --git a/includes/parser/Preprocessor.php b/includes/parser/Preprocessor.php index 19bcbf238c..bd13f9ae97 100644 --- a/includes/parser/Preprocessor.php +++ b/includes/parser/Preprocessor.php @@ -231,7 +231,7 @@ interface PPNode { function getName(); /** - * Split a <part> node into an associative array containing: + * Split a "<part>" node into an associative array containing: * name PPNode name * index String index * value PPNode value @@ -239,13 +239,13 @@ interface PPNode { function splitArg(); /** - * Split an <ext> node into an associative array containing name, attr, inner and close + * Split an "<ext>" node into an associative array containing name, attr, inner and close * All values in the resulting array are PPNodes. Inner and close are optional. */ function splitExt(); /** - * Split an <h> node + * Split an "<h>" node */ function splitHeading(); } diff --git a/includes/parser/Preprocessor_DOM.php b/includes/parser/Preprocessor_DOM.php index f991df2a2f..7fe420d8e6 100644 --- a/includes/parser/Preprocessor_DOM.php +++ b/includes/parser/Preprocessor_DOM.php @@ -112,7 +112,7 @@ class Preprocessor_DOM implements Preprocessor { * * @param $text String: the text to parse * @param $flags Integer: bitwise combination of: - * Parser::PTD_FOR_INCLUSION Handle <noinclude>/<includeonly> as if the text is being + * Parser::PTD_FOR_INCLUSION Handle "<noinclude>" and "<includeonly>" as if the text is being * included. Default is to assume a direct page view. * * The generated DOM tree must depend only on the input text and the flags. @@ -1658,10 +1658,10 @@ class PPNode_DOM implements PPNode { } /** - * Split a <part> node into an associative array containing: - * name PPNode name - * index String index - * value PPNode value + * Split a "<part>" node into an associative array containing: + * - name PPNode name + * - index String index + * - value PPNode value * * @return array */ @@ -1681,7 +1681,7 @@ class PPNode_DOM implements PPNode { } /** - * Split an <ext> node into an associative array containing name, attr, inner and close + * Split an "<ext>" node into an associative array containing name, attr, inner and close * All values in the resulting array are PPNodes. Inner and close are optional. * * @return array @@ -1708,7 +1708,7 @@ class PPNode_DOM implements PPNode { } /** - * Split a <h> node + * Split a "<h>" node * @return array */ function splitHeading() { diff --git a/includes/parser/Preprocessor_Hash.php b/includes/parser/Preprocessor_Hash.php index f455a1db7e..0e202fd61b 100644 --- a/includes/parser/Preprocessor_Hash.php +++ b/includes/parser/Preprocessor_Hash.php @@ -24,7 +24,7 @@ /** * Differences from DOM schema: * * attribute nodes are children - * * <h> nodes that aren't at the top are replaced with <possible-h> + * * "<h>" nodes that aren't at the top are replaced with <possible-h> * @ingroup Parser */ class Preprocessor_Hash implements Preprocessor { @@ -91,7 +91,7 @@ class Preprocessor_Hash implements Preprocessor { * * @param $text String: the text to parse * @param $flags Integer: bitwise combination of: - * Parser::PTD_FOR_INCLUSION Handle <noinclude>/<includeonly> as if the text is being + * Parser::PTD_FOR_INCLUSION Handle "<noinclude>" and "<includeonly>" as if the text is being * included. Default is to assume a direct page view. * * The generated DOM tree must depend only on the input text and the flags. @@ -1603,10 +1603,10 @@ class PPNode_Hash_Tree implements PPNode { } /** - * Split a <part> node into an associative array containing: - * name PPNode name - * index String index - * value PPNode value + * Split a "<part>" node into an associative array containing: + * - name PPNode name + * - index String index + * - value PPNode value * * @return array */ @@ -1638,7 +1638,7 @@ class PPNode_Hash_Tree implements PPNode { } /** - * Split an <ext> node into an associative array containing name, attr, inner and close + * Split an "<ext>" node into an associative array containing name, attr, inner and close * All values in the resulting array are PPNodes. Inner and close are optional. * * @return array @@ -1666,7 +1666,7 @@ class PPNode_Hash_Tree implements PPNode { } /** - * Split an <h> node + * Split an "<h>" node * * @return array */ @@ -1692,7 +1692,7 @@ class PPNode_Hash_Tree implements PPNode { } /** - * Split a <template> or <tplarg> node + * Split a "<template>" or "<tplarg>" node * * @return array */ diff --git a/includes/resourceloader/ResourceLoader.php b/includes/resourceloader/ResourceLoader.php index 8b1452edfb..99fe7ed5eb 100644 --- a/includes/resourceloader/ResourceLoader.php +++ b/includes/resourceloader/ResourceLoader.php @@ -858,7 +858,7 @@ class ResourceLoader { /** * Combines an associative array mapping media type to CSS into a - * single stylesheet with @media blocks. + * single stylesheet with "@media" blocks. * * @param $styles Array: List of CSS strings keyed by media type * diff --git a/includes/resourceloader/ResourceLoaderModule.php b/includes/resourceloader/ResourceLoaderModule.php index 035ff0975f..1e19d0fa4e 100644 --- a/includes/resourceloader/ResourceLoaderModule.php +++ b/includes/resourceloader/ResourceLoaderModule.php @@ -237,8 +237,8 @@ abstract class ResourceLoaderModule { /** * Where on the HTML page should this module's JS be loaded? - * 'top': in the <head> - * 'bottom': at the bottom of the <body> + * - 'top': in the "<head>" + * - 'bottom': at the bottom of the "<body>" * * @return string */ -- 2.20.1