mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-10-15 14:26:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Extend documentation

Browse Source
This commit is contained in:
ZyX
2014-07-22 08:22:39 +04:00
parent 1e11de5385
commit de58394f34
2 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/nvim/ex_cmds.lua
View File

@@ -1,5 +1,6 @@
bit = require 'bit' bit = require 'bit'
-- Description of the values below is contained in ex_cmds_defs.h file.
local RANGE = 0x001 local RANGE = 0x001
local BANG = 0x002 local BANG = 0x002
local EXTRA = 0x004 local EXTRA = 0x004
@@ -26,6 +27,8 @@ local EXFLAGS = 0x400000
local FILES = bit.bor(XFILE, EXTRA) local FILES = bit.bor(XFILE, EXTRA)
local WORD1 = bit.bor(EXTRA, NOSPC) local WORD1 = bit.bor(EXTRA, NOSPC)
local FILE1 = bit.bor(FILES, NOSPC) local FILE1 = bit.bor(FILES, NOSPC)
-- The following table is described in ex_cmds_defs.h file.
return { return {
{ {
command='append', command='append',

15
src/nvim/ex_cmds_defs.h
View File

@@ -21,6 +21,21 @@
* 1. Add an entry to the table in src/nvim/ex_cmds.lua. Keep it sorted on the * 1. Add an entry to the table in src/nvim/ex_cmds.lua. Keep it sorted on the
* shortest version of the command name that works. If it doesn't start with * shortest version of the command name that works. If it doesn't start with
* a lower case letter, add it at the end. * a lower case letter, add it at the end.
*
* Each table entry is a table with the following keys:
*
* Key | Description
* ------- | -------------------------------------------------------------
* command | Name of the command. Required.
* enum | Name of the enum entry. If not set defaults to CMD_{command}.
* flags | A set of the flags from below list joined by bitwise or.
* func | Name of the function containing the implementation.
*
* Referenced function should be either non-static one or defined in
* ex_docmd.c and be coercible to ex_func_T type from below.
*
* All keys not described in the above table are reserved for future use.
*
* 2. Add a "case: CMD_xxx" in the big switch in ex_docmd.c. * 2. Add a "case: CMD_xxx" in the big switch in ex_docmd.c.
* 3. Add an entry in the index for Ex commands at ":help ex-cmd-index". * 3. Add an entry in the index for Ex commands at ":help ex-cmd-index".
* 4. Add documentation in ../doc/xxx.txt. Add a tag for both the short and * 4. Add documentation in ../doc/xxx.txt. Add a tag for both the short and