Summary

Fully Qualified Name:	Laminas\Code\Generator\DocBlockGenerator
Extends:	AbstractGenerator

Description

Methods

Name	Description	Defined By
__construct()		DocBlockGenerator
fromArray()	Generate from array	DocBlockGenerator
fromReflection()	Build a DocBlock generator object from a reflection object	DocBlockGenerator
generate()		DocBlockGenerator
getIndentation()		AbstractGenerator
getLongDescription()		DocBlockGenerator
getShortDescription()		DocBlockGenerator
getSourceContent()		AbstractGenerator
getTags()		DocBlockGenerator
getWordWrap()		DocBlockGenerator
isSourceDirty()		AbstractGenerator
setIndentation()		AbstractGenerator
setLongDescription()		DocBlockGenerator
setOptions()		AbstractGenerator
setShortDescription()		DocBlockGenerator
setSourceContent()		AbstractGenerator
setSourceDirty()		AbstractGenerator
setTag()		DocBlockGenerator
setTags()		DocBlockGenerator
setWordWrap()		DocBlockGenerator

Method Details

__construct()

Parameter Name	Type	Description
$shortDescription	string
$longDescription	string
$tags	array

Returns:

fromArray()

Generate from array

Parameter Name	Type	Description
$array	array

Returns: \DocBlockGenerator

fromReflection()

Build a DocBlock generator object from a reflection object

Parameter Name	Type	Description
$reflectionDocBlock	\DocBlockReflection

Returns: \DocBlockGenerator

generate()

Returns: string

getIndentation()

Returns: string

getLongDescription()

Returns: string

getShortDescription()

Returns: string

getSourceContent()

Returns: string

getTags()

Returns: \TagInterface[]

getWordWrap()

Returns: bool

isSourceDirty()

Returns: bool

setIndentation()

Parameter Name	Type	Description
$indentation	string

Returns: \AbstractGenerator

setLongDescription()

Parameter Name	Type	Description
$longDescription	string

Returns: \DocBlockGenerator

setOptions()

Parameter Name	Type	Description
$options	array|\Traversable

Returns: \AbstractGenerator

setShortDescription()

Parameter Name	Type	Description
$shortDescription	string

Returns: \DocBlockGenerator

setSourceContent()

Parameter Name	Type	Description
$sourceContent	string

Returns: \AbstractGenerator

setSourceDirty()

Parameter Name	Type	Description
$isSourceDirty	bool

Returns: \AbstractGenerator

setTag()

Parameter Name	Type	Description
$tag	array|\TagInterface

Returns: \DocBlockGenerator

setTags()

Parameter Name	Type	Description
$tags	array

Returns: \DocBlockGenerator

setWordWrap()

Parameter Name	Type	Description
$value	bool

Returns: \DocBlockGenerator