PHP Class executableDoc

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

Méthodes publiques

Свойство Type Description
$_functions methodDoc[] The subfunctions this function has.
$_parameters fieldDoc[] The parameters this function takes.
$_throws classDoc[] The exceptions this function throws.

Méthodes publiques

Méthode Description
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.

Method Details

addMethod() public méthode

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

flatSignature() public méthode

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
Résultat str

functions() public méthode

Get subfunctions.
public functions ( ) : MethodDoc[]
Résultat MethodDoc[] An array of subfunctions.

paramTags() public méthode

Return the param tags in this function.
public paramTags ( ) : Tag[]
Résultat Tag[]

parameters() public méthode

Get argument information.
public parameters ( ) : FieldDoc[]
Résultat FieldDoc[] An array of parameter, one element per argument in the order the arguments are present

signature() public méthode

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
Résultat str

thrownExceptions() public méthode

Return exceptions this function throws.
public thrownExceptions ( ) : ClassDoc[]
Résultat ClassDoc[]

throwsTags() public méthode

Return the throws tags in this function.
public throwsTags ( ) : Type
Résultat Type

Property Details

$_functions public_oe property

The subfunctions this function has.
public methodDoc[] $_functions
Résultat methodDoc[]

$_parameters public_oe property

The parameters this function takes.
public fieldDoc[] $_parameters
Résultat fieldDoc[]

$_throws public_oe property

The exceptions this function throws.
public classDoc[] $_throws
Résultat classDoc[]