1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-15 10:57:08 +01:00
psalm/src/Psalm/Scanner/FunctionDocblockComment.php

82 lines
1.6 KiB
PHP
Raw Normal View History

2016-11-13 05:59:31 +01:00
<?php
namespace Psalm\Scanner;
2016-11-13 05:59:31 +01:00
class FunctionDocblockComment
{
/**
* @var string|null
*/
public $return_type = null;
/**
* @var array<int, array{name:string, type:string, line_number: int}>
2016-11-13 05:59:31 +01:00
*/
public $params = [];
/**
* @var array<int, array{name:string, type:string, line_number: int}>
*/
public $globals = [];
2016-11-13 05:59:31 +01:00
/**
* Whether or not the function is deprecated
2017-05-27 02:16:18 +02:00
*
* @var bool
2016-11-13 05:59:31 +01:00
*/
public $deprecated = false;
/**
* Whether or not the function uses get_args
*
2017-05-27 02:16:18 +02:00
* @var bool
2016-11-13 05:59:31 +01:00
*/
public $variadic = false;
/**
* Whether or not to ignore the nullability of this function's return type
*
2017-05-27 02:16:18 +02:00
* @var bool
*/
public $ignore_nullable_return = false;
/**
* Whether or not to ignore the nullability of this function's return type
*
* @var bool
*/
public $ignore_falsable_return = false;
2016-11-13 05:59:31 +01:00
/**
* @var array<int, string>
2016-11-13 05:59:31 +01:00
*/
public $suppress = [];
/** @var int */
public $return_type_line_number;
2017-02-10 02:35:17 +01:00
/**
* @var array<int, array<int, string>>
*/
public $template_types = [];
/**
* @var array<int, array{template_type: string, param_name: string, line_number?: int}>
2017-02-10 02:35:17 +01:00
*/
public $template_typeofs = [];
/**
* @var array<int, array{type: string, param_name: string}>
*/
public $assertions = [];
/**
* @var array<int, array{type: string, param_name: string}>
*/
public $if_true_assertions = [];
/**
* @var array<int, array{type: string, param_name: string}>
*/
public $if_false_assertions = [];
2016-11-13 05:59:31 +01:00
}