QcCommandHelp Class

/help (decisions E-243, E-911): without a word one line per group (QcCommandCategory) with the commands the source may run; /help <group> [page] those commands with their descriptions, pageSize to a page; /help <command> its usage, its description and the words its usage cannot name (QcCommandSpec::names, the structures of /locate). More...

Header: #include <server/commands/QcCommandHelp.h>

List of all members, including inherited members

Public Functions

void	run(const QcCommandContext &context) const

Static Public Members

bool	mayRun(const QcCommandSource &source, const QcCommandMacroDefinition &macro)
const qsizetype	pageSize

Detailed Description

The macros of the content (decision E-248) form the group "other" with their plain texts.

Member Function Documentation

`[static]` bool QcCommandHelp::mayRun(const QcCommandSource &source, const QcCommandMacroDefinition &macro)

Returns whether source may run macro at all.

void QcCommandHelp::run(const QcCommandContext &context) const

Runs /help for the call context.

Member Variable Documentation

const qsizetype QcCommandHelp::pageSize

Commands on a page of a group.

Contents