8231122: @Index tag with newline causes tag search to fail

Reviewed-by: jjg
openjdk · Sep 24, 2019 · 8743f0b · 8743f0b
1 parent a63b541
commit 8743f0b
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 11 deletions.
diff --git a/...jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/TagletWriterImpl.java b/...jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/TagletWriterImpl.java
@@ -110,7 +110,8 @@ protected Content indexTagOutput(Element element, DocTree tag) {
 
         String tagText =  ch.getText(itt.getSearchTerm());
         if (tagText.charAt(0) == '"' && tagText.charAt(tagText.length() - 1) == '"') {
-            tagText = tagText.substring(1, tagText.length() - 1);
+            tagText = tagText.substring(1, tagText.length() - 1)
+                             .replaceAll("\\s+", " ");
         }
         String desc = ch.getText(itt.getDescription());
 

diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/Links.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/Links.java
@@ -312,7 +312,7 @@ public Content createLink(DocLink link, Content label, boolean isExternal) {
      * @return a valid HTML name
      */
     public String getName(String name) {
-        return name.replaceAll(" +", "");
+        return name.replaceAll("\\s+", "");
     }
 
 }
diff --git a/test/langtools/jdk/javadoc/doclet/testSearchScript/TestSearchScript.java b/test/langtools/jdk/javadoc/doclet/testSearchScript/TestSearchScript.java
@@ -149,11 +149,12 @@ public void testModuleSearch() throws ScriptException, IOException, NoSuchMethod
         checkSearch(inv, "operty", List.of());
 
         // search tag
-        checkSearch(inv, "search tag", List.of("search tag"));
-        checkSearch(inv, "search   tag", List.of("search tag"));
-        checkSearch(inv, "search ", List.of("search tag"));
-        checkSearch(inv, "tag", List.of("search tag"));
-        checkSearch(inv, "sea", List.of("search tag"));
+        checkSearch(inv, "search tag", List.of("multiline search tag", "search tag"));
+        checkSearch(inv, "search   tag", List.of("multiline search tag", "search tag"));
+        checkSearch(inv, "search ", List.of("multiline search tag", "search tag"));
+        checkSearch(inv, "tag", List.of("multiline search tag", "search tag"));
+        checkSearch(inv, "sea", List.of("multiline search tag", "search tag"));
+        checkSearch(inv, "multi", List.of("multiline search tag"));
         checkSearch(inv, "ear", List.of());
     }
 
@@ -244,7 +245,7 @@ public void testPackageSource() throws ScriptException, IOException, NoSuchMetho
                 List.of("listpkg.List.of(E, E, E, E)", "listpkg.List.of(E, E, E, E, E)"));
         checkSearch(inv, "l . o (e,e,e,",
                 List.of("listpkg.List.of(E, E, E, E)", "listpkg.List.of(E, E, E, E, E)"));
-        checkSearch(inv, "search    \tt", List.of("search tag"));
+        checkSearch(inv, "search    \tt", List.of("other search tag"));
         checkSearch(inv, "sear ch", List.of());
         checkSearch(inv, "( e ..", List.of("listpkg.List.of(E...)"));
         checkSearch(inv, "( i [ ]", List.of("listpkg.Nolist.withArrayArg(int[])"));

diff --git a/test/langtools/jdk/javadoc/doclet/testSearchScript/listpkg/Nolist.java b/test/langtools/jdk/javadoc/doclet/testSearchScript/listpkg/Nolist.java
@@ -27,9 +27,8 @@
 import java.util.Map;
 
 /**
- * Example class containing "list" but not matching at any word boundary.
- *
- * {@index "search tag"}.
+ * Example class containing "list" but not matching at any word boundary. {@index "other
+ * search tag"}.
  */
 public class Nolist {
 

diff --git a/test/langtools/jdk/javadoc/doclet/testSearchScript/mapmodule/mappkg/Map.java b/test/langtools/jdk/javadoc/doclet/testSearchScript/mapmodule/mappkg/Map.java
@@ -25,6 +25,13 @@
 
 import java.util.Iterator;
 
+/**
+ * Map interface.
+ *
+ * {@index "multiline
+ *          search
+ *          tag"}
+ */
 public interface Map {
     public void put(Object key, Object value);
     public boolean contains(Object key);