Having such comments is worse than not having them. They add zero
information. But you must read the text to understand there is
nothing you don't already know from the class and the method name.
This is similar to I994d11e. Even more trivial, because this here is
about comments that don't say anything but "constructor".
Change-Id: I474dcdb5997bea3aafd11c0760ee072dfaff124c
52 files changed:
public $rssIsPermalink = false;
/**
public $rssIsPermalink = false;
/**
* @param string|Title $title Item's title
* @param string $description
* @param string $url URL uniquely designating the item.
* @param string|Title $title Item's title
* @param string $description
* @param string $url URL uniquely designating the item.
private $oldimage = '';
/**
private $oldimage = '';
/**
* @param File $file File object we're deleting
*/
public function __construct( $file ) {
* @param File $file File object we're deleting
*/
public function __construct( $file ) {
public $mMaxSize = 10000000;
public $mMaxCount = 100;
public $mMaxSize = 10000000;
public $mMaxCount = 100;
- /**
- * Constructor
- */
public function __construct() {
if ( !function_exists( 'gzdeflate' ) ) {
throw new MWException( "Need zlib support to read or write this "
public function __construct() {
if ( !function_exists( 'gzdeflate' ) ) {
throw new MWException( "Need zlib support to read or write this "
* @param object|array $row Either a database row or an array
* @throws MWException
* @access private
* @param object|array $row Either a database row or an array
* @throws MWException
* @access private
private $mUsers = null, $mFiles = null;
/**
private $mUsers = null, $mFiles = null;
/**
* @param bool|IDatabase $database
* - boolean: Whether to use the master DB
* - IDatabase: Database connection to use
* @param bool|IDatabase $database
* - boolean: Whether to use the master DB
* - IDatabase: Database connection to use
* @param string $global Name of the global variable.
* @param string|callable $class Name of the class of the real object
* or a factory function to call
* @param string $global Name of the global variable.
* @param string|callable $class Name of the class of the real object
* or a factory function to call
* Only public since 1.21
*
* @param Page $page
* Only public since 1.21
*
* @param Page $page
private $mergeableKeys = null;
/**
private $mergeableKeys = null;
/**
* For constructor parameters, see the documentation in DefaultSettings.php
* for $wgLocalisationCacheConf.
*
* For constructor parameters, see the documentation in DefaultSettings.php
* for $wgLocalisationCacheConf.
*
public $format, $type, $titleMsg, $descMsg;
/**
public $format, $type, $titleMsg, $descMsg;
/**
* @param string $format Feed's format (either 'rss' or 'atom')
* @param string $type Type of feed (for cache keys)
*/
* @param string $format Feed's format (either 'rss' or 'atom')
* @param string $type Type of feed (for cache keys)
*/
private $digitTransformLang;
/**
private $digitTransformLang;
/**
* @param $lang Language How to convert digits.
* For example, if given language "my" than ၇ is treated like 7.
*
* @param $lang Language How to convert digits.
* For example, if given language "my" than ၇ is treated like 7.
*
* @param IContextSource $context Context to inherit from
*/
public function __construct( IContextSource $context ) {
* @param IContextSource $context Context to inherit from
*/
public function __construct( IContextSource $context ) {
* @param IMaintainableDatabase $db A database subclass
* @param array $tablesToClone An array of tables to clone, unprefixed
* @param string $newTablePrefix Prefix to assign to the tables
* @param IMaintainableDatabase $db A database subclass
* @param array $tablesToClone An array of tables to clone, unprefixed
* @param string $newTablePrefix Prefix to assign to the tables
* @param Title $title Title of the page we're updating
* @param ParserOutput $parserOutput Output from a full parse of this page
* @param bool $recursive Queue jobs for recursive updates?
* @param Title $title Title of the page we're updating
* @param ParserOutput $parserOutput Output from a full parse of this page
* @param bool $recursive Queue jobs for recursive updates?
* @param int $id Page id to update
* @param Title|string $title Title of page to update
* @param Content|string|bool $c Content of the page to update. Default: false.
* @param int $id Page id to update
* @param Title|string $title Title of page to update
* @param Content|string|bool $c Content of the page to update. Default: false.
protected $bailoutComplexity = 0;
/**
protected $bailoutComplexity = 0;
/**
* Computes diff between sequences of strings.
*
* @param string[] $from_lines An array of strings.
* Computes diff between sequences of strings.
*
* @param string[] $from_lines An array of strings.
* @param IContextSource $context Context to use, anything else will be ignored
* @param int $old Old ID we want to show and diff with.
* @param string|int $new Either revision ID or 'prev' or 'next'. Default: 0.
* @param IContextSource $context Context to use, anything else will be ignored
* @param int $old Old ID we want to show and diff with.
* @param string|int $new Either revision ID or 'prev' or 'next'. Default: 0.
private $httpCode, $header, $content;
/**
private $httpCode, $header, $content;
/**
* @param int $httpCode HTTP status code to send to the client
* @param string|Message $content Content of the message
* @param string|Message|null $header Content of the header (\<title\> and \<h1\>)
* @param int $httpCode HTTP status code to send to the client
* @param string|Message $content Content of the message
* @param string|Message|null $header Content of the header (\<title\> and \<h1\>)
* Do not call this except from inside a repo class.
* @param Title $title
* @param FileRepo $repo
* Do not call this except from inside a repo class.
* @param Title $title
* @param FileRepo $repo
* @param string $siteName
* @param string $admin
* @param array $option
* @param string $siteName
* @param string $admin
* @param array $option
protected $holdContentHandlerUseDB = true;
/**
protected $holdContentHandlerUseDB = true;
/**
* @param Database $db To perform updates on
* @param bool $shared Whether to perform updates on shared tables
* @param Maintenance $maintenance Maintenance object which created us
* @param Database $db To perform updates on
* @param bool $shared Whether to perform updates on shared tables
* @param Maintenance $maintenance Maintenance object which created us
protected $installer;
/**
protected $installer;
/**
* @param Installer $installer
*/
public function __construct( Installer $installer ) {
* @param Installer $installer
*/
public function __construct( Installer $installer ) {
protected $currentPageName;
/**
protected $currentPageName;
/**
* @param WebRequest $request
*/
public function __construct( WebRequest $request ) {
* @param WebRequest $request
*/
public function __construct( WebRequest $request ) {
* @see ArrayObject::__construct
*
* @since 1.20
* @see ArrayObject::__construct
*
* @since 1.20
private $callableName;
/**
private $callableName;
/**
* @throws InvalidArgumentException if $callable is not a callable.
* @param callable $callable Function or method to memoize.
* @param int $ttl TTL in seconds. Defaults to 3600 (1hr). Capped at 86400 (24h).
* @throws InvalidArgumentException if $callable is not a callable.
* @param callable $callable Function or method to memoize.
* @param int $ttl TTL in seconds. Defaults to 3600 (1hr). Capped at 86400 (24h).
const KEY_SUFFIX = ':2';
/**
const KEY_SUFFIX = ':2';
/**
* Available parameters are:
* - nativeSerialize: If true, pass objects to apc_store(), and trust it
* to serialize them correctly. If false, serialize
* Available parameters are:
* - nativeSerialize: If true, pass objects to apc_store(), and trust it
* to serialize them correctly. If false, serialize
*/
class APCUBagOStuff extends APCBagOStuff {
/**
*/
class APCUBagOStuff extends APCBagOStuff {
/**
* Available parameters are:
* - nativeSerialize: If true, pass objects to apcu_store(), and trust it
* to serialize them correctly. If false, serialize
* Available parameters are:
* - nativeSerialize: If true, pass objects to apcu_store(), and trust it
* to serialize them correctly. If false, serialize
class MemcachedPeclBagOStuff extends MemcachedBagOStuff {
/**
class MemcachedPeclBagOStuff extends MemcachedBagOStuff {
/**
* Available parameters are:
* - servers: The list of IP:port combinations holding the memcached servers.
* - persistent: Whether to use a persistent connection
* Available parameters are:
* - servers: The list of IP:port combinations holding the memcached servers.
* - persistent: Whether to use a persistent connection
* Primary job is to initialize the XMLParser
*/
function __construct( LoggerInterface $logger = null ) {
* Primary job is to initialize the XMLParser
*/
function __construct( LoggerInterface $logger = null ) {
protected $legacy = false;
/**
protected $legacy = false;
/**
* @since 1.19
* @param string $type
* @param string $subtype
* @since 1.19
* @param string $type
* @param string $subtype
private $linkRenderer;
/**
private $linkRenderer;
/**
* The first two parameters used to be $skin and $out, but now only a context
* is needed, that's why there's a second unused parameter.
*
* The first two parameters used to be $skin and $out, but now only a context
* is needed, that's why there's a second unused parameter.
*
* @param string $type One of '', 'block', 'protect', 'rights', 'delete',
* 'upload', 'move'
* @param bool $rc Whether to update recent changes as well as the logging table
* @param string $type One of '', 'block', 'protect', 'rights', 'delete',
* 'upload', 'move'
* @param bool $rc Whether to update recent changes as well as the logging table
public $mLogEventsList;
/**
public $mLogEventsList;
/**
* @param LogEventsList $list
* @param string|array $types Log types to show
* @param string $performer The user who made the log entries
* @param LogEventsList $list
* @param string|array $types Log types to show
* @param string $performer The user who made the log entries
const DJVUTXT_MEMORY_LIMIT = 300000;
/**
const DJVUTXT_MEMORY_LIMIT = 300000;
/**
* @param string $filename The DjVu file name.
*/
function __construct( $filename ) {
* @param string $filename The DjVu file name.
*/
function __construct( $filename ) {
* @param string $file Filename.
* @param string $byteOrder Type of byte ordering either 'BE' (Big Endian)
* or 'LE' (Little Endian). Default ''.
* @param string $file Filename.
* @param string $byteOrder Type of byte ordering either 'BE' (Big Endian)
* or 'LE' (Little Endian). Default ''.
private $languagePrefixes = [];
/**
private $languagePrefixes = [];
/**
* Creates an SVGReader drawing from the source provided
* @param string $source URI from which to read
* @throws MWException|Exception
* Creates an SVGReader drawing from the source provided
* @param string $source URI from which to read
* @throws MWException|Exception
* @warning For interaction with the parser cache, use
* WikiPage::makeParserOptions(), ContentHandler::makeParserOptions(), or
* ParserOptions::newCanonical() instead.
* @warning For interaction with the parser cache, use
* WikiPage::makeParserOptions(), ContentHandler::makeParserOptions(), or
* ParserOptions::newCanonical() instead.
protected $params = [];
/**
protected $params = [];
/**
* @param Profiler $collector The actual profiler
* @param array $params Configuration array, passed down from $wgProfiler
*/
* @param Profiler $collector The actual profiler
* @param array $params Configuration array, passed down from $wgProfiler
*/
* @param IDatabase $db The database to search from
*/
public function __construct( IDatabase $db = null ) {
* @param IDatabase $db The database to search from
*/
public function __construct( IDatabase $db = null ) {
const PATH_PAGE = 'page_path';
/**
const PATH_PAGE = 'page_path';
/**
* @since 1.21
*
* @param string $type
* @since 1.21
*
* @param string $type
protected $internalId = null;
/**
protected $internalId = null;
/**
* @since 1.21
*
* @param string $type
* @since 1.21
*
* @param string $type
*/
class SpecialActiveUsers extends SpecialPage {
*/
class SpecialActiveUsers extends SpecialPage {
- /**
- * Constructor
- */
public function __construct() {
parent::__construct( 'Activeusers' );
}
public function __construct() {
parent::__construct( 'Activeusers' );
}
- /**
- * Constructor
- */
public function __construct() {
parent::__construct( 'Allmessages' );
}
public function __construct() {
parent::__construct( 'Allmessages' );
}
protected $nsfromMsg = 'allpagesfrom';
/**
protected $nsfromMsg = 'allpagesfrom';
/**
* @param string $name Name of the special page, as seen in links and URLs (default: 'Allpages')
*/
function __construct( $name = 'Allpages' ) {
* @param string $name Name of the special page, as seen in links and URLs (default: 'Allpages')
*/
function __construct( $name = 'Allpages' ) {
private $pageLinkDepth;
private $importSources;
private $pageLinkDepth;
private $importSources;
- /**
- * Constructor
- */
public function __construct() {
parent::__construct( 'Import', 'import' );
}
public function __construct() {
parent::__construct( 'Import', 'import' );
}
* @ingroup SpecialPage
*/
class SpecialListUsers extends IncludableSpecialPage {
* @ingroup SpecialPage
*/
class SpecialListUsers extends IncludableSpecialPage {
- /**
- * Constructor
- */
public function __construct() {
parent::__construct( 'Listusers' );
}
public function __construct() {
parent::__construct( 'Listusers' );
}
*/
class SpecialUpload extends SpecialPage {
/**
*/
class SpecialUpload extends SpecialPage {
/**
- * Constructor : initialise object
* Get data POSTed through the form and assign them to the object
* @param WebRequest $request Data posted.
*/
* Get data POSTed through the form and assign them to the object
* @param WebRequest $request Data posted.
*/
* @param Serializer $serializer
*/
public function __construct( Serializer $serializer ) {
* @param Serializer $serializer
*/
public function __construct( Serializer $serializer ) {
class UserRightsProxy {
/**
class UserRightsProxy {
/**
* @see newFromId()
* @see newFromName()
* @param IDatabase $db Db connection
* @see newFromId()
* @see newFromName()
* @param IDatabase $db Db connection
/** @var FileContentsHasher */
private static $instance;
/** @var FileContentsHasher */
private static $instance;
- /**
- * Constructor.
- */
public function __construct() {
$this->cache = ObjectCache::getLocalServerInstance( 'hash' );
}
public function __construct() {
$this->cache = ObjectCache::getLocalServerInstance( 'hash' );
}
public $mUnidtable = [];// array of the translation in each variant
/**
public $mUnidtable = [];// array of the translation in each variant
/**
* @param string $text The text between -{ and }-
* @param LanguageConverter $converter
*/
* @param string $text The text between -{ and }-
* @param LanguageConverter $converter
*/
- /**
- * Constructor
- */
public function __construct() {
parent::__construct();
$this->addDescription( 'Creates a sitemap for the site' );
public function __construct() {
parent::__construct();
$this->addDescription( 'Creates a sitemap for the site' );
private $includeExif = false;
/**
private $includeExif = false;
/**
* @param array $options Options for script.
*/
public function __construct( array $options ) {
* @param array $options Options for script.
*/
public function __construct( array $options ) {
* @param array $options Options for script.
* @param string $extension The extension name (or names).
*/
* @param array $options Options for script.
* @param string $extension The extension name (or names).
*/