Reflection Docblock

See extends BaseTag
in package

FinalYes

Reflection class for an {@}see tag in a Docblock.

Table of Contents

Properties

$description  : Description|null
$name  : string
$refers  : Reference

Methods

__construct()  : mixed
Initializes this tag.
__toString()  : string
Returns a string representation of this tag.
create()  : Tag|mixed
getDescription()  : Description|null
getName()  : string
Gets the name of this tag.
getReference()  : Reference
Returns the ref of this tag.
render()  : string
resolveFqsen()  : Fqsen

Properties

$name

protected string $name = 'see'

Name of the tag

Methods

__toString()

Returns a string representation of this tag.

public __toString() : string
Return values
string

create()

public static create(string $body[, FqsenResolver|null $typeResolver = null ][, DescriptionFactory|null $descriptionFactory = null ][, Context|null $context = null ]) : Tag|mixed
Parameters
$body : string
$typeResolver : FqsenResolver|null = null
$descriptionFactory : DescriptionFactory|null = null
$context : Context|null = null
Return values
Tag|mixed —

Class that implements Tag

getName()

Gets the name of this tag.

public getName() : string
Return values
string —

The name of this tag.

render()

public render([Formatter|null $formatter = null ]) : string
Parameters
$formatter : Formatter|null = null
Return values
string

resolveFqsen()

private static resolveFqsen(string $parts, FqsenResolver|null $fqsenResolver, Context|null $context) : Fqsen
Parameters
$parts : string
$fqsenResolver : FqsenResolver|null
$context : Context|null
Return values
Fqsen 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results