From 7668f89d5be6d463bf6ab0c2d3a0393e3ec26e7f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mathias=20Fu=C3=9Fenegger?=
 <mfussenegger@users.noreply.github.com>
Date: Mon, 24 Jul 2023 20:21:35 +0200
Subject: [PATCH] fix(lsp): replace @private with @nodoc for public client
 functions (#24415)

* fix(lsp): replace @private with @nodoc for public client functions

To prevent lua-ls warnings in plugins which use the functions.

* fix(lsp): remove duplicate type annotations/class definitions

These annotations became duplicate with https://github.com/neovim/neovim/pull/23750
---
 runtime/lua/vim/lsp.lua       | 10 ++---
 runtime/lua/vim/lsp/types.lua | 79 +----------------------------------
 2 files changed, 7 insertions(+), 82 deletions(-)

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 78b5f53723..1a1dc684ba 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1455,7 +1455,7 @@ function lsp.start_client(config)
     end)
   end
 
-  ---@private
+  ---@nodoc
   --- Sends a request to the server.
   ---
   --- This is a thin wrapper around {client.rpc.request} with some additional
@@ -1559,7 +1559,7 @@ function lsp.start_client(config)
     return request_result
   end
 
-  ---@private
+  ---@nodoc
   --- Sends a notification to an LSP server.
   ---
   ---@param method string LSP method name.
@@ -1590,7 +1590,7 @@ function lsp.start_client(config)
     return client_active
   end
 
-  ---@private
+  ---@nodoc
   --- Cancels a request with a given request id.
   ---
   ---@param id (integer) id of request to cancel
@@ -1613,7 +1613,8 @@ function lsp.start_client(config)
   -- Track this so that we can escalate automatically if we've already tried a
   -- graceful shutdown
   local graceful_shutdown_failed = false
-  ---@private
+
+  ---@nodoc
   --- Stops a client, optionally with force.
   ---
   ---By default, it will just ask the - server to shutdown without force. If
@@ -2311,7 +2312,6 @@ function lsp.omnifunc(findstart, base)
 
   local startbyte
 
-  ---@private
   local function on_done()
     local mode = api.nvim_get_mode()['mode']
     if mode == 'i' or mode == 'ic' then
diff --git a/runtime/lua/vim/lsp/types.lua b/runtime/lua/vim/lsp/types.lua
index cdfbcfb11b..98e948c945 100644
--- a/runtime/lua/vim/lsp/types.lua
+++ b/runtime/lua/vim/lsp/types.lua
@@ -5,92 +5,17 @@
 ---@class lsp.HandlerContext
 ---@field method string
 ---@field client_id integer
----@field bufnr integer
----@field params any
+---@field bufnr? integer
+---@field params? any
 
 ---@class lsp.ResponseError
 ---@field code integer
 ---@field message string
 ---@field data string|number|boolean|table[]|table|nil
 
----@class lsp.ShowMessageRequestParams
----@field type lsp.MessageType
----@field message string
----@field actions nil|lsp.MessageActionItem[]
-
----@class lsp.MessageActionItem
----@field title string
-
----@class lsp.FileEvent
----@field uri string
----@field type lsp.FileChangeType
-
----@class lsp.Position
----@field line integer
----@field character integer
-
----@class lsp.Range
----@field start lsp.Position
----@field end lsp.Position
-
----@class lsp.Diagnostic
----@field range lsp.Range
----@field message string
----@field severity? lsp.DiagnosticSeverity
----@field code integer | string
----@field source string
----@field tags? lsp.DiagnosticTag[]
----@field relatedInformation DiagnosticRelatedInformation[]
-
 --- @class lsp.DocumentFilter
 --- @field language? string
 --- @field scheme? string
 --- @field pattern? string
 
---- @alias lsp.DocumentSelector lsp.DocumentFilter[]
-
 --- @alias lsp.RegisterOptions any | lsp.StaticRegistrationOptions | lsp.TextDocumentRegistrationOptions
-
---- @class lsp.Registration
---- @field id string
---- @field method string
---- @field registerOptions? lsp.RegisterOptions
-
---- @alias lsp.RegistrationParams {registrations: lsp.Registration[]}
-
---- @class lsp.StaticRegistrationOptions
---- @field id? string
-
---- @class lsp.TextDocumentRegistrationOptions
---- @field documentSelector? lsp.DocumentSelector
-
---- @class lsp.Unregistration
---- @field id string
---- @field method string
-
---- @alias lsp.UnregistrationParams {unregisterations: lsp.Unregistration[]}
-
----@class lsp.Location
----@field uri string
----@field range lsp.Range
-
----@class lsp.MarkupContent
----@field kind string
----@field value string
-
----@class lsp.InlayHintLabelPart
----@field value string
----@field tooltip? string | lsp.MarkupContent
----@field location? lsp.Location
-
----@class lsp.TextEdit
----@field range lsp.Range
----@field newText string
-
----@class lsp.InlayHint
----@field position lsp.Position
----@field label string | lsp.InlayHintLabelPart[]
----@field kind? integer
----@field textEdits? lsp.TextEdit[]
----@field paddingLeft? boolean
----@field paddingRight? boolean