McpHelp

java.lang.Object

rife.bld.help.McpHelp

All Implemented Interfaces:: CommandHelp

public class McpHelp extends Object implements CommandHelp

Provides help for the MCP command.

Since:: 2.4.0

Constructor Summary

Constructors

Constructor

Description

McpHelp()
Method Summary

Modifier and Type

Method

Description

String

getDescription(String topic)

Returns the full help description of a command.

String

getSummary()

Returns a short description about the command.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- McpHelp
  
  public McpHelp()
Method Details
- getSummary
  
  public String getSummary()
  
  Description copied from interface: CommandHelp
  
  Returns a short description about the command.
  
  Specified by:
  
  getSummary in interface CommandHelp
  
  Returns:
  
  the short summary, defaults to ""
- getDescription
  
  public String getDescription(String topic)
  
  Description copied from interface: CommandHelp
  
  Returns the full help description of a command.
  
  Specified by:
  
  getDescription in interface CommandHelp
  
  Returns:
  
  the full help description, defaults to ""