Solar_Cli_MakeDocs

Generates package and API documentation files.

Catalog

This class is part of the Solar_Cli package.

Inheritance:

None.

These are all the public properties in the Solar_Cli_MakeDocs class.

These are all the public methods in the Solar_Cli_MakeDocs class.

__construct(): Constructor.
__destruct(): Destructor; closes STDOUT and STDERR file handles.
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.
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.
writeClassConstants(): Writes the Constants file.
writeClassContents(): Writes the table-of-contents XML file.
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.
writeClassesList(): Writes the contents file for the list of classes.
writePackageClassList(): Writes one package description file.
writePackages(): Writes the entire "packages" directory.