Configuration

Configuration definition for the parser.

package

Default

Methods

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

getDefaultPackageName() : string

Response

string

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

getEncoding() : string

Response

string

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

getExtensions() : array<mixed,string>

Response

array<mixed,string>

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

getMarkers() : array<mixed,string>

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.

Response

array<mixed,string>

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

getTarget() : string

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.

Response

string

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

getVisibility() : string

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

Response

string

Properties

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

defaultPackageName : string
var

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

Serializer\Type

("string")

Serializer\SerializedName

("default-package-name")

Type(s)

string

destination location for the parser's output cache

target : string
var

destination location for the parser's output cache

Serializer\Type

("string")

Type(s)

string

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

visibility : string
var

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

Serializer\Type

("string")

Type(s)

string

default encoding of the files that are parsed.

encoding : string
var

default encoding of the files that are parsed.

Serializer\Type

("string")

Type(s)

string

a list of codes that can be used at the beginning of a comment to have it mentioned in a special markers report.

markers : array<mixed,string>
var

a list of codes that can be used at the beginning of a comment to have it mentioned in a special markers report.

Serializer\Type

("array")

Serializer\XmlList

(entry = "item")

Merger\Replace

Type(s)

array<mixed,string>

A list of supported file extensions used to limit the number of files to be interpreted.

extensions : array<mixed,string>
var

A list of supported file extensions used to limit the number of files to be interpreted.

Serializer\Type

("array")

Serializer\XmlList

(entry = "extension")

Merger\Replace

Type(s)

array<mixed,string>