formatting and documentation

Author: AppAppWorks

Sources/SourceKitLSP/Clang/ClangLanguageService.swift

@@ -622,9 +622,12 @@ extension ClangLanguageService {
     return try await forwardRequestToClangd(req)
   }
 
-  func openGeneratedInterface(document: DocumentURI, moduleName: String, groupName: String?, symbolUSR symbol: String?)
-    async throws -> GeneratedInterfaceDetails?
-  {
+  func openGeneratedInterface(
+    document: DocumentURI,
+    moduleName: String,
+    groupName: String?,
+    symbolUSR symbol: String?
+  ) async throws -> GeneratedInterfaceDetails? {
     throw ResponseError.unknown("unsupported method")
   }
 

Sources/SourceKitLSP/LanguageService.swift

@@ -78,7 +78,6 @@ public struct RenameLocation: Sendable {
 
 /// The textual output of a module interface.
 public struct GeneratedInterfaceDetails: ResponseType, Hashable {
-
   public var uri: DocumentURI
   public var position: Position?
 
@@ -158,6 +157,14 @@ public protocol LanguageService: AnyObject, Sendable {
   func completion(_ req: CompletionRequest) async throws -> CompletionList
   func hover(_ req: HoverRequest) async throws -> HoverResponse?
   func symbolInfo(_ request: SymbolInfoRequest) async throws -> [SymbolDetails]
+
+  /// Request a generated interface of a module to display in the IDE.
+  /// **(LSP Extension)**
+  ///
+  /// - Parameter document: The document whose compiler arguments should be used to generate the interface.
+  /// - Parameter moduleName: The module to generate an index for.
+  /// - Parameter groupName: The module group name.
+  /// - Parameter symbol: The symbol USR to search for in the generated module interface.
   func openGeneratedInterface(
     document: DocumentURI,
     moduleName: String,