infernap12/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2026-03-19 04:13:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

8001929: fix doclint errors in langtools doc comments

Browse Source 
Reviewed-by: darcy
This commit is contained in:
Jonathan Gibbons 2012-10-30 10:15:19 -07:00
parent 7c26f7db54
commit 0777dc6caa
9 changed files with 7 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
langtools/src/share/classes/com/sun/tools/doclets/formats/html/HtmlDocletWriter.java
View File

@ -860,8 +860,7 @@ public class HtmlDocletWriter extends HtmlDocWriter {
}
/**
* 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).

2
langtools/src/share/classes/com/sun/tools/doclets/formats/html/SplitIndexWriter.java
View File

@ -62,8 +62,6 @@ public class SplitIndexWriter extends AbstractIndexWriter {
* 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,

10
langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlDocWriter.java
View File

@ -75,8 +75,6 @@ public abstract class HtmlDocWriter extends HtmlWriter {
* 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 @@ public abstract class HtmlDocWriter extends HtmlWriter {
* 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 @@ public abstract class HtmlDocWriter extends HtmlWriter {
* 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 @@ public abstract class HtmlDocWriter extends HtmlWriter {
* 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 @@ public abstract class HtmlDocWriter extends HtmlWriter {
* 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.

4
langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlWriter.java
View File

@ -149,14 +149,12 @@ public class HtmlWriter {
*
* @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;

4
langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/DocPath.java
View File

@ -114,13 +114,13 @@ public class DocPath {
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();

2
langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/SourcePath.java
View File

@ -110,7 +110,7 @@ public class SourcePath {
/**
* 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) {

4
langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/Util.java
View File

@ -397,7 +397,7 @@ public class Util {
* "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 @@ public class Util {
* 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

2
langtools/src/share/classes/com/sun/tools/javac/code/TypeTag.java
View File

@ -106,7 +106,7 @@ public enum TypeTag {
*/
DEFERRED,
/** The tag of the bottom type <null>.
/** The tag of the bottom type {@code <null>}.
*/
BOT,

1
langtools/src/share/classes/com/sun/tools/javac/comp/Attr.java
View File

@ -227,7 +227,6 @@ public class Attr extends JCTree.Visitor {
* 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
*/