PHP Class methodDoc

Inheritance: extends ExecutableDoc
Show file Open project: peej/phpdoctor

Public Properties

Property Type Description
$_abstract boolean Is this class abstract.
$_returnType type The type of variable this method returns.

Public Methods

Method Description
addParameter ( &$parameter ) Add a parameter to this method.
isAbstract ( ) : boolean Return true if this class is abstract.
isConstructor ( ) : boolean Return true if this class is an constructor.
isDestructor ( ) : boolean Return true if this class is an destructor.
isFunction ( ) : boolean Is this construct a function.
isMethod ( ) : boolean Is this construct a method.
methodDoc ( $name, &$parent, &$root, $filename, $lineNumber, $sourcePath ) Constructor
returnType ( ) : Type Get return type.
returnTypeAsString ( ) : str Format a return type for outputting. Recognised types are turned into HTML anchor tags to the documentation page for the class defining them.

Method Details

addParameter() public method

Add a parameter to this method.
public addParameter ( &$parameter )

isAbstract() public method

Return true if this class is abstract.
public isAbstract ( ) : boolean
return boolean

isConstructor() public method

Return true if this class is an constructor.
public isConstructor ( ) : boolean
return boolean

isDestructor() public method

Return true if this class is an destructor.
public isDestructor ( ) : boolean
return boolean

isFunction() public method

Is this construct a function.
public isFunction ( ) : boolean
return boolean

isMethod() public method

Is this construct a method.
public isMethod ( ) : boolean
return boolean

methodDoc() public method

Constructor
public methodDoc ( $name, &$parent, &$root, $filename, $lineNumber, $sourcePath )

returnType() public method

Get return type.
public returnType ( ) : Type
return Type

returnTypeAsString() public method

Format a return type for outputting. Recognised types are turned into HTML anchor tags to the documentation page for the class defining them.
public returnTypeAsString ( ) : str
return str The string representation of the return type

Property Details

$_abstract public property

Is this class abstract.
public bool $_abstract
return boolean

$_returnType public property

The type of variable this method returns.
public type $_returnType
return type