PHP 클래스 rootDoc

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

공개 프로퍼티들

프로퍼티 타입 설명
$_packages packageDoc[] The parsed packages.
$_phpdoctor phpdoctor Reference to the PHPDoctor application object.
$_sources str[] The parsed contents of the source files

공개 메소드들

메소드 설명
addPackage ( &$package ) Add a package to this root.
addSource ( $filename, $source, $fileData ) Add a source file to this root.
classNamed ( $name ) : ClassDoc Return a reference to a classDoc for the specified class/interface name
classes ( ) : ClassDoc[] Return a reference to the classes and interfaces to be documented.
functions ( ) : MethodDoc[] Return a reference to the functions to be documented.
globals ( ) : FieldDoc[] Return a reference to the globals to be documented.
options ( ) : str[] Return a reference to the set options.
packageNamed ( $name, $create = FALSE ) : PackageDoc Return a reference to a packageDoc for the specified package name. If a package of the requested name does not exist, this method will create the package object, add it to the root and return it.
packages ( ) : PackageDoc[] Return a reference to the packages to be documented.
phpdoctor ( ) : PHPDoctor. Return a reference to the PHPDoctor application object.
rootDoc ( &$phpdoctor ) Constructor
sources ( ) : str[] Return a reference to the source files to be documented.

메소드 상세

addPackage() 공개 메소드

Add a package to this root.
public addPackage ( &$package )

addSource() 공개 메소드

Add a source file to this root.
public addSource ( $filename, $source, $fileData )

classNamed() 공개 메소드

Return a reference to a classDoc for the specified class/interface name
public classNamed ( $name ) : ClassDoc
리턴 ClassDoc

classes() 공개 메소드

Return a reference to the classes and interfaces to be documented.
public classes ( ) : ClassDoc[]
리턴 ClassDoc[]

functions() 공개 메소드

Return a reference to the functions to be documented.
public functions ( ) : MethodDoc[]
리턴 MethodDoc[]

globals() 공개 메소드

Return a reference to the globals to be documented.
public globals ( ) : FieldDoc[]
리턴 FieldDoc[]

options() 공개 메소드

Return a reference to the set options.
public options ( ) : str[]
리턴 str[] An array of strings.

packageNamed() 공개 메소드

Return a reference to a packageDoc for the specified package name. If a package of the requested name does not exist, this method will create the package object, add it to the root and return it.
public packageNamed ( $name, $create = FALSE ) : PackageDoc
리턴 PackageDoc

packages() 공개 메소드

Return a reference to the packages to be documented.
public packages ( ) : PackageDoc[]
리턴 PackageDoc[]

phpdoctor() 공개 메소드

Return a reference to the PHPDoctor application object.
public phpdoctor ( ) : PHPDoctor.
리턴 PHPDoctor.

rootDoc() 공개 메소드

Constructor
public rootDoc ( &$phpdoctor )

sources() 공개 메소드

Return a reference to the source files to be documented.
public sources ( ) : str[]
리턴 str[]

프로퍼티 상세

$_packages 공개적으로 프로퍼티

The parsed packages.
public packageDoc[] $_packages
리턴 packageDoc[]

$_phpdoctor 공개적으로 프로퍼티

Reference to the PHPDoctor application object.
public phpdoctor $_phpdoctor
리턴 phpdoctor

$_sources 공개적으로 프로퍼티

The parsed contents of the source files
public str[] $_sources
리턴 str[]