blob: bd81537e8794e3766d68cccc1598a979619f5d43 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
package bjc.utils.cli;
/**
* Interface for the help entry for a command
*
* @author ben
*
*/
public interface ICommandHelp {
/**
* Get the description of a command.
*
* @return The description of a command
*/
public String getDescription();
/**
* Get the summary line for a command.
*
* A summary line should consist of a string of the following format
* "<command-name>\t<command-summary>"
* where anything in angle brackets should be filled in.
* @return The summary line line for a command
*/
public String getSummary();
}
|
