Remove auto-generated "Constructor" documentation on constructors
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. Change-Id: I994d11e05f202b880390723e148d79c72cca29f0
This commit is contained in:
parent
b0ae261d2c
commit
d14faa6bed
22 changed files with 0 additions and 35 deletions
|
|
@ -60,7 +60,6 @@ class MergeHistory {
|
|||
protected $revisionsMerged;
|
||||
|
||||
/**
|
||||
* MergeHistory constructor.
|
||||
* @param Title $source Page from which history will be merged
|
||||
* @param Title $dest Page to which history will be merged
|
||||
* @param string|bool $timestamp Timestamp up to which history from the source will be merged
|
||||
|
|
|
|||
|
|
@ -55,8 +55,6 @@ class StubObject {
|
|||
protected $params;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @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
|
||||
|
|
|
|||
|
|
@ -259,8 +259,6 @@ abstract class Action implements MessageLocalizer {
|
|||
}
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* Only public since 1.21
|
||||
*
|
||||
* @param Page $page
|
||||
|
|
|
|||
1
includes/cache/LinkBatch.php
vendored
1
includes/cache/LinkBatch.php
vendored
|
|
@ -43,7 +43,6 @@ class LinkBatch {
|
|||
protected $caller;
|
||||
|
||||
/**
|
||||
* LinkBatch constructor.
|
||||
* @param LinkTarget[] $arr Initial items to be added to the batch
|
||||
*/
|
||||
public function __construct( $arr = [] ) {
|
||||
|
|
|
|||
|
|
@ -183,7 +183,6 @@ class LocalisationCache {
|
|||
private $mergeableKeys = null;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
* For constructor parameters, see the documentation in DefaultSettings.php
|
||||
* for $wgLocalisationCacheConf.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -59,7 +59,6 @@ class WikiTextStructure {
|
|||
];
|
||||
|
||||
/**
|
||||
* WikiTextStructure constructor.
|
||||
* @param ParserOutput $parserOutput
|
||||
*/
|
||||
public function __construct( ParserOutput $parserOutput ) {
|
||||
|
|
|
|||
|
|
@ -211,7 +211,6 @@ class Diff {
|
|||
protected $bailoutComplexity = 0;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
* Computes diff between sequences of strings.
|
||||
*
|
||||
* @param string[] $from_lines An array of strings.
|
||||
|
|
|
|||
|
|
@ -215,7 +215,6 @@ class LocalFile extends File {
|
|||
}
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
* Do not call this except from inside a repo class.
|
||||
* @param Title $title
|
||||
* @param FileRepo $repo
|
||||
|
|
|
|||
|
|
@ -47,8 +47,6 @@ class CliInstaller extends Installer {
|
|||
];
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $siteName
|
||||
* @param string $admin
|
||||
* @param array $option
|
||||
|
|
|
|||
|
|
@ -41,8 +41,6 @@ class LocalSettingsGenerator {
|
|||
protected $installer;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param Installer $installer
|
||||
*/
|
||||
public function __construct( Installer $installer ) {
|
||||
|
|
|
|||
|
|
@ -130,8 +130,6 @@ class WebInstaller extends Installer {
|
|||
protected $currentPageName;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param WebRequest $request
|
||||
*/
|
||||
public function __construct( WebRequest $request ) {
|
||||
|
|
|
|||
|
|
@ -67,7 +67,6 @@ abstract class GenericArrayObject extends ArrayObject {
|
|||
}
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
* @see ArrayObject::__construct
|
||||
*
|
||||
* @since 1.20
|
||||
|
|
|
|||
|
|
@ -46,8 +46,6 @@ class MemoizedCallable {
|
|||
private $callableName;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @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).
|
||||
|
|
|
|||
|
|
@ -130,8 +130,6 @@ class XMPReader implements LoggerAwareInterface {
|
|||
private $logger;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* Primary job is to initialize the XMLParser
|
||||
*/
|
||||
function __construct( LoggerInterface $logger = null ) {
|
||||
|
|
|
|||
|
|
@ -437,8 +437,6 @@ class ManualLogEntry extends LogEntryBase {
|
|||
protected $legacy = false;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @since 1.19
|
||||
* @param string $type
|
||||
* @param string $subtype
|
||||
|
|
|
|||
|
|
@ -55,7 +55,6 @@ class LogEventsList extends ContextSource {
|
|||
private $linkRenderer;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
* 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.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -12,7 +12,6 @@ class PerRowAugmentor implements ResultSetAugmentor {
|
|||
private $rowAugmentor;
|
||||
|
||||
/**
|
||||
* PerRowAugmentor constructor.
|
||||
* @param ResultAugmentor $augmentor Per-result augmentor to use.
|
||||
*/
|
||||
public function __construct( ResultAugmentor $augmentor ) {
|
||||
|
|
|
|||
|
|
@ -39,7 +39,6 @@ abstract class SearchIndexFieldDefinition implements SearchIndexField {
|
|||
private $mergeCallback;
|
||||
|
||||
/**
|
||||
* SearchIndexFieldDefinition constructor.
|
||||
* @param string $name Field name
|
||||
* @param int $type Index type
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -40,8 +40,6 @@ class MediaWikiSite extends Site {
|
|||
const PATH_PAGE = 'page_path';
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @since 1.21
|
||||
*
|
||||
* @param string $type
|
||||
|
|
|
|||
|
|
@ -122,8 +122,6 @@ class Site implements Serializable {
|
|||
protected $internalId = null;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @since 1.21
|
||||
*
|
||||
* @param string $type
|
||||
|
|
|
|||
|
|
@ -29,8 +29,6 @@ use Wikimedia\Rdbms\IDatabase;
|
|||
class UserRightsProxy {
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @see newFromId()
|
||||
* @see newFromName()
|
||||
* @param IDatabase $db Db connection
|
||||
|
|
|
|||
|
|
@ -27,9 +27,6 @@ class FileContentsHasher {
|
|||
/** @var FileContentsHasher */
|
||||
private static $instance;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*/
|
||||
public function __construct() {
|
||||
$this->cache = ObjectCache::getLocalServerInstance( 'hash' );
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue