refactor(docs): remove unnecessary @private/@nodoc annotations (#33951)

* refactor(docs): remove `@private` annotations from local functions

* refactor(docs): remove unnecessary `@nodoc` annotations
This commit is contained in:
Maria José Solano
2025-05-10 16:42:48 -05:00
committed by GitHub
parent 8605f5655b
commit bee45fc0e7
13 changed files with 1 additions and 25 deletions

View File

@@ -1,4 +1,3 @@
---@nodoc
---@class vim._comment.Parts
---@field left string Left part of comment
---@field right string Right part of comment

View File

@@ -923,8 +923,6 @@ function vim._expand_pat(pat, env)
local final_env = env
--- @private
---
--- Allows submodules to be defined on a `vim.<module>` table without eager-loading the module.
---
--- Cmdline completion (`:lua vim.lsp.c<tab>`) accesses `vim.lsp._submodules` when no other candidates.

View File

@@ -1947,7 +1947,6 @@ local patterns_hashbang = {
['^vim\\>'] = { 'vim', { vim_regex = true } },
}
---@private
--- File starts with "#!".
--- @param contents string[]
--- @param path string
@@ -2140,7 +2139,6 @@ local patterns_text = {
['^#n$'] = 'sed',
}
---@private
--- File does not start with "#!".
--- @param contents string[]
--- @param path string

View File

@@ -35,7 +35,6 @@ local M = {}
--- @param fn F Function to memoize.
--- @param weak? boolean Use a weak table (default `true`)
--- @return F # Memoized version of {fn}
--- @nodoc
function M._memoize(hash, fn, weak)
-- this is wrapped in a function to lazily require the module
return require('vim.func._memoize')(hash, fn, weak)

View File

@@ -328,7 +328,6 @@ function M.get_line_diagnostics(bufnr, line_nr, opts, client_id)
end
--- Clear diagnostics from pull based clients
--- @private
local function clear(bufnr)
for _, namespace in pairs(_client_pull_namespaces) do
vim.diagnostic.reset(namespace, bufnr)
@@ -337,7 +336,6 @@ end
--- Disable pull diagnostics for a buffer
--- @param bufnr integer
--- @private
local function disable(bufnr)
local bufstate = bufstates[bufnr]
if bufstate then
@@ -350,7 +348,6 @@ end
---@param bufnr integer buffer number
---@param client_id? integer Client ID to refresh (default: all clients)
---@param only_visible? boolean Whether to only refresh for the visible regions of the buffer (default: false)
---@private
local function _refresh(bufnr, client_id, only_visible)
if
only_visible

View File

@@ -231,7 +231,6 @@ local function buf_enable(bufnr)
M._buf_refresh(bufnr)
end
--- @nodoc
--- @param bufnr integer
--- @param client_id? integer
function M._buf_refresh(bufnr, client_id)

View File

@@ -476,8 +476,6 @@ RCS[ms.textDocument_documentHighlight] = function(_, result, ctx)
util.buf_highlight_references(ctx.bufnr, result, client.offset_encoding)
end
--- @private
---
--- Displays call hierarchy in the quickfix window.
---
--- @param direction 'from'|'to' `"from"` for incoming calls and `"to"` for outgoing calls

View File

@@ -231,7 +231,6 @@ end
--- Refresh inlay hints, only if we have attached clients that support it
---@param bufnr (integer) Buffer handle, or 0 for current
---@param opts? vim.lsp.util._refresh.Opts Additional options to pass to util._refresh
---@private
local function _refresh(bufnr, opts)
opts = opts or {}
opts['bufnr'] = bufnr

View File

@@ -36,7 +36,6 @@ end
local M = {}
--- Mapping of error codes used by the client
--- @nodoc
local client_errors = {
INVALID_SERVER_MESSAGE = 1,
INVALID_SERVER_JSON = 2,

View File

@@ -25,7 +25,6 @@ local M = {}
---@alias Range Range2|Range4|Range6
---@private
---@param a_row integer
---@param a_col integer
---@param b_row integer
@@ -166,7 +165,6 @@ function M.contains(r1, r2)
return true
end
--- @private
--- @param source integer|string
--- @param index integer
--- @return integer

View File

@@ -1164,7 +1164,6 @@ function LanguageTree:_edit(
end
end
---@nodoc
---@param bufnr integer
---@param changed_tick integer
---@param start_row integer
@@ -1236,12 +1235,10 @@ function LanguageTree:_on_bytes(
)
end
---@nodoc
function LanguageTree:_on_reload()
self:invalidate(true)
end
---@nodoc
function LanguageTree:_on_detach(...)
self:invalidate(true)
self:_do_callback('detach', ...)