diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2023-07-12 19:27:14 +0200 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2023-08-03 14:01:53 +0200 |
| commit | d2f81330247ee060d557330b2716ccea8f789a50 (patch) | |
| tree | cfc05f6f29b46d280a0207d71df51d8cda9b402e /src | |
| parent | 214b125132778c5d51d4d7e673d31a9be835e150 (diff) | |
| download | rneovim-d2f81330247ee060d557330b2716ccea8f789a50.tar.gz rneovim-d2f81330247ee060d557330b2716ccea8f789a50.tar.bz2 rneovim-d2f81330247ee060d557330b2716ccea8f789a50.zip | |
docs: misc
Co-authored-by: Kevin Pham <keevan.pham@gmail.com>
Diffstat (limited to 'src')
| -rw-r--r-- | src/nvim/api/autocmd.c | 10 | ||||
| -rw-r--r-- | src/nvim/api/command.c | 2 | ||||
| -rw-r--r-- | src/nvim/api/options.c | 2 |
3 files changed, 8 insertions, 6 deletions
diff --git a/src/nvim/api/autocmd.c b/src/nvim/api/autocmd.c index 0e06594663..6ab1283f89 100644 --- a/src/nvim/api/autocmd.c +++ b/src/nvim/api/autocmd.c @@ -517,11 +517,9 @@ cleanup: return autocmd_id; } -/// Delete an autocommand by id. +/// Deletes an autocommand by id. /// -/// NOTE: Only autocommands created via the API have an id. -/// @param id Integer The id returned by nvim_create_autocmd -/// @see |nvim_create_autocmd()| +/// @param id Integer Autocommand id returned by |nvim_create_autocmd()| void nvim_del_autocmd(Integer id, Error *err) FUNC_API_SINCE(9) { @@ -533,8 +531,8 @@ void nvim_del_autocmd(Integer id, Error *err) } } -/// Clear all autocommands that match the corresponding {opts}. To delete -/// a particular autocmd, see |nvim_del_autocmd()|. +/// Clears all autocommands selected by {opts}. To delete autocmds see |nvim_del_autocmd()|. +/// /// @param opts Parameters /// - event: (string|table) /// Examples: diff --git a/src/nvim/api/command.c b/src/nvim/api/command.c index b254e326f9..75140beb88 100644 --- a/src/nvim/api/command.c +++ b/src/nvim/api/command.c @@ -1230,6 +1230,8 @@ err: /// /// Currently only |user-commands| are supported, not builtin Ex commands. /// +/// @see |nvim_get_all_options_info()| +/// /// @param opts Optional parameters. Currently only supports /// {"builtin":false} /// @param[out] err Error details, if any. diff --git a/src/nvim/api/options.c b/src/nvim/api/options.c index 858a663b9f..3d42f60940 100644 --- a/src/nvim/api/options.c +++ b/src/nvim/api/options.c @@ -315,6 +315,8 @@ void nvim_set_option_value(uint64_t channel_id, String name, Object value, Dict( /// The dictionary has the full option names as keys and option metadata /// dictionaries as detailed at |nvim_get_option_info2()|. /// +/// @see |nvim_get_commands()| +/// /// @return dictionary of all options Dictionary nvim_get_all_options_info(Error *err) FUNC_API_SINCE(7) |