ExampleDescriptor

in package
extends TagDescriptor

Descriptor representing the example tag with a descriptor.

ExampleDescriptor.php

Properties

protected$name  : string                

protected$description  : string                

protected$errors  : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>                

private$filePath  : string                

private$lineCount  : int|null                

private$startingLine  : int|null                

private$example  : string

Methods

Initializes the tag by setting the name and errors,

public__construct(string $name) : mixed

Parameters

$name : string

Returns

mixed —
Inherited from
\phpDocumentor\Descriptor\TagDescriptor

Returns the name for this tag.

publicgetName() : string

Returns

string —
Inherited from
\phpDocumentor\Descriptor\TagDescriptor

Sets a description for this tab instance.

publicsetDescription(string $description) : void

Parameters

$description : string
Inherited from
\phpDocumentor\Descriptor\TagDescriptor

Returns the description for this tag,

publicgetDescription() : string

Returns

string —
Inherited from
\phpDocumentor\Descriptor\TagDescriptor

Sets a list of errors found on the usage of this tag.

publicsetErrors(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> $errors) : void

Parameters

$errors : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>
Inherited from
\phpDocumentor\Descriptor\TagDescriptor

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

Sets the location where the example points to.

publicsetFilePath(string $filePath) : void

Parameters

$filePath : string

Returns the location where this example points to.

publicgetFilePath() : string

Returns

string —

Returns the location where this example points to.

publicsetStartingLine(int $startingLine) : void

Parameters

$startingLine : int

Returns the location where this example points to.

publicgetStartingLine() : int|null

Returns

int|null —

Returns the location where this example points to.

publicsetLineCount(int $lineCount) : void

Parameters

$lineCount : int

Returns the location where this example points to.

publicgetLineCount() : int|null

Returns

int|null —

Returns the content of the example.

publicsetExample(string $example) : void

Parameters

$example : string

Returns the content of the example.

publicgetExample() : string

Returns

string —

Sets the name for this tag.

protectedsetName(string $name) : void

Parameters

$name : string
Inherited from
\phpDocumentor\Descriptor\TagDescriptor