DocComment
in package
FinalYes
Table of Contents
Constants
- PSALM_ANNOTATIONS = ['return', 'param', 'template', 'var', 'type', 'template-covariant', 'property', 'property-read', 'property-write', 'method', 'assert', 'assert-if-true', 'assert-if-false', 'suppress', 'ignore-nullable-return', 'override-property-visibility', 'override-method-visibility', 'seal-properties', 'seal-methods', 'no-seal-properties', 'no-seal-methods', 'ignore-falsable-return', 'variadic', 'pure', 'ignore-variable-method', 'ignore-variable-property', 'internal', 'taint-sink', 'taint-source', 'assert-untainted', 'scope-this', 'mutation-free', 'external-mutation-free', 'immutable', 'readonly', 'allow-private-mutation', 'readonly-allow-private-mutation', 'yield', 'trace', 'import-type', 'flow', 'taint-specialize', 'taint-escape', 'taint-unescape', 'self-out', 'consistent-constructor', 'stub-override', 'require-extends', 'require-implements', 'param-out', 'ignore-var', 'consistent-templates', 'if-this-is', 'this-out', 'check-type', 'check-type-exact', 'api', 'inheritors']
Methods
- parsePreservingLength() : ParsedDocblock
- Parse a docblock comment into its parts.
- parseSuppressList() : array<int, string>
Constants
PSALM_ANNOTATIONS
public
mixed
PSALM_ANNOTATIONS
= ['return', 'param', 'template', 'var', 'type', 'template-covariant', 'property', 'property-read', 'property-write', 'method', 'assert', 'assert-if-true', 'assert-if-false', 'suppress', 'ignore-nullable-return', 'override-property-visibility', 'override-method-visibility', 'seal-properties', 'seal-methods', 'no-seal-properties', 'no-seal-methods', 'ignore-falsable-return', 'variadic', 'pure', 'ignore-variable-method', 'ignore-variable-property', 'internal', 'taint-sink', 'taint-source', 'assert-untainted', 'scope-this', 'mutation-free', 'external-mutation-free', 'immutable', 'readonly', 'allow-private-mutation', 'readonly-allow-private-mutation', 'yield', 'trace', 'import-type', 'flow', 'taint-specialize', 'taint-escape', 'taint-unescape', 'self-out', 'consistent-constructor', 'stub-override', 'require-extends', 'require-implements', 'param-out', 'ignore-var', 'consistent-templates', 'if-this-is', 'this-out', 'check-type', 'check-type-exact', 'api', 'inheritors']
Methods
parsePreservingLength()
Parse a docblock comment into its parts.
public
static parsePreservingLength(Doc $docblock[, bool $no_psalm_error = false ]) : ParsedDocblock
Parameters
- $docblock : Doc
- $no_psalm_error : bool = false
Return values
ParsedDocblockparseSuppressList()
public
static parseSuppressList(string $suppress_entry) : array<int, string>
Parameters
- $suppress_entry : string