Skip to content

Commit

Permalink
chore(docs): auto-generate vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
declancm committed Jul 13, 2024
1 parent c72c3ae commit 5416310
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions doc/cinnamon.nvim.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*cinnamon.nvim.txt* For Neovim >= 0.8.0 Last change: 2024 July 12
*cinnamon.nvim.txt* For Neovim >= 0.8.0 Last change: 2024 July 13

==============================================================================
Table of Contents *cinnamon.nvim-table-of-contents*
Expand Down Expand Up @@ -65,22 +65,24 @@ DEFAULT OPTIONS ~
},
---@class ScrollOptions
options = {
-- Post-movement callback
callback = nil, ---@type function?
-- Optional post-movement callback
callback = function() end,
-- Delay between each movement step (in ms)
delay = 7,
max_delta = {
-- Maximum distance for line movements. Set to `nil` to disable
line = nil, ---@type number?
-- Maximum distance for column movements. Set to `nil` to disable
column = nil, ---@type number?
-- Maximum distance for line movements before smooth
-- scrolling is skipped. Set to `false` to disable
line = false,
-- Maximum distance for column movements before smooth
-- scrolling is skipped. Set to `false` to disable
column = false,
-- Maximum duration for a movement (in ms). Automatically adjusts the step delay
time = 1000, ---@type number
time = 1000,
},
-- The scrolling mode
-- `cursor`: Smoothly scrolls the cursor for any movement
-- `window`: Smoothly scrolls the window ONLY when the cursor moves out of view
mode = "cursor", ---@type "cursor" | "window"
mode = "cursor",
},
}
<
Expand Down

0 comments on commit 5416310

Please sign in to comment.