PHP Class methodDoc

Inheritance: extends ExecutableDoc
Afficher le fichier Open project: peej/phpdoctor

Méthodes publiques

Свойство Type Description
$_abstract boolean Is this class abstract.
$_returnType type The type of variable this method returns.

Méthodes publiques

Méthode 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 méthode

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

isAbstract() public méthode

Return true if this class is abstract.
public isAbstract ( ) : boolean
Résultat boolean

isConstructor() public méthode

Return true if this class is an constructor.
public isConstructor ( ) : boolean
Résultat boolean

isDestructor() public méthode

Return true if this class is an destructor.
public isDestructor ( ) : boolean
Résultat boolean

isFunction() public méthode

Is this construct a function.
public isFunction ( ) : boolean
Résultat boolean

isMethod() public méthode

Is this construct a method.
public isMethod ( ) : boolean
Résultat boolean

methodDoc() public méthode

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

returnType() public méthode

Get return type.
public returnType ( ) : Type
Résultat Type

returnTypeAsString() public méthode

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
Résultat str The string representation of the return type

Property Details

$_abstract public_oe property

Is this class abstract.
public bool $_abstract
Résultat boolean

$_returnType public_oe property

The type of variable this method returns.
public type $_returnType
Résultat type