chore(fmt): Consistent function doc style
This commit is contained in:
@@ -49,8 +49,8 @@ function M._get_sidebar(set_current)
|
||||
return sidebar
|
||||
end
|
||||
|
||||
---Run a Sidebar method by getting the sidebar of current tabpage, with args
|
||||
-- NOP if sidebar not found for this tabpage.
|
||||
---Run a Sidebar method by getting the sidebar of current tabpage, with args.
|
||||
---NOP if sidebar not found for this tabpage.
|
||||
---@param method string Must be valid
|
||||
---@param args table?
|
||||
---@return any return_of_method Depends on sidebar `method`
|
||||
@@ -71,7 +71,7 @@ end
|
||||
M.close = M.close_outline
|
||||
|
||||
---Toggle the outline window, and return whether the outline window is open
|
||||
-- after this operation.
|
||||
---after this operation.
|
||||
---@param opts outline.OutlineOpts? Table of options
|
||||
---@return boolean is_open Whether outline window is now open
|
||||
function M.toggle_outline(opts)
|
||||
@@ -86,7 +86,7 @@ end
|
||||
M.toggle = M.toggle_outline
|
||||
|
||||
---Set cursor to focus on the outline window, return whether the window is
|
||||
-- currently open.
|
||||
---currently open.
|
||||
---@return boolean is_open Whether the window is open
|
||||
function M.focus_outline()
|
||||
return M._sidebar_do('focus')
|
||||
|
||||
@@ -247,6 +247,7 @@ function Sidebar:reset_cursor_style()
|
||||
vim.o.guicursor = self.original_cursor
|
||||
end
|
||||
|
||||
---Set the cursor to current.line_in_outline and column to a convenient place
|
||||
---@param current outline.FlatSymbolNode?
|
||||
function Sidebar:update_cursor_pos(current)
|
||||
local col = 0
|
||||
@@ -261,7 +262,7 @@ function Sidebar:update_cursor_pos(current)
|
||||
end
|
||||
|
||||
---Calls build_outline and then calls update_cursor_pos if update_cursor is
|
||||
--not false
|
||||
---not false
|
||||
---@param update_cursor boolean?
|
||||
---@param set_cursor_to_node outline.SymbolNode|outline.FlatSymbolNode?
|
||||
function Sidebar:_update_lines(update_cursor, set_cursor_to_node)
|
||||
@@ -315,12 +316,13 @@ function Sidebar:__refresh()
|
||||
end
|
||||
end
|
||||
|
||||
-- stylua: ignore start
|
||||
function Sidebar:_refresh()
|
||||
(utils.debounce(function()
|
||||
self:__refresh()
|
||||
end, 100))()
|
||||
(utils.debounce(function() self:__refresh() end, 100))()
|
||||
end
|
||||
-- stylua: ignore end
|
||||
|
||||
---Currently hovered node in outline
|
||||
---@return outline.FlatSymbolNode
|
||||
function Sidebar:_current_node()
|
||||
local current_line = vim.api.nvim_win_get_cursor(self.view.winnr)[1]
|
||||
|
||||
Reference in New Issue
Block a user