phpDocumentor

SeeAssembler extends BaseTagAssembler
in package

Constructs a new Descriptor from a Reflector object for the `@see` tag.

This class will gather the properties that were parsed by the Reflection mechanism for, specifically, an @see tag and use that to create a SeeDescriptor that describes all properties that an @see tag may have.

Table of Contents

$builder  : ProjectDescriptorBuilder|null
$reducers  : array<string|int, AssemblerReducer>
__construct()  : mixed
buildDescriptor()  : SeeDescriptor
Creates a new Descriptor from the given Reflector.
create()  : TDescriptor|null
deduplicateTypes()  : Type|null
getBuilder()  : ProjectDescriptorBuilder|null
Returns the builder for this Assembler or null if none is set.
setBuilder()  : void
Registers the Builder with this Assembler.
assembleDocBlock()  : void
Assemble DocBlock.
extractPackageFromDocBlock()  : string|null
Extracts the package from the DocBlock.

Properties

Methods

create()

public create(TInput $data) : TDescriptor|null
Parameters
$data : TInput
Return values
TDescriptor|null

deduplicateTypes()

public static deduplicateTypes(Type|null $type) : Type|null
Parameters
$type : Type|null
Tags
deprecated

the functionality in this method has been moved to the Compound type in the latest unreleased version of the TypeResolver library

Return values
Type|null

extractPackageFromDocBlock()

Extracts the package from the DocBlock.

protected extractPackageFromDocBlock(DocBlock|null $docBlock) : string|null
Parameters
$docBlock : DocBlock|null
Return values
string|null

Search results