Merge pull request #1983 from cmcgee1024/add_symbol_graph_skip_inherited_docs

Add symbol graph options for skipping inherited docs

Author: cmcgee1024

Sources/SwiftDriver/Jobs/FrontendJobHelpers.swift

@@ -909,6 +909,7 @@ extension Driver {
     try commandLine.appendLast(.symbolGraphMinimumAccessLevel, from: &parsedOptions)
     try commandLine.appendLast(.symbolGraphPrettyPrint, from: &parsedOptions)
     try commandLine.appendLast(.symbolGraphSkipSynthesizedMembers, from: &parsedOptions)
+    try commandLine.appendLast(.symbolGraphSkipInheritedDocs, from: &parsedOptions)
   }
 
   mutating func addEntry(_ entries: inout [VirtualPath.Handle: [FileType: VirtualPath.Handle]], input: TypedVirtualPath?, output: TypedVirtualPath) throws {

Sources/SwiftOptions/Options.swift

@@ -891,6 +891,7 @@ extension Option {
   public static let symbolGraphBlockAvailabilityPlatforms: Option = Option("-symbol-graph-block-availability-platforms", .separate, attributes: [.helpHidden, .frontend, .noInteractive, .supplementaryOutput], metaVar: "<platforms>", helpText: "Remove the given platforms from symbol graph availability metadata, e.g. 'macOS,Swift'")
   public static let symbolGraphPrettyPrint: Option = Option("-symbol-graph-pretty-print", .flag, attributes: [.helpHidden, .noInteractive], helpText: "Pretty-print the output symbol graph JSON")
   public static let symbolGraphSkipSynthesizedMembers: Option = Option("-symbol-graph-skip-synthesized-members", .flag, attributes: [.helpHidden, .noInteractive], helpText: "Skip members inherited through classes or default implementations")
+  public static let symbolGraphSkipInheritedDocs: Option = Option("-symbol-graph-skip-inherited-docs", .flag, attributes: [.helpHidden, .noInteractive], helpText: "Skip emitting doc comments for members inherited through classes or default implementations")
   public static let symbolGraphMinimumAccessLevel: Option = Option("-symbol-graph-minimum-access-level", .separate, attributes: [.helpHidden, .frontend, .noInteractive, .supplementaryOutput], metaVar: "<level>", helpText: "Include symbols with this access level or more when emitting a symbol graph")
   public static let sysroot: Option = Option("-sysroot", .separate, attributes: [.frontend, .synthesizeInterface, .argumentIsPath], metaVar: "<sysroot>", helpText: "Native Platform sysroot")
   public static let S: Option = Option("-S", .flag, alias: Option.emitAssembly, attributes: [.frontend, .noInteractive], group: .modes)
@@ -1864,6 +1865,7 @@ extension Option {
       Option.symbolGraphMinimumAccessLevel,
       Option.symbolGraphPrettyPrint,
       Option.symbolGraphSkipSynthesizedMembers,
+      Option.symbolGraphSkipInheritedDocs,
       Option.sysroot,
       Option.S,
       Option.tabWidth,

Tests/SwiftDriverTests/SwiftDriverTests.swift

@@ -3576,6 +3576,19 @@ final class SwiftDriverTests: XCTestCase {
     }
   }
 
+  func testEmitSymbolGraphSkipInheritedDocs() throws {
+    do {
+      let root = localFileSystem.currentWorkingDirectory!.appending(components: "foo", "bar")
+
+      var driver = try Driver(args: ["swiftc", "foo.swift", "bar.swift", "-module-name", "Test", "-emit-module-path", rebase("Test.swiftmodule", at: root), "-emit-symbol-graph", "-emit-symbol-graph-dir", "/foo/bar/", "-symbol-graph-skip-inherited-docs", "-emit-library"])
+      let plannedJobs = try driver.planBuild().removingAutolinkExtractJobs()
+
+      // We don't know the output file of the symbol graph, just make sure the flag is passed along.
+      XCTAssertJobInvocationMatches(plannedJobs[0], .flag("-emit-symbol-graph"))
+      XCTAssertJobInvocationMatches(plannedJobs[0], .flag("-symbol-graph-skip-inherited-docs"))
+    }
+  }
+
   func testEmitModuleSeparately() throws {
     var envVars = ProcessEnv.block
     envVars["SWIFT_DRIVER_LD_EXEC"] = ld.nativePathString(escaped: false)