phpDocumentor

MarkerFromTagsExtractor extends ApiDocumentationPass
in package

FinalYes

This index builder collects all markers from tags and inserts them into the marker index.

Table of Contents

Methods

__invoke()  : CompilableSubject
Executes a compiler pass.
getDescription()  : string
Returns a textual description of what this pass does for output purposes.
process()  : ApiSetDescriptor
addTodoMarkerToFile()  : void
Adds a marker with the TO DO information to the file on a given line number.
getFileDescriptor()  : FileDescriptor
Retrieves the File Descriptor from the given element.

Attributes

#[Stage]

#[Stage]

Methods

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