Merge pull request #1615 from kimdv/kimdv/-dont-generate-docs-for-buildables

Dont add docs to buildable extensions

Author: kimdv

CodeGeneration/Sources/generate-swiftsyntax/templates/swiftsyntaxbuilder/BuildableNodesFile.swift

@@ -22,13 +22,13 @@ let buildableNodesFile = SourceFileSyntax(leadingTrivia: copyrightHeader) {
     let type = node.type
 
     if let convenienceInit = try! createConvenienceInitializer(node: node) {
-      let docComment = node.description?.split(separator: "\n", omittingEmptySubsequences: false).map { "/// \($0)" }.joined(separator: "\n") ?? ""
-      ExtensionDeclSyntax(
-        leadingTrivia: "\(docComment)\n",
-        extendedType: SimpleTypeIdentifierSyntax(name: .identifier(type.syntaxBaseName))
-      ) {
-        convenienceInit
-      }
+      DeclSyntax(
+        """
+        extension \(raw: type.syntaxBaseName) {
+        \(convenienceInit)
+        }
+        """
+      )
     }
   }
 }

Sources/SwiftSyntaxBuilder/generated/BuildableNodes.swift

@@ -371,7 +371,6 @@ extension DoStmtSyntax {
   }
 }
 
-/// A `case` declaration of a Swift `enum`. It can have 1 or more `EnumCaseElement`s inside, each declaring a different case of the enum.
 extension EnumCaseDeclSyntax {
   /// A convenience initializer that allows initializing syntax collections using result builders
   public init(
@@ -403,7 +402,6 @@ extension EnumCaseDeclSyntax {
   }
 }
 
-/// A Swift `enum` declaration.
 extension EnumDeclSyntax {
   /// A convenience initializer that allows initializing syntax collections using result builders
   public init(
@@ -819,14 +817,6 @@ extension IfExprSyntax {
   }
 }
 
-/// An initializer declaration like the following.
-/// 
-/// ```swift
-/// init(someParameter: Int) {
-/// }
-/// ```
-/// 
-/// The body is optional because this node also represents initializer requirements inside protocols.
 extension InitializerDeclSyntax {
   /// A convenience initializer that allows initializing syntax collections using result builders
   public init(
@@ -1171,61 +1161,6 @@ extension SourceFileSyntax {
   }
 }
 
-///     A struct declaration like the following.
-/// 
-///     ```swift
-///     struct SomeStruct {
-///       let someMember: String
-///       var anotherMember: Int
-/// 
-///       func foo() {
-///         print(someMember)
-///       }
-/// 
-///       mutating func bar() {
-///         anotherMember = 42
-///       }
-///     }
-///     ```
-/// 
-///     A struct declaration may be declared without any members.
-/// 
-///     ```swift
-///     struct EmptyStruct {
-/// 
-///     }
-///     ```
-/// 
-///     A struct declaration may include a type inheritance clause listing
-///     one or more protocols the struct conforms to.
-/// 
-///     The example below uses Hashable and Equatable protocols whose members
-///     are automatically synthesized by the compiler if the struct contains
-///     stored members that are themselves `Hashable` and `Equatable`.
-/// 
-///     ```swift
-///     struct AdvancedStruct: Hashable, Equatable {
-///       let someMember: String
-///       var anotherMember: Int
-///     }
-///     ```
-/// 
-///     A struct declaration may include a generic parameter clause as well
-///     as a generic where clause.
-/// 
-///     ```swift
-///     struct Stack<Element> {
-///       var items: [Element] = []
-/// 
-///       mutating func push(_ item: Element) {
-///         items.append(item)
-///       }
-/// 
-///       mutating func pop() -> Element {
-///         return items.removeLast()
-///       }
-///    }
-///    ```
 extension StructDeclSyntax {
   /// A convenience initializer that allows initializing syntax collections using result builders
   public init(