Methods

__construct()

__construct(array $options) 
Inherited

inherited_from \Zend\Code\Generator\DocBlock\Tag::__construct()

Parameters

$options

array

Build a Tag generator object from a reflection object

fromReflection(\Zend\Code\Reflection\DocBlock\Tag\TagInterface $reflectionTagReturn) : \Zend\Code\Generator\DocBlock\Tag\ReturnTag

generate()

generate() : string

Returns

string

getDatatype()

getDatatype() : string

Returns

string

getDescription()

getDescription() : string
Inherited

inherited_from \Zend\Code\Generator\DocBlock\Tag::getDescription()

Returns

string

getIndentation()

getIndentation() : string
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::getIndentation()
inherited_from \Zend\Code\Generator\DocBlock\Tag::getIndentation()

Returns

string

getName()

getName() : string
Inherited

inherited_from \Zend\Code\Generator\DocBlock\Tag::getName()

Returns

string

getSourceContent()

getSourceContent() : string
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::getSourceContent()
inherited_from \Zend\Code\Generator\DocBlock\Tag::getSourceContent()

Returns

string

isSourceDirty()

isSourceDirty() : bool
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::isSourceDirty()
inherited_from \Zend\Code\Generator\DocBlock\Tag::isSourceDirty()

Returns

bool

setDatatype()

setDatatype(string $datatype) : \Zend\Code\Generator\DocBlock\Tag\ReturnTag

Parameters

$datatype

string

Returns

setDescription()

setDescription(string $description) : \Zend\Code\Generator\DocBlock\Tag
Inherited

inherited_from \Zend\Code\Generator\DocBlock\Tag::setDescription()

Parameters

$description

string

Returns

setIndentation()

setIndentation(string $indentation) : \Zend\Code\Generator\AbstractGenerator
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::setIndentation()
inherited_from \Zend\Code\Generator\DocBlock\Tag::setIndentation()

Parameters

$indentation

string

Returns

setName()

setName(string $name) : \Zend\Code\Generator\DocBlock\Tag
Inherited

inherited_from \Zend\Code\Generator\DocBlock\Tag::setName()

Parameters

$name

string

Returns

setOptions()

setOptions(array | \Traversable $options) : \Zend\Code\Generator\AbstractGenerator
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::setOptions()
inherited_from \Zend\Code\Generator\DocBlock\Tag::setOptions()

Parameters

$options

array\Traversable

Exceptions

\Zend\Code\Generator\Exception\InvalidArgumentException

Returns

setSourceContent()

setSourceContent(string $sourceContent) : \Zend\Code\Generator\AbstractGenerator
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::setSourceContent()
inherited_from \Zend\Code\Generator\DocBlock\Tag::setSourceContent()

Parameters

$sourceContent

string

Returns

setSourceDirty()

setSourceDirty(bool $isSourceDirty) : \Zend\Code\Generator\AbstractGenerator
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::setSourceDirty()
inherited_from \Zend\Code\Generator\DocBlock\Tag::setSourceDirty()

Parameters

$isSourceDirty

bool

Returns

 Properties

 

$datatype

$datatype : string

 

$description

$description : string
Inherited

inherited_from \Zend\Code\Generator\DocBlock\Tag::$$description
 

<p>4 spaces by default</p>

$indentation : int | string
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::$$indentation
inherited_from \Zend\Code\Generator\DocBlock\Tag::$$indentation
 

$isSourceDirty

$isSourceDirty : bool
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::$$isSourceDirty
inherited_from \Zend\Code\Generator\DocBlock\Tag::$$isSourceDirty
 

$name

$name : string
Inherited

inherited_from \Zend\Code\Generator\DocBlock\Tag::$$name
 

$sourceContent

$sourceContent : string
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::$$sourceContent
inherited_from \Zend\Code\Generator\DocBlock\Tag::$$sourceContent
 

$typeFormats

$typeFormats : array
Inherited

inherited_from \Zend\Code\Generator\DocBlock\Tag::$$typeFormats

 Constants

 

Line feed to use in place of EOL

LINE_FEED 
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::LINE_FEED
inherited_from \Zend\Code\Generator\DocBlock\Tag::LINE_FEED