提交 13aed9b5 编写于 作者: J jjg

8001929: fix doclint errors in langtools doc comments

Reviewed-by: darcy
上级 33e96c31
...@@ -860,8 +860,7 @@ public class HtmlDocletWriter extends HtmlDocWriter { ...@@ -860,8 +860,7 @@ public class HtmlDocletWriter extends HtmlDocWriter {
} }
/** /**
* Return the path to the class page for a classdoc. Works same as * Return the path to the class page for a classdoc.
* {@link #pathToClass(ClassDoc)}.
* *
* @param cd Class to which the path is requested. * @param cd Class to which the path is requested.
* @param name Name of the file(doesn't include path). * @param name Name of the file(doesn't include path).
......
...@@ -62,8 +62,6 @@ public class SplitIndexWriter extends AbstractIndexWriter { ...@@ -62,8 +62,6 @@ public class SplitIndexWriter extends AbstractIndexWriter {
* from this file. * from this file.
* *
* @param path Path to the file which is getting generated. * @param path Path to the file which is getting generated.
* @param filename Name of the file which is getting genrated.
* @param relpath Relative path from this file to the current directory.
* @param indexbuilder Unicode based Index from {@link IndexBuilder} * @param indexbuilder Unicode based Index from {@link IndexBuilder}
*/ */
public SplitIndexWriter(ConfigurationImpl configuration, public SplitIndexWriter(ConfigurationImpl configuration,
......
...@@ -75,8 +75,6 @@ public abstract class HtmlDocWriter extends HtmlWriter { ...@@ -75,8 +75,6 @@ public abstract class HtmlDocWriter extends HtmlWriter {
* Return Html Hyper Link string. * Return Html Hyper Link string.
* *
* @param link String name of the file. * @param link String name of the file.
* @param where Position of the link in the file. Character '#' is not
* needed.
* @param label Tag for the link. * @param label Tag for the link.
* @param strong Boolean that sets label to strong. * @param strong Boolean that sets label to strong.
* @return String Hyper Link. * @return String Hyper Link.
...@@ -95,8 +93,6 @@ public abstract class HtmlDocWriter extends HtmlWriter { ...@@ -95,8 +93,6 @@ public abstract class HtmlDocWriter extends HtmlWriter {
* Get Html Hyper Link string. * Get Html Hyper Link string.
* *
* @param link String name of the file. * @param link String name of the file.
* @param where Position of the link in the file. Character '#' is not
* needed.
* @param label Tag for the link. * @param label Tag for the link.
* @param strong Boolean that sets label to strong. * @param strong Boolean that sets label to strong.
* @param stylename String style of text defined in style sheet. * @param stylename String style of text defined in style sheet.
...@@ -131,8 +127,6 @@ public abstract class HtmlDocWriter extends HtmlWriter { ...@@ -131,8 +127,6 @@ public abstract class HtmlDocWriter extends HtmlWriter {
* Get Html Hyper Link string. * Get Html Hyper Link string.
* *
* @param link String name of the file. * @param link String name of the file.
* @param where Position of the link in the file. Character '#' is not
* needed.
* @param label Tag for the link. * @param label Tag for the link.
* @return a content tree for the hyper link * @return a content tree for the hyper link
*/ */
...@@ -150,8 +144,6 @@ public abstract class HtmlDocWriter extends HtmlWriter { ...@@ -150,8 +144,6 @@ public abstract class HtmlDocWriter extends HtmlWriter {
* Get Html Hyper Link string. * Get Html Hyper Link string.
* *
* @param link String name of the file. * @param link String name of the file.
* @param where Position of the link in the file. Character '#' is not
* needed.
* @param label Tag for the link. * @param label Tag for the link.
* @param strong Boolean that sets label to strong. * @param strong Boolean that sets label to strong.
* @param stylename String style of text defined in style sheet. * @param stylename String style of text defined in style sheet.
...@@ -201,8 +193,6 @@ public abstract class HtmlDocWriter extends HtmlWriter { ...@@ -201,8 +193,6 @@ public abstract class HtmlDocWriter extends HtmlWriter {
* Get Html Hyper Link. * Get Html Hyper Link.
* *
* @param link String name of the file. * @param link String name of the file.
* @param where Position of the link in the file. Character '#' is not
* needed.
* @param label Tag for the link. * @param label Tag for the link.
* @param title String that describes the link's content for accessibility. * @param title String that describes the link's content for accessibility.
* @param target Target frame. * @param target Target frame.
......
...@@ -149,14 +149,12 @@ public class HtmlWriter { ...@@ -149,14 +149,12 @@ public class HtmlWriter {
* *
* @param path The directory path to be created for this file * @param path The directory path to be created for this file
* or null if none to be created. * or null if none to be created.
* @param filename File Name to which the PrintWriter will
* do the Output.
* @exception IOException Exception raised by the FileWriter is passed on * @exception IOException Exception raised by the FileWriter is passed on
* to next level. * to next level.
* @exception UnsupportedEncodingException Exception raised by the * @exception UnsupportedEncodingException Exception raised by the
* OutputStreamWriter is passed on to next level. * OutputStreamWriter is passed on to next level.
*/ */
public HtmlWriter(Configuration configuration,DocPath path) public HtmlWriter(Configuration configuration, DocPath path)
throws IOException, UnsupportedEncodingException { throws IOException, UnsupportedEncodingException {
writer = Util.genWriter(configuration, path); writer = Util.genWriter(configuration, path);
this.configuration = configuration; this.configuration = configuration;
......
...@@ -114,13 +114,13 @@ public class DocPath { ...@@ -114,13 +114,13 @@ public class DocPath {
path = (p.endsWith("/") ? p.substring(0, p.length() - 1) : p); path = (p.endsWith("/") ? p.substring(0, p.length() - 1) : p);
} }
/** @inheritDoc */ /** {@inheritDoc} */
@Override @Override
public boolean equals(Object other) { public boolean equals(Object other) {
return (other instanceof DocPath) && path.equals(((DocPath)other).path); return (other instanceof DocPath) && path.equals(((DocPath)other).path);
} }
/** @inheritDoc */ /** {@inheritDoc} */
@Override @Override
public int hashCode() { public int hashCode() {
return path.hashCode(); return path.hashCode();
......
...@@ -110,7 +110,7 @@ public class SourcePath { ...@@ -110,7 +110,7 @@ public class SourcePath {
/** /**
* Find the specified directory in the source path. * Find the specified directory in the source path.
* *
* @param name Name of the directory to be searched for in the source path. * @param p Name of the directory to be searched for in the source path.
* @return File Return the directory if found else return null. * @return File Return the directory if found else return null.
*/ */
public File getDirectory(DocPath p) { public File getDirectory(DocPath p) {
......
...@@ -397,7 +397,7 @@ public class Util { ...@@ -397,7 +397,7 @@ public class Util {
* "java" and then "java/applet" if they don't exist. The file separator * "java" and then "java/applet" if they don't exist. The file separator
* string "/" is platform dependent system property. * string "/" is platform dependent system property.
* *
* @param path Directory path string. * @param dir Directory path string.
*/ */
public static void createDirectory(Configuration configuration, File dir) { public static void createDirectory(Configuration configuration, File dir) {
if (dir == null) { if (dir == null) {
...@@ -643,8 +643,6 @@ public class Util { ...@@ -643,8 +643,6 @@ public class Util {
* FileOutputStream and OutputStreamWriter depending upon docencoding. * FileOutputStream and OutputStreamWriter depending upon docencoding.
* *
* @param path The directory path to be created for this file. * @param path The directory path to be created for this file.
* @param filename File Name to which the PrintWriter will do the Output.
* @param docencoding Encoding to be used for this file.
* @exception IOException Exception raised by the FileWriter is passed on * @exception IOException Exception raised by the FileWriter is passed on
* to next level. * to next level.
* @exception UnsupportedEncodingException Exception raised by the * @exception UnsupportedEncodingException Exception raised by the
......
...@@ -106,7 +106,7 @@ public enum TypeTag { ...@@ -106,7 +106,7 @@ public enum TypeTag {
*/ */
DEFERRED, DEFERRED,
/** The tag of the bottom type <null>. /** The tag of the bottom type {@code <null>}.
*/ */
BOT, BOT,
......
...@@ -227,7 +227,6 @@ public class Attr extends JCTree.Visitor { ...@@ -227,7 +227,6 @@ public class Attr extends JCTree.Visitor {
* are correct. * are correct.
* *
* @param tree The tree whose kind and type is checked * @param tree The tree whose kind and type is checked
* @param owntype The computed type of the tree
* @param ownkind The computed kind of the tree * @param ownkind The computed kind of the tree
* @param resultInfo The expected result of the tree * @param resultInfo The expected result of the tree
*/ */
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册