PHP Класс executableDoc

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

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

Свойство Тип Описание
$_functions methodDoc[] The subfunctions this function has.
$_parameters fieldDoc[] The parameters this function takes.
$_throws classDoc[] The exceptions this function throws.

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

Метод Описание
addMethod ( &$function ) Add a subfunction to this function.
flatSignature ( ) : str Get flat signature. Return a string which is the flat signiture of this function. It is the parameter list, type is not qualified.
functions ( ) : MethodDoc[] Get subfunctions.
paramTags ( ) : Tag[] Return the param tags in this function.
parameters ( ) : FieldDoc[] Get argument information.
signature ( ) : str Get the signature. It is the parameter list, type is qualified.
thrownExceptions ( ) : ClassDoc[] Return exceptions this function throws.
throwsTags ( ) : Type Return the throws tags in this function.

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

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

Add a subfunction to this function.
public addMethod ( &$function )

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

for a function
mymethod(foo x, int y)
it will return
(foo x, int y)
Recognised types are turned into HTML anchor tags to the documentation page for the class defining them.
public flatSignature ( ) : str
Результат str

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

Get subfunctions.
public functions ( ) : MethodDoc[]
Результат MethodDoc[] An array of subfunctions.

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

Return the param tags in this function.
public paramTags ( ) : Tag[]
Результат Tag[]

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

Get argument information.
public parameters ( ) : FieldDoc[]
Результат FieldDoc[] An array of parameter, one element per argument in the order the arguments are present

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

for a function
mymethod(foo x, int y)
it will return
(bar.foo x, int y)
Recognised types are turned into HTML anchor tags to the documentation page for the class defining them.
public signature ( ) : str
Результат str

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

Return exceptions this function throws.
public thrownExceptions ( ) : ClassDoc[]
Результат ClassDoc[]

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

Return the throws tags in this function.
public throwsTags ( ) : Type
Результат Type

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

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

The subfunctions this function has.
public methodDoc[] $_functions
Результат methodDoc[]

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

The parameters this function takes.
public fieldDoc[] $_parameters
Результат fieldDoc[]

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

The exceptions this function throws.
public classDoc[] $_throws
Результат classDoc[]