kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-20 03:05:11 -07:00
Code Issues Packages Projects Releases Wiki Activity

doc/api: Closes #1842

Browse Source
This commit is contained in:
Justin M. Keyes 2016-10-31 16:16:37 +01:00
parent b172f9904f
commit e427cdf2d4
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
runtime/doc/api.txt
View File

@ -49,15 +49,20 @@ Tabpage -> enum value kObjectTypeTabpage
==============================================================================
3. API metadata *api-metadata*
Nvim exposes metadata about the API as a Dictionary with the following keys:
Nvim exposes API metadata as a Dictionary. Some items are described below:
version Nvim version, API level/compatibility
functions API function signatures
types Custom handle types defined by Nvim
error_types Possible error types returned by API functions
version Nvim version, API level/compatibility
version.api_level Current API level
version.api_compatible API is backwards-compatible with this level
version.api_prerelease Declares the current API level as unstable >
(version.api_prerelease && fn.since == version.api_level)
functions API function signatures
{fn}.since API level where function {fn} was introduced
{fn}.deprecated_since API level where function {fn} was deprecated
types Custom handle types defined by Nvim
error_types Possible error types returned by API functions
This metadata is mostly useful for external programs accessing the API via
RPC, see |rpc-api|.
External programs ("clients") can use the metadata to discover the |rpc-api|.
==============================================================================
4. Buffer highlighting *api-highlights*