Methods
All methods in the Solar_Cli_MakeDocs class.
Public
-
__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.
Protected
-
_buildConfig() -
Builds and returns the default config for a class, including all configs inherited from its parents.
-
_err() -
Prints text to STDERR without a trailing newline.
-
_errln() -
Prints text to STDERR and appends a newline.
-
_exception() -
Convenience method for returning exceptions with localized text.
-
_exec() -
Main action: parse the classes and write documentation.
-
_fetchGetoptOptions() -
Gets the option settings from the class hierarchy.
-
_getFile() -
Builds a target filename path in the 'class' or 'package' directory.
-
_out() -
Prints text to STDOUT without a trailing newline.
-
_outln() -
Prints text to STDOUT and appends a newline.
-
_postConfig() -
A hook that activates after _buildConfig() in the constructor.
-
_postConstruct() -
Post-construction tasks to complete object construction.
-
_postExec() -
Runs just after the main _exec() method.
-
_preConfig() -
A hook that activates before _buildConfig() in the constructor.
-
_preExec() -
Runs just before the main _exec() method.
-
_setup() -
Post-construction setup logic.
-
_title1() -
Returns level-1 title markup.
-
_title2() -
Returns level-2 title markup.
-
_title3() -
Returns level-3 title markup.
-
_touch() -
Touches a file to create it or update its timestamp.
-
_write() -
Writes a file to the target directory.
Private
None.