DocBlockGenerator Class Reference

Public Member Functions
	__construct ($shortDescription=null, $longDescription=null, array $tags=[])
	setShortDescription ($shortDescription)
	getShortDescription ()
	setLongDescription ($longDescription)
	getLongDescription ()
	setTags (array $tags)
	setTag ($tag)
	getTags ()
	setWordWrap ($value)
	getWordWrap ()
	generate ()
Public Member Functions inherited from AbstractGenerator
	__construct ($options=[])
	setSourceDirty ($isSourceDirty=true)
	isSourceDirty ()
	setIndentation ($indentation)
	getIndentation ()
	setSourceContent ($sourceContent)
	getSourceContent ()
	setOptions ($options)

Static Public Member Functions
static	fromReflection (DocBlockReflection $reflectionDocBlock)
	Build a DocBlock generator object from a reflection object.
static	fromArray (array $array)
	Generate from array.

Protected Member Functions
	docCommentize ($content)

Static Protected Member Functions
static	getTagManager ()

Protected Attributes
	$shortDescription = null
	$longDescription = null
	$tags = []
	$indentation = ''
	$wordwrap = true
Protected Attributes inherited from AbstractGenerator
	$isSourceDirty = true
	$indentation = ' '
	$sourceContent = null

Static Protected Attributes
static	$tagManager

Additional Inherited Members
Public Attributes inherited from AbstractGenerator
const	LINE_FEED = "\n"
	Line feed to use in place of EOL.

Constructor & Destructor Documentation

__construct	(		$shortDescription = null,
			$longDescription = null,
		array	$tags = []
	)

Parameters

string	$shortDescription
string	$longDescription
array	$tags

Member Function Documentation

docCommentize (   $content )

protected

Parameters

string

$content

Returns

string

static fromArray ( array  $array )

static

Generate from array.

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

Exceptions

Exception\InvalidArgumentException

Parameters

array

$array

Returns

DocBlockGenerator

static fromReflection ( DocBlockReflection  $reflectionDocBlock )

static

Build a DocBlock generator object from a reflection object.

Parameters

DocBlockReflection

$reflectionDocBlock

Returns

DocBlockGenerator

generate

(

)

Returns

string

Implements GeneratorInterface.

getLongDescription

(

)

Returns

string

getShortDescription

(

)

Returns

string

static getTagManager ( )

staticprotected

getTags

(

)

Returns

TagInterface[]

getWordWrap

(

)

Returns

bool

setLongDescription

(

$longDescription

)

Parameters

string

$longDescription

Returns

DocBlockGenerator

setShortDescription

(

$shortDescription

)

Parameters

string

$shortDescription

Returns

DocBlockGenerator

setTag

(

$tag

)

Parameters

array | TagInterface

$tag

Exceptions

Exception\InvalidArgumentException

Returns

DocBlockGenerator

setTags

(

array

$tags

)

Parameters

array

$tags

Returns

DocBlockGenerator

setWordWrap

(

$value

)

Parameters

bool

$value

Returns

DocBlockGenerator

Member Data Documentation

$indentation = ''

protected

$longDescription = null

protected

$shortDescription = null

protected

$tagManager

staticprotected

$tags = []

protected

$wordwrap = true

protected