1. interface
  2. StubTests
  3. \
  4. Framework
  5. \
  6. Parsers
  7. \
  8. Stubs
  9. \
  10. PhpDoc
  11. \
  12. PhpDocParserInterface

PhpDocParserInterface

interface PhpDocParserInterface (View source)

Interface for PhpDoc parsers.

Allows switching between different PhpDoc parsing implementations (e.g., phpDocumentor, PHPStan, custom parsers).

Methods

ParsedPhpDoc
parseDocComment(string|null $docComment)

Parse a PhpDoc comment string and extract all relevant information.

ParsedPhpDoc
parseElementPhpDoc(DocCommentNode|null $docComment)

Parse a PhpDoc comment from a DocCommentNode and merge with attribute information.

Details

at line 20
ParsedPhpDoc parseDocComment(string|null $docComment)

Parse a PhpDoc comment string and extract all relevant information.

Parameters

string|null $docComment

The PhpDoc comment text (including /* \/)

Return Value

ParsedPhpDoc

Parsed PhpDoc data, or empty object if parsing fails

at line 30
ParsedPhpDoc parseElementPhpDoc(DocCommentNode|null $docComment)

Parse a PhpDoc comment from a DocCommentNode and merge with attribute information.

This method handles both PhpDoc tags and PhpStormStubsElementAvailable attributes, with attributes taking precedence over PhpDoc tags.

Parameters

DocCommentNode|null $docComment

The doc comment node from AST

Return Value

ParsedPhpDoc

Parsed and merged PhpDoc data