$defaultPackageName : string
Configuration definition for the parser.
getDefaultPackageName() : string
Returns the package name that will be given to elements when there is no [email protected]` tag defined or inherited.
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.
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.