Overview
Generates package and API documentation files.
Configuration Keys
class_dir: The directory in which to write class docs.package_dir: The directory in which to write package docs.docbook_dir: The directory in which to write converted DocBook files.
Constants
None.
Public Properties
These are all the public properties in the Solar_Cli_MakeDocs class.
You can also view the list of all public, protected, and private properties.
Public Methods
These are all the public methods in the Solar_Cli_MakeDocs 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.
-
writeClassConfig() -
Writes the Config file.
-
writeClassConstants() -
Writes the Constants file.
-
writeClassIndex() -
Writes the index file for a single class.
-
writeClassMethod() -
Writes an individual method file.
-
writeClassMethods() -
Writes the Methods file.
-
writeClassOverview() -
Writes the Overview file.
-
writeClassProperties() -
Writes the Properties file.
-
writeClasses() -
Writes the "class" directory.
-
writeClassesIndex() -
Writes the index file for the list of classes.
-
writePackageClassList() -
Writes one package description file.
-
writePackageIndex() -
Writes the package index file.
-
writePackages() -
Writes the entire "packages" directory.