VersionDescriptor

in package
extends TagDescriptor

Descriptor representing the version tag on a class, interface, trait or file.

Properties

protected$name  : string                

protected$description  : string                

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

protected$version  : string                

Methods

Initializes the tag by setting the name and errors,

public__construct(string $name) : mixed

Parameters

$name : string

Returns

mixed

Returns the name for this tag.

publicgetName() : string

Returns

string

Sets a description for this tab instance.

publicsetDescription(string $description) : void

Parameters

$description : string

Returns the description for this tag,

publicgetDescription() : string

Returns

string

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>

Returns all errors associated with this tag.

publicgetErrors() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Returns the current version for the associated element.

publicgetVersion() : string

Returns

string

Sets the version for the associated element.

publicsetVersion(string $version) : void

Parameters

$version : string

Sets the name for this tag.

protectedsetName(string $name) : void

Parameters

$name : string