changeset 14366:af625e568667

8001929: fix doclint errors in langtools doc comments Reviewed-by: darcy
author jjg
date Tue, 30 Oct 2012 10:15:19 -0700
parents 20f388573215
children c890ac2d9641
files langtools/src/share/classes/com/sun/tools/doclets/formats/html/HtmlDocletWriter.java langtools/src/share/classes/com/sun/tools/doclets/formats/html/SplitIndexWriter.java langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlDocWriter.java langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlWriter.java langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/DocPath.java langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/SourcePath.java langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/Util.java langtools/src/share/classes/com/sun/tools/javac/code/TypeTag.java langtools/src/share/classes/com/sun/tools/javac/comp/Attr.java
diffstat 9 files changed, 7 insertions(+), 25 deletions(-) [+]
line wrap: on
line diff
--- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/HtmlDocletWriter.java	Mon Oct 29 10:39:49 2012 -0700
+++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/HtmlDocletWriter.java	Tue Oct 30 10:15:19 2012 -0700
@@ -860,8 +860,7 @@
     }
 
     /**
-     * Return the path to the class page for a classdoc. Works same as
-     * {@link #pathToClass(ClassDoc)}.
+     * Return the path to the class page for a classdoc.
      *
      * @param cd   Class to which the path is requested.
      * @param name Name of the file(doesn't include path).
--- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/SplitIndexWriter.java	Mon Oct 29 10:39:49 2012 -0700
+++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/SplitIndexWriter.java	Tue Oct 30 10:15:19 2012 -0700
@@ -62,8 +62,6 @@
      * from this file.
      *
      * @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}
      */
     public SplitIndexWriter(ConfigurationImpl configuration,
--- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlDocWriter.java	Mon Oct 29 10:39:49 2012 -0700
+++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlDocWriter.java	Tue Oct 30 10:15:19 2012 -0700
@@ -75,8 +75,6 @@
      * Return Html Hyper Link string.
      *
      * @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 strong       Boolean that sets label to strong.
      * @return String    Hyper Link.
@@ -95,8 +93,6 @@
      * Get Html Hyper Link string.
      *
      * @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 strong       Boolean that sets label to strong.
      * @param stylename  String style of text defined in style sheet.
@@ -131,8 +127,6 @@
      * Get Html Hyper Link string.
      *
      * @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.
      * @return a content tree for the hyper link
      */
@@ -150,8 +144,6 @@
      * Get Html Hyper Link string.
      *
      * @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 strong       Boolean that sets label to strong.
      * @param stylename  String style of text defined in style sheet.
@@ -201,8 +193,6 @@
      * Get Html Hyper Link.
      *
      * @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 title      String that describes the link's content for accessibility.
      * @param target     Target frame.
--- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlWriter.java	Mon Oct 29 10:39:49 2012 -0700
+++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlWriter.java	Tue Oct 30 10:15:19 2012 -0700
@@ -149,14 +149,12 @@
      *
      * @param path The directory path to be created for this file
      *             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
      * to next level.
      * @exception UnsupportedEncodingException Exception raised by the
      * OutputStreamWriter is passed on to next level.
      */
-    public HtmlWriter(Configuration configuration,DocPath path)
+    public HtmlWriter(Configuration configuration, DocPath path)
             throws IOException, UnsupportedEncodingException {
         writer = Util.genWriter(configuration, path);
         this.configuration = configuration;
--- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/DocPath.java	Mon Oct 29 10:39:49 2012 -0700
+++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/DocPath.java	Tue Oct 30 10:15:19 2012 -0700
@@ -114,13 +114,13 @@
         path = (p.endsWith("/") ? p.substring(0, p.length() - 1) : p);
     }
 
-    /** @inheritDoc */
+    /** {@inheritDoc} */
     @Override
     public boolean equals(Object other) {
         return (other instanceof DocPath) && path.equals(((DocPath)other).path);
     }
 
-    /** @inheritDoc */
+    /** {@inheritDoc} */
     @Override
     public int hashCode() {
         return path.hashCode();
--- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/SourcePath.java	Mon Oct 29 10:39:49 2012 -0700
+++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/SourcePath.java	Tue Oct 30 10:15:19 2012 -0700
@@ -110,7 +110,7 @@
     /**
      * 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.
      */
     public File getDirectory(DocPath p) {
--- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/Util.java	Mon Oct 29 10:39:49 2012 -0700
+++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/Util.java	Tue Oct 30 10:15:19 2012 -0700
@@ -397,7 +397,7 @@
      * "java" and then "java/applet" if they don't exist. The file separator
      * string "/" is platform dependent system property.
      *
-     * @param path Directory path string.
+     * @param dir Directory path string.
      */
     public static void createDirectory(Configuration configuration, File dir) {
         if (dir == null) {
@@ -643,8 +643,6 @@
      * FileOutputStream and OutputStreamWriter depending upon docencoding.
      *
      * @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
      * to next level.
      * @exception UnsupportedEncodingException Exception raised by the
--- a/langtools/src/share/classes/com/sun/tools/javac/code/TypeTag.java	Mon Oct 29 10:39:49 2012 -0700
+++ b/langtools/src/share/classes/com/sun/tools/javac/code/TypeTag.java	Tue Oct 30 10:15:19 2012 -0700
@@ -106,7 +106,7 @@
      */
     DEFERRED,
 
-    /** The tag of the bottom type <null>.
+    /** The tag of the bottom type {@code <null>}.
      */
     BOT,
 
--- a/langtools/src/share/classes/com/sun/tools/javac/comp/Attr.java	Mon Oct 29 10:39:49 2012 -0700
+++ b/langtools/src/share/classes/com/sun/tools/javac/comp/Attr.java	Tue Oct 30 10:15:19 2012 -0700
@@ -227,7 +227,6 @@
      *  are correct.
      *
      *  @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 resultInfo  The expected result of the tree
      */