phpDocumentor

DeprecatedDescriptor extends TagDescriptor
in package

Descriptor representing the deprecated tag with a descriptor.

Table of Contents

$description  : DescriptionDescriptor
$errors  : Collection<string|int, Error>
$name  : string
$version  : string
__construct()  : mixed
Initializes the tag by setting the name and errors,
__toString()  : string
getDescription()  : DescriptionDescriptor
Returns the description for this tag,
getErrors()  : Collection<string|int, Error>
Returns all errors associated with this tag.
getName()  : string
Returns the name for this tag.
getVersion()  : string
Returns the version since when the associated element was deprecated.
setDescription()  : void
Sets a description for this tab instance.
setErrors()  : void
Sets a list of errors found on the usage of this tag.
setVersion()  : void
Sets the version since when the associated element was deprecated.
setName()  : void
Sets the name for this tag.

Properties

$version

private string $version = ''

represents the version since when the element was deprecated.

Methods

__toString()

public __toString() : string
Return values
string

getName()

Returns the name for this tag.

public getName() : string
Return values
string

getVersion()

Returns the version since when the associated element was deprecated.

public getVersion() : string
Return values
string

setVersion()

Sets the version since when the associated element was deprecated.

public setVersion(string $version) : void
Parameters
$version : string
Return values
void

setName()

Sets the name for this tag.

protected setName(string $name) : void
Parameters
$name : string
Return values
void

Search results