Methods

__construct()

__construct(string $shortDescription, string $longDescription, array $tags) 

Parameters

$shortDescription

string

$longDescription

string

$tags

array

Generate from array

fromArray(array $array) : \Zend\Code\Generator\DocBlockGenerator

configkey shortdescription string The short description for this doc block
configkey longdescription string The long description for this doc block
configkey tags array

Parameters

$array

array

Exceptions

\Zend\Code\Generator\Exception\InvalidArgumentException

Returns

Build a DocBlock generator object from a reflection object

fromReflection(\Zend\Code\Reflection\DocBlockReflection $reflectionDocBlock) : \Zend\Code\Generator\DocBlockGenerator

generate()

generate() : string

Returns

string

getIndentation()

getIndentation() : string
Inherited

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

Returns

string

getLongDescription()

getLongDescription() : string

Returns

string

getShortDescription()

getShortDescription() : string

Returns

string

getSourceContent()

getSourceContent() : string
Inherited

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

Returns

string

Get the word wrap

getWordWrap() : boolean

Returns

boolean

isSourceDirty()

isSourceDirty() : bool
Inherited

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

Returns

bool

setIndentation()

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

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

Parameters

$indentation

string

Returns

setLongDescription()

setLongDescription(string $longDescription) : \Zend\Code\Generator\DocBlockGenerator

Parameters

$longDescription

string

Returns

setOptions()

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

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

Parameters

$options

array\Traversable

Exceptions

\Zend\Code\Generator\Exception\InvalidArgumentException

Returns

setShortDescription()

setShortDescription(string $shortDescription) : \Zend\Code\Generator\DocBlockGenerator

Parameters

$shortDescription

string

Returns

setSourceContent()

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

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

Parameters

$sourceContent

string

Returns

setSourceDirty()

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

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

Parameters

$isSourceDirty

bool

Returns

setTags()

setTags(array $tags) : \Zend\Code\Generator\DocBlockGenerator

Parameters

$tags

array

Returns

Set the word wrap

setWordWrap(boolean $value) : \Zend\Code\Generator\DocBlockGenerator

Parameters

$value

boolean

Returns

docCommentize()

docCommentize(string $content) : string

Parameters

$content

string

Returns

string

 Properties

 

$indentation

$indentation : string

 

$isSourceDirty

$isSourceDirty : bool
Inherited

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

$longDescription

$longDescription : string

 

$shortDescription

$shortDescription : string

 

$sourceContent

$sourceContent : string
Inherited

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

$tags

$tags : array

 

$wordwrap

$wordwrap : boolean

 Constants

 

Line feed to use in place of EOL

LINE_FEED 
Inherited

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