Merge pull request #9071 from makiam/html-comment-tag-fix

Fix for issue 9018: Javadoc viewer shows HTML comments

Author: matthiasblaesing

java/java.sourceui/src/org/netbeans/api/java/source/ui/ElementJavadoc.java

@@ -123,8 +123,6 @@
 import com.vladsch.flexmark.ext.tables.TablesExtension;
 import com.vladsch.flexmark.html.HtmlRenderer;
 import com.vladsch.flexmark.parser.Parser;
-import com.vladsch.flexmark.util.data.DataHolder;
-import com.vladsch.flexmark.util.data.MutableDataSet;
 import javax.lang.model.element.RecordComponentElement;
 import org.netbeans.api.java.queries.SourceLevelQuery;
 import org.netbeans.api.java.queries.SourceLevelQuery.Profile;
@@ -191,7 +189,7 @@ public class ElementJavadoc {
     }
 
     /** Creates an object describing the Javadoc of given element. The object
-     * is capable of getting the text formated into HTML, resolve the links,
+     * is capable of getting the text formatted into HTML, resolve the links,
      * jump to external javadoc.
      * 
      * @param compilationInfo CompilationInfo
@@ -203,7 +201,7 @@ public static final ElementJavadoc create(CompilationInfo compilationInfo, Eleme
     }
 
     /** Creates an object describing the Javadoc of given element. The object
-     * is capable of getting the text formated into HTML, resolve the links,
+     * is capable of getting the text formatted into HTML, resolve the links,
      * jump to external javadoc.
      *
      * @param compilationInfo CompilationInfo
@@ -216,7 +214,7 @@ public static final ElementJavadoc create(CompilationInfo compilationInfo, Eleme
         return new ElementJavadoc(compilationInfo, element, null, cancel);
     }
 
-    /** Gets the javadoc comment formated as HTML.      
+    /** Gets the javadoc comment formatted as HTML.
      * @return HTML text of the javadoc
      */
     public String getText() {
@@ -228,7 +226,7 @@ public String getText() {
         }
     }
 
-    /** Gets the javadoc comment formated as HTML.
+    /** Gets the javadoc comment formatted as HTML.
      * @return {@link Future} of HTML text of the javadoc
      * @since 1.20
      */
@@ -237,7 +235,7 @@ public Future<String> getTextAsync() {
     }
 
     /** Gets URL of the external javadoc.
-     * @return Text of the Javadoc comment formated as HTML
+     * @return Text of the Javadoc comment formatted as HTML
      */ 
     public URL getURL() {
         return docURL;
@@ -422,7 +420,7 @@ private ElementJavadoc(CompilationInfo compilationInfo, Element element, final U
             return;
         }
         try {
-            //Optimisitic no http
+            //Optimistic no http
             CharSequence doc = getElementDoc(element, compilationInfo, header, url, true);
             if (doc == null) {
                 computeDocURL(Collections.emptyList(), true, cancel);
@@ -1392,6 +1390,8 @@ private StringBuilder inlineTags(List<? extends DocTree> tags, TreePath docPath,
                     sb.append(systemPropTag.getPropertyName());
                     sb.append("</code>"); //NOI18N
                     break;
+                case COMMENT:
+                    break;
                 default:
                     sb.append("<code>"); //NOI18N
                     try {

java/java.sourceui/test/unit/src/org/netbeans/api/java/source/ui/ElementJavadocTest.java

@@ -157,8 +157,27 @@ public void testLinkNoRef() throws Exception {
         String expectedJavadoc = "<pre>public class <b>Test</b><br>extends <a href='*0'>Object</a></pre><p>Hello!\n" +
                                  "\n" +
                                  "<p>";
-
+        
         assertEquals(expectedJavadoc, actualJavadoc);
     }
 
+    /**
+     * Test for issue 9018: Javadoc viewer shows HTML comments
+     * @throws Exception 
+     */
+    public void testHiddenTagInDoc() throws Exception {
+        prepareTest("test/Test.java", "/**\n" +
+                    " * Next commented text is not expected to be in output document\n" +
+                    " * <!-- This text not expected to be in output document -->\n" +
+                    " */\n" +
+                    "public class Te<caret>st {}");
+        String actualJavadoc = ElementJavadoc.create(info, selectedElement).getText();
+        String expectedJavadoc = "<pre>public class <b>Test</b><br>extends <a href='*0'>Object</a></pre><p>Next commented text is not expected to be in output document\n" +
+
+                                 "<p>";
+        assertEquals(expectedJavadoc, actualJavadoc);
+    }
+    
+    
+    
 }