diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2017-12-10 01:24:54 +0100 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2017-12-10 17:13:22 +0100 |
| commit | dc232b74fb1a7927d6c13bd8c80bb42fc18a859f (patch) | |
| tree | ae508f45a06a593abe1132e895adc0cefc00c654 | |
| parent | abe38f7d26d68d7032ea391c039c56c8b87675a5 (diff) | |
| download | rneovim-dc232b74fb1a7927d6c13bd8c80bb42fc18a859f.tar.gz rneovim-dc232b74fb1a7927d6c13bd8c80bb42fc18a859f.tar.bz2 rneovim-dc232b74fb1a7927d6c13bd8c80bb42fc18a859f.zip | |
doc: hack to avoid doxygen bug
Use `@cond <something>` to obscure a section from doxygen.
doxygen thinks kvec_withinit_t() is a function. That adds noise to the
generated API documentation, and also prevents the following function
from being noticed.
| -rw-r--r-- | runtime/doc/api.txt | 6 | ||||
| -rw-r--r-- | src/nvim/api/vim.c | 6 |
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 /// |