\phpDocumentor\Descriptor\Builder\Reflector\TagsDeprecatedAssembler

Constructs a new descriptor from the Reflector for an [email protected]` tag.

This object will read the reflected information for the @deprecated tag and create a \phpDocumentor\Descriptor\Tag\DeprecatedDescriptor object that can be used in the rest of the application and templates.

Summary

Methods
Properties
Constants
getBuilder()
setBuilder()
create()
No public properties found
No constants found
assembleDocBlock()
extractPackageFromDocBlock()
$builder
N/A
No private methods found
No private properties found
N/A

Properties

Methods

setBuilder()

setBuilder(\phpDocumentor\Descriptor\ProjectDescriptorBuilder  $builder) : void

Registers the Builder with this Assembler.

The Builder may be used to recursively assemble Descriptors using the \ProjectDescriptorBuilder::buildDescriptor() method.

Parameters

\phpDocumentor\Descriptor\ProjectDescriptorBuilder $builder

create()

create(\phpDocumentor\Reflection\DocBlock\Tag\DeprecatedTag  $data) : \phpDocumentor\Descriptor\Tag\DeprecatedDescriptor

Creates a new Descriptor from the given Reflector.

Parameters

\phpDocumentor\Reflection\DocBlock\Tag\DeprecatedTag $data

Returns

\phpDocumentor\Descriptor\Tag\DeprecatedDescriptor

assembleDocBlock()

assembleDocBlock(\phpDocumentor\Reflection\DocBlock|null  $docBlock, \phpDocumentor\Descriptor\DescriptorAbstract  $target) : void

Assemble DocBlock.

Parameters

\phpDocumentor\Reflection\DocBlock|null $docBlock
\phpDocumentor\Descriptor\DescriptorAbstract $target

extractPackageFromDocBlock()

extractPackageFromDocBlock(\phpDocumentor\Reflection\DocBlock  $docBlock) : string|null

Extracts the package from the DocBlock.

Parameters

\phpDocumentor\Reflection\DocBlock $docBlock

Returns

string|null