chore: fix see also (#99)

eaball35 · web-flow · commit f3c5a40dc08e · 2022-01-27T11:35:30.000-08:00
diff --git a/third_party/docfx-doclet-143274/src/main/java/com/microsoft/lookup/BaseLookup.java b/third_party/docfx-doclet-143274/src/main/java/com/microsoft/lookup/BaseLookup.java
@@ -22,6 +22,7 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
@@ -205,7 +206,7 @@ protected String determineComment(T element) {
      * Provides support for deprecated and see tags
      */
     String replaceBlockTags(DocCommentTree docCommentTree, String comment) {
-        List<String> seeItems = new ArrayList<>();
+        Set<String> seeItems = new HashSet<>();
         String commentWithBlockTags = comment;
         for (DocTree blockTag : docCommentTree.getBlockTags()) {
             switch (blockTag.getKind()) {
@@ -284,8 +285,8 @@ public String makeTypeShort(String value) {
                 .collect(Collectors.joining("<"));
     }
 
-    private String getSeeAlsoSummary(List<String> seeItems) {
-        return String.format("\n<b>See Also:</b> %s\n", String.join(", ", seeItems));
+    private String getSeeAlsoSummary(Set<String> seeItems) {
+        return String.format("\nSee Also: %s\n", String.join(", ", seeItems));
     }
 
     private String getDeprecatedSummary(DeprecatedTree deprecatedTree) {
@@ -297,8 +298,8 @@ private String getSeeTagRef(SeeTree seeTree) {
         String ref = seeTree.getReference().stream()
                 .map(r -> String.valueOf(r)).collect(Collectors.joining(""));
         // if it's already a tag, use that otherwise build xref tag
-        if (ref.matches("^<.+>.*")) {
-            return ref;
+        if (ref.matches("^<.+>(.|\n)*")) {
+            return ref.replaceAll("\n", "").replaceAll("(  )+", " ");
         }
         return String.format("<xref uid=\"%1$s\" data-throw-if-not-resolved=\"false\">%1$s</xref>", ref);
     }
diff --git a/third_party/docfx-doclet-143274/src/test/java/com/microsoft/samples/google/ValidationException.java b/third_party/docfx-doclet-143274/src/test/java/com/microsoft/samples/google/ValidationException.java
@@ -37,6 +37,8 @@
  * Exception thrown if there is a validation problem with a path template, http config, or related
  * framework methods. Comes as an illegal argument exception subclass. Allows to globally set a
  * thread-local validation context description which each exception inherits.
+ * @see <a href="https://cloud.google.com/storage/docs/json_api/v1/status-codes">Google Cloud
+ *      Storage error codes</a>
  */
 public class ValidationException extends IllegalArgumentException {
 
diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.SuperHero.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.SuperHero.yml
@@ -254,7 +254,7 @@ items:
   overload: "com.microsoft.samples.SuperHero.successfullyAttacked*"
   type: "Method"
   package: "com.microsoft.samples"
-  summary: "\n<strong>Deprecated.</strong> <em>As of version 1.1, use . . . instead</em>\n\n<p>This is a simple description of the method. . .\n <a href=\"http://www.supermanisthegreatest.com\">Superman!</a>\n </p>\n<b>See Also:</b> <a href=\"http://www.link_to_jira/HERO-402\">HERO-402</a>\n"
+  summary: "\n<strong>Deprecated.</strong> <em>As of version 1.1, use . . . instead</em>\n\n<p>This is a simple description of the method. . .\n <a href=\"http://www.supermanisthegreatest.com\">Superman!</a>\n </p>\nSee Also: <a href=\"http://www.link_to_jira/HERO-402\">HERO-402</a>\n"
   syntax:
     content: "public int successfullyAttacked(int incomingDamage, String damageType)"
     parameters:
diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.ValidationException.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.ValidationException.yml
@@ -16,7 +16,7 @@ items:
   fullName: "com.microsoft.samples.google.ValidationException"
   type: "Class"
   package: "com.microsoft.samples.google"
-  summary: "Exception thrown if there is a validation problem with a path template, http config, or related\n framework methods. Comes as an illegal argument exception subclass. Allows to globally set a\n thread-local validation context description which each exception inherits."
+  summary: "Exception thrown if there is a validation problem with a path template, http config, or related\n framework methods. Comes as an illegal argument exception subclass. Allows to globally set a\n thread-local validation context description which each exception inherits.\nSee Also: <a href=\"https://cloud.google.com/storage/docs/json_api/v1/status-codes\">Google Cloud Storage error codes</a>\n"
   syntax:
     content: "public class ValidationException extends IllegalArgumentException"
   inheritance:
diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.subpackage.Person.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.subpackage.Person.yml
@@ -21,7 +21,7 @@ items:
   fullName: "com.microsoft.samples.subpackage.Person<T>"
   type: "Class"
   package: "com.microsoft.samples.subpackage"
-  summary: "Class that describes some person\n\n This comment has links to:\n <ul>\n <li>Owner class <xref uid=\"com.microsoft.samples.subpackage.Person\" data-throw-if-not-resolved=\"false\">Person</xref></li>\n <li>Its inner class <xref uid=\"com.microsoft.samples.subpackage.Person.IdentificationInfo\" data-throw-if-not-resolved=\"false\">Person.IdentificationInfo</xref></li>\n <li>Its method <xref uid=\"com.microsoft.samples.subpackage.Person.setLastName(java.lang.String)\" data-throw-if-not-resolved=\"false\">Person#setLastName(String lastName)</xref></li>\n <li>Its method without params <xref uid=\"com.microsoft.samples.subpackage.Person.setLastName()\" data-throw-if-not-resolved=\"false\">Person#setLastName()</xref></li>\n <li>Its public field <xref uid=\"com.microsoft.samples.subpackage.Person.age\" data-throw-if-not-resolved=\"false\">Person#age</xref></li>\n <li>Another class which used here <xref uid=\"java.util.Set\" data-throw-if-not-resolved=\"false\">Set</xref></li>\n <li>Another class which not used here <xref uid=\"java.util.List\" data-throw-if-not-resolved=\"false\">List</xref></li>\n <li>Broken link <xref uid=\"\" data-throw-if-not-resolved=\"false\">sdfdsagdsfghfgh</xref></li>\n <li>Plain link <xref uid=\"\" data-throw-if-not-resolved=\"false\">someContent</xref></li>\n <li>Link that starts from '#' <xref uid=\"com.microsoft.samples.subpackage.Person.setLastName()\" data-throw-if-not-resolved=\"false\">#setLastName()</xref></li>\n <li>Link with label <xref uid=\"java.util.Set\" data-throw-if-not-resolved=\"false\">WordOne</xref></li>\n </ul>\n\n This is an \"at\" symbol: @\n<b>See Also:</b> <xref uid=\"com.microsoft.samples.subpackage.Display\" data-throw-if-not-resolved=\"false\">Display</xref>\n"
+  summary: "Class that describes some person\n\n This comment has links to:\n <ul>\n <li>Owner class <xref uid=\"com.microsoft.samples.subpackage.Person\" data-throw-if-not-resolved=\"false\">Person</xref></li>\n <li>Its inner class <xref uid=\"com.microsoft.samples.subpackage.Person.IdentificationInfo\" data-throw-if-not-resolved=\"false\">Person.IdentificationInfo</xref></li>\n <li>Its method <xref uid=\"com.microsoft.samples.subpackage.Person.setLastName(java.lang.String)\" data-throw-if-not-resolved=\"false\">Person#setLastName(String lastName)</xref></li>\n <li>Its method without params <xref uid=\"com.microsoft.samples.subpackage.Person.setLastName()\" data-throw-if-not-resolved=\"false\">Person#setLastName()</xref></li>\n <li>Its public field <xref uid=\"com.microsoft.samples.subpackage.Person.age\" data-throw-if-not-resolved=\"false\">Person#age</xref></li>\n <li>Another class which used here <xref uid=\"java.util.Set\" data-throw-if-not-resolved=\"false\">Set</xref></li>\n <li>Another class which not used here <xref uid=\"java.util.List\" data-throw-if-not-resolved=\"false\">List</xref></li>\n <li>Broken link <xref uid=\"\" data-throw-if-not-resolved=\"false\">sdfdsagdsfghfgh</xref></li>\n <li>Plain link <xref uid=\"\" data-throw-if-not-resolved=\"false\">someContent</xref></li>\n <li>Link that starts from '#' <xref uid=\"com.microsoft.samples.subpackage.Person.setLastName()\" data-throw-if-not-resolved=\"false\">#setLastName()</xref></li>\n <li>Link with label <xref uid=\"java.util.Set\" data-throw-if-not-resolved=\"false\">WordOne</xref></li>\n </ul>\n\n This is an \"at\" symbol: @\nSee Also: <xref uid=\"com.microsoft.samples.subpackage.Display\" data-throw-if-not-resolved=\"false\">Display</xref>\n"
   syntax:
     content: "public class Person<T>"
     typeParameters:
