org.lsst.ccs.command

Class HelpGenerator

java.lang.Object

org.lsst.ccs.command.HelpGenerator

public class HelpGenerator
extends Object

Provides help based on information from a command dictionary.

Author:

tonyj

Constructor Summary

Constructors

Constructor and Description
HelpGenerator(PrintWriter out, Dictionary dict) Create a HelpGenerator

Method Summary

Methods

Modifier and Type	Method and Description
void	help()
void	help(String command)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HelpGenerator

public HelpGenerator(PrintWriter out,
             Dictionary dict)

Create a HelpGenerator

Parameters:

out - Where the output of the help commands should be sent

dict - The dictionary used to provide help

Method Detail

help

@Command(description="List available commands")
public void help()

help

@Command(description="Show help for a single command")
public void help(@Argument(name="command")
                           String command)