CRPCTable::help

Build the help text for a command, or the command overview.

Synopsis

Declared in <rpc/server.h>

std::string
help(
    std::string_view name,
    JSONRPCRequest const& helpreq) const;

Return Value

The formatted help text.

Parameters

NameDescription
nameThe method to describe, or empty for the full listing.
helpreqThe request providing context for generating help.