Tue, 30 Oct 2012 10:15:19 -0700
8001929: fix doclint errors in langtools doc comments
Reviewed-by: darcy
1.1 --- a/src/share/classes/com/sun/tools/doclets/formats/html/HtmlDocletWriter.java Mon Oct 29 10:39:49 2012 -0700 1.2 +++ b/src/share/classes/com/sun/tools/doclets/formats/html/HtmlDocletWriter.java Tue Oct 30 10:15:19 2012 -0700 1.3 @@ -860,8 +860,7 @@ 1.4 } 1.5 1.6 /** 1.7 - * Return the path to the class page for a classdoc. Works same as 1.8 - * {@link #pathToClass(ClassDoc)}. 1.9 + * Return the path to the class page for a classdoc. 1.10 * 1.11 * @param cd Class to which the path is requested. 1.12 * @param name Name of the file(doesn't include path).
2.1 --- a/src/share/classes/com/sun/tools/doclets/formats/html/SplitIndexWriter.java Mon Oct 29 10:39:49 2012 -0700 2.2 +++ b/src/share/classes/com/sun/tools/doclets/formats/html/SplitIndexWriter.java Tue Oct 30 10:15:19 2012 -0700 2.3 @@ -62,8 +62,6 @@ 2.4 * from this file. 2.5 * 2.6 * @param path Path to the file which is getting generated. 2.7 - * @param filename Name of the file which is getting genrated. 2.8 - * @param relpath Relative path from this file to the current directory. 2.9 * @param indexbuilder Unicode based Index from {@link IndexBuilder} 2.10 */ 2.11 public SplitIndexWriter(ConfigurationImpl configuration,
3.1 --- a/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlDocWriter.java Mon Oct 29 10:39:49 2012 -0700 3.2 +++ b/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlDocWriter.java Tue Oct 30 10:15:19 2012 -0700 3.3 @@ -75,8 +75,6 @@ 3.4 * Return Html Hyper Link string. 3.5 * 3.6 * @param link String name of the file. 3.7 - * @param where Position of the link in the file. Character '#' is not 3.8 - * needed. 3.9 * @param label Tag for the link. 3.10 * @param strong Boolean that sets label to strong. 3.11 * @return String Hyper Link. 3.12 @@ -95,8 +93,6 @@ 3.13 * Get Html Hyper Link string. 3.14 * 3.15 * @param link String name of the file. 3.16 - * @param where Position of the link in the file. Character '#' is not 3.17 - * needed. 3.18 * @param label Tag for the link. 3.19 * @param strong Boolean that sets label to strong. 3.20 * @param stylename String style of text defined in style sheet. 3.21 @@ -131,8 +127,6 @@ 3.22 * Get Html Hyper Link string. 3.23 * 3.24 * @param link String name of the file. 3.25 - * @param where Position of the link in the file. Character '#' is not 3.26 - * needed. 3.27 * @param label Tag for the link. 3.28 * @return a content tree for the hyper link 3.29 */ 3.30 @@ -150,8 +144,6 @@ 3.31 * Get Html Hyper Link string. 3.32 * 3.33 * @param link String name of the file. 3.34 - * @param where Position of the link in the file. Character '#' is not 3.35 - * needed. 3.36 * @param label Tag for the link. 3.37 * @param strong Boolean that sets label to strong. 3.38 * @param stylename String style of text defined in style sheet. 3.39 @@ -201,8 +193,6 @@ 3.40 * Get Html Hyper Link. 3.41 * 3.42 * @param link String name of the file. 3.43 - * @param where Position of the link in the file. Character '#' is not 3.44 - * needed. 3.45 * @param label Tag for the link. 3.46 * @param title String that describes the link's content for accessibility. 3.47 * @param target Target frame.
4.1 --- a/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlWriter.java Mon Oct 29 10:39:49 2012 -0700 4.2 +++ b/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlWriter.java Tue Oct 30 10:15:19 2012 -0700 4.3 @@ -149,14 +149,12 @@ 4.4 * 4.5 * @param path The directory path to be created for this file 4.6 * or null if none to be created. 4.7 - * @param filename File Name to which the PrintWriter will 4.8 - * do the Output. 4.9 * @exception IOException Exception raised by the FileWriter is passed on 4.10 * to next level. 4.11 * @exception UnsupportedEncodingException Exception raised by the 4.12 * OutputStreamWriter is passed on to next level. 4.13 */ 4.14 - public HtmlWriter(Configuration configuration,DocPath path) 4.15 + public HtmlWriter(Configuration configuration, DocPath path) 4.16 throws IOException, UnsupportedEncodingException { 4.17 writer = Util.genWriter(configuration, path); 4.18 this.configuration = configuration;
5.1 --- a/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/DocPath.java Mon Oct 29 10:39:49 2012 -0700 5.2 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/DocPath.java Tue Oct 30 10:15:19 2012 -0700 5.3 @@ -114,13 +114,13 @@ 5.4 path = (p.endsWith("/") ? p.substring(0, p.length() - 1) : p); 5.5 } 5.6 5.7 - /** @inheritDoc */ 5.8 + /** {@inheritDoc} */ 5.9 @Override 5.10 public boolean equals(Object other) { 5.11 return (other instanceof DocPath) && path.equals(((DocPath)other).path); 5.12 } 5.13 5.14 - /** @inheritDoc */ 5.15 + /** {@inheritDoc} */ 5.16 @Override 5.17 public int hashCode() { 5.18 return path.hashCode();
6.1 --- a/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/SourcePath.java Mon Oct 29 10:39:49 2012 -0700 6.2 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/SourcePath.java Tue Oct 30 10:15:19 2012 -0700 6.3 @@ -110,7 +110,7 @@ 6.4 /** 6.5 * Find the specified directory in the source path. 6.6 * 6.7 - * @param name Name of the directory to be searched for in the source path. 6.8 + * @param p Name of the directory to be searched for in the source path. 6.9 * @return File Return the directory if found else return null. 6.10 */ 6.11 public File getDirectory(DocPath p) {
7.1 --- a/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/Util.java Mon Oct 29 10:39:49 2012 -0700 7.2 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/Util.java Tue Oct 30 10:15:19 2012 -0700 7.3 @@ -397,7 +397,7 @@ 7.4 * "java" and then "java/applet" if they don't exist. The file separator 7.5 * string "/" is platform dependent system property. 7.6 * 7.7 - * @param path Directory path string. 7.8 + * @param dir Directory path string. 7.9 */ 7.10 public static void createDirectory(Configuration configuration, File dir) { 7.11 if (dir == null) { 7.12 @@ -643,8 +643,6 @@ 7.13 * FileOutputStream and OutputStreamWriter depending upon docencoding. 7.14 * 7.15 * @param path The directory path to be created for this file. 7.16 - * @param filename File Name to which the PrintWriter will do the Output. 7.17 - * @param docencoding Encoding to be used for this file. 7.18 * @exception IOException Exception raised by the FileWriter is passed on 7.19 * to next level. 7.20 * @exception UnsupportedEncodingException Exception raised by the
8.1 --- a/src/share/classes/com/sun/tools/javac/code/TypeTag.java Mon Oct 29 10:39:49 2012 -0700 8.2 +++ b/src/share/classes/com/sun/tools/javac/code/TypeTag.java Tue Oct 30 10:15:19 2012 -0700 8.3 @@ -106,7 +106,7 @@ 8.4 */ 8.5 DEFERRED, 8.6 8.7 - /** The tag of the bottom type <null>. 8.8 + /** The tag of the bottom type {@code <null>}. 8.9 */ 8.10 BOT, 8.11
9.1 --- a/src/share/classes/com/sun/tools/javac/comp/Attr.java Mon Oct 29 10:39:49 2012 -0700 9.2 +++ b/src/share/classes/com/sun/tools/javac/comp/Attr.java Tue Oct 30 10:15:19 2012 -0700 9.3 @@ -227,7 +227,6 @@ 9.4 * are correct. 9.5 * 9.6 * @param tree The tree whose kind and type is checked 9.7 - * @param owntype The computed type of the tree 9.8 * @param ownkind The computed kind of the tree 9.9 * @param resultInfo The expected result of the tree 9.10 */