Merge pull request #84212 from cmcgee1024/add_skip_inherited_docs

Add symbol graph option for skipping inherited docs

Author: cmcgee1024

include/swift/Option/Options.td

@@ -1783,6 +1783,11 @@ def symbol_graph_pretty_print: Flag<["-"], "symbol-graph-pretty-print">,
   Flags<[FrontendOption, NoInteractiveOption, HelpHidden, SupplementaryOutput]>,
   HelpText<"Pretty-print the output symbol graph JSON">;
 
+def symbol_graph_skip_inherited_docs: Flag<["-"], "symbol-graph-skip-inherited-docs">,
+  Flags<[FrontendOption, NoInteractiveOption, HelpHidden, SupplementaryOutput]>,
+  HelpText<"Skip emitting doc comments for members inherited through classes or "
+           "default implementations">;
+
 def symbol_graph_skip_synthesized_members: Flag<["-"], "symbol-graph-skip-synthesized-members">,
   Flags<[FrontendOption, NoInteractiveOption, HelpHidden, SupplementaryOutput]>,
   HelpText<"Skip members inherited through classes or default implementations">;

lib/Driver/ToolChains.cpp

@@ -707,6 +707,7 @@ ToolChain::constructInvocation(const CompileJobAction &job,
                           options::OPT_omit_extension_block_symbols);
   context.Args.AddLastArg(Arguments, options::OPT_symbol_graph_minimum_access_level);
   context.Args.AddLastArg(Arguments, options::OPT_symbol_graph_skip_synthesized_members);
+  context.Args.AddLastArg(Arguments, options::OPT_symbol_graph_skip_inherited_docs);
   context.Args.AddLastArg(Arguments, options::OPT_symbol_graph_pretty_print);
 
   return II;

lib/Frontend/CompilerInvocation.cpp

@@ -2243,6 +2243,7 @@ static void ParseSymbolGraphArgs(symbolgraphgen::SymbolGraphOptions &Opts,
   // default values for generating symbol graphs during a build
   Opts.PrettyPrint = Args.hasArg(OPT_symbol_graph_pretty_print);
   Opts.EmitSynthesizedMembers = !Args.hasArg(OPT_symbol_graph_skip_synthesized_members);
+  Opts.SkipInheritedDocs = !Args.hasArg(OPT_symbol_graph_skip_inherited_docs);
   Opts.PrintMessages = false;
   Opts.IncludeClangDocs = false;
 }

test/SymbolGraph/Symbols/DocComment/SkipInherited.swift

@@ -0,0 +1,19 @@
+// RUN: %empty-directory(%t)
+// RUN: %target-build-swift %s -module-name SkipInheritedDocs -emit-module-path %t/SkipInheritedDocs.swiftmodule
+// RUN: %target-swift-symbolgraph-extract -module-name SkipInheritedDocs -I %t -pretty-print -skip-inherited-docs -output-dir %t
+// RUN: %FileCheck %s --input-file %t/SkipInheritedDocs.symbols.json
+
+/// Parent docs.
+public protocol P1 {
+  /// Parent func docs.
+  func p2()
+}
+
+/// Child docs
+public class C1: P1 {
+  public func p2() {}
+}
+
+// CHECK: "Parent func docs."
+// CHECK-NOT: "Parent func docs."
+