aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--runtime/doc/api.txt6
-rw-r--r--src/nvim/api/vim.c6
2 files changed, 11 insertions, 1 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index ef8b9c7d47..ecf829d356 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -446,7 +446,11 @@ nvim_get_keymap({mode}) *nvim_get_keymap()*
Array of maparg()-like dictionaries describing mappings
nvim_get_api_info() *nvim_get_api_info()*
- TODO: Documentation
+ Returns a 2-tuple (Array), where item 0 is the current channel
+ id and item 1 is the |api-metadata| map (Dictionary).
+
+ Return:~
+ 2-tuple [{channel-id}, {api-metadata}]
Attributes:~
{async}
diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c
index 416e7d22d2..f0db391abe 100644
--- a/src/nvim/api/vim.c
+++ b/src/nvim/api/vim.c
@@ -789,6 +789,10 @@ ArrayOf(Dictionary) nvim_get_keymap(String mode)
return keymap_array(mode, NULL);
}
+/// Returns a 2-tuple (Array), where item 0 is the current channel id and item
+/// 1 is the |api-metadata| map (Dictionary).
+///
+/// @returns 2-tuple [{channel-id}, {api-metadata}]
Array nvim_get_api_info(uint64_t channel_id)
FUNC_API_SINCE(1) FUNC_API_ASYNC FUNC_API_REMOTE_ONLY
{
@@ -896,7 +900,9 @@ typedef struct {
Object *ret_node_p;
} ExprASTConvStackItem;
+///@cond DOXYGEN_NOT_A_FUNCTION
typedef kvec_withinit_t(ExprASTConvStackItem, 16) ExprASTConvStack;
+///@endcond
/// Parse a VimL expression
///