PHP 클래스 methodDoc

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

공개 프로퍼티들

프로퍼티 타입 설명
$_abstract boolean Is this class abstract.
$_returnType type The type of variable this method returns.

공개 메소드들

메소드 설명
addParameter ( &$parameter ) Add a parameter to this method.
isAbstract ( ) : boolean Return true if this class is abstract.
isConstructor ( ) : boolean Return true if this class is an constructor.
isDestructor ( ) : boolean Return true if this class is an destructor.
isFunction ( ) : boolean Is this construct a function.
isMethod ( ) : boolean Is this construct a method.
methodDoc ( $name, &$parent, &$root, $filename, $lineNumber, $sourcePath ) Constructor
returnType ( ) : Type Get return type.
returnTypeAsString ( ) : str Format a return type for outputting. Recognised types are turned into HTML anchor tags to the documentation page for the class defining them.

메소드 상세

addParameter() 공개 메소드

Add a parameter to this method.
public addParameter ( &$parameter )

isAbstract() 공개 메소드

Return true if this class is abstract.
public isAbstract ( ) : boolean
리턴 boolean

isConstructor() 공개 메소드

Return true if this class is an constructor.
public isConstructor ( ) : boolean
리턴 boolean

isDestructor() 공개 메소드

Return true if this class is an destructor.
public isDestructor ( ) : boolean
리턴 boolean

isFunction() 공개 메소드

Is this construct a function.
public isFunction ( ) : boolean
리턴 boolean

isMethod() 공개 메소드

Is this construct a method.
public isMethod ( ) : boolean
리턴 boolean

methodDoc() 공개 메소드

Constructor
public methodDoc ( $name, &$parent, &$root, $filename, $lineNumber, $sourcePath )

returnType() 공개 메소드

Get return type.
public returnType ( ) : Type
리턴 Type

returnTypeAsString() 공개 메소드

Format a return type for outputting. Recognised types are turned into HTML anchor tags to the documentation page for the class defining them.
public returnTypeAsString ( ) : str
리턴 str The string representation of the return type

프로퍼티 상세

$_abstract 공개적으로 프로퍼티

Is this class abstract.
public bool $_abstract
리턴 boolean

$_returnType 공개적으로 프로퍼티

The type of variable this method returns.
public type $_returnType
리턴 type