Свойство | Тип | Описание | |
---|---|---|---|
$_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. |
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 |
public functions ( ) : MethodDoc[] | ||
Результат | MethodDoc[] | An array of subfunctions. |
public paramTags ( ) : Tag[] | ||
Результат | Tag[] |
public parameters ( ) : FieldDoc[] | ||
Результат | FieldDoc[] | An array of parameter, one element per argument in the order the arguments are present |
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 |
public thrownExceptions ( ) : ClassDoc[] | ||
Результат | ClassDoc[] |
public throwsTags ( ) : Type | ||
Результат | Type |
public methodDoc[] $_functions | ||
Результат | methodDoc[] |
public fieldDoc[] $_parameters | ||
Результат | fieldDoc[] |