phpDocumentor

Debug extends ApiDocumentationPass
in package

FinalYes

This class is responsible for sending statistical information to the log.

For debugging purposes it can be convenient to send statistical information about the ProjectDescriptor to the log of phpDocumentor.

Table of Contents

Properties

$analyzer  : ProjectAnalyzer
$log  : LoggerInterface

Methods

__construct()  : mixed
Registers the logger with this Compiler Pass.
__invoke()  : CompilableSubject
Executes a compiler pass.
getDescription()  : string
Returns a textual description of what this pass does for output purposes.
process()  : ApiSetDescriptor

Attributes

#[Stage]

#[Stage]

Properties

$log

protected LoggerInterface $log

the logger to write the debug results to

Methods

__construct()

Registers the logger with this Compiler Pass.

public __construct(LoggerInterface $log, ProjectAnalyzer $analyzer) : mixed
Parameters
$log : LoggerInterface
$analyzer : ProjectAnalyzer

getDescription()

Returns a textual description of what this pass does for output purposes.

public getDescription() : string

Please note that the command line will be truncated to 68 characters ( .. 000.000s) so longer descriptions won't have much use.

Return values
string

        
On this page

Search results