PHP Class methodDoc

Inheritance: extends ExecutableDoc

Public Properties

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

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.

Add a parameter to this method.

public addParameter ( &$parameter )

Return true if this class is abstract.

public isAbstract ( ) : boolean
return	boolean

Return true if this class is an constructor.

public isConstructor ( ) : boolean
return	boolean

Return true if this class is an destructor.

public isDestructor ( ) : boolean
return	boolean

Is this construct a function.

public isFunction ( ) : boolean
return	boolean

Is this construct a method.

public isMethod ( ) : boolean
return	boolean

Constructor

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

Get return type.

public returnType ( ) : Type
return	Type

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

Is this class abstract.

public bool $_abstract
return	boolean

The type of variable this method returns.

public type $_returnType
return	type