\phpDocumentor\ParserConfiguration

Configuration definition for the parser.

Summary

Methods
Properties
Constants
getDefaultPackageName()
getEncoding()
getExtensions()
getMarkers()
getTarget()
getVisibility()
No public properties found
No constants found
No protected methods found
$defaultPackageName
$target
$visibility
$encoding
$markers
$extensions
N/A
No private methods found
No private properties found
N/A

Properties

$defaultPackageName

$defaultPackageName : string

Type

string — name of the package when there is no @package tag defined.

$target

$target : string

Type

string — destination location for the parser's output cache

$visibility

$visibility : string

Type

string — which visibilities to include in the docs, May be public, protected, private

$encoding

$encoding : string

Type

string — default encoding of the files that are parsed.

$markers

$markers : array<mixed,string>

Type

array<mixed,string> — a list of codes that can be used at the beginning of a comment to have it mentioned in a special markers report.

$extensions

$extensions : array<mixed,string>

Type

array<mixed,string> — A list of supported file extensions used to limit the number of files to be interpreted.

Methods

getDefaultPackageName()

getDefaultPackageName() : string

Returns the package name that will be given to elements when there is no [email protected]` tag defined or inherited.

Returns

string

getEncoding()

getEncoding() : string

Returns the character encoding in which the files that are to be parsed should be encoded with.

Returns

string

getExtensions()

getExtensions() : array<mixed,string>

Returns the file extensions which are to be interpreted by the parser.

Returns

array<mixed,string>

getMarkers()

getMarkers() : array<mixed,string>

Returns which 'markers' should be scanned for and included in the markers report.

A marker is a single word or code that directly follows an inline comment; all text following that marker is interpreted as its description and these are shown in a special report generated by phpDocumentor.

Example of a marker:

// TODO: This is a marker

phpDocumentor will ignore any colon that immmediately follows the marker word; and this colon may also be omitted.

Returns

array<mixed,string>

getTarget()

getTarget() : string

Returns the path where the product of the parsing process should be written to.

The parsing process will output a product, usually cache, consisting of settings and the descriptors that are generated during the parsing process. This product, or cache, is used in future runs to only update what has actually changed and as such speed up processing.

Because the parser's product can be omitted from the generated documentation it is possible to store the cache in a central location and have the transformer output the generated documentation somewhere else.

Returns

string

getVisibility()

getVisibility() : string

Returns a comma-separated list of visibilities that can be used to restrict which elements are included in the documentation.

The following values are supported: public, protected and private.

Returns

string