• 홈
• doc

PHP 클래스 doc

파일 보기 프로젝트 열기: peej/phpdoctor 1 사용 예제들

공개 프로퍼티들

프로퍼티	타입	설명
$_data	mixed[]	Data about the element creamed from the token stream before the object for this element was created. This array contains extra data about the element that occurs before the element definition in the token stream (including doc comment data), it is merged with the objects fields upon object completion.
$_docComment	str	The unprocessed doc comment.
$_name	str	The name of this construct
$_root	rootDoc	Reference to the root element.
$_tags	tag[]	Array of doc tags.
$inBody	integer	Whether parsing is inside this elements curly braces.

공개 메소드들

메소드	설명
getFileContents ( $filename ) : str	Get body of a text document
getRawCommentText ( ) : str	Return the full unprocessed text of the comment.
isClass ( ) : boolean	Is this construct a class. Note: interfaces are not classes. False until overridden.
isConstructor ( ) : boolean	Is this construct a constructor. False until overridden.
isException ( ) : boolean	Is this construct an exception. False until overridden.
isField ( ) : boolean	Is this construct a field. False until overridden.
isFinal ( ) : boolean	Is this construct final. False until overridden.
isFunction ( ) : boolean	Is this construct a function. False until overridden.
isGlobal ( ) : boolean	Is this construct a global variable. False until overridden.
isInterface ( ) : boolean	Is this construct an interface. False until overridden.
isMethod ( ) : boolean	Is this construct a method. False until overridden.
isOrdinaryClass ( ) : boolean	Is this construct an ordinary class (not an interface or an exception).
isTrait ( ) : boolean	Is this construct an trait. False until overridden.
mergeData ( )	Merge the contents of the doc comment into the element object.
name ( ) : str	Return the name of this doc item.
set ( $member, $value ) : boolean	Setter method.
setByRef ( $member, &$value ) : boolean	Setter by reference method.
setTag ( $tagName, $tag )	Set a tag.
tags ( $tagName = NULL ) : Tag[]	Return tags of the specified kind in this Doc item. For example, if 'tagName' has value "@serial", all tags in this Doc item of type "@serial" will be returned. If NULL is given for 'tagName', all tags in this Doc item are returned.

메소드 상세

프로퍼티 상세