blob: 327fb757ec3c5661543c406ad7997564619160b1 (
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
27
|
package bjc.utils.cli;
/**
* Interface for the help entry for a command
*
* @author ben
*
*/
public interface CommandHelp {
/**
* Get the description of a command.
*
* @return The description of a command
*/
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
*/
String getSummary();
}
|
