---

yaml
---
r: 348963
b: refs/heads/master
c: ba6891d
h: refs/heads/master
i:
  348961: b167af3
  348959: 4b99b7c

Author: nkcsgexi

[refs]

@@ -1,5 +1,5 @@
 ---
-refs/heads/master: adb9e1d42c368006839db2a8f9fd864337410ca0
+refs/heads/master: ba6891d7c8704e4a32fc85c716e5f5707d6f3599
 refs/heads/master-next: 203b3026584ecad859eb328b2e12490099409cd5
 refs/tags/osx-passed: b6b74147ef8a386f532cf9357a1bde006e552c54
 refs/tags/swift-2.2-SNAPSHOT-2015-12-01-a: 6bb18e013c2284f2b45f5f84f2df2887dc0f7dea

trunk/lib/Serialization/SerializeDoc.cpp

@@ -298,41 +298,48 @@ static void writeGroupNames(const comment_block::GroupNamesLayout &GroupNames,
   GroupNames.emit(Scratch, BlobStream.str());
 }
 
-static bool shouldIncludeDecl(Decl *D) {
-  if (auto *VD = dyn_cast<ValueDecl>(D)) {
-    // Skip the decl if it's not visible to clients. The use of
-    // getEffectiveAccess is unusual here; we want to take the testability
-    // state into account and emit documentation if and only if they are
-    // visible to clients (which means public ordinarily, but
-    // public+internal when testing enabled).
-    if (VD->getEffectiveAccess() < swift::AccessLevel::Public)
-      return false;
-  }
+static bool hasDoubleUnderscore(Decl *D) {
   // Exclude decls with double-underscored names, either in arguments or
   // base names.
-  StringRef Prefix = "__";
-  if (auto *ED = dyn_cast<ExtensionDecl>(D)) {
-    return shouldIncludeDecl(ED->getExtendedNominal());
-  }
+  static StringRef Prefix = "__";
 
   if (auto AFD = dyn_cast<AbstractFunctionDecl>(D)) {
     // If it's a function with a parameter with leading double underscore,
     // it's a private function.
     if (AFD->getParameters()->hasInternalParameter(Prefix))
-      return false;
+      return true;
   }
 
   if (auto SubscriptD = dyn_cast<SubscriptDecl>(D)) {
     if (SubscriptD->getIndices()->hasInternalParameter(Prefix))
-      return false;
+      return true;
   }
   if (auto *VD = dyn_cast<ValueDecl>(D)) {
     auto Name = VD->getBaseName();
     if (!Name.isSpecial() &&
         Name.getIdentifier().str().startswith(Prefix)) {
-      return false;
+      return true;
     }
   }
+  return false;
+}
+
+static bool shouldIncludeDecl(Decl *D, bool ExcludeDoubleUnderscore) {
+  if (auto *VD = dyn_cast<ValueDecl>(D)) {
+    // Skip the decl if it's not visible to clients. The use of
+    // getEffectiveAccess is unusual here; we want to take the testability
+    // state into account and emit documentation if and only if they are
+    // visible to clients (which means public ordinarily, but
+    // public+internal when testing enabled).
+    if (VD->getEffectiveAccess() < swift::AccessLevel::Public)
+      return false;
+  }
+  if (auto *ED = dyn_cast<ExtensionDecl>(D)) {
+    return shouldIncludeDecl(ED->getExtendedNominal(), ExcludeDoubleUnderscore);
+  }
+  if (ExcludeDoubleUnderscore && hasDoubleUnderscore(D)) {
+    return false;
+  }
   return true;
 }
 
@@ -393,7 +400,7 @@ static void writeDeclCommentTable(
     }
 
     bool walkToDeclPre(Decl *D) override {
-      if (!shouldIncludeDecl(D))
+      if (!shouldIncludeDecl(D, /*ExcludeDoubleUnderscore*/true))
         return false;
       if (!shouldSerializeDoc(D))
         return true;
@@ -789,7 +796,10 @@ struct BasicDeclLocsTableWriter : public ASTWalker {
 
   bool walkToDeclPre(Decl *D) override {
     // We shouldn't expose any Decls that .swiftdoc file isn't willing to expose.
-    if (!shouldIncludeDecl(D))
+    // .swiftdoc doesn't include comments for double underscored symbols, but for .swiftsourceinfo,
+    // having the source location for these symbols isn't a concern becuase these
+    // symbols are in .swiftinterface anyway.
+    if (!shouldIncludeDecl(D, /*ExcludeDoubleUnderscore*/false))
       return false;
     if (!shouldSerializeSourceLoc(D))
       return true;

trunk/test/Serialization/comments-hidden.swift

@@ -14,6 +14,13 @@
 // RUN: %FileCheck %s -check-prefix=TESTING < %t.testing.txt
 // RUN: %FileCheck %s -check-prefix=TESTING-NEGATIVE < %t.testing.txt
 
+// Test the case when we have .swiftsourceinfo
+//
+// RUN: %empty-directory(%t)
+// RUN: %target-swift-frontend -enable-testing -module-name comments -emit-module -emit-module-path %t/comments.swiftmodule -emit-module-doc -emit-module-doc-path %t/comments.swiftdoc -emit-module-source-info-path %t/comments.swiftsourceinfo %s
+// RUN: %target-swift-ide-test -print-module-comments -module-to-print=comments -source-filename %s -I %t > %t.testing.txt
+// RUN: %FileCheck %s -check-prefix=SOURCE-LOC < %t.testing.txt
+
 /// PublicClass Documentation
 public class PublicClass {
   /// Public Function Documentation
@@ -73,4 +80,9 @@ private class PrivateClass {
 // TESTING: InternalClass Documentation
 // TESTING: Internal Function Documentation
 
-
+// SOURCE-LOC: comments-hidden.swift:37:15: Func/PublicClass.__UnderscoredPublic RawComment=none BriefComment=none DocCommentAsXML=none
+// SOURCE-LOC: comments-hidden.swift:39:10: Constructor/PublicClass.init RawComment=none BriefComment=none DocCommentAsXML=none
+// SOURCE-LOC: comments-hidden.swift:41:10: Subscript/PublicClass.subscript RawComment=none BriefComment=none DocCommentAsXML=none
+// SOURCE-LOC: comments-hidden.swift:43:10: Constructor/PublicClass.init RawComment=none BriefComment=none DocCommentAsXML=none
+// SOURCE-LOC: comments-hidden.swift:45:10: Subscript/PublicClass.subscript RawComment=none BriefComment=none DocCommentAsXML=none
+// SOURCE-LOC: comments-hidden.swift:50:15: Func/-= RawComment=none BriefComment=none DocCommentAsXML=none