1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-15 10:57:08 +01:00
psalm/src/Psalm/Internal/Scanner/VarDocblockComment.php
Joe Hoyle e59670ef68
Add documentation to LSP (#5267)
* Add documention to LSP

Add descriptions for all Classes, Functions, Methods, Class Constants for LSP methods for Hover, SignatureInformation and Completions

* Descriptions for class name completions

* PHPCS

* Fix docblock being overriden

* Remove trailing comma in args

* Add description to function param before early `continue`

* Update php-language-server-protocol to 1.5

* Break up long array docblocks

* Break up docblock onto newline

Co-authored-by: Matthew Brown <github@muglug.com>
2021-02-24 10:14:04 -05:00

91 lines
1.3 KiB
PHP

<?php
namespace Psalm\Internal\Scanner;
use Psalm\Type;
/**
* @internal
*/
class VarDocblockComment
{
/**
* @var ?Type\Union
*/
public $type;
/**
* @var ?string
*/
public $original_type;
/**
* @var string|null
*/
public $var_id = null;
/**
* @var int|null
*/
public $line_number;
/**
* @var int|null
*/
public $type_start;
/**
* @var int|null
*/
public $type_end;
/**
* Whether or not the property is deprecated
*
* @var bool
*/
public $deprecated = false;
/**
* Whether or not the property is internal
*
* @var bool
*/
public $internal = false;
/**
* If set, the property is internal to the given namespace.
*
* @var null|string
*/
public $psalm_internal = null;
/**
* Whether or not the property is readonly
*
* @var bool
*/
public $readonly = false;
/**
* Whether or not to allow mutation by internal methods
*
* @var bool
*/
public $allow_private_mutation = false;
/**
* @var list<string>
*/
public $removed_taints = [];
/**
* @var array<int, string>
*/
public $suppressed_issues = [];
/**
* @var ?string
*/
public $description;
}