Classes, interfaces and traits

Configuration

Configuration definition for the parser.

« More »

Exception

Provides the basic exception for the parser package.

« More »

File

Parses a single file into a FileDescriptor and adds it to the given ProjectBuilder.

« More »

Parser

Class responsible for parsing the given file or files to the intermediate structure file.

This class can be used to parse one or more files to the intermediate file format for further processing.

Example of use:

$files = new \phpDocumentor\File\Collection();
$ files->addDirectories(getcwd());
$parser = new \phpDocumentor\Parser\Parser();
$parser->setPath($files->getProjectRoot());
echo $parser->parseFiles($files);
« More »

ServiceProvider

This provider is responsible for registering the parser component with the given Application.

« More »

Classes, interfaces and traits

Files

Represents the settings in the phpdoc.xml related to finding the files that are to be parsed.

« More »

Classes, interfaces and traits

ParserPopulator

« More »

Classes, interfaces and traits

ParseCommand

Parses the given source code and creates a structure file.

The parse task uses the source files defined either by -f or -d options and generates a structure file (structure.xml) at the target location (which is the folder 'output' unless the option -t is provided).

« More »

Classes, interfaces and traits

FilesNotFoundException

Exception that is thrown when the parser expects files but is unable to find them.

« More »

MissingDependencyException

This exception is thrown when a required dependency is not included.

« More »

Classes, interfaces and traits

PreFileEvent

Event thrown before the parsing of an individual file.

« More »