diff options
| author | Lewis Russell <lewis6991@gmail.com> | 2023-07-15 16:55:32 +0100 |
|---|---|---|
| committer | Lewis Russell <lewis6991@gmail.com> | 2023-07-17 16:25:28 +0100 |
| commit | 0ac3c4d6314df5fe40571a83e157a425ab7ce16d (patch) | |
| tree | b5aee7b6a624b7ebc324206bd562c13e74459055 /runtime/lua/vim/_meta/mpack.lua | |
| parent | 3fd504dbec39eeced1bea17d9f3bd06de7f3e4d8 (diff) | |
| download | rneovim-0ac3c4d6314df5fe40571a83e157a425ab7ce16d.tar.gz rneovim-0ac3c4d6314df5fe40571a83e157a425ab7ce16d.tar.bz2 rneovim-0ac3c4d6314df5fe40571a83e157a425ab7ce16d.zip | |
docs(lua): move function docs to lua files
Diffstat (limited to 'runtime/lua/vim/_meta/mpack.lua')
| -rw-r--r-- | runtime/lua/vim/_meta/mpack.lua | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/runtime/lua/vim/_meta/mpack.lua b/runtime/lua/vim/_meta/mpack.lua new file mode 100644 index 0000000000..2764177e5c --- /dev/null +++ b/runtime/lua/vim/_meta/mpack.lua @@ -0,0 +1,13 @@ +--- @meta + +--- @defgroup lua-mpack +--- +--- @brief The \*vim.mpack\* module provides encoding and decoding of Lua objects to and +--- from msgpack-encoded strings. Supports |vim.NIL| and |vim.empty_dict()|. + +--- Decodes (or "unpacks") the msgpack-encoded {str} to a Lua object. +--- @param str string +function vim.mpack.decode(str) end + +--- Encodes (or "packs") Lua object {obj} as msgpack in a Lua string. +function vim.mpack.encode(obj) end |