Added Documentation

Author: lokesh-tr

src/sourcekit-lsp/LanguageClientManager.ts

@@ -561,7 +561,7 @@ export class LanguageClientManager {
             },
             errorHandler: new SourceKitLSPErrorHandler(5),
             initializationOptions: {
-                peekDocuments: true,
+                peekDocuments: true, // client capability to handle `PeekDocumentsRequest`
             },
         };
 

src/sourcekit-lsp/lspExtensions.ts

@@ -18,17 +18,45 @@ import { Position, Uri } from "vscode";
 
 // Definitions for non-standard requests used by sourcekit-lsp
 
+// Peek Documents
 export interface PeekDocumentsParams {
+    /**
+     * The `Uri` of the text document in which to show the "peeked" editor
+     * (default: current document in the active editor)
+     */
     uri?: Uri;
+
+    /**
+     * The position in the given text document in which to show the
+     * "peeked editor" (default: current cursor position in the active editor)
+     */
     position?: Position;
+
+    /**
+     * An array `Uri` of the documents to appear inside the "peeked" editor
+     */
     locations: Uri[];
+
+    /**
+     * Presentation strategy when having multiple locations (default: "peek")
+     */
     multiple: string;
 }
 
+/**
+ * Response to indicate the `success` of the `PeekDocumentsRequest`
+ */
 export interface PeekDocumentsResult {
     success: boolean;
 }
 
+/**
+ * Request from the server to the client to show the given documents in a "peeked" editor.
+ *
+ * This request is handled by the client to show the given documents in a "peeked" editor (i.e. inline with / inside the editor canvas).
+ *
+ * It requires the experimental client capability `"peekDocuments"` to use.
+ */
 export const PeekDocumentsRequest = new langclient.RequestType<
     PeekDocumentsParams,
     PeekDocumentsResult,