| /* |
| * Copyright (c) 2009, 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 6786690 6820360 |
| * @summary This test verifies the nesting of definition list tags. |
| * @author Bhavesh Patel |
| * @library ../lib/ |
| * @build JavadocTester TestHtmlDefinitionListTag |
| * @run main TestHtmlDefinitionListTag |
| */ |
| |
| public class TestHtmlDefinitionListTag extends JavadocTester { |
| |
| private static final String BUG_ID = "6786690-6820360"; |
| |
| // Test common to all runs of javadoc. The class signature should print |
| // properly enclosed definition list tags and the Annotation Type |
| // Optional Element should print properly nested definition list tags |
| // for default value. |
| private static final String[][] TEST_ALL = { |
| {BUG_ID + FS + "pkg1" + FS + "C1.html", "<pre>public class " + |
| "<span class=\"strong\">C1</span>" + NL + |
| "extends java.lang.Object" + NL + "implements java.io.Serializable</pre>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C4.html", "<dl>" + NL + |
| "<dt>Default:</dt>" + NL + "<dd>true</dd>" + NL + |
| "</dl>"}}; |
| |
| // Test for normal run of javadoc in which various ClassDocs and |
| // serialized form should have properly nested definition list tags |
| // enclosing comments, tags and deprecated information. |
| private static final String[][] TEST_CMNT_DEPR = { |
| {BUG_ID + FS + "pkg1" + FS + "package-summary.html", "<dl>" + NL + |
| "<dt><span class=\"strong\">Since:</span></dt>" + NL + |
| "<dd>JDK1.0</dd>" + NL + "</dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C1.html", "<dl>" + NL + "<dt><span class=\"strong\">Since:</span></dt>" + NL + |
| "<dd>JDK1.0</dd>" + NL + "<dt><span class=\"strong\">See Also:</span></dt>" + NL + |
| "<dd><a href=\"../pkg1/C2.html\" title=\"class in pkg1\"><code>" + |
| "C2</code></a>, " + NL + "<a href=\"../serialized-form.html#pkg1.C1\">" + |
| "Serialized Form</a></dd>" + NL + "</dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C1.html", "<dl>" + NL + "<dt><span class=\"strong\">Since:</span></dt>" + NL + |
| "<dd>1.4</dd>" + NL + |
| "<dt><span class=\"strong\">See Also:</span></dt>" + NL + "<dd>" + |
| "<a href=\"../pkg1/C1.html#setUndecorated(boolean)\">" + |
| "<code>setUndecorated(boolean)</code></a></dd>" + NL + "</dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C1.html", "<dl>"+ NL + "<dt><span class=\"strong\">Parameters:</span></dt>" + NL + "<dd><code>title" + |
| "</code> - the title</dd>" + NL + "<dd><code>test</code> - boolean value" + |
| "</dd>" + NL + "<dt><span class=\"strong\">Throws:</span></dt>" + NL + |
| "<dd><code>java.lang.IllegalArgumentException</code> - if the " + |
| "<code>owner</code>'s" + NL + |
| " <code>GraphicsConfiguration</code> is not from a screen " + |
| "device</dd>" + NL + "<dd><code>HeadlessException</code></dd>" + NL + "</dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C1.html", "<dl>" + NL + "<dt><span class=\"strong\">Parameters:</span></dt>" + NL + "<dd><code>undecorated" + |
| "</code> - <code>true</code> if no decorations are" + NL + |
| " to be enabled;" + NL + " <code>false</code> " + |
| "if decorations are to be enabled.</dd>" + NL + "<dt><span class=\"strong\">Since:" + |
| "</span></dt>" + NL + "<dd>1.4</dd>" + NL + |
| "<dt><span class=\"strong\">See Also:</span></dt>" + NL + "<dd>" + |
| "<a href=\"../pkg1/C1.html#readObject()\"><code>readObject()" + |
| "</code></a></dd>" + NL + "</dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C1.html", "<dl>" + NL + "<dt><span class=\"strong\">Throws:</span></dt>" + NL + |
| "<dd><code>java.io.IOException</code></dd>" + NL + "<dt><span class=\"strong\">See Also:" + |
| "</span></dt>" + NL + "<dd><a href=\"../pkg1/C1.html#setUndecorated(boolean)\">" + |
| "<code>setUndecorated(boolean)</code></a></dd>" + NL + "</dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C2.html", "<dl>" + NL + "<dt><span class=\"strong\">Parameters:" + |
| "</span></dt>" + NL + "<dd><code>set</code> - boolean</dd>" + NL + "<dt><span class=\"strong\">" + |
| "Since:</span></dt>" + NL + "<dd>1.4</dd>" + NL + "</dl>"}, |
| {BUG_ID + FS + "serialized-form.html", "<dl>" + NL + "<dt><span class=\"strong\">Throws:</span>" + |
| "</dt>" + NL + "<dd><code>" + |
| "java.io.IOException</code></dd>" + NL + "<dt><span class=\"strong\">See Also:</span>" + |
| "</dt>" + NL + "<dd><a href=\"pkg1/C1.html#setUndecorated(boolean)\">" + |
| "<code>C1.setUndecorated(boolean)</code></a></dd>" + NL + "</dl>"}, |
| {BUG_ID + FS + "serialized-form.html", "<span class=\"strong\">Deprecated.</span>" + |
| " <i>As of JDK version 1.5, replaced by" + NL + |
| " <a href=\"pkg1/C1.html#setUndecorated(boolean)\">" + |
| "<code>setUndecorated(boolean)</code></a>.</i></div>" + NL + |
| "<div class=\"block\">This field indicates whether the C1 is " + |
| "undecorated.</div>" + NL + " " + NL + "<dl>" + NL + "<dt><span class=\"strong\">Since:</span></dt>" + NL + |
| "<dd>1.4</dd>" + NL + "<dt><span class=\"strong\">See Also:</span>" + |
| "</dt>" + NL + "<dd><a href=\"pkg1/C1.html#setUndecorated(boolean)\">" + |
| "<code>C1.setUndecorated(boolean)</code></a></dd>" + NL + "</dl>"}, |
| {BUG_ID + FS + "serialized-form.html", "<span class=\"strong\">Deprecated.</span>" + |
| " <i>As of JDK version 1.5, replaced by" + NL + |
| " <a href=\"pkg1/C1.html#setUndecorated(boolean)\">" + |
| "<code>setUndecorated(boolean)</code></a>.</i></div>" + NL + |
| "<div class=\"block\">Reads the object stream.</div>" + NL + |
| "<dl>" + NL + "<dt><span class=\"strong\">Throws:" + |
| "</span></dt>" + NL + "<dd><code><code>" + |
| "IOException</code></code></dd>" + NL + |
| "<dd><code>java.io.IOException</code></dd>" + NL + "</dl>"}, |
| {BUG_ID + FS + "serialized-form.html", "<span class=\"strong\">Deprecated.</span>" + |
| " </div>" + NL + |
| "<div class=\"block\">The name for this class.</div>"}}; |
| |
| // Test with -nodeprecated option. The ClassDocs should have properly nested |
| // definition list tags enclosing comments and tags. The ClassDocs should not |
| // display definition list for deprecated information. The serialized form |
| // should display properly nested definition list tags for comments, tags |
| // and deprecated information. |
| private static final String[][] TEST_NODEPR = { |
| {BUG_ID + FS + "pkg1" + FS + "package-summary.html", "<dl>" + NL + |
| "<dt><span class=\"strong\">Since:</span></dt>" + NL + |
| "<dd>JDK1.0</dd>" + NL + "</dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C1.html", "<dl>" + NL + "<dt><span class=\"strong\">Since:</span>" + |
| "</dt>" + NL + "<dd>JDK1.0</dd>" + NL + "<dt><span class=\"strong\">See Also:" + |
| "</span></dt>" + NL + "<dd><a href=\"../pkg1/C2.html\" title=\"class in pkg1\">" + |
| "<code>C2</code></a>, " + NL + "<a href=\"../serialized-form.html#pkg1.C1\">" + |
| "Serialized Form</a></dd>" + NL + "</dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C1.html", "<dl>" + NL + "<dt><span class=\"strong\">Parameters:" + |
| "</span></dt>" + NL + "<dd><code>title</code> - the title</dd>" + NL + "<dd><code>" + |
| "test</code> - boolean value</dd>" + NL + "<dt><span class=\"strong\">Throws:" + |
| "</span></dt>" + NL + "<dd><code>java.lang.IllegalArgumentException" + |
| "</code> - if the <code>owner</code>'s" + NL + " <code>GraphicsConfiguration" + |
| "</code> is not from a screen device</dd>" + NL + "<dd><code>" + |
| "HeadlessException</code></dd>" + NL + "</dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C1.html", "<dl>" + NL + "<dt><span class=\"strong\">Parameters:" + |
| "</span></dt>" + NL + "<dd><code>undecorated</code> - <code>true</code>" + |
| " if no decorations are" + NL + " to be enabled;" + NL + |
| " <code>false</code> if decorations are to be enabled." + |
| "</dd>" + NL + "<dt><span class=\"strong\">Since:</span></dt>" + NL + "<dd>1.4</dd>" + NL + |
| "<dt><span class=\"strong\">See Also:</span></dt>" + NL + "<dd><a href=\"../pkg1/C1.html#readObject()\">" + |
| "<code>readObject()</code></a></dd>" + NL + "</dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C1.html", "<dl>" + NL + "<dt><span class=\"strong\">Throws:</span>" + |
| "</dt>" + NL + "<dd><code>java.io.IOException</code></dd>" + NL + "<dt>" + |
| "<span class=\"strong\">See Also:</span></dt>" + NL + "<dd><a href=\"../pkg1/C1.html#setUndecorated(boolean)\">" + |
| "<code>setUndecorated(boolean)</code></a></dd>" + NL + "</dl>"}, |
| {BUG_ID + FS + "serialized-form.html", "<dl>" + NL + "<dt><span class=\"strong\">Throws:</span>" + |
| "</dt>" + NL + "<dd><code>" + |
| "java.io.IOException</code></dd>" + NL + "<dt><span class=\"strong\">See Also:</span>" + |
| "</dt>" + NL + "<dd><a href=\"pkg1/C1.html#setUndecorated(boolean)\">" + |
| "<code>C1.setUndecorated(boolean)</code></a></dd>" + NL + "</dl>"}, |
| {BUG_ID + FS + "serialized-form.html", "<span class=\"strong\">Deprecated.</span>" + |
| " <i>As of JDK version 1.5, replaced by" + NL + |
| " <a href=\"pkg1/C1.html#setUndecorated(boolean)\">" + |
| "<code>setUndecorated(boolean)</code></a>.</i></div>" + NL + |
| "<div class=\"block\">This field indicates whether the C1 is " + |
| "undecorated.</div>" + NL + " " + NL + "<dl>" + NL + "<dt><span class=\"strong\">Since:</span></dt>" + NL + |
| "<dd>1.4</dd>" + NL + "<dt><span class=\"strong\">See Also:</span>" + |
| "</dt>" + NL + "<dd><a href=\"pkg1/C1.html#setUndecorated(boolean)\">" + |
| "<code>C1.setUndecorated(boolean)</code></a></dd>" + NL + "</dl>"}, |
| {BUG_ID + FS + "serialized-form.html", "<span class=\"strong\">Deprecated.</span>" + |
| " <i>As of JDK version 1.5, replaced by" + NL + |
| " <a href=\"pkg1/C1.html#setUndecorated(boolean)\">" + |
| "<code>setUndecorated(boolean)</code></a>.</i></div>" + NL + |
| "<div class=\"block\">Reads the object stream.</div>" + NL + |
| "<dl>" + NL + "<dt><span class=\"strong\">Throws:" + |
| "</span></dt>" + NL + "<dd><code><code>" + |
| "IOException</code></code></dd>" + NL + |
| "<dd><code>java.io.IOException</code></dd>" + NL + "</dl>"}, |
| {BUG_ID + FS + "serialized-form.html", "<span class=\"strong\">Deprecated.</span>" + |
| " </div>" + NL + "<div class=\"block\">" + |
| "The name for this class.</div>"}}; |
| |
| // Test with -nocomment and -nodeprecated options. The ClassDocs whould |
| // not display definition lists for any member details. |
| private static final String[][] TEST_NOCMNT_NODEPR = { |
| {BUG_ID + FS + "pkg1" + FS + "C1.html", "<pre>public void readObject()" + NL + |
| " throws java.io.IOException</pre>" + NL + "</li>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C2.html", "<pre>public C2()</pre>" + NL + |
| "</li>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C1.ModalExclusionType.html", "<pre>public " + |
| "static final <a href=\"../pkg1/C1.ModalExclusionType.html\" " + |
| "title=\"enum in pkg1\">C1.ModalExclusionType</a> " + |
| "APPLICATION_EXCLUDE</pre>" + NL + "</li>"}, |
| {BUG_ID + FS + "serialized-form.html", "<pre>boolean " + |
| "undecorated</pre>" + NL + "<div class=\"block\"><span class=\"strong\">" + |
| "Deprecated.</span> <i>As of JDK version 1.5, replaced by" + NL + |
| " <a href=\"pkg1/C1.html#setUndecorated(boolean)\"><code>" + |
| "setUndecorated(boolean)</code></a>.</i></div>" + NL + "</li>"}, |
| {BUG_ID + FS + "serialized-form.html", "<span class=\"strong\">" + |
| "Deprecated.</span> <i>As of JDK version" + |
| " 1.5, replaced by" + NL + |
| " <a href=\"pkg1/C1.html#setUndecorated(boolean)\">" + |
| "<code>setUndecorated(boolean)</code></a>.</i></div>" + NL + "</li>"}}; |
| |
| // Test for valid HTML generation which should not comprise of empty |
| // definition list tags. |
| private static final String[][] NEGATED_TEST = { |
| {BUG_ID + FS + "pkg1" + FS + "package-summary.html", "<dl></dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "package-summary.html", "<dl>" + NL + "</dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C1.html", "<dl></dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C1.html", "<dl>" + NL + "</dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C1.ModalExclusionType.html", "<dl></dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C1.ModalExclusionType.html", "<dl>" + NL + "</dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C2.html", "<dl></dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C2.html", "<dl>" + NL + "</dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C2.ModalType.html", "<dl></dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C2.ModalType.html", "<dl>" + NL + "</dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C3.html", "<dl></dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C3.html", "<dl>" + NL + "</dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C4.html", "<dl></dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C4.html", "<dl>" + NL + "</dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C5.html", "<dl></dl>"}, |
| {BUG_ID + FS + "pkg1" + FS + "C5.html", "<dl>" + NL + "</dl>"}, |
| {BUG_ID + FS + "overview-tree.html", "<dl></dl>"}, |
| {BUG_ID + FS + "overview-tree.html", "<dl>" + NL + "</dl>"}, |
| {BUG_ID + FS + "serialized-form.html", "<dl></dl>"}, |
| {BUG_ID + FS + "serialized-form.html", "<dl>" + NL + "</dl>"}}; |
| |
| private static final String[] ARGS1 = |
| new String[] { |
| "-Xdoclint:none", "-d", BUG_ID, "-sourcepath", SRC_DIR, "pkg1"}; |
| |
| private static final String[] ARGS2 = |
| new String[] { |
| "-Xdoclint:none", "-d", BUG_ID, "-nocomment", "-sourcepath", SRC_DIR, "pkg1"}; |
| |
| private static final String[] ARGS3 = |
| new String[] { |
| "-Xdoclint:none", "-d", BUG_ID, "-nodeprecated", "-sourcepath", SRC_DIR, "pkg1"}; |
| |
| private static final String[] ARGS4 = |
| new String[] { |
| "-Xdoclint:none", "-d", BUG_ID, "-nocomment", "-nodeprecated", "-sourcepath", SRC_DIR, "pkg1"}; |
| |
| /** |
| * The entry point of the test. |
| * @param args the array of command line arguments. |
| */ |
| public static void main(String[] args) { |
| TestHtmlDefinitionListTag tester = new TestHtmlDefinitionListTag(); |
| tester.exactNewlineMatch = false; |
| run(tester, ARGS1, TEST_ALL, NEGATED_TEST); |
| run(tester, ARGS1, TEST_CMNT_DEPR, NEGATED_TEST); |
| run(tester, ARGS2, TEST_ALL, NEGATED_TEST); |
| run(tester, ARGS2, NO_TEST, TEST_CMNT_DEPR); |
| run(tester, ARGS3, TEST_ALL, NEGATED_TEST); |
| run(tester, ARGS3, TEST_NODEPR, TEST_NOCMNT_NODEPR); |
| run(tester, ARGS4, TEST_ALL, NEGATED_TEST); |
| run(tester, ARGS4, TEST_NOCMNT_NODEPR, TEST_CMNT_DEPR); |
| tester.printSummary(); |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public String getBugId() { |
| return BUG_ID; |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public String getBugName() { |
| return getClass().getName(); |
| } |
| } |
