phpDocumentor

DeprecatedDescriptor extends TagDescriptor
in package

FinalYes

Descriptor representing the deprecated tag with a descriptor.

Table of Contents

Properties

$description  : DescriptionDescriptor|null
$errors  : Collection<string|int, Error>
$name  : string
$version  : string

Methods

__construct()  : mixed
Initializes the tag by setting the name and errors,
__toString()  : string
getDescription()  : DescriptionDescriptor
Returns the description for this element.
getErrors()  : Collection<string|int, Error>
Returns all errors associated with this tag.
getName()  : string
Returns the name for this element.
getVersion()  : string
Returns the version since when the associated element was deprecated.
setDescription()  : void
Sets a description or none to inherit from a parent.
setVersion()  : void
Sets the version since when the associated element was deprecated.

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 element.

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

        
On this page

Search results