Fix a bug that caused documentation to be added at the start of the declaration’s trivia

This meant that if there were two newlines before the declaration, the documentation would be separated to the declaration by one newline and if the declaration was at the start of a line, the declaration would be on the same line as the doc comment, effectively making the documentation part of a comment.

Author: ahoppen

Sources/SourceKitLSP/Swift/CodeActions/AddDocumentation.swift

@@ -52,7 +52,6 @@ public struct AddDocumentation: EditRefactoringProvider {
 
     let newlineAndIndentation = [.newlines(1)] + (syntax.firstToken(viewMode: .sourceAccurate)?.indentationOfLine ?? [])
     var content: [TriviaPiece] = []
-    content += newlineAndIndentation
     content.append(.docLineComment("/// A description"))
 
     if let parameters = syntax.parameters?.parameters {
@@ -82,8 +81,9 @@ public struct AddDocumentation: EditRefactoringProvider {
       content += newlineAndIndentation
       content.append(.docLineComment("/// - Returns:"))
     }
+    content += newlineAndIndentation
 
-    let insertPos = syntax.position
+    let insertPos = syntax.positionAfterSkippingLeadingTrivia
     return [
       SourceEdit(
         range: insertPos..<insertPos,

Tests/SourceKitLSPTests/SyntaxRefactorTests.swift

@@ -27,15 +27,15 @@ final class SyntaxRefactorTests: XCTestCase {
       provider: AddDocumentation.self,
       expected: [
         SourceEdit(
-          range: AbsolutePosition(utf8Offset: 0)..<AbsolutePosition(utf8Offset: 0),
+          range: AbsolutePosition(utf8Offset: 2)..<AbsolutePosition(utf8Offset: 2),
           replacement: """
-
-              /// A description
+            /// A description
               /// - Parameters:
               ///   - syntax:
               ///   - context:
               ///
               /// - Returns:
+              \("")
             """
         )
       ]
@@ -51,11 +51,11 @@ final class SyntaxRefactorTests: XCTestCase {
       provider: AddDocumentation.self,
       expected: [
         SourceEdit(
-          range: AbsolutePosition(utf8Offset: 0)..<AbsolutePosition(utf8Offset: 0),
+          range: AbsolutePosition(utf8Offset: 2)..<AbsolutePosition(utf8Offset: 2),
           replacement: """
-
-              /// A description
+            /// A description
               /// - Parameter syntax:
+              \("")
             """
         )
       ]