xenia/kakoune
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Tweak command docstrins

Browse Source
This commit is contained in:
Maxime Coste 2015-03-14 12:17:43 +00:00
parent 82833608c9
commit 8a211fc87a
1 changed files with 36 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
src/commands.cc
View File

@ -211,7 +211,8 @@ const CommandDesc edit_cmd = {
const CommandDesc force_edit_cmd = { const CommandDesc force_edit_cmd = {
"edit!", "edit!",
"e!", "e!",
"edit! <switches> <filename>: open the given filename in a buffer, force reload if needed", "edit! <switches> <filename>: open the given filename in a buffer, "
"force reload if needed",
edit_params, edit_params,
CommandFlags::None, CommandFlags::None,
CommandHelper{}, CommandHelper{},
@ -226,16 +227,16 @@ void write_buffer(const ParametersParser& parser, Context& context)
if (parser.positional_count() == 0 and !(buffer.flags() & Buffer::Flags::File)) if (parser.positional_count() == 0 and !(buffer.flags() & Buffer::Flags::File))
throw runtime_error("cannot write a non file buffer without a filename"); throw runtime_error("cannot write a non file buffer without a filename");
String filename = parser.positional_count() == 0 ? buffer.name() auto filename = parser.positional_count() == 0 ?
: parse_filename(parser[0]); buffer.name() : parse_filename(parser[0]);
write_buffer_to_file(buffer, filename); write_buffer_to_file(buffer, filename);
} }
const CommandDesc write_cmd = { const CommandDesc write_cmd = {
"write", "write",
"w", "w",
"write [filename]: write the current buffer to it's file or to [filename] if specified", "write [filename]: write the current buffer to it's file "
"or to [filename] if specified",
single_optional_name_param, single_optional_name_param,
CommandFlags::None, CommandFlags::None,
CommandHelper{}, CommandHelper{},
@ -294,7 +295,8 @@ void quit()
const CommandDesc quit_cmd = { const CommandDesc quit_cmd = {
"quit", "quit",
"q", "q",
"quit current client, and the kakoune session if the client is the last (if not running in daemon mode)", "quit current client, and the kakoune session if the client is the last "
"(if not running in daemon mode)",
no_params, no_params,
CommandFlags::None, CommandFlags::None,
CommandHelper{}, CommandHelper{},
@ -305,8 +307,9 @@ const CommandDesc quit_cmd = {
const CommandDesc force_quit_cmd = { const CommandDesc force_quit_cmd = {
"quit!", "quit!",
"q!", "q!",
"quit current client, and the kakoune session if the client is the last (if not running in daemon mode)\n" "quit current client, and the kakoune session if the client is the last "
"force quit even if the client is the last and some buffers are not saved.", "(if not running in daemon mode). force quit even if the client is the "
"last and some buffers are not saved.",
no_params, no_params,
CommandFlags::None, CommandFlags::None,
CommandHelper{}, CommandHelper{},
@ -332,7 +335,8 @@ const CommandDesc write_quit_cmd = {
const CommandDesc force_write_quit_cmd = { const CommandDesc force_write_quit_cmd = {
"wq!", "wq!",
nullptr, nullptr,
"write current buffer and quit current client, even if other buffers are not saved", "write current buffer and quit current client, even if other buffers are "
"not saved",
no_params, no_params,
CommandFlags::None, CommandFlags::None,
CommandHelper{}, CommandHelper{},
@ -397,7 +401,7 @@ void delete_buffer(const ParametersParser& parser, Context& context)
const CommandDesc delbuf_cmd = { const CommandDesc delbuf_cmd = {
"delbuf", "delbuf",
"db", "db",
"delbuf [name]: delete the current buffer or the buffer named <name> if given", "delbuf [name]: delete current buffer or the buffer named <name> if given",
single_optional_name_param, single_optional_name_param,
CommandFlags::None, CommandFlags::None,
CommandHelper{}, CommandHelper{},
@ -408,7 +412,8 @@ const CommandDesc delbuf_cmd = {
const CommandDesc force_delbuf_cmd = { const CommandDesc force_delbuf_cmd = {
"delbuf!", "delbuf!",
"db!", "db!",
"delbuf! [name]: delete the current buffer or the buffer named <name> if given, even if the buffer is unsaved", "delbuf! [name]: delete current buffer or the buffer named <name> if "
"given, even if the buffer is unsaved",
single_optional_name_param, single_optional_name_param,
CommandFlags::None, CommandFlags::None,
CommandHelper{}, CommandHelper{},
@ -499,10 +504,14 @@ Highlighter& get_highlighter(const Context& context, StringView path)
const CommandDesc add_highlighter_cmd = { const CommandDesc add_highlighter_cmd = {
"addhl", "addhl",
"ah", "ah",
"addhl <scope>/<group>/<id> <type> <type params>...: add an highlighter\n" "addhl <type> <type params>...: add an highlighter",
"<scope> can be shared or window",
ParameterDesc{ ParameterDesc{
SwitchMap{ { "group", { true, "specify the group in which to put the highlighter" } } }, SwitchMap{
{ "group",
{ true,
"specify the group in which to put the highlighter. If "
"starting with /, searche in shared highlighters, if not, "
"it is searched in the current window" } } },
ParameterDesc::Flags::SwitchesOnlyAtStart, 1 }, ParameterDesc::Flags::SwitchesOnlyAtStart, 1 },
CommandFlags::None, CommandFlags::None,
[](const Context& context, CommandParameters params) -> String [](const Context& context, CommandParameters params) -> String
@ -563,7 +572,8 @@ const CommandDesc rm_highlighter_cmd = {
const CommandDesc add_hook_cmd = { const CommandDesc add_hook_cmd = {
"hook", "hook",
nullptr, nullptr,
"hook <switches> <scope> <hook_name> <command>: add <command> in <scope> to be executed on hook <hook_name>\n" "hook <switches> <scope> <hook_name> <command>: add <command> in <scope> "
"to be executed on hook <hook_name>\n"
"scope can be: \n" "scope can be: \n"
" * global: hook is executed for any buffer or window\n" " * global: hook is executed for any buffer or window\n"
" * buffer: hook is executed only for the current buffer\n" " * buffer: hook is executed only for the current buffer\n"
@ -745,7 +755,7 @@ void define_command(const ParametersParser& parser, Context& context)
const CommandDesc define_command_cmd = { const CommandDesc define_command_cmd = {
"def", "def",
nullptr, nullptr,
"def <switches> <name> <commands>: define a command named <name> corresponding to <commands>", "def <switches> <name> <cmds>: define a command <name> executing <cmds>",
ParameterDesc{ ParameterDesc{
SwitchMap{ { "shell-params", { false, "pass parameters to each shell escape as $0..$N" } }, SwitchMap{ { "shell-params", { false, "pass parameters to each shell escape as $0..$N" } },
{ "allow-override", { false, "allow overriding an existing command" } }, { "allow-override", { false, "allow overriding an existing command" } },
@ -767,7 +777,7 @@ const CommandDesc define_command_cmd = {
const CommandDesc alias_cmd = { const CommandDesc alias_cmd = {
"alias", "alias",
nullptr, nullptr,
"alias <scope> <alias> <command>: define a command alias in given scope", "alias <scope> <alias> <command>: alias <alias> to <command> in <scope>\n",
ParameterDesc{SwitchMap{}, ParameterDesc::Flags::None, 3, 3}, ParameterDesc{SwitchMap{}, ParameterDesc::Flags::None, 3, 3},
CommandFlags::None, CommandFlags::None,
CommandHelper{}, CommandHelper{},
@ -782,8 +792,8 @@ const CommandDesc alias_cmd = {
const CommandDesc unalias_cmd = { const CommandDesc unalias_cmd = {
"unalias", "unalias",
nullptr, nullptr,
"unalias <scope> <alias> [<expected>]: remove a command alias in given scope\n" "unalias <scope> <alias> [<expected>]: remove <alias> from <scope>\n"
"if <expected> is specified, the alias is removed only if its value is <expected>", "If <expected> is specified, remove <alias> only if its value is <expected>",
ParameterDesc{SwitchMap{}, ParameterDesc::Flags::None, 2, 3}, ParameterDesc{SwitchMap{}, ParameterDesc::Flags::None, 2, 3},
CommandFlags::None, CommandFlags::None,
CommandHelper{}, CommandHelper{},
@ -967,7 +977,7 @@ const CommandDesc declare_option_cmd = {
"decl", "decl",
nullptr, nullptr,
"decl <type> <name> [value]: declare option <name> of type <type>.\n" "decl <type> <name> [value]: declare option <name> of type <type>.\n"
"set its initial value to <value> if given and if the option did not exist\n" "set its initial value to <value> if given and the option did not exist\n"
"Available types:\n" "Available types:\n"
" int: integer\n" " int: integer\n"
" bool: boolean (true/false or yes/no)\n" " bool: boolean (true/false or yes/no)\n"
@ -1037,12 +1047,8 @@ KeymapMode parse_keymap_mode(const String& str)
const CommandDesc map_key_cmd = { const CommandDesc map_key_cmd = {
"map", "map",
nullptr, nullptr,
"map <scope> <mode> <key> <keys>: map <key> to <keys> in given mode at given scope.\n" "map <scope> <mode> <key> <keys>: map <key> to <keys> in given mode in <scope>.\n"
"Valid scopes:\n" "<mode> can be:\n"
" window\n"
" buffer\n"
" global\n"
"Valid modes:\n"
" normal\n" " normal\n"
" insert\n" " insert\n"
" menu\n" " menu\n"
@ -1277,7 +1283,8 @@ const CommandDesc prompt_cmd = {
const CommandDesc menu_cmd = { const CommandDesc menu_cmd = {
"menu", "menu",
nullptr, nullptr,
"menu <switches> <name1> <commands1> <name2> <commands2>...: display a menu and execute commands for the selected item", "menu <switches> <name1> <commands1> <name2> <commands2>...: display a "
"menu and execute commands for the selected item",
ParameterDesc{ ParameterDesc{
SwitchMap{ { "auto-single", { false, "instantly validate if only one item is available" } }, SwitchMap{ { "auto-single", { false, "instantly validate if only one item is available" } },
{ "select-cmds", { false, "each item specify an additional command to run when selected" } } } { "select-cmds", { false, "each item specify an additional command to run when selected" } } }
@ -1371,8 +1378,8 @@ const CommandDesc info_cmd = {
const CommandDesc try_catch_cmd = { const CommandDesc try_catch_cmd = {
"try", "try",
nullptr, nullptr,
"try <command> [catch <error_command>]: execute command in current context.\n" "try <cmds> [catch <error_cmds>]: execute <cmds> in current context.\n"
"if an error is raised and <error_command> is specified, execute it.\n" "if an error is raised and <error_cmds> is specified, execute it; "
"The error is not propagated further.", "The error is not propagated further.",
ParameterDesc{ SwitchMap{}, ParameterDesc::Flags::None, 1, 3 }, ParameterDesc{ SwitchMap{}, ParameterDesc::Flags::None, 1, 3 },
CommandFlags::None, CommandFlags::None,