Clean Up Documentation

Author: thecoolwinter

CodeEdit/Features/CEWorkspace/Models/CEWorkspaceFileManager+FileManagement.swift

@@ -46,7 +46,8 @@ extension CEWorkspaceFileManager {
     ///   - file: The file to add the new file to.
     ///   - useExtension: The file extension to use. Leave `nil` to guess using relevant nearby files.
     /// - Authors: Mattijs Eikelenboom, KaiTheRedNinja. *Moved from 7c27b1e*
-    /// - Returns: Boolean indicating whether or not the file was created
+    /// - Throws: Throws a `CocoaError.fileWriteUnknown` with the file url if creating the file fails, and calls
+    ///           ``rebuildFiles(fromItem:deep:)`` which throws other `FileManager` errors.
     func addFile(fileName: String, toFile file: CEWorkspaceFile, useExtension: String? = nil) throws {
         // check the folder for other files, and see what the most common file extension is
         var fileExtension: String

CodeEdit/Features/LSP/LanguageServer/Capabilities/LanguageServer+DocumentSync.swift

@@ -12,7 +12,7 @@ extension LanguageServer {
     // swiftlint:disable line_length
     /// Determines the type of document sync the server supports.
     /// https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_synchronization_sc
-    fileprivate func serverDocumentSyncSupport() -> TextDocumentSyncKind {
+    fileprivate func resolveDocumentSyncKind() -> TextDocumentSyncKind {
         // swiftlint:enable line_length
         var syncKind: TextDocumentSyncKind = .none
         switch serverCapabilities.textDocumentSync {
@@ -26,7 +26,8 @@ extension LanguageServer {
         return syncKind
     }
 
-    fileprivate func serverSupportsOpenClose() -> Bool {
+    /// Determines whether or not the server supports document tracking.
+    fileprivate func resolveOpenCloseSupport() -> Bool {
         switch serverCapabilities.textDocumentSync {
         case .optionA(let options):
             return options.openClose ?? false
@@ -37,7 +38,7 @@ extension LanguageServer {
         }
     }
 
-    // Avoids a lint error
+    // Used to avoid a lint error (`large_tuple`) for the return type of `getIsolatedDocumentContent`
     fileprivate struct DocumentContent {
         let uri: String
         let language: LanguageIdentifier
@@ -46,9 +47,10 @@ extension LanguageServer {
 
     /// Tells the language server we've opened a document and would like to begin working with it.
     /// - Parameter document: The code document to open.
+    /// - Throws: Throws errors produced by the language server connection.
     func openDocument(_ document: CodeFileDocument) async throws {
         do {
-            guard serverSupportsOpenClose(), let content = await getIsolatedDocumentContent(document) else {
+            guard resolveOpenCloseSupport(), let content = await getIsolatedDocumentContent(document) else {
                 return
             }
             logger.debug("Opening Document \(content.uri, privacy: .private)")
@@ -81,9 +83,10 @@ extension LanguageServer {
 
     /// Stops tracking a file and notifies the language server.
     /// - Parameter uri: The URI of the document to close.
+    /// - Throws: Throws errors produced by the language server connection.
     func closeDocument(_ uri: String) async throws {
         do {
-            guard serverSupportsOpenClose() && openFiles.document(for: uri) != nil else { return }
+            guard resolveOpenCloseSupport() && openFiles.document(for: uri) != nil else { return }
             logger.debug("Closing document \(uri, privacy: .private)")
             openFiles.removeDocument(for: uri)
             let params = DidCloseTextDocumentParams(textDocument: TextDocumentIdentifier(uri: uri))
@@ -99,15 +102,15 @@ extension LanguageServer {
     ///   - uri: The URI of the document to update.
     ///   - range: The range being replaced.
     ///   - string: The string being inserted into the replacement range.
-    /// - Returns: `true` if the document was successfully updated, `false`
+    /// - Throws: Throws errors produced by the language server connection.
     func documentChanged(
         uri: String,
         replacedContentIn range: LSPRange,
         with string: String
     ) async throws {
         do {
             logger.debug("Document updated, \(uri, privacy: .private)")
-            switch serverDocumentSyncSupport() {
+            switch resolveDocumentSyncKind() {
             case .full:
                 guard let file = openFiles.document(for: uri) else { return }
                 let content = await MainActor.run {