Overview
Generates package and API documentation files.
Configuration Keys
class_dir
: The directory in which wiki-based class docs are stored.package_dir
: The directory in which wiki-based package docs are stored.docbook_dir
: The directory in which to save DocBook files.
Constants
None.
Public Properties
The Solar_Cli_MakeDocbook class has no public properties; try the list of all properties.
Public Methods
These are all the public methods in the Solar_Cli_MakeDocbook class.
You can also view the list of all public, protected, and private methods.
-
__construct()
-
Constructor.
-
__destruct()
-
Destructor; closes STDOUT and STDERR file handles.
-
dump()
-
Convenience method for getting a dump the whole object, or one of its properties, or an external variable.
-
exec()
-
Public interface to execute the command.
-
getInfoHelp()
-
Returns the help text for this command.
-
getInfoOptions()
-
Returns an array of option flags and descriptions for this command.
-
locale()
-
Looks up class-specific locale strings based on a key.
-
setConsoleController()
-
Injects the console-controller object (if any) that invoked this command.