phpDocumentor
Back to top  

Reflection class for a @uses tag in a Docblock.

category phpDocumentor
package Reflection
author Mike van Riel
license MIT
link http://phpdoc.org

 Methods

Parses a tag and populates the member variables.

__construct(string $type, string $content) 
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag_See::__construct()

Parameters

$type

string

Tag identifier for this tag (should be 'return')

$content

string

Contents for this tag.

Exceptions

\phpDocumentor_Reflection_Exception if an invalid tag line was presented

Returns the exported information (we should use the export static method BUT this throws an exception at this point).

__toString() : void
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::__toString()
inherited_from \phpDocumentor_Reflection_DocBlock_Tag_See::__toString()

Factory method responsible for instantiating the correct sub type.

createInstance(string $tag_line) : \phpDocumentor_Reflection_DocBlock_Tag
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::createInstance()
inherited_from \phpDocumentor_Reflection_DocBlock_Tag_See::createInstance()

Parameters

$tag_line

string

The text for this tag, including description.

Exceptions

\phpDocumentor_Reflection_Exception if an invalid tag line was presented.

Returns

\phpDocumentor_Reflection_DocBlock_Tag

Builds a string representation of this object.

export() : void
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::export()
inherited_from \phpDocumentor_Reflection_DocBlock_Tag_See::export()

Returns the content of this tag.

getContent() : string
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::getContent()
inherited_from \phpDocumentor_Reflection_DocBlock_Tag_See::getContent()

Returns

string

Returns the description component of this tag.

getDescription() : string
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::getDescription()
inherited_from \phpDocumentor_Reflection_DocBlock_Tag_See::getDescription()

Returns

string

Get the line number of the tag

getLineNumber() : int
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::getLineNumber()
inherited_from \phpDocumentor_Reflection_DocBlock_Tag_See::getLineNumber()

Returns

inttag line number

Returns the name of this tag.

getName() : string
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::getName()
inherited_from \phpDocumentor_Reflection_DocBlock_Tag_See::getName()

Returns

string

Returns the type of the variable.

getReference() : string
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag_See::getReference()

Returns

string

Inject the docblock class

setDocBlock(phpDocumentor_Reflection_DocBlockedAbstract $docblock) : void
Inherited

This exposes some common functionality contained in the docblock abstract.

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::setDocBlock()
inherited_from \phpDocumentor_Reflection_DocBlock_Tag_See::setDocBlock()

Parameters

$docblock

\phpDocumentor_Reflection_DocBlockedAbstract

DocBlock class

Set the tag line number

setLineNumber(int $number) : void
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::setLineNumber()
inherited_from \phpDocumentor_Reflection_DocBlock_Tag_See::setLineNumber()

Parameters

$number

int

the line number of the tag

 Properties

 

content of the tag

$content : string
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::$$content
inherited_from \phpDocumentor_Reflection_DocBlock_Tag_See::$$content
 

description of the content of this tag

$description : string
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::$$description
inherited_from \phpDocumentor_Reflection_DocBlock_Tag_See::$$description
 

docblock class

$docblock : \phpDocumentor_Reflection_DocBlockedAbstract
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::$$docblock
inherited_from \phpDocumentor_Reflection_DocBlock_Tag_See::$$docblock
 

line number of the tag

$line_number : int
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::$$line_number
inherited_from \phpDocumentor_Reflection_DocBlock_Tag_See::$$line_number
 

$refers

$refers : string
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag_See::$$refers
 

Name of the tag

$tag : string
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::$$tag
inherited_from \phpDocumentor_Reflection_DocBlock_Tag_See::$$tag