Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## avrora.util.help
Interface HelpItem

All Known Implementing Classes:
  ClassMapValueItem, HelpCategory, SubcategoryItem, ValueItem

public interface HelpItem

Method Summary
`java.lang.String` | `getHelp()` The `getHelp()` method returns a string that is suitable to being formatted into a single paragraph.
`void` | `printHelp()` The `printHelp()` method prints a representation of the help to the console, formatted appropriately according to the terminal size.

Method Detail

### getHelp

    public java.lang.String getHelp()

  The `getHelp()` method returns a string that is suitable to being formatted into a single paragraph. This string should contain a few sentences about what the option, action, input format, etc represents and how to use it.

  Returns:
    a string representation of the help for this item

### printHelp

    public void printHelp()

  The `printHelp()` method prints a representation of the help to the console, formatted appropriately according to the terminal size.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD