DocBlockTrait

Inheritance diagram for DocBlockTrait:

Protected Properties
string[]	$warnings = []

Protected Methods
void	writeDocBlock (RefXML $xml, string $docblock)
	Writes the docblock. More...
void	writeDocBlock_Prune (&$docblock)
void	writeDocBlock_Tags (RefXML $xml, string &$docblock)
void	writeDocBlock_Tags_internal (RefXML $xml, string &$docblock)
void	writeDocBlock_Tags_see (RefXML $xml, string &$docblock)
void	writeDocBlock_Tags_todo (RefXML $xml, string &$docblock)

Methods

writeDocBlock()

void writeDocBlock ( RefXML  $xml, string  $docblock  )

protected

Writes the docblock.

Instead of pulling the docblock from $this, a working-copy is given.

This gives the reflector a chance to modify the docblock before it's committed.

The docblock is cleaned of inconsequential leading whitespace (before *) on each line, and is ultimately ignored if empty.

Parameters

RefXML	$xml
string	$docblock

Todo:

resolve aliases to fqn

writeDocBlock_Prune()

void writeDocBlock_Prune ( &  $docblock )

protected

Parameters

$docblock

writeDocBlock_Tags()

void writeDocBlock_Tags ( RefXML  $xml, string &  $docblock  )

protected

Parameters

RefXML	$xml
string	$docblock

Reimplemented in AbstractRefClass.

writeDocBlock_Tags_internal()

void writeDocBlock_Tags_internal ( RefXML  $xml, string &  $docblock  )

protected

Parameters

RefXML	$xml
string	$docblock

writeDocBlock_Tags_see()

void writeDocBlock_Tags_see ( RefXML  $xml, string &  $docblock  )

protected

Parameters

RefXML	$xml
string	$docblock

Todo:

resolve aliases to fqn

writeDocBlock_Tags_todo()

void writeDocBlock_Tags_todo ( RefXML  $xml, string &  $docblock  )

protected

Parameters

RefXML	$xml
string	$docblock