Igor.Responder.Help (Igor v0.3.1)

View Source

Displays help for commands.

Responders should implement the Igor.Responder.Help.Proto protocol, so that this responder can display help for it.

Responders that use Igor.Responder.Helper or Igor.Responder.ModuleHelper will do this automatically, and can use the @help module attribute to set the help information. See the documentation for Igor.Responder.Helper and Igor.Responder.ModuleHelper for more information.

Summary

Functions

help_summary(cmdprefix, help)

@spec help_summary(cmdprefix :: String.t(), help :: map()) ::
  Polyjuice.Client.MsgBuilder.MsgData.t()