ExampleDescriptor
in package
extends TagDescriptor
Descriptor representing the example tag with a descriptor.
Properties
$name inherited
protected$name : string
- Inherited from
- \phpDocumentor\Descriptor\TagDescriptor
$description inherited
protected$description : string
- Inherited from
- \phpDocumentor\Descriptor\TagDescriptor
$errors inherited
protected$errors : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>
- Inherited from
- \phpDocumentor\Descriptor\TagDescriptor
$filePath Line 24
private$filePath : string
$lineCount Line 27
private$lineCount : int|null
$startingLine Line 30
private$startingLine : int|null
$example Line 33
private$example : string
Methods
__construct() inherited
Initializes the tag by setting the name and errors,
public__construct(string $name) : mixed
setDescription() inherited
Sets a description for this tab instance.
publicsetDescription(string $description) : void
setErrors() inherited
Sets a list of errors found on the usage of this tag.
publicsetErrors(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> $errors) : void
Parameters
- Inherited from
- \phpDocumentor\Descriptor\TagDescriptor
getErrors() inherited
Returns all errors associated with this tag.
publicgetErrors() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> —- Inherited from
- \phpDocumentor\Descriptor\TagDescriptor
setFilePath() Line 38
Sets the location where the example points to.
publicsetFilePath(string $filePath) : void
Parameters
getFilePath() Line 46
Returns the location where this example points to.
publicgetFilePath() : string
Returns
string —
setStartingLine() Line 54
Returns the location where this example points to.
publicsetStartingLine(int $startingLine) : void
Parameters
getStartingLine() Line 62
Returns the location where this example points to.
publicgetStartingLine() : int|null
Returns
int|null —
setLineCount() Line 70
Returns the location where this example points to.
publicsetLineCount(int $lineCount) : void
Parameters
getLineCount() Line 78
Returns the location where this example points to.
publicgetLineCount() : int|null