PHP Class TheSeer\phpDox\Collector\MethodObject

Show file Open project: theseer/phpdox Class Usage Examples

Public Methods

Method	Description
__construct ( AbstractUnitObject $unit, TheSeer\fDOM\fDOMElement $ctx )
addInlineComment ( TheSeer\phpDox\Collector\InlineComment $InlineComment )
addParameter ( string $name ) : ParameterObject
export ( )
getName ( )
getOwner ( )
hasInheritDoc ( )
inhertDocBlock ( MethodObject $method )
setAbstract ( boolean $isAbstract )
setDocBlock ( DocBlock $docblock )
setEndLine ( integer $endLine )
setFinal ( boolean $isFinal )
setName ( string $name )
setStartLine ( integer $startLine )
setStatic ( boolean $isStatic )
setVisibility ( string $visibility )

Private Methods

Method	Description
getInlineContainer ( ) : TheSeer\fDOM\fDOMElement

Method Details

__construct() public method

public __construct ( AbstractUnitObject $unit, TheSeer\fDOM\fDOMElement $ctx )
$unit	AbstractUnitObject
$ctx	TheSeer\fDOM\fDOMElement

addInlineComment() public method

public addInlineComment ( TheSeer\phpDox\Collector\InlineComment $InlineComment )
$InlineComment	TheSeer\phpDox\Collector\InlineComment

addParameter() public method

public addParameter ( string $name ) : ParameterObject
$name	string
return	ParameterObject

export() public method

public export ( )

getName() public method

public getName ( )

getOwner() public method

public getOwner ( )

hasInheritDoc() public method

public hasInheritDoc ( )

inhertDocBlock() public method

public inhertDocBlock ( MethodObject $method )
$method	MethodObject

setAbstract() public method

public setAbstract ( boolean $isAbstract )
$isAbstract	boolean

setDocBlock() public method

public setDocBlock ( DocBlock $docblock )
$docblock	TheSeer\phpDox\DocBlock\DocBlock

setEndLine() public method

public setEndLine ( integer $endLine )
$endLine	integer

setFinal() public method

public setFinal ( boolean $isFinal )
$isFinal	boolean

setName() public method

public setName ( string $name )
$name	string

setStartLine() public method

public setStartLine ( integer $startLine )
$startLine	integer

setStatic() public method

public setStatic ( boolean $isStatic )
$isStatic	boolean

setVisibility() public method

public setVisibility ( string $visibility )
$visibility	string