PHP Класс methodDoc

Наследование: extends ExecutableDoc
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$_abstract boolean Is this class abstract.
$_returnType type The type of variable this method returns.

Открытые методы

Метод Описание
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.

Описание методов

addParameter() публичный Метод

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

isAbstract() публичный Метод

Return true if this class is abstract.
public isAbstract ( ) : boolean
Результат boolean

isConstructor() публичный Метод

Return true if this class is an constructor.
public isConstructor ( ) : boolean
Результат boolean

isDestructor() публичный Метод

Return true if this class is an destructor.
public isDestructor ( ) : boolean
Результат boolean

isFunction() публичный Метод

Is this construct a function.
public isFunction ( ) : boolean
Результат boolean

isMethod() публичный Метод

Is this construct a method.
public isMethod ( ) : boolean
Результат boolean

methodDoc() публичный Метод

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

returnType() публичный Метод

Get return type.
public returnType ( ) : Type
Результат Type

returnTypeAsString() публичный Метод

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
Результат str The string representation of the return type

Описание свойств

$_abstract публичное свойство

Is this class abstract.
public bool $_abstract
Результат boolean

$_returnType публичное свойство

The type of variable this method returns.
public type $_returnType
Результат type