add flag to skip docs on synthesized symbols

Author: QuietMisdreavus

include/swift/Frontend/FrontendOptions.h

@@ -394,6 +394,10 @@ class FrontendOptions {
   ///
   /// \sa SymbolGraphASTWalker
   std::string SymbolGraphOutputDir;
+  
+  /// Whether to emit doc comment information in symbol graphs for symbols
+  /// which are inherited through classes or default implementations.
+  bool SkipInheritedDocs = false;
 
 private:
   static bool canActionEmitDependencies(ActionType);

include/swift/Option/Options.td

@@ -1214,4 +1214,10 @@ def minimum_access_level : Separate<["-"], "minimum-access-level">,
   HelpText<"Include symbols with this access level or more">,
   MetaVarName<"<level>">;
 
+def skip_inherited_docs : Flag<["-"], "skip-inherited-docs">,
+  Flags<[SwiftSymbolGraphExtractOption, FrontendOption,
+         NoInteractiveOption, SupplementaryOutput, HelpHidden]>,
+  HelpText<"Skip emitting doc comments for members inherited through classes or "
+           "default implementations">;
+
 include "FrontendOptions.td"

include/swift/Serialization/SerializationOptions.h

@@ -31,6 +31,7 @@ namespace swift {
     const char *DocOutputPath = nullptr;
     const char *SourceInfoOutputPath = nullptr;
     std::string SymbolGraphOutputDir;
+    bool SkipSymbolGraphInheritedDocs = true;
 
     StringRef GroupInfoPath;
     StringRef ImportedHeader;

include/swift/SymbolGraphGen/SymbolGraphOptions.h

@@ -39,6 +39,9 @@ struct SymbolGraphOptions {
   /// Whether to print informational messages when rendering
   /// a symbol graph.
   bool PrintMessages;
+  
+  /// Whether to skip docs for symbols with compound, "SYNTHESIZED" USRs.
+  bool SkipInheritedDocs;
 };
 
 } // end namespace symbolgraphgen

lib/Frontend/ArgsToFrontendOptionsConverter.cpp

@@ -248,6 +248,8 @@ bool ArgsToFrontendOptionsConverter::convert(
   if (const Arg *A = Args.getLastArg(OPT_emit_symbol_graph_dir)) {
     Opts.SymbolGraphOutputDir = A->getValue();
   }
+  
+  Opts.SkipInheritedDocs = Args.hasArg(OPT_skip_inherited_docs);
 
   return false;
 }

lib/Frontend/Frontend.cpp

@@ -168,6 +168,7 @@ SerializationOptions CompilerInvocation::computeSerializationOptions(
     llvm::sys::fs::make_absolute(OutputDir);
     serializationOpts.SymbolGraphOutputDir = OutputDir.str().str();
   }
+  serializationOpts.SkipSymbolGraphInheritedDocs = opts.SkipInheritedDocs;
 
   if (!getIRGenOptions().ForceLoadSymbolName.empty())
     serializationOpts.AutolinkForceLoad = true;

lib/Serialization/Serialization.cpp

@@ -5634,6 +5634,7 @@ void swift::serialize(ModuleOrSourceFile DC,
         AccessLevel::Public,
         /*EmitSynthesizedMembers*/true,
         /*PrintMessages*/false,
+        /*EmitInheritedDocs*/options.SkipSymbolGraphInheritedDocs,
       };
       symbolgraphgen::emitSymbolGraphForModule(M, SGOpts);
     }

lib/SymbolGraphGen/Symbol.cpp

@@ -172,6 +172,9 @@ void Symbol::serializeRange(size_t InitialIndentation,
 }
 
 void Symbol::serializeDocComment(llvm::json::OStream &OS) const {
+  if (Graph->Walker.Options.SkipInheritedDocs && SynthesizedBaseTypeDecl) {
+    return;
+  }
   const auto *DocCommentProvidingDecl =
       dyn_cast_or_null<ValueDecl>(
           getDocCommentProvidingDecl(VD, /*AllowSerialized=*/true));

test/SymbolGraph/Relationships/Synthesized/InheritedDocs.swift

@@ -1,7 +1,18 @@
 // RUN: %empty-directory(%t)
-// RUN: %target-build-swift %s -module-name InheritedDocs -emit-module -emit-module-path %t/
+// RUN: %target-swift-frontend %s -module-name InheritedDocs -emit-module -emit-module-path %t/InheritedDocs.swiftmodule -emit-module-source-info-path %t/InheritedDocs.swiftsourceinfo -emit-module-doc-path %t/InheritedDocs.swiftdoc
+
 // RUN: %target-swift-symbolgraph-extract -module-name InheritedDocs -I %t -pretty-print -output-dir %t
-// RUN: %FileCheck %s --input-file %t/InheritedDocs.symbols.json
+// RUN: %FileCheck %s --input-file %t/InheritedDocs.symbols.json --check-prefixes CHECK,DOCS
+
+// RUN: %target-swift-symbolgraph-extract -module-name InheritedDocs -I %t -pretty-print -output-dir %t -skip-inherited-docs
+// RUN: %FileCheck %s --input-file %t/InheritedDocs.symbols.json --check-prefixes CHECK,SKIP
+
+// RUN: %empty-directory(%t)
+// RUN: %target-build-swift %s -module-name InheritedDocs -emit-module -emit-module-path %t/InheritedDocs.swiftmodule -emit-symbol-graph -emit-symbol-graph-dir %t/ -skip-inherited-docs
+// RUN: %FileCheck %s --input-file %t/InheritedDocs.symbols.json --check-prefixes SKIP
+
+// DOCS-COUNT-3: Some Function
+// SKIP-COUNT-2: Some Function
 
 // CHECK:            "source": "s:13InheritedDocs1PPAAE8someFuncyyF::SYNTHESIZED::s:13InheritedDocs1SV"
 // CHECK-NEXT:       "target": "s:13InheritedDocs1SV"

tools/SourceKit/lib/SwiftLang/SwiftSourceDocInfo.cpp

@@ -870,6 +870,7 @@ fillSymbolInfo(CursorSymbolInfo &Symbol, const DeclInfo &DInfo,
         AccessLevel::Private,
         /*EmitSynthesizedMembers*/ false,
         /*PrintMessages*/ false,
+        /*SkipInheritedDocs*/ false,
     };
 
     symbolgraphgen::printSymbolGraphForDecl(DInfo.VD, DInfo.BaseType,

tools/driver/swift_symbolgraph_extract_main.cpp

@@ -167,6 +167,7 @@ int swift_symbolgraph_extract_main(ArrayRef<const char *> Args,
       AccessLevel::Public,
       !ParsedArgs.hasArg(OPT_skip_synthesized_members),
       ParsedArgs.hasArg(OPT_v),
+      ParsedArgs.hasArg(OPT_skip_inherited_docs),
   };
 
   if (auto *A = ParsedArgs.getLastArg(OPT_minimum_access_level)) {