mirror of
https://github.com/danog/psalm.git
synced 2025-01-21 21:31:13 +01:00
Add a bit of documentation
This commit is contained in:
parent
eb69d55b29
commit
55c12cd01c
@ -11,6 +11,11 @@ use Psalm\IssueBuffer;
|
||||
use Psalm\Provider\FileProvider;
|
||||
use Psalm\Provider\FileReferenceProvider;
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*
|
||||
* Called in the analysis phase of Psalm's execution
|
||||
*/
|
||||
class Analyzer
|
||||
{
|
||||
/**
|
||||
|
@ -4,6 +4,11 @@ namespace Psalm\Codebase;
|
||||
use Psalm\Type;
|
||||
use Psalm\FunctionLikeParameter;
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*
|
||||
* Gets values from the call map array, which stores data about native functions and methods
|
||||
*/
|
||||
class CallMap
|
||||
{
|
||||
/**
|
||||
|
@ -18,6 +18,11 @@ use Psalm\Storage\ClassLikeStorage;
|
||||
use Psalm\Type;
|
||||
use ReflectionProperty;
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*
|
||||
* Handles information about classes, interfaces and traits
|
||||
*/
|
||||
class ClassLikes
|
||||
{
|
||||
/**
|
||||
|
@ -7,6 +7,11 @@ use Psalm\Provider\ClassLikeStorageProvider;
|
||||
use Psalm\Storage\MethodStorage;
|
||||
use Psalm\Type;
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*
|
||||
* Handles information about class methods
|
||||
*/
|
||||
class Methods
|
||||
{
|
||||
/**
|
||||
|
@ -12,6 +12,11 @@ use Psalm\Storage\ClassLikeStorage;
|
||||
use Psalm\Storage\FileStorage;
|
||||
use Psalm\Type;
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*
|
||||
* Populates file and class information so that analysis can work properly
|
||||
*/
|
||||
class Populator
|
||||
{
|
||||
/**
|
||||
|
@ -4,6 +4,11 @@ namespace Psalm\Codebase;
|
||||
use Psalm\CodeLocation;
|
||||
use Psalm\Provider\ClassLikeStorageProvider;
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*
|
||||
* Handles information about class properties
|
||||
*/
|
||||
class Properties
|
||||
{
|
||||
/**
|
||||
|
@ -11,6 +11,11 @@ use Psalm\Storage\MethodStorage;
|
||||
use Psalm\Storage\PropertyStorage;
|
||||
use Psalm\Type;
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*
|
||||
* Handles information gleaned from class and function reflection
|
||||
*/
|
||||
class Reflection
|
||||
{
|
||||
/**
|
||||
|
@ -8,6 +8,11 @@ use Psalm\Provider\FileStorageProvider;
|
||||
use Psalm\Provider\StatementsProvider;
|
||||
use Psalm\Scanner\FileScanner;
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*
|
||||
* Contains methods that aid in the scanning of Psalm's codebase
|
||||
*/
|
||||
class Scanner
|
||||
{
|
||||
/**
|
||||
|
@ -1,6 +1,9 @@
|
||||
<?php
|
||||
namespace Psalm\Type\Atomic;
|
||||
|
||||
/**
|
||||
* Represents a string whose value is a fully-qualified class found by get_class($var)
|
||||
*/
|
||||
class GetClassT extends T
|
||||
{
|
||||
}
|
||||
|
@ -1,6 +1,9 @@
|
||||
<?php
|
||||
namespace Psalm\Type\Atomic;
|
||||
|
||||
/**
|
||||
* Represents a string whose value is that of a type found by gettype($var)
|
||||
*/
|
||||
class GetTypeT extends T
|
||||
{
|
||||
}
|
||||
|
@ -4,6 +4,9 @@ namespace Psalm\Type\Atomic;
|
||||
use Psalm\Type;
|
||||
use Psalm\Type\Union;
|
||||
|
||||
/**
|
||||
* Represents an array where we know its key values
|
||||
*/
|
||||
class ObjectLike extends \Psalm\Type\Atomic
|
||||
{
|
||||
/**
|
||||
|
@ -1,6 +1,10 @@
|
||||
<?php
|
||||
namespace Psalm\Type\Atomic;
|
||||
|
||||
/**
|
||||
* Represents a string that we know holds some type information about another variable,
|
||||
* specified in the $typeof property
|
||||
*/
|
||||
abstract class T extends TString
|
||||
{
|
||||
/**
|
||||
|
@ -1,6 +1,9 @@
|
||||
<?php
|
||||
namespace Psalm\Type\Atomic;
|
||||
|
||||
/**
|
||||
* Represents an array with generic type parameters.
|
||||
*/
|
||||
class TArray extends \Psalm\Type\Atomic
|
||||
{
|
||||
use GenericTrait;
|
||||
|
Loading…
x
Reference in New Issue
Block a user