[AST] Restore previous behavior for DocCommentAsXML

rintaro · rintaro · commit b1fae101f209 · 2019-06-20T12:05:04.000-07:00
Associate requirement decl with DocComment.
diff --git a/include/swift/AST/Comment.h b/include/swift/AST/Comment.h
@@ -22,16 +22,23 @@ class TypeDecl;
 struct RawComment;
 
 class DocComment {
+  const Decl *D;
   swift::markup::Document *Doc = nullptr;
   swift::markup::CommentParts Parts;
 
-  DocComment(swift::markup::Document *Doc, swift::markup::CommentParts Parts)
-      : Doc(Doc), Parts(Parts) {}
+  DocComment(const Decl *D, swift::markup::Document *Doc,
+             swift::markup::CommentParts Parts)
+      : D(D), Doc(Doc), Parts(Parts) {}
+
 public:
-  static DocComment *create(swift::markup::MarkupContext &MC, RawComment RC);
+  static DocComment *create(const Decl *D, swift::markup::MarkupContext &MC,
+                            RawComment RC);
 
   void addInheritanceNote(swift::markup::MarkupContext &MC, TypeDecl *base);
 
+  const Decl *getDecl() const { return D; }
+  void setDecl(const Decl *D) { this->D = D; }
+
   const swift::markup::Document *getDocument() const { return Doc; }
 
   swift::markup::CommentParts getParts() const {
@@ -106,4 +113,3 @@ void printBriefComment(RawComment RC, llvm::raw_ostream &OS);
 } // namespace swift
 
 #endif // LLVM_SWIFT_AST_COMMENT_H
-
diff --git a/lib/AST/DocComment.cpp b/lib/AST/DocComment.cpp
@@ -352,12 +352,13 @@ swift::extractCommentParts(swift::markup::MarkupContext &MC,
   return Parts;
 }
 
-DocComment *DocComment::create(markup::MarkupContext &MC, RawComment RC) {
+DocComment *DocComment::create(const Decl *D, markup::MarkupContext &MC,
+                               RawComment RC) {
   assert(!RC.isEmpty());
   swift::markup::LineList LL = MC.getLineList(RC);
   auto *Doc = swift::markup::parseDocument(MC, LL);
   auto Parts = extractCommentParts(MC, Doc);
-  return new (MC) DocComment(Doc, Parts);
+  return new (MC) DocComment(D, Doc, Parts);
 }
 
 void DocComment::addInheritanceNote(swift::markup::MarkupContext &MC,
@@ -385,7 +386,7 @@ DocComment *swift::getSingleDocComment(swift::markup::MarkupContext &MC,
   auto RC = D->getRawComment();
   if (RC.isEmpty())
     return nullptr;
-  return DocComment::create(MC, RC);
+  return DocComment::create(D, MC, RC);
 }
 
 namespace {
@@ -480,10 +481,19 @@ swift::getCascadingDocComment(swift::markup::MarkupContext &MC, const Decl *D) {
   assert(doc && "getDocCommentProvidingDecl() returned decl with no comment");
 
   // If the doc-comment is inherited from other decl, add a note about it.
-  if (docD != D)
-    if (auto baseD = docD->getDeclContext()->getSelfNominalTypeDecl())
+  if (docD != D) {
+    doc->setDecl(D);
+    if (auto baseD = docD->getDeclContext()->getSelfNominalTypeDecl()) {
       doc->addInheritanceNote(MC, baseD);
 
+      // If the doc is inherited from protocol requirement, associate the
+      // requirement with the doc-comment.
+      // FIXME: This is to keep the old behavior.
+      if (isa<ProtocolDecl>(baseD))
+        doc->setDecl(docD);
+    }
+  }
+
   return doc;
 }
 
diff --git a/lib/IDE/CommentConversion.cpp b/lib/IDE/CommentConversion.cpp
@@ -258,7 +258,7 @@ struct CommentToXMLConverter {
     OS << "</Tags>";
   }
 
-  void visitDocComment(const Decl *D, const DocComment *DC);
+  void visitDocComment(const DocComment *DC);
   void visitCommentParts(const swift::markup::CommentParts &Parts);
 };
 } // unnamed namespace
@@ -297,7 +297,8 @@ void CommentToXMLConverter::visitCommentParts(const swift::markup::CommentParts
   }
 }
 
-void CommentToXMLConverter::visitDocComment(const Decl *D, const DocComment *DC) {
+void CommentToXMLConverter::visitDocComment(const DocComment *DC) {
+  const Decl *D = DC->getDecl();
 
   StringRef RootEndTag;
   if (isa<AbstractFunctionDecl>(D)) {
@@ -463,7 +464,7 @@ bool ide::getDocumentationCommentAsXML(const Decl *D, raw_ostream &OS) {
     return false;
 
   CommentToXMLConverter Converter(OS);
-  Converter.visitDocComment(D, DC);
+  Converter.visitDocComment(DC);
 
   OS.flush();
   return true;
diff --git a/test/IDE/comment_inherited_protocol.swift b/test/IDE/comment_inherited_protocol.swift
@@ -63,23 +63,23 @@ protocol ChildProtocol : ParentProtocol1, ParentProtocol2 {
 extension ChildProtocol {
   // Should come from ParentProtocol1.
   func onlyParent1() {}
-  // CHECK: Func/onlyParent1 {{.*}} DocCommentAsXML=[<Function file="{{.*}}" line="{{.*}}" column="{{.*}}"><Name>onlyParent1()</Name><USR>s:14swift_ide_test13ChildProtocolPAAE11onlyParent1yyF</USR><Declaration>func onlyParent1()</Declaration><CommentParts><Abstract><Para>ParentProtocol1.onlyParent1()</Para></Abstract><Discussion><Note><Para>This documentation comment was inherited from <codeVoice>ParentProtocol1</codeVoice>.</Para></Note></Discussion></CommentParts></Function>]
+  // CHECK: Func/onlyParent1 {{.*}} DocCommentAsXML=[<Function file="{{.*}}" line="{{.*}}" column="{{.*}}"><Name>onlyParent1()</Name><USR>s:14swift_ide_test15ParentProtocol1P11onlyParent1yyF</USR><Declaration>func onlyParent1()</Declaration><CommentParts><Abstract><Para>ParentProtocol1.onlyParent1()</Para></Abstract><Discussion><Note><Para>This documentation comment was inherited from <codeVoice>ParentProtocol1</codeVoice>.</Para></Note></Discussion></CommentParts></Function>]
 
   // Should come from ParentProtocol1.
   var onlyParent1Var: Int { return 0 }
-  // CHECK: Var/onlyParent1Var {{.*}} DocCommentAsXML=[<Other file="{{.*}}" line="{{.*}}" column="{{.*}}"><Name>onlyParent1Var</Name><USR>s:14swift_ide_test13ChildProtocolPAAE14onlyParent1VarSivp</USR><Declaration>var onlyParent1Var: Int { get }</Declaration><CommentParts><Abstract><Para>ParentProtocol.onlyParent1Var</Para></Abstract><Discussion><Note><Para>This documentation comment was inherited from <codeVoice>ParentProtocol1</codeVoice>.</Para></Note></Discussion></CommentParts></Other>]
+  // CHECK: Var/onlyParent1Var {{.*}} DocCommentAsXML=[<Other file="{{.*}}" line="{{.*}}" column="{{.*}}"><Name>onlyParent1Var</Name><USR>s:14swift_ide_test15ParentProtocol1P14onlyParent1VarSivp</USR><Declaration>var onlyParent1Var: Int { get }</Declaration><CommentParts><Abstract><Para>ParentProtocol.onlyParent1Var</Para></Abstract><Discussion><Note><Para>This documentation comment was inherited from <codeVoice>ParentProtocol1</codeVoice>.</Para></Note></Discussion></CommentParts></Other>]
 
   // Should come from ParentProtocol1.
   subscript(index: Int) -> Int { return 0 }
   // CHECK: Subscript/subscript {{.*}} DocCommentAsXML=[<Other file="{{.*}}" line="{{.*}}" column="{{.*}}"><Name>subscript(_:)</Name><USR>{{.*}}</USR><Declaration>subscript(index: Int) -&gt; Int { get }</Declaration><CommentParts><Abstract><Para>ParentProtocol.subscript(index:)</Para></Abstract><Discussion><Note><Para>This documentation comment was inherited from <codeVoice>ParentProtocol1</codeVoice>.</Para></Note></Discussion></CommentParts></Other>]
 
   // Should come from ParentProtocol1.
   typealias AssocType = Int
-  // CHECK: TypeAlias/AssocType {{.*}} DocCommentAsXML=[<Other file="{{.*}}" line="{{.*}}" column="{{.*}}"><Name>AssocType</Name><USR>s:14swift_ide_test13ChildProtocolPAAE9AssocTypea</USR><Declaration>typealias AssocType = Int</Declaration><CommentParts><Abstract><Para>ParentProtocol.AssocType</Para></Abstract><Discussion><Note><Para>This documentation comment was inherited from <codeVoice>ParentProtocol1</codeVoice>.</Para></Note></Discussion></CommentParts></Other>]
+  // CHECK: TypeAlias/AssocType {{.*}} DocCommentAsXML=[<Other file="{{.*}}" line="{{.*}}" column="{{.*}}"><Name>AssocType</Name><USR>s:14swift_ide_test15ParentProtocol1P9AssocTypeQa</USR><Declaration>associatedtype AssocType</Declaration><CommentParts><Abstract><Para>ParentProtocol.AssocType</Para></Abstract><Discussion><Note><Para>This documentation comment was inherited from <codeVoice>ParentProtocol1</codeVoice>.</Para></Note></Discussion></CommentParts></Other>]
 
   // Should come from ParentProtocol2.
   func onlyParent2() {}
-  // CHECK: Func/onlyParent2 {{.*}} DocCommentAsXML=[<Function file="{{.*}}" line="{{.*}}" column="{{.*}}"><Name>onlyParent2()</Name><USR>s:14swift_ide_test13ChildProtocolPAAE11onlyParent2yyF</USR><Declaration>func onlyParent2()</Declaration><CommentParts><Abstract><Para>ParentProtocol2.onlyParent2()</Para></Abstract><Discussion><Note><Para>This documentation comment was inherited from <codeVoice>ParentProtocol2</codeVoice>.</Para></Note></Discussion></CommentParts></Function>]
+  // CHECK: Func/onlyParent2 {{.*}} DocCommentAsXML=[<Function file="{{.*}}" line="{{.*}}" column="{{.*}}"><Name>onlyParent2()</Name><USR>s:14swift_ide_test15ParentProtocol2P11onlyParent2yyF</USR><Declaration>func onlyParent2()</Declaration><CommentParts><Abstract><Para>ParentProtocol2.onlyParent2()</Para></Abstract><Discussion><Note><Para>This documentation comment was inherited from <codeVoice>ParentProtocol2</codeVoice>.</Para></Note></Discussion></CommentParts></Function>]
 
   // Should show nothing because the requirement is in both parents.
   func commonParentRequirement() {}
