docs: Fix nullable documentation for class properties
Change-Id: I6d0577124d852103f485ffdc819876a13f6641c3
This commit is contained in:
parent
1ed7ad4ffb
commit
769bdbf091
26 changed files with 31 additions and 30 deletions
|
|
@ -36,12 +36,13 @@ class MagicWordArray {
|
|||
/** @var MagicWordFactory */
|
||||
private $factory;
|
||||
|
||||
/** @var array */
|
||||
/** @var array|null */
|
||||
private $hash;
|
||||
|
||||
/** @var string[]|null */
|
||||
private $baseRegex;
|
||||
|
||||
/** @var string[]|null */
|
||||
private $regex;
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ use MediaWiki\User\UserIdentity;
|
|||
class RevisionStoreCacheRecord extends RevisionStoreRecord {
|
||||
|
||||
/**
|
||||
* @var callable ( int $revId ): [ int $rev_deleted, UserIdentity $user ]
|
||||
* @var null|callable ( int $revId ): [ int $rev_deleted, UserIdentity $user ]
|
||||
*/
|
||||
private $mCallback;
|
||||
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ use Wikimedia\Rdbms\ILoadBalancer;
|
|||
* Static accessor class for site_stats and related things
|
||||
*/
|
||||
class SiteStats {
|
||||
/** @var stdClass */
|
||||
/** @var stdClass|null */
|
||||
private static $row;
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -446,7 +446,7 @@ class ApiMain extends ApiBase {
|
|||
]
|
||||
];
|
||||
|
||||
/** @var ApiFormatBase */
|
||||
/** @var ApiFormatBase|null */
|
||||
private $mPrinter;
|
||||
|
||||
/** @var ApiModuleManager */
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ abstract class ApiQueryBase extends ApiBase {
|
|||
private $mQueryModule, $mDb;
|
||||
|
||||
/**
|
||||
* @var SelectQueryBuilder
|
||||
* @var SelectQueryBuilder|null
|
||||
*/
|
||||
private $queryBuilder;
|
||||
|
||||
|
|
|
|||
2
includes/cache/localisation/LCStoreCDB.php
vendored
2
includes/cache/localisation/LCStoreCDB.php
vendored
|
|
@ -36,7 +36,7 @@ class LCStoreCDB implements LCStore {
|
|||
/** @var Reader[]|false[] */
|
||||
private $readers;
|
||||
|
||||
/** @var Writer */
|
||||
/** @var Writer|null */
|
||||
private $writer;
|
||||
|
||||
/** @var string Current language code */
|
||||
|
|
|
|||
|
|
@ -72,7 +72,7 @@ class RequestContext implements IContextSource, MutableContext {
|
|||
private $authority;
|
||||
|
||||
/**
|
||||
* @var Language
|
||||
* @var Language|null
|
||||
*/
|
||||
private $lang;
|
||||
|
||||
|
|
@ -92,7 +92,7 @@ class RequestContext implements IContextSource, MutableContext {
|
|||
private $config;
|
||||
|
||||
/**
|
||||
* @var RequestContext
|
||||
* @var RequestContext|null
|
||||
*/
|
||||
private static $instance = null;
|
||||
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@ class LegacyHandler extends AbstractProcessingHandler {
|
|||
|
||||
/**
|
||||
* Log sink
|
||||
* @var resource
|
||||
* @var resource|null
|
||||
*/
|
||||
protected $sink;
|
||||
|
||||
|
|
|
|||
|
|
@ -192,7 +192,7 @@ class DifferenceEngine extends ContextSource {
|
|||
/** @var bool Refresh the diff cache */
|
||||
protected $mRefreshCache = false;
|
||||
|
||||
/** @var SlotDiffRenderer[] DifferenceEngine classes for the slots, keyed by role name. */
|
||||
/** @var SlotDiffRenderer[]|null DifferenceEngine classes for the slots, keyed by role name. */
|
||||
protected $slotDiffRenderers = null;
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ class DiffHistoryBlob implements HistoryBlob {
|
|||
public $mSize = 0;
|
||||
|
||||
/**
|
||||
* @var array Array of diffs. If a diff D from A to B is notated D = B - A,
|
||||
* @var array|null Array of diffs. If a diff D from A to B is notated D = B - A,
|
||||
* and Z is an empty string:
|
||||
*
|
||||
* { item[map[i]] - item[map[i-1]] where i > 0
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ class HashRing implements Serializable {
|
|||
|
||||
/** @var array[] Non-empty position-ordered list of (position, location name) */
|
||||
protected $baseRing;
|
||||
/** @var array[] Non-empty position-ordered list of (position, location name) */
|
||||
/** @var array[]|null Non-empty position-ordered list of (position, location name) */
|
||||
protected $liveRing;
|
||||
|
||||
/** @var integer Overall number of node groups per server */
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@
|
|||
class MappedIterator extends FilterIterator {
|
||||
/** @var callable */
|
||||
protected $vCallback;
|
||||
/** @var callable */
|
||||
/** @var callable|null */
|
||||
protected $aCallback;
|
||||
/** @var array */
|
||||
protected $cache = [];
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ use Wikimedia\AtEase\AtEase;
|
|||
*/
|
||||
class UploadedFileStream implements StreamInterface {
|
||||
|
||||
/** @var resource File handle */
|
||||
/** @var resource|null File handle */
|
||||
private $fp;
|
||||
|
||||
/** @var int|false|null File size. False if not set yet. */
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@
|
|||
* @ingroup FileBackend
|
||||
*/
|
||||
abstract class FSFileBackendList implements Iterator {
|
||||
/** @var Iterator */
|
||||
/** @var Iterator|null */
|
||||
protected $iter;
|
||||
/** @var string */
|
||||
protected $lastError;
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ class DatabaseSqlite extends Database {
|
|||
/** @var int The number of rows affected as an integer */
|
||||
protected $lastAffectedRowCount;
|
||||
|
||||
/** @var PDO */
|
||||
/** @var PDO|null */
|
||||
protected $conn;
|
||||
|
||||
/** @var FSLockManager (hopefully on the same server as the DB) */
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ use stdClass;
|
|||
* doesn't go anywhere near an actual database.
|
||||
*/
|
||||
class FakeResultWrapper extends ResultWrapper {
|
||||
/** @var stdClass[]|array[] */
|
||||
/** @var stdClass[]|array[]|null */
|
||||
protected $result;
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ class MysqliResultWrapper extends ResultWrapper {
|
|||
/** @var DatabaseMysqli */
|
||||
private $db;
|
||||
|
||||
/** @var mysqli_result */
|
||||
/** @var mysqli_result|null */
|
||||
private $result;
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -7,9 +7,9 @@ use PDO;
|
|||
use PDOStatement;
|
||||
|
||||
class SqliteResultWrapper extends ResultWrapper {
|
||||
/** @var PDOStatement */
|
||||
/** @var PDOStatement|null */
|
||||
private $result;
|
||||
/** @var ArrayIterator */
|
||||
/** @var ArrayIterator|null */
|
||||
private $rows;
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ class ImageHistoryPseudoPager extends ReverseChronologicalPager {
|
|||
protected $preventClickjacking = false;
|
||||
|
||||
/**
|
||||
* @var File
|
||||
* @var File|null
|
||||
*/
|
||||
protected $mImg;
|
||||
|
||||
|
|
|
|||
|
|
@ -134,7 +134,7 @@ class WikiPage implements Page, IDBAccessObject, PageRecord {
|
|||
protected $mDataLoadedFrom = self::READ_NONE;
|
||||
|
||||
/**
|
||||
* @var RevisionRecord
|
||||
* @var RevisionRecord|null
|
||||
*/
|
||||
private $mLastRevision = null;
|
||||
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ use Wikimedia\Minify\CSSMin;
|
|||
* @since 1.25
|
||||
*/
|
||||
class ResourceLoaderImageModule extends ResourceLoaderModule {
|
||||
/** @var array */
|
||||
/** @var array|null */
|
||||
protected $definition;
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ class SearchResultSet extends BaseSearchResultSet {
|
|||
/**
|
||||
* Cache of titles.
|
||||
* Lists titles of the result set, in the same order as results.
|
||||
* @var Title[]
|
||||
* @var Title[]|null
|
||||
*/
|
||||
private $titles;
|
||||
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@ abstract class LoginSignupSpecialPage extends AuthManagerSpecialPage {
|
|||
/** @var User FIXME another flag for passing data. */
|
||||
protected $targetUser;
|
||||
|
||||
/** @var HTMLForm */
|
||||
/** @var HTMLForm|null */
|
||||
protected $authForm;
|
||||
|
||||
abstract protected function isSignup();
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ class SpecialFileDuplicateSearch extends SpecialPage {
|
|||
private $filename = '';
|
||||
|
||||
/**
|
||||
* @var File selected reference file, if present
|
||||
* @var File|null selected reference file, if present
|
||||
*/
|
||||
private $file = null;
|
||||
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ class ClassCollector {
|
|||
protected $classes;
|
||||
|
||||
/**
|
||||
* @var array Token from token_get_all() that started an expect sequence
|
||||
* @var array|null Token from token_get_all() that started an expect sequence
|
||||
*/
|
||||
protected $startToken;
|
||||
|
||||
|
|
@ -44,7 +44,7 @@ class ClassCollector {
|
|||
protected $tokens;
|
||||
|
||||
/**
|
||||
* @var array Class alias with target/name fields
|
||||
* @var array|null Class alias with target/name fields
|
||||
*/
|
||||
protected $alias;
|
||||
|
||||
|
|
|
|||
|
|
@ -79,12 +79,12 @@ class TextPassDumper extends BackupDumper {
|
|||
protected $spawnProc = false;
|
||||
|
||||
/**
|
||||
* @var resource
|
||||
* @var resource|null
|
||||
*/
|
||||
protected $spawnWrite;
|
||||
|
||||
/**
|
||||
* @var resource
|
||||
* @var resource|null
|
||||
*/
|
||||
protected $spawnRead;
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue