stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

7006178: findbugs high priority issues in new javadoc

Browse Source 
Reviewed-by: jjg
This commit is contained in:
Bhavesh Patel 2011-03-11 15:39:51 -08:00
parent c6006bc605
commit 91cd6261bc
5 changed files with 91 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
langtools/src/share/classes/com/sun/tools/doclets/formats/html/ClassUseWriter.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1998, 2010, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1998, 2011, 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
@ -305,11 +305,7 @@ public class ClassUseWriter extends SubWriterHolderWriter {
tr.addContent(tdFirst);
HtmlTree tdLast = new HtmlTree(HtmlTag.TD);
tdLast.addStyle(HtmlStyle.colLast);
if (pkg != null) {
addSummaryComment(pkg, tdLast);
} else {
tdLast.addContent(getSpace());
}
addSummaryComment(pkg, tdLast);
tr.addContent(tdLast);
tbody.addContent(tr);
}
@ -355,10 +351,7 @@ public class ClassUseWriter extends SubWriterHolderWriter {
contentTree.addContent(tdFirst);
HtmlTree tdLast = new HtmlTree(HtmlTag.TD);
tdLast.addStyle(HtmlStyle.colLast);
if (pkg != null)
addSummaryComment(pkg, tdLast);
else
tdLast.addContent(getSpace());
addSummaryComment(pkg, tdLast);
contentTree.addContent(tdLast);
}

7
langtools/src/share/classes/com/sun/tools/doclets/formats/html/PackageUseWriter.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1998, 2010, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1998, 2011, 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
@ -246,10 +246,7 @@ public class PackageUseWriter extends SubWriterHolderWriter {
contentTree.addContent(tdFirst);
HtmlTree tdLast = new HtmlTree(HtmlTag.TD);
tdLast.addStyle(HtmlStyle.colLast);
if (pkg != null)
addSummaryComment(pkg, tdLast);
else
tdLast.addContent(getSpace());
addSummaryComment(pkg, tdLast);
contentTree.addContent(tdLast);
}

41
langtools/test/com/sun/javadoc/testUseOption/C.java Normal file
View File

@ -0,0 +1,41 @@
/*
* Copyright (c) 2011, 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.
*/
/**
* Class in an unnamed package.
*/
public class C {
/**
* Field in C.
*/
public UsedInC fieldInC;
/**
* Method in C.
*/
public UsedInC methodInC(UsedInC p) {
return p;
}
}

22
langtools/test/com/sun/javadoc/testUseOption/TestUseOption.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2002, 2004, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2002, 2011, 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
@ -23,7 +23,7 @@
/*
* @test
* @bug 4496290 4985072
* @bug 4496290 4985072 7006178
* @summary A simple test to determine if -use works.
* @author jamieh
* @library ../lib/
@ -34,7 +34,7 @@
public class TestUseOption extends JavadocTester {
private static final String BUG_ID = "4496290-4985072";
private static final String BUG_ID = "4496290-4985072-7006178";
//Input for string search tests.
private static final String[] TEST2 = {
@ -54,6 +54,16 @@ public class TestUseOption extends JavadocTester {
"Method in C8.",
};
private static final String[][] TEST3 = {
{BUG_ID + "-3" + FS + "class-use" + FS + "UsedInC.html", "Uses of <a href=" +
"\"../UsedInC.html\" title=\"class in &lt;Unnamed&gt;\">" +
"UsedInC</a> in <a href=\"../package-summary.html\">&lt;Unnamed&gt;</a>"
},
{BUG_ID + "-3" + FS + "package-use.html", "<td class=\"colOne\">" +
"<a href=\"class-use/UsedInC.html#&lt;Unnamed&gt;\">UsedInC</a>&nbsp;</td>"
}
};
private static final String[] ARGS = new String[] {
"-d", BUG_ID, "-sourcepath", SRC_DIR, "-use", "pkg1", "pkg2"
};
@ -62,6 +72,10 @@ public class TestUseOption extends JavadocTester {
"-d", BUG_ID+"-2", "-sourcepath", SRC_DIR, "-use", "pkg1", "pkg2"
};
private static final String[] ARGS3 = new String[] {
"-d", BUG_ID + "-3", "-sourcepath", SRC_DIR, "-use", SRC_DIR + FS + "C.java", SRC_DIR + FS + "UsedInC.java"
};
/**
* The entry point of the test.
* @param args the array of command line arguments.
@ -93,6 +107,8 @@ public class TestUseOption extends JavadocTester {
prevIndex = currentIndex;
}
tester.printSummary();
run(tester, ARGS3, TEST3, NO_TEST);
tester.printSummary();
}
/**

26
langtools/test/com/sun/javadoc/testUseOption/UsedInC.java Normal file
View File

@ -0,0 +1,26 @@
/*
* Copyright (c) 2011, 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.
*/
public class UsedInC
{
}