PHP 클래스 executableDoc

상속: extends ProgramElementDoc
파일 보기 프로젝트 열기: peej/phpdoctor

공개 프로퍼티들

프로퍼티 타입 설명
$_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[]