OpenJDK / bsd-port / jdk9 / langtools
changeset 2115:bf6b11347b1a
8026370: javadoc creates empty <span class="italic"></span>
Reviewed-by: jjg
author | bpatel |
---|---|
date | Tue, 15 Oct 2013 11:20:27 -0700 |
parents | 79649bf21a92 |
children | 70a301b35e71 |
files | src/share/classes/com/sun/tools/doclets/formats/html/TagletWriterImpl.java src/share/classes/com/sun/tools/doclets/formats/html/markup/ContentBuilder.java src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlTree.java test/com/sun/javadoc/testTagOutput/TestTagOutput.java test/com/sun/javadoc/testTagOutput/pkg1/DeprecatedTag.java |
diffstat | 5 files changed, 130 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
--- a/src/share/classes/com/sun/tools/doclets/formats/html/TagletWriterImpl.java Tue Oct 15 16:23:18 2013 +0200 +++ b/src/share/classes/com/sun/tools/doclets/formats/html/TagletWriterImpl.java Tue Oct 15 11:20:27 2013 -0700 @@ -118,7 +118,8 @@ if (deprs.length > 0) { Content body = commentTagsToOutput(null, doc, deprs[0].inlineTags(), false); - result.addContent(HtmlTree.SPAN(HtmlStyle.italic, body)); + if (!body.isEmpty()) + result.addContent(HtmlTree.SPAN(HtmlStyle.italic, body)); } } else { if (Util.isDeprecated(member.containingClass())) {
--- a/src/share/classes/com/sun/tools/doclets/formats/html/markup/ContentBuilder.java Tue Oct 15 16:23:18 2013 +0200 +++ b/src/share/classes/com/sun/tools/doclets/formats/html/markup/ContentBuilder.java Tue Oct 15 11:20:27 2013 -0700 @@ -41,8 +41,6 @@ @Override public void addContent(Content content) { nullCheck(content); - if ((content instanceof ContentBuilder) && content.isEmpty()) - return; ensureMutableContents(); if (content instanceof ContentBuilder) { contents.addAll(((ContentBuilder) content).contents);
--- a/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlTree.java Tue Oct 15 16:23:18 2013 +0200 +++ b/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlTree.java Tue Oct 15 11:20:27 2013 -0700 @@ -102,7 +102,12 @@ * @param tagContent tag content to be added */ public void addContent(Content tagContent) { - if (tagContent == HtmlTree.EMPTY || tagContent.isValid()) { + if (tagContent instanceof ContentBuilder) { + for (Content content: ((ContentBuilder)tagContent).contents) { + addContent(content); + } + } + else if (tagContent == HtmlTree.EMPTY || tagContent.isValid()) { if (content.isEmpty()) content = new ArrayList<Content>(); content.add(tagContent);
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/test/com/sun/javadoc/testTagOutput/TestTagOutput.java Tue Oct 15 11:20:27 2013 -0700 @@ -0,0 +1,78 @@ +/* + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +/* + * @test + * @bug 8026370 + * @summary This test checks the generated tag output. + * @author Bhavesh Patel + * @library ../lib/ + * @build JavadocTester TestTagOutput + * @run main TestTagOutput + */ + +public class TestTagOutput extends JavadocTester { + + private static final String BUG_ID = "8026370"; + private static final String[][] TEST = { + {BUG_ID + FS + "pkg1" + FS + "DeprecatedTag.html", + "<div class=\"block\"><span class=\"strong\">Deprecated.</span> </div>"}, + {BUG_ID + FS + "pkg1" + FS + "DeprecatedTag.html", + "<div class=\"block\"><span class=\"strong\">Deprecated.</span> " + + "<span class=\"italic\">Do not use this.</span></div>"}}; + + private static final String[][] NEGATED_TEST = { + {BUG_ID + FS + "pkg1" + FS + "DeprecatedTag.html", + "<div class=\"block\"><span class=\"strong\">Deprecated." + + "</span> <span class=\"italic\"></span></div>"}}; + + private static final String[] ARGS = + new String[] { + "-d", BUG_ID, "-sourcepath", SRC_DIR, "pkg1"}; + + /** + * The entry point of the test. + * @param args the array of command line arguments. + */ + public static void main(String[] args) { + TestTagOutput tester = new TestTagOutput(); + run(tester, ARGS, TEST, NEGATED_TEST); + tester.printSummary(); + } + + /** + * {@inheritDoc} + */ + public String getBugId() { + return BUG_ID; + } + + /** + * {@inheritDoc} + */ + public String getBugName() { + return getClass().getName(); + } +}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/test/com/sun/javadoc/testTagOutput/pkg1/DeprecatedTag.java Tue Oct 15 11:20:27 2013 -0700 @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +package pkg1; + +public class DeprecatedTag { + + /** + * This method is deprecated. + * + * @deprecated + */ + public void deprecatedMethod() { + } + + /** + * This method is also deprecated. + * + * @deprecated Do not use this. + */ + public void deprecatedMethodWithDesc() { + } +} +