\phpDocumentor\ParserFile

__construct()

__construct(\phpDocumentor\Parser\Parser  $parser) 

Registers the Parser object to get settings from.

Parameters

parse()

parse(string  $filename, \phpDocumentor\Descriptor\ProjectDescriptorBuilder  $builder) : void

Parses the file identified by the given filename and passes the resulting FileDescriptor to the ProjectBuilder.

Parameters

getRelativeFilename()

getRelativeFilename(string  $filename) : string

Returns the filename, relative to the root of the project directory.

Parameters

Throws

\InvalidArgumentException

if file is not in the project root.

Returns

createFileReflector()

createFileReflector(\phpDocumentor\Descriptor\ProjectDescriptorBuilder  $builder, string  $filename) : \phpDocumentor\Reflection\FileReflector|null

Creates a new FileReflector for the given filename or null if the file contains no modifications.

Parameters

Returns

Returns a new FileReflector or null if no modifications were detected for the given filename.

logErrorsForDescriptor()

logErrorsForDescriptor(\phpDocumentor\Descriptor\FileDescriptor  $fileDescriptor) : void

Writes the errors found in the Descriptor to the log.

Parameters

log()

log(string  $message, string  $priority = \Psr\Log\LogLevel::INFO, array<mixed,string>  $parameters = array()) : void

Dispatches a logging request.

Parameters