[][src]Attribute Macro command_attr::check

#[check]

A macro for marking a function as a condition checker to groups and commands.

Options

SyntaxDescriptionArgument explanation
#[name(s)]
#[name = s]
How the check should be listed in help.s is a string. If this option isn't provided, the value is assumed to be "<fn>".
#[display_in_help]
#[display_in_help(b)]
If the check should be listed in help. Has no effect on check_in_help.b is a boolean. If no boolean is provided, the value is assumed to be true.
#[check_in_help]
#[check_in_help(b)]
If the check should be evaluated in help.b is a boolean. If no boolean is provided, the value is assumed to be true.