diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2023-08-03 06:14:15 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-08-03 06:14:15 -0700 |
| commit | 4d859d00d13893815b6072a7bf2022dd89d5e3f8 (patch) | |
| tree | e536f6b205d59ffac0444990c4e60b0cb3398a27 /src/nvim/api/autocmd.c | |
| parent | f1772272b4fda43c093fc495f54b5e7c11968d62 (diff) | |
| parent | b1fb04475e6fa0c44895cb6fe97b75816d74c297 (diff) | |
| download | rneovim-4d859d00d13893815b6072a7bf2022dd89d5e3f8.tar.gz rneovim-4d859d00d13893815b6072a7bf2022dd89d5e3f8.tar.bz2 rneovim-4d859d00d13893815b6072a7bf2022dd89d5e3f8.zip | |
Merge #24351 docs
Diffstat (limited to 'src/nvim/api/autocmd.c')
| -rw-r--r-- | src/nvim/api/autocmd.c | 10 |
1 files changed, 4 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: |