Class SimpleHelp

Description

Renders the help for the command line arguments.

Located in /arguments.php (line 138)


	
			
Method Summary
 SimpleHelp __construct ([string $overview = ''])
 void explainFlag (string/array $flags, string $explanation)
 string render ()
Methods
Constructor __construct (line 147)

Sets up the top level explanation for the program.

SimpleHelp __construct ([string $overview = ''])
  • string $overview: Summary of program.
explainFlag (line 159)

Adds the explanation for a group of flags that all have the same function.

void explainFlag (string/array $flags, string $explanation)
  • string/array $flags: Flag and alternates. Don't worry about leading dashes as these are inserted automatically.
  • string $explanation: What that flag group does.
render (line 169)

Generates the help text.

  • return: The complete formatted text.
string render ()

Documentation generated on Sun, 31 Oct 2010 16:30:53 -0500 by phpDocumentor 1.4.3