From: Antoine Musso Date: Mon, 22 Oct 2012 10:29:52 +0000 (+0200) Subject: miscellaneous doxygen warnings X-Git-Tag: 1.31.0-rc.0~21917 X-Git-Url: https://git.heureux-cyclage.org/?p=lhc%2Fweb%2Fwiklou.git;a=commitdiff_plain;h=9362bb6c56691822a687dea0a17975dcdeb0b407 miscellaneous doxygen warnings * @licence -> @license * Protects inline HTML by using double quotes, our inline comments uses elements such as

or * Commands in lowercase (@TODO -> @todo, @NOTE -> @note) * removes @abstract and @static since doxygen detects them from PHP code. * various undocumented function parameters * typos in parameters declarations Change-Id: I62ad6fc124c355bf31acc780b9614a59cf79a421 --- diff --git a/includes/CacheHelper.php b/includes/CacheHelper.php index ac46fc4260..f0ae5a313f 100644 --- a/includes/CacheHelper.php +++ b/includes/CacheHelper.php @@ -18,7 +18,7 @@ * http://www.gnu.org/copyleft/gpl.html * * @file - * @licence GNU GPL v2 or later + * @license GNU GPL v2 or later * @author Jeroen De Dauw < jeroendedauw@gmail.com > */ diff --git a/includes/DataUpdate.php b/includes/DataUpdate.php index 088bb7e774..04029db3da 100644 --- a/includes/DataUpdate.php +++ b/includes/DataUpdate.php @@ -74,7 +74,6 @@ abstract class DataUpdate implements DeferrableUpdate { * This allows for limited transactional logic across multiple backends for storing * secondary data. * - * @static * @param $updates array a list of DataUpdate instances * @throws Exception|null */ diff --git a/includes/IP.php b/includes/IP.php index 10c707e722..1b40f4bc1a 100644 --- a/includes/IP.php +++ b/includes/IP.php @@ -18,7 +18,7 @@ * http://www.gnu.org/copyleft/gpl.html * * @file - * @author Antoine Musso , Aaron Schulz + * @author Antoine Musso "", Aaron Schulz */ // Some regex definition to "play" with IP address and IP address blocks diff --git a/includes/Title.php b/includes/Title.php index c3e37a0f2b..a7bea9d357 100644 --- a/includes/Title.php +++ b/includes/Title.php @@ -1369,6 +1369,8 @@ class Title { * * @see self::getLocalURL * @see wfExpandUrl + * @param $query + * @param $query2 bool * @param $proto Protocol type to use in URL * @return String the URL */ @@ -1495,6 +1497,8 @@ class Title { * * See getLocalURL for the arguments. * + * @param $query + * @param $query2 bool * @param $proto Protocol to use; setting this will cause a full URL to be used * @see self::getLocalURL * @return String the URL diff --git a/includes/WebResponse.php b/includes/WebResponse.php index 9c613a97bc..e4677380f4 100644 --- a/includes/WebResponse.php +++ b/includes/WebResponse.php @@ -44,7 +44,7 @@ class WebResponse { * @param $value String: value to give cookie * @param $expire Int: number of seconds til cookie expires * @param $prefix String: Prefix to use, if not $wgCookiePrefix (use '' for no prefix) - * @param @domain String: Cookie domain to use, if not $wgCookieDomain + * @param $domain String: Cookie domain to use, if not $wgCookieDomain * @param $forceSecure Bool: * true: force the cookie to be set with the secure attribute * false: force the cookie to be set without the secure attribute @@ -149,7 +149,7 @@ class FauxResponse extends WebResponse { * @param $expire Int: number of seconds til cookie expires (Default: 0) * @param $prefix TODO DOCUMENT (Default: null) * @param $domain TODO DOCUMENT (Default: null) - * + * @param $forceSecure TODO DOCUMENT (Default: null) */ public function setcookie( $name, $value, $expire = 0, $prefix = null, $domain = null, $forceSecure = null ) { $this->cookies[$name] = $value; diff --git a/includes/WikiPage.php b/includes/WikiPage.php index bdec273134..c148a5f14d 100644 --- a/includes/WikiPage.php +++ b/includes/WikiPage.php @@ -1447,7 +1447,7 @@ class WikiPage extends Page implements IDBAccessObject { /** * @param $section null|bool|int or a section number (0, 1, 2, T1, T2...) - * @param $content Content: new content of the section + * @param $sectionContent Content: new content of the section * @param $sectionTitle String: new section's subject, only if $section is 'new' * @param $edittime String: revision timestamp or null to use the current revision * @@ -2450,6 +2450,7 @@ class WikiPage extends Page implements IDBAccessObject { * @param $reason string delete reason for deletion log * @param $suppress boolean suppress all revisions and log the deletion in * the suppression log instead of the deletion log + * @param $id int article ID * @param $commit boolean defaults to true, triggers transaction end * @param &$error Array of errors to append to * @param $user User The deleting user diff --git a/includes/actions/InfoAction.php b/includes/actions/InfoAction.php index 510f4ef48c..e986323bac 100644 --- a/includes/actions/InfoAction.php +++ b/includes/actions/InfoAction.php @@ -582,7 +582,7 @@ class InfoAction extends FormlessAction { } /** - * Returns the name that goes in the

page title. + * Returns the name that goes in the "

" page title. * * @return string */ @@ -653,7 +653,7 @@ class InfoAction extends FormlessAction { } /** - * Returns the description that goes below the

tag. + * Returns the description that goes below the "

" tag. * * @return string */ diff --git a/includes/api/ApiFormatNone.php b/includes/api/ApiFormatNone.php index 31c90e101a..b3bde37851 100644 --- a/includes/api/ApiFormatNone.php +++ b/includes/api/ApiFormatNone.php @@ -4,7 +4,7 @@ * * Created on Oct 22, 2006 * - * Copyright © 2006 Yuri Astrakhan @gmail.com + * Copyright © 2006 Yuri Astrakhan "@gmail.com" * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/includes/api/ApiQueryORM.php b/includes/api/ApiQueryORM.php index 3b18d8a92d..ace2105b1f 100644 --- a/includes/api/ApiQueryORM.php +++ b/includes/api/ApiQueryORM.php @@ -23,7 +23,7 @@ * @file * @ingroup API * - * @licence GNU GPL v2+ + * @license GNU GPL v2+ * @author Jeroen De Dauw < jeroendedauw@gmail.com > */ abstract class ApiQueryORM extends ApiQueryBase { diff --git a/includes/cache/CacheDependency.php b/includes/cache/CacheDependency.php index a3c2b52ae2..5cdc867b63 100644 --- a/includes/cache/CacheDependency.php +++ b/includes/cache/CacheDependency.php @@ -74,7 +74,7 @@ class DependencyWrapper { /** * Get the user-defined value - * @return bool|\Mixed + * @return bool|Mixed */ function getValue() { return $this->value; diff --git a/includes/content/AbstractContent.php b/includes/content/AbstractContent.php index 495711ab05..0a8bb9e997 100644 --- a/includes/content/AbstractContent.php +++ b/includes/content/AbstractContent.php @@ -381,8 +381,8 @@ abstract class AbstractContent implements Content { * * @since 1.21 * - * @param $page \WikiPage the deleted page - * @param $parserOutput null|\ParserOutput optional parser output object + * @param $page WikiPage the deleted page + * @param $parserOutput null|ParserOutput optional parser output object * for efficient access to meta-information about the content object. * Provide if you have one handy. * diff --git a/includes/content/Content.php b/includes/content/Content.php index d830dc7dc2..66d720955d 100644 --- a/includes/content/Content.php +++ b/includes/content/Content.php @@ -45,10 +45,10 @@ interface Content { * @return string The wikitext to include when another page includes this * content, or false if the content is not includable in a wikitext page. * - * @TODO: allow native handling, bypassing wikitext representation, like + * @todo allow native handling, bypassing wikitext representation, like * for includable special pages. - * @TODO: allow transclusion into other content models than Wikitext! - * @TODO: used in WikiPage and MessageCache to get message text. Not so + * @todo allow transclusion into other content models than Wikitext! + * @todo used in WikiPage and MessageCache to get message text. Not so * nice. What should we use instead?! */ public function getWikitextForTransclusion(); @@ -74,7 +74,7 @@ interface Content { * string, a nested array structure, an object, a binary blob... * anything, really. * - * @NOTE: Caller must be aware of content model! + * @note Caller must be aware of content model! */ public function getNativeData(); @@ -460,8 +460,8 @@ interface Content { * * @since 1.21 * - * @param $page \WikiPage the deleted page - * @param $parserOutput null|\ParserOutput optional parser output object + * @param $page WikiPage the deleted page + * @param $parserOutput null|ParserOutput optional parser output object * for efficient access to meta-information about the content object. * Provide if you have one handy. * diff --git a/includes/content/ContentHandler.php b/includes/content/ContentHandler.php index 33c803eed2..9c4c3afc94 100644 --- a/includes/content/ContentHandler.php +++ b/includes/content/ContentHandler.php @@ -80,7 +80,6 @@ abstract class ContentHandler { * * @since 1.21 * - * @static * @param $content Content|null * @return null|string the textual form of $content, if available * @throws MWException if $content is not an instance of TextContent and @@ -123,8 +122,6 @@ abstract class ContentHandler { * * @since 1.21 * - * @static - * * @param $text string the textual representation, will be * unserialized to create the Content object * @param $title null|Title the title of the page this text belongs to. @@ -184,7 +181,6 @@ abstract class ContentHandler { * * @since 1.21 * - * @static * @param $title Title * @return null|string default model name for the page given by $title */ @@ -256,7 +252,6 @@ abstract class ContentHandler { * * @since 1.21 * - * @static * @param $title Title * @return ContentHandler */ @@ -271,7 +266,6 @@ abstract class ContentHandler { * * @since 1.21 * - * @static * @param $content Content * @return ContentHandler */ @@ -304,7 +298,6 @@ abstract class ContentHandler { * * @since 1.21 * - * @static * @param $modelId String The ID of the content model for which to get a * handler. Use CONTENT_MODEL_XXX constants. * @return ContentHandler The ContentHandler singleton for handling the @@ -352,7 +345,6 @@ abstract class ContentHandler { * Model names are localized using system messages. Message keys * have the form content-model-$name, where $name is getContentModelName( $id ). * - * @static * @param $name String The content model ID, as given by a CONTENT_MODEL_XXX * constant or returned by Revision::getContentModel(). * @@ -415,7 +407,6 @@ abstract class ContentHandler { * * @since 1.21 * - * @abstract * @param $content Content The Content object to serialize * @param $format null|String The desired serialization format * @return string Serialized form of the content @@ -427,7 +418,6 @@ abstract class ContentHandler { * * @since 1.21 * - * @abstract * @param $blob string serialized form of the content * @param $format null|String the format used for serialization * @return Content the Content object created by deserializing $blob diff --git a/includes/content/TextContent.php b/includes/content/TextContent.php index 8e832ececa..74c5a882cd 100644 --- a/includes/content/TextContent.php +++ b/includes/content/TextContent.php @@ -91,7 +91,7 @@ class TextContent extends AbstractContent { /** * Returns the text represented by this Content object, as a string. * - * @param the raw text + * @return string: the raw text */ public function getNativeData( ) { $text = $this->mText; @@ -101,7 +101,7 @@ class TextContent extends AbstractContent { /** * Returns the text represented by this Content object, as a string. * - * @param the raw text + * @return string: the raw text */ public function getTextForSearchIndex( ) { return $this->getNativeData(); @@ -110,7 +110,7 @@ class TextContent extends AbstractContent { /** * Returns the text represented by this Content object, as a string. * - * @param the raw text + * @return string: the raw text */ public function getWikitextForTransclusion( ) { return $this->getNativeData(); @@ -133,15 +133,16 @@ class TextContent extends AbstractContent { } /** - * Diff this content object with another content object.. + * Diff this content object with another content object. * * @since 1.21diff * - * @param $that Content the other content object to compare this content object to - * @param $lang Language the language object to use for text segmentation. + * @param $that Content: The other content object to compare this content + * object to. + * @param $lang Language: The language object to use for text segmentation. * If not given, $wgContentLang is used. * - * @return DiffResult a diff representing the changes that would have to be + * @return DiffResult: A diff representing the changes that would have to be * made to this content object to make it equal to $that. */ public function diff( Content $that, Language $lang = null ) { diff --git a/includes/content/TextContentHandler.php b/includes/content/TextContentHandler.php index 9dff67edd4..9c2ae35625 100644 --- a/includes/content/TextContentHandler.php +++ b/includes/content/TextContentHandler.php @@ -30,9 +30,9 @@ class TextContentHandler extends ContentHandler { * * This text-based implementation uses wfMerge(). * - * @param $oldContent \Content|string String - * @param $myContent \Content|string String - * @param $yourContent \Content|string String + * @param $oldContent Content|string String + * @param $myContent Content|string String + * @param $yourContent Content|string String * * @return Content|Bool */ @@ -87,4 +87,4 @@ class TextContentHandler extends ContentHandler { public function makeEmptyContent() { return new TextContent( '' ); } -} \ No newline at end of file +} diff --git a/includes/content/WikitextContent.php b/includes/content/WikitextContent.php index 8f1381fdce..c11018bca3 100644 --- a/includes/content/WikitextContent.php +++ b/includes/content/WikitextContent.php @@ -212,8 +212,8 @@ class WikitextContent extends TextContent { * * @param $hasLinks Bool if it is known whether this content contains * links, provide this information here, to avoid redundant parsing to - * find out. - * @param $title null|\Title + * find out (default: null). + * @param $title Title: (default: null) * * @internal param \IContextSource $context context for parsing if necessary * @@ -268,11 +268,10 @@ class WikitextContent extends TextContent { * * @since 1.21 * - * @param $content Content the content to render - * @param $title \Title - * @param $revId null - * @param $options null|ParserOptions - * @param $generateHtml bool + * @param $title Title + * @param $revId int Revision to pass to the parser (default: null) + * @param $options ParserOptions (default: null) + * @param $generateHtml bool (default: false) * * @internal param \IContextSource|null $context * @return ParserOutput representing the HTML form of the text diff --git a/includes/db/DatabaseIbm_db2.php b/includes/db/DatabaseIbm_db2.php index 62c90d174e..880d70291a 100644 --- a/includes/db/DatabaseIbm_db2.php +++ b/includes/db/DatabaseIbm_db2.php @@ -1183,7 +1183,7 @@ class DatabaseIbm_db2 extends DatabaseBase { * @param array|string $conds * @param string $fname * @throws DBUnexpectedError - * @return bool|\ResultWrapper + * @return bool|ResultWrapper */ public function delete( $table, $conds, $fname = 'DatabaseIbm_db2::delete' ) { if ( !$conds ) { diff --git a/includes/db/DatabaseMssql.php b/includes/db/DatabaseMssql.php index ff67f47273..317ff09020 100644 --- a/includes/db/DatabaseMssql.php +++ b/includes/db/DatabaseMssql.php @@ -528,7 +528,7 @@ class DatabaseMssql extends DatabaseBase { * @param array $insertOptions * @param array $selectOptions * @throws DBQueryError - * @return null|\ResultWrapper + * @return null|ResultWrapper */ function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = 'DatabaseMssql::insertSelect', $insertOptions = array(), $selectOptions = array() ) { diff --git a/includes/db/IORMRow.php b/includes/db/IORMRow.php index e99ba6cc6b..1ea4b12671 100644 --- a/includes/db/IORMRow.php +++ b/includes/db/IORMRow.php @@ -27,7 +27,7 @@ * @file * @ingroup ORM * - * @licence GNU GPL v2 or later + * @license GNU GPL v2 or later * @author Jeroen De Dauw < jeroendedauw@gmail.com > */ diff --git a/includes/db/IORMTable.php b/includes/db/IORMTable.php index 9693789f02..be4036ea0e 100644 --- a/includes/db/IORMTable.php +++ b/includes/db/IORMTable.php @@ -23,7 +23,7 @@ * @file * @ingroup ORM * - * @licence GNU GPL v2 or later + * @license GNU GPL v2 or later * @author Jeroen De Dauw < jeroendedauw@gmail.com > */ diff --git a/includes/db/ORMIterator.php b/includes/db/ORMIterator.php index 090b893206..754279765a 100644 --- a/includes/db/ORMIterator.php +++ b/includes/db/ORMIterator.php @@ -23,7 +23,7 @@ * @file * @ingroup ORM * - * @licence GNU GPL v2 or later + * @license GNU GPL v2 or later * @author Jeroen De Dauw < jeroendedauw@gmail.com > */ interface ORMIterator extends Iterator { diff --git a/includes/db/ORMResult.php b/includes/db/ORMResult.php index 2a5837a1e7..160033c4cf 100644 --- a/includes/db/ORMResult.php +++ b/includes/db/ORMResult.php @@ -25,7 +25,7 @@ * @file ORMResult.php * @ingroup ORM * - * @licence GNU GPL v2 or later + * @license GNU GPL v2 or later * @author Jeroen De Dauw < jeroendedauw@gmail.com > */ diff --git a/includes/db/ORMRow.php b/includes/db/ORMRow.php index 303f3a20d1..fa25868d7a 100644 --- a/includes/db/ORMRow.php +++ b/includes/db/ORMRow.php @@ -27,7 +27,7 @@ * @file ORMRow.php * @ingroup ORM * - * @licence GNU GPL v2 or later + * @license GNU GPL v2 or later * @author Jeroen De Dauw < jeroendedauw@gmail.com > */ @@ -138,8 +138,9 @@ abstract class ORMRow implements IORMRow { * * @since 1.20 * - * @param string $name - * @param mixed $default + * @param $name string: Field name + * @param $default mixed: Default value to return when none is found + * (default: null) * * @throws MWException * @return mixed @@ -159,7 +160,7 @@ abstract class ORMRow implements IORMRow { * * @since 1.20 * - * @param string$name + * @param $name string * * @return mixed */ diff --git a/includes/db/ORMTable.php b/includes/db/ORMTable.php index e3a3434005..0756ce83f4 100644 --- a/includes/db/ORMTable.php +++ b/includes/db/ORMTable.php @@ -23,7 +23,7 @@ * @file ORMTable.php * @ingroup ORM * - * @licence GNU GPL v2 or later + * @license GNU GPL v2 or later * @author Jeroen De Dauw < jeroendedauw@gmail.com > */ diff --git a/includes/debug/Debug.php b/includes/debug/Debug.php index d02bcf53b5..8c60eca251 100644 --- a/includes/debug/Debug.php +++ b/includes/debug/Debug.php @@ -135,6 +135,7 @@ class MWDebug { * @since 1.19 * @param $msg string * @param $callerOffset int + * @param $level int A PHP error level. See sendWarning() * @return mixed */ public static function warning( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) { diff --git a/includes/filebackend/SwiftFileBackend.php b/includes/filebackend/SwiftFileBackend.php index 25c14f5560..e1b0a62f21 100644 --- a/includes/filebackend/SwiftFileBackend.php +++ b/includes/filebackend/SwiftFileBackend.php @@ -1216,10 +1216,10 @@ class SwiftFileBackend extends FileBackendStore { * $readGrps is a list of the possible criteria for a request to have * access to read a container. Each item is one of the following formats: * - account:user : Grants access if the request is by the given user - * - .r: : Grants access if the request is from a referrer host that + * - ".r:" : Grants access if the request is from a referrer host that * matches the expression and the request is not for a listing. * Setting this to '*' effectively makes a container public. - * - .rlistings: : Grants access if the request is from a referrer host that + * -".rlistings:": Grants access if the request is from a referrer host that * matches the expression and the request for a listing. * * $writeGrps is a list of the possible criteria for a request to have diff --git a/includes/installer/WebInstaller.php b/includes/installer/WebInstaller.php index 2f46ff0bd2..48927705f0 100644 --- a/includes/installer/WebInstaller.php +++ b/includes/installer/WebInstaller.php @@ -56,10 +56,11 @@ class WebInstaller extends Installer { /** * The main sequence of page names. These will be displayed in turn. - * To add one: - * * Add it here - * * Add a config-page- message - * * Add a WebInstaller_ class + * + * To add a new installer page: + * * Add it to this WebInstaller::$pageSequence property + * * Add a "config-page-" message + * * Add a "WebInstaller_" class * @var array */ public $pageSequence = array( diff --git a/includes/libs/GenericArrayObject.php b/includes/libs/GenericArrayObject.php index e72541c0df..9b3e796e79 100644 --- a/includes/libs/GenericArrayObject.php +++ b/includes/libs/GenericArrayObject.php @@ -29,7 +29,7 @@ * * @file * - * @licence GNU GPL v2+ + * @license GNU GPL v2+ * @author Jeroen De Dauw < jeroendedauw@gmail.com > */ abstract class GenericArrayObject extends ArrayObject { diff --git a/includes/resourceloader/ResourceLoader.php b/includes/resourceloader/ResourceLoader.php index 92e7fcf8fd..670586383d 100644 --- a/includes/resourceloader/ResourceLoader.php +++ b/includes/resourceloader/ResourceLoader.php @@ -873,7 +873,7 @@ class ResourceLoader { * Combines an associative array mapping media type to CSS into a * single stylesheet with "@media" blocks. * - * @param $styles Array: Array keyed by media type containing (arrays of) CSS strings. + * @param $stylePairs Array: Array keyed by media type containing (arrays of) CSS strings. * * @return Array */ diff --git a/includes/search/SearchEngine.php b/includes/search/SearchEngine.php index e1bb32f25b..f8f5fa59f6 100644 --- a/includes/search/SearchEngine.php +++ b/includes/search/SearchEngine.php @@ -163,7 +163,7 @@ class SearchEngine { /** * Really find the title match. - * @return null|\Title + * @return null|Title */ private static function getNearMatchInternal( $searchterm ) { global $wgContLang, $wgEnableSearchContributorsByIP; diff --git a/includes/search/SearchMssql.php b/includes/search/SearchMssql.php index 4edce35f97..23dd479ffa 100644 --- a/includes/search/SearchMssql.php +++ b/includes/search/SearchMssql.php @@ -192,7 +192,7 @@ class SearchMssql extends SearchEngine { * @param $id Integer * @param $title String * @param $text String - * @return bool|\ResultWrapper + * @return bool|ResultWrapper */ function update( $id, $title, $text ) { // We store the column data as UTF-8 byte order marked binary stream @@ -215,7 +215,7 @@ class SearchMssql extends SearchEngine { * * @param $id Integer * @param $title String - * @return bool|\ResultWrapper + * @return bool|ResultWrapper */ function updateTitle( $id, $title ) { $table = $this->db->tableName( 'searchindex' ); diff --git a/includes/site/MediaWikiSite.php b/includes/site/MediaWikiSite.php index 71a17c821e..716f14494a 100644 --- a/includes/site/MediaWikiSite.php +++ b/includes/site/MediaWikiSite.php @@ -8,7 +8,7 @@ * @file * @ingroup Site * - * @licence GNU GPL v2+ + * @license GNU GPL v2+ * @author John Erling Blad < jeblad@gmail.com > * @author Daniel Kinzler * @author Jeroen De Dauw < jeroendedauw@gmail.com > @@ -282,7 +282,7 @@ class MediaWikiSite extends SiteObject { * * @since 1.21 * - * @param string|false + * @param $pagename string: Page name (default: false) * * @return string */ diff --git a/includes/site/Site.php b/includes/site/Site.php index 350a19d10a..200a006608 100644 --- a/includes/site/Site.php +++ b/includes/site/Site.php @@ -23,7 +23,7 @@ * @file * @ingroup Site * - * @licence GNU GPL v2+ + * @license GNU GPL v2+ * @author Jeroen De Dauw < jeroendedauw@gmail.com > */ interface Site { diff --git a/includes/site/SiteArray.php b/includes/site/SiteArray.php index df43148bc3..141629e050 100644 --- a/includes/site/SiteArray.php +++ b/includes/site/SiteArray.php @@ -23,7 +23,7 @@ * @file * @ingroup Site * - * @licence GNU GPL v2+ + * @license GNU GPL v2+ * @author Jeroen De Dauw < jeroendedauw@gmail.com > */ class SiteArray extends GenericArrayObject implements SiteList { diff --git a/includes/site/SiteList.php b/includes/site/SiteList.php index 68bd106155..6273364438 100644 --- a/includes/site/SiteList.php +++ b/includes/site/SiteList.php @@ -23,7 +23,7 @@ * @file * @ingroup Site * - * @licence GNU GPL v2+ + * @license GNU GPL v2+ * @author Jeroen De Dauw < jeroendedauw@gmail.com > */ interface SiteList extends Countable, Traversable, Serializable, ArrayAccess { diff --git a/includes/site/SiteObject.php b/includes/site/SiteObject.php index 7f143d1f0b..6470c86e0d 100644 --- a/includes/site/SiteObject.php +++ b/includes/site/SiteObject.php @@ -23,7 +23,7 @@ * @file * @ingroup Site * - * @licence GNU GPL v2+ + * @license GNU GPL v2+ * @author Jeroen De Dauw < jeroendedauw@gmail.com > * @author Daniel Werner */ diff --git a/includes/site/Sites.php b/includes/site/Sites.php index 9e87ed9253..56d567ea81 100644 --- a/includes/site/Sites.php +++ b/includes/site/Sites.php @@ -25,7 +25,7 @@ * @file * @ingroup Site * - * @licence GNU GPL v2+ + * @license GNU GPL v2+ * @author Jeroen De Dauw < jeroendedauw@gmail.com > */ class Sites { diff --git a/includes/site/SitesTable.php b/includes/site/SitesTable.php index 71e55f85bf..a03c5989fe 100644 --- a/includes/site/SitesTable.php +++ b/includes/site/SitesTable.php @@ -24,7 +24,7 @@ * @file * @ingroup Site * - * @licence GNU GPL v2+ + * @license GNU GPL v2+ * @author Jeroen De Dauw < jeroendedauw@gmail.com > */ class SitesTable extends ORMTable { diff --git a/includes/specials/SpecialBooksources.php b/includes/specials/SpecialBooksources.php index fb6532665a..8e528dc3f6 100644 --- a/includes/specials/SpecialBooksources.php +++ b/includes/specials/SpecialBooksources.php @@ -63,7 +63,7 @@ class SpecialBookSources extends SpecialPage { /** * Returns whether a given ISBN (10 or 13) is valid. True indicates validity. - * @param isbn string ISBN passed for check + * @param $isbn string ISBN passed for check * @return bool */ public static function isValidISBN( $isbn ) { diff --git a/includes/specials/SpecialCachedPage.php b/includes/specials/SpecialCachedPage.php index b3f6c7202f..949ac35145 100644 --- a/includes/specials/SpecialCachedPage.php +++ b/includes/specials/SpecialCachedPage.php @@ -119,7 +119,7 @@ abstract class SpecialCachedPage extends SpecialPage implements ICacheHelper { * * @since 1.20 * - * @param {function} $computeFunction + * @param function $computeFunction * @param array|mixed $args * @param string|null $key * @@ -137,7 +137,7 @@ abstract class SpecialCachedPage extends SpecialPage implements ICacheHelper { * * @since 1.20 * - * @param {function} $computeFunction + * @param function $computeFunction * @param array $args * @param string|null $key */ diff --git a/includes/specials/SpecialListusers.php b/includes/specials/SpecialListusers.php index 11d7f4de2b..8b448281c5 100644 --- a/includes/specials/SpecialListusers.php +++ b/includes/specials/SpecialListusers.php @@ -36,7 +36,9 @@ class UsersPager extends AlphabeticPager { /** * @param $context IContextSource - * @param $par null|array + * @param $par array (Default null) + * @param $including boolean Whether this page is being transcluded in + * another page */ function __construct( IContextSource $context = null, $par = null, $including = null ) { if ( $context ) { diff --git a/includes/upload/UploadStash.php b/includes/upload/UploadStash.php index 560acdecdd..733c686680 100644 --- a/includes/upload/UploadStash.php +++ b/includes/upload/UploadStash.php @@ -152,7 +152,7 @@ class UploadStash { /** * Getter for file metadata. * - * @param key String: key under which file information is stored + * @param $key String: key under which file information is stored * @return Array */ public function getMetadata ( $key ) { @@ -163,7 +163,7 @@ class UploadStash { /** * Getter for fileProps * - * @param key String: key under which file information is stored + * @param $key String: key under which file information is stored * @return Array */ public function getFileProps ( $key ) { diff --git a/maintenance/Doxyfile b/maintenance/Doxyfile index e3ba4e5a1d..b4948b3e14 100644 --- a/maintenance/Doxyfile +++ b/maintenance/Doxyfile @@ -62,7 +62,8 @@ ALIASES = "type{1}= \1 :" \ "protected=\access protected" \ "public=\access public" \ "copyright=\note" \ - "license=\note" + "license=\note" \ + "codeCoverageIgnore=" OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_JAVA = NO OPTIMIZE_FOR_FORTRAN = NO