Property | Type | Description | |
---|---|---|---|
$_classes | classDoc[] | The classes in this package | |
$_functions | methodDoc[] | The functions in this package | |
$_globals | fieldDoc[] | The globals in this package |
Method | Description | |
---|---|---|
addClass ( &$class ) | Add a class to this package. | |
addFunction ( &$function ) | Add a function to this package. | |
addGlobal ( &$global ) | Add a global to this package. | |
allClasses ( ) : ClassDoc[] | Get all included classes (including exceptions and interfaces). | |
asPath ( ) : str | Return the package path. | |
depth ( ) : integer | Calculate the depth of this package from the root. | |
exceptions ( ) : ClassDoc[] | Get exceptions in this package. | |
findClass ( $className ) : ClassDoc | Lookup for a class within this package. | |
functions ( ) : MethodDoc[] | Get functions in this package. | |
globals ( ) : FieldDoc[] | Get globals in this package. | |
interfaces ( ) : ClassDoc[] | Get interfaces in this package. | |
ordinaryClasses ( ) : ClassDoc[] | Get ordinary classes (excluding exceptions and interfaces) in this package. | |
packageDoc ( $name, &$root ) | Constructor | |
traits ( ) : ClassDoc[] | Get traits in this package. |
public allClasses ( ) : ClassDoc[] | ||
return | ClassDoc[] | An array of classes |
public exceptions ( ) : ClassDoc[] | ||
return | ClassDoc[] | An array of exceptions |
public findClass ( $className ) : ClassDoc | ||
return | ClassDoc | A class |
public functions ( ) : MethodDoc[] | ||
return | MethodDoc[] | An array of functions |
public globals ( ) : FieldDoc[] | ||
return | FieldDoc[] | An array of globals |
public interfaces ( ) : ClassDoc[] | ||
return | ClassDoc[] | An array of interfaces |
public ordinaryClasses ( ) : ClassDoc[] | ||
return | ClassDoc[] | An array of classes |
public traits ( ) : ClassDoc[] | ||
return | ClassDoc[] | An array of traits |
public classDoc[] $_classes | ||
return | classDoc[] |
public methodDoc[] $_functions | ||
return | methodDoc[] |