PHP Class executableDoc

Inheritance: extends ProgramElementDoc
ファイルを表示 Open project: peej/phpdoctor

Public Properties

Property Type Description
$_functions methodDoc[] The subfunctions this function has.
$_parameters fieldDoc[] The parameters this function takes.
$_throws classDoc[] The exceptions this function throws.

Public Methods

Method 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 method

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

flatSignature() public method

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
return str

functions() public method

Get subfunctions.
public functions ( ) : MethodDoc[]
return MethodDoc[] An array of subfunctions.

paramTags() public method

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

parameters() public method

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

signature() public method

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
return str

thrownExceptions() public method

Return exceptions this function throws.
public thrownExceptions ( ) : ClassDoc[]
return ClassDoc[]

throwsTags() public method

Return the throws tags in this function.
public throwsTags ( ) : Type
return Type

Property Details

$_functions public_oe property

The subfunctions this function has.
public methodDoc[] $_functions
return methodDoc[]

$_parameters public_oe property

The parameters this function takes.
public fieldDoc[] $_parameters
return fieldDoc[]

$_throws public_oe property

The exceptions this function throws.
public classDoc[] $_throws
return classDoc[]