|
Previous Class |
Solar_Docs_Apiref |
Next Page |
Solar_Docs_Apiref
Recursively parses a class directory for API reference documentation.
Catalog
This class is part of the Solar_Docs package.
Inheritance:
- Solar_Base
- Solar_Docs_Apiref
Constants
None.
Public Properties
These are all the public properties in the Solar_Docs_Apiref class.
You can also view the list of all public, protected, and private properties.
$api- The entire API as a structured array.
$packages- An array of all packages discovered.
$subpackages- An array of all subpackages discovered.
Public Methods
These are all the public methods in the Solar_Docs_Apiref class.
You can also view the list of all public, protected, and private methods.
__construct()- Constructor.
__destruct()- Default destructor; does nothing other than provide a safe fallback for calls to parent::__destruct().
addClass()- Adds a class to the API docs.
addFiles()- Adds classes from a file hierarchy.
apiVersion()- Reports the API version for this class.
dump()- Convenience method for getting a dump the whole object, or one of its properties, or an external variable.
locale()- Looks up class-specific locale strings based on a key.