OpenJDK / jdk / jdk12
changeset 14259:fb94a1df0d53
8000208: fix langtools javadoc comment issues
Reviewed-by: bpatel, mcimadamore
line wrap: on
line diff
--- a/langtools/src/share/classes/com/sun/javadoc/Tag.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/javadoc/Tag.java Tue Oct 09 19:31:58 2012 -0700 @@ -70,14 +70,14 @@ * than one tag of a given kind: * <p> * <table border="1" cellpadding="4" cellspacing="0"> - * <tr><th><tt> kind() </th> <th><tt> name() </th></tr> - * <tr><td><tt> @throws </td> <td><tt> @throws </td></tr> - * <tr><td><tt> @throws </td> <td><tt> @exception </td></tr> - * <tr><td><tt> @see </td> <td><tt> @see </td></tr> - * <tr><td><tt> @see </td> <td><tt> @link </td></tr> - * <tr><td><tt> @see </td> <td><tt> @linkplain </td></tr> - * <tr><td><tt> @serial </td> <td><tt> @serial </td></tr> - * <tr><td><tt> @serial </td> <td><tt> @serialData </td></tr> + * <tr><th><tt> kind() </tt></th> <th><tt> name() </tt></th></tr> + * <tr><td><tt> @throws </tt></td> <td><tt> @throws </tt></td></tr> + * <tr><td><tt> @throws </tt></td> <td><tt> @exception </tt></td></tr> + * <tr><td><tt> @see </tt></td> <td><tt> @see </tt></td></tr> + * <tr><td><tt> @see </tt></td> <td><tt> @link </tt></td></tr> + * <tr><td><tt> @see </tt></td> <td><tt> @linkplain </tt></td></tr> + * <tr><td><tt> @serial </tt></td> <td><tt> @serial </tt></td></tr> + * <tr><td><tt> @serial </tt></td> <td><tt> @serialData </tt></td></tr> * </table> */ String kind();
--- a/langtools/src/share/classes/com/sun/tools/classfile/BootstrapMethods_attribute.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/classfile/BootstrapMethods_attribute.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2011, 2012, 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 @@ -28,8 +28,8 @@ import java.io.IOException; /** - * See JVMS <TBD> - * http://cr.openjdk.java.net/~jrose/pres/indy-javadoc-mlvm/ + * See JVMS 4.7.21 + * http://docs.oracle.com/javase/specs/jvms/se7/html/jvms-4.html#jvms-4.7.21 * * <p><b>This is NOT part of any supported API. * If you write code that depends on this, you do so at your own risk.
--- a/langtools/src/share/classes/com/sun/tools/classfile/Dependencies.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/classfile/Dependencies.java Tue Oct 09 19:31:58 2012 -0700 @@ -98,7 +98,7 @@ * Get the ClassFile object for a specified class. * @param className the name of the class to be returned. * @return the ClassFile for the given class - * @throws Dependencies#ClassFileNotFoundException if the classfile cannot be + * @throws Dependencies.ClassFileNotFoundException if the classfile cannot be * found */ public ClassFile getClassFile(String className)
--- a/langtools/src/share/classes/com/sun/tools/classfile/Instruction.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/classfile/Instruction.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2009, 2012, 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 @@ -103,7 +103,7 @@ R visitConstantPoolRefAndValue(Instruction instr, int index, int value, P p); /** See {@link Kind#LOCAL}. */ R visitLocal(Instruction instr, int index, P p); - /** See {@link Kind#LOCAL_UBYTE}. */ + /** See {@link Kind#LOCAL_BYTE}. */ R visitLocalAndValue(Instruction instr, int index, int value, P p); /** See {@link Kind#DYNAMIC}. */ R visitLookupSwitch(Instruction instr, int default_, int npairs, int[] matches, int[] offsets, P p);
--- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/AbstractExecutableMemberWriter.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/AbstractExecutableMemberWriter.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1997, 2012, 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 @@ -81,7 +81,7 @@ * Add the summary link for the member. * * @param context the id of the context where the link will be printed - * @param classDoc the classDoc that we should link to + * @param cd the classDoc that we should link to * @param member the member being linked to * @param tdSummary the content tree to which the link will be added */ @@ -101,7 +101,7 @@ /** * Add the inherited summary link for the member. * - * @param classDoc the classDoc that we should link to + * @param cd the classDoc that we should link to * @param member the member being linked to * @param linksTree the content tree to which the link will be added */ @@ -138,7 +138,7 @@ * Add all the parameters for the executable member. * * @param member the member to write parameters for. - * @param tree the content tree to which the parameters information will be added. + * @param htmltree the content tree to which the parameters information will be added. */ protected void addParameters(ExecutableMemberDoc member, Content htmltree) { addParameters(member, true, htmltree); @@ -149,7 +149,7 @@ * * @param member the member to write parameters for. * @param includeAnnotations true if annotation information needs to be added. - * @param tree the content tree to which the parameters information will be added. + * @param htmltree the content tree to which the parameters information will be added. */ protected void addParameters(ExecutableMemberDoc member, boolean includeAnnotations, Content htmltree) {
--- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/AbstractMemberWriter.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/AbstractMemberWriter.java Tue Oct 09 19:31:58 2012 -0700 @@ -365,7 +365,7 @@ * Add the comment for the given member. * * @param member the member being documented. - * @param contentTree the content tree to which the comment will be added. + * @param htmltree the content tree to which the comment will be added. */ protected void addComment(ProgramElementDoc member, Content htmltree) { if (member.inlineTags().length > 0) {
--- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/ConfigurationImpl.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/ConfigurationImpl.java Tue Oct 09 19:31:58 2012 -0700 @@ -188,8 +188,8 @@ // ClassWriter. /** - * Constructor. Initialises resource for the - * {@link com.sun.tools.doclets.MessageRetriever}. + * Constructor. Initializes resource for the + * {@link com.sun.tools.doclets.internal.toolkit.util.MessageRetriever MessageRetriever}. */ private ConfigurationImpl() { standardmessage = new MessageRetriever(this,
--- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/DeprecatedListWriter.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/DeprecatedListWriter.java Tue Oct 09 19:31:58 2012 -0700 @@ -208,7 +208,7 @@ * * @param builder the deprecated list builder * @param type the type of list being documented - * @param contentTree the content tree to which the anchor will be added + * @param htmlTree the content tree to which the anchor will be added */ private void addAnchor(DeprecatedAPIListBuilder builder, int type, Content htmlTree) { if (builder.hasDocumentation(type)) {
--- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/HtmlDocletWriter.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/HtmlDocletWriter.java Tue Oct 09 19:31:58 2012 -0700 @@ -1407,7 +1407,7 @@ /** * Returns a package name label. * - * @param parsedName the package name + * @param packageName the package name * @return the package name content */ public Content getPackageLabel(String packageName) { @@ -2635,7 +2635,7 @@ /** * Adds the annotatation types for the given doc. * - * @param packageDoc the package to write annotations for + * @param doc the package to write annotations for * @param htmltree the content tree to which the annotation types will be added */ public void addAnnotationInfo(ProgramElementDoc doc, Content htmltree) {
--- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/HtmlSerialFieldWriter.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/HtmlSerialFieldWriter.java Tue Oct 09 19:31:58 2012 -0700 @@ -121,10 +121,10 @@ /** * Add the member header. * - * @param fieldsType the class document to be listed - * @param fieldTypeStr the string for the filed type to be documented + * @param fieldType the class document to be listed + * @param fieldTypeStr the string for the field type to be documented * @param fieldDimensions the dimensions of the field string to be added - * @param firldName name of the field to be added + * @param fieldName name of the field to be added * @param contentTree the content tree to which the member header will be added */ public void addMemberHeader(ClassDoc fieldType, String fieldTypeStr,
--- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/LinkFactoryImpl.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/LinkFactoryImpl.java Tue Oct 09 19:31:58 2012 -0700 @@ -155,7 +155,6 @@ * "../../java/lang/Object.html" * * @param linkInfo the information about the link. - * @param fileName the file name, to which path string is. */ private String pathString(LinkInfoImpl linkInfo) { if (linkInfo.context == LinkInfoImpl.PACKAGE_FRAME) {
--- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/PackageIndexWriter.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/PackageIndexWriter.java Tue Oct 09 19:31:58 2012 -0700 @@ -229,7 +229,7 @@ * Adds the lower navigation bar and the bottom text * (from the -bottom option) at the bottom of page. * - * @param the documentation tree to which the navigation bar footer will be added + * @param body the documentation tree to which the navigation bar footer will be added */ protected void addNavigationBarFooter(Content body) { addNavLinks(false, body);
--- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/SerializedFormWriterImpl.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/SerializedFormWriterImpl.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 1998, 2010, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1998, 2012, 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 @@ -29,6 +29,7 @@ import com.sun.javadoc.*; import com.sun.tools.doclets.formats.html.markup.*; import com.sun.tools.doclets.internal.toolkit.*; +import com.sun.tools.doclets.internal.toolkit.util.DocletAbortException; /** * Generate the Serialized Form Information Page.
--- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlTree.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlTree.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2010, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2010, 2012, 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 @@ -423,9 +423,9 @@ /** * Generates a META tag with the http-equiv, content and charset attributes. * - * @param http-equiv http equiv attribute for the META tag + * @param httpEquiv http equiv attribute for the META tag * @param content type of content - * @param charset character set used + * @param charSet character set used * @return an HtmlTree object for the META tag */ public static HtmlTree META(String httpEquiv, String content, String charSet) {
--- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlWriter.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlWriter.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1997, 2012, 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 @@ -158,7 +158,7 @@ * @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 + * @exception UnsupportedEncodingException Exception raised by the * OutputStreamWriter is passed on to next level. */ public HtmlWriter(Configuration configuration,
--- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/EnumConstantWriter.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/EnumConstantWriter.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2003, 2012, 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 @@ -56,7 +56,7 @@ * Get the enum constants documentation tree header. * * @param enumConstant the enum constant being documented - * @param enumConstantDetailsTree the content tree representing enum constant details + * @param enumConstantsDetailsTree the content tree representing enum constant details * @return content tree for the enum constant documentation header */ public Content getEnumConstantsTreeHeader(FieldDoc enumConstant,
--- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/ConstantsSummaryBuilder.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/ConstantsSummaryBuilder.java Tue Oct 09 19:31:58 2012 -0700 @@ -346,7 +346,6 @@ /** * Return the list of visible constant fields for the given classdoc. - * @param cd the classdoc to examine. * @return the list of visible constant fields for the given classdoc. */ protected List<FieldDoc> members() {
--- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/MemberSummaryBuilder.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/MemberSummaryBuilder.java Tue Oct 09 19:31:58 2012 -0700 @@ -166,7 +166,6 @@ * This information can be used for doclet specific documentation * generation. * - * @param classDoc the {@link ClassDoc} we want to check. * @param type the type of members to return. * @return a list of methods that will be documented. * @see VisibleMemberMap
--- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/ParamTaglet.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/ParamTaglet.java Tue Oct 09 19:31:58 2012 -0700 @@ -183,7 +183,7 @@ * Given an array of <code>ParamTag</code>s,return its string representation. * Try to inherit the param tags that are missing. * - * @param doc the doc that holds the param tags. + * @param holder the doc that holds the param tags. * @param writer the TagletWriter that will write this tag. * @param formalParameters The array of parmeters (from type or executable * member) to check. @@ -256,7 +256,7 @@ * been documented. * @param rankMap a {@link java.util.Map} which holds ordering * information about the parameters. - * @param nameMap a {@link java.util.Map} which holds a mapping + * @param rankMap a {@link java.util.Map} which holds a mapping * of a rank of a parameter to its name. This is * used to ensure that the right name is used * when parameter documentation is inherited.
--- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/ValueTaglet.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/ValueTaglet.java Tue Oct 09 19:31:58 2012 -0700 @@ -108,7 +108,7 @@ * @param config the current configuration of the doclet. * @param tag the value tag. * @param name the name of the field to search for. The name should be in - * <qualified class name>#<field name> format. If the class name is omitted, + * {@code <qualified class name>#<field name>} format. If the class name is omitted, * it is assumed that the field is in the current class. * * @return the corresponding FieldDoc. If the name is null or empty string,
--- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/ClassDocCatalog.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/ClassDocCatalog.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2001, 2012, 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 @@ -184,7 +184,7 @@ /** * Return all of the classes specified on the command-line that * belong to the given package. - * @param packageDoc the package to return the classes for. + * @param pkgDoc the package to return the classes for. */ public ClassDoc[] allClasses(PackageDoc pkgDoc) { return pkgDoc.isIncluded() ?
--- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/DeprecatedAPIListBuilder.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/DeprecatedAPIListBuilder.java Tue Oct 09 19:31:58 2012 -0700 @@ -146,7 +146,7 @@ /** * Return the list of deprecated Doc objects of a given type. * - * @param the constant representing the type of list being returned. + * @param type the constant representing the type of list being returned. */ public List<Doc> getList(int type) { return deprecatedLists.get(type);
--- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/Extern.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/Extern.java Tue Oct 09 19:31:58 2012 -0700 @@ -91,7 +91,7 @@ * If the same package name is found in the map, then the first mapped * Item object or offline location will be retained. * - * @param packagename Package name found in the "package-list" file. + * @param packageName Package name found in the "package-list" file. * @param path URL or Directory path from where the "package-list" * file is picked. * @param relative True if path is URL, false if directory path. @@ -179,7 +179,7 @@ /** * Get the Extern Item object associated with this package name. * - * @param pkgname Package name. + * @param pkgName Package name. */ private Item findPackageItem(String pkgName) { if (packageToItemMap == null) {
--- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/VisibleMemberMap.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/VisibleMemberMap.java Tue Oct 09 19:31:58 2012 -0700 @@ -126,7 +126,7 @@ * Return the package private members inherited by the class. Only return * if parent is package private and not documented. * - * @param configuation the current configuration of the doclet. + * @param configuration the current configuration of the doclet. * @return the package private members inherited by the class. */ private List<ProgramElementDoc> getInheritedPackagePrivateMethods(Configuration configuration) { @@ -149,7 +149,7 @@ * end of the list members that are inherited by inaccessible parents. We * document these members in the child because the parent is not documented. * - * @param configuation the current configuration of the doclet. + * @param configuration the current configuration of the doclet. */ public List<ProgramElementDoc> getLeafClassMembers(Configuration configuration) { List<ProgramElementDoc> result = getMembersFor(classdoc);
--- a/langtools/src/share/classes/com/sun/tools/javac/api/DiagnosticFormatter.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/api/DiagnosticFormatter.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2009, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2008, 2012, 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 @@ -138,7 +138,7 @@ /** * Configure the set of diagnostic parts that should be displayed * by the formatter. - * @param options options to set + * @param visibleParts the parts to be set */ public void setVisible(Set<DiagnosticPart> visibleParts);
--- a/langtools/src/share/classes/com/sun/tools/javac/api/JavacTool.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/api/JavacTool.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2012, 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 @@ -66,7 +66,7 @@ * Constructor used by service provider mechanism. The recommended way to * obtain an instance of this class is by using {@link #create} or the * service provider mechanism. - * @see javax.tools.JavaCompilerTool + * @see javax.tools.JavaCompiler * @see javax.tools.ToolProvider * @see #create */
--- a/langtools/src/share/classes/com/sun/tools/javac/code/Printer.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/code/Printer.java Tue Oct 09 19:31:58 2012 -0700 @@ -124,7 +124,7 @@ /** * Get a localized string represenation for a given type. * - * @param ts type to be displayed + * @param t type to be displayed * @param locale the locale in which the string is to be rendered * @return localized string representation */ @@ -135,7 +135,7 @@ /** * Get a localized string represenation for a given symbol. * - * @param ts symbol to be displayed + * @param s symbol to be displayed * @param locale the locale in which the string is to be rendered * @return localized string representation */
--- a/langtools/src/share/classes/com/sun/tools/javac/code/Symtab.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/code/Symtab.java Tue Oct 09 19:31:58 2012 -0700 @@ -301,7 +301,7 @@ } /** Enter a class into symbol table. - * @param The name of the class. + * @param s The name of the class. */ private Type enterClass(String s) { return reader.enterClass(names.fromString(s)).type;
--- a/langtools/src/share/classes/com/sun/tools/javac/code/TypeTags.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/code/TypeTags.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 1999, 2005, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1999, 2012, 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 @@ -106,7 +106,7 @@ */ public static final int DEFERRED = FORALL+1; - /** The tag of the bottom type <null>. + /** The tag of the bottom type {@code <null>}. */ public static final int BOT = DEFERRED+1;
--- a/langtools/src/share/classes/com/sun/tools/javac/code/Types.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/code/Types.java Tue Oct 09 19:31:58 2012 -0700 @@ -1427,8 +1427,8 @@ * conservative in that it is allowed to say that two types are * not disjoint, even though they actually are. * - * The type C<X> is castable to C<Y> exactly if X and Y are not - * disjoint. + * The type {@code C<X>} is castable to {@code C<Y>} exactly if + * {@code X} and {@code Y} are not disjoint. */ public boolean disjointType(Type t, Type s) { return disjointType.visit(t, s); @@ -1523,7 +1523,7 @@ * something of type `t' can be a subtype of `s'? This is * different from the question "is `t' not a subtype of `s'?" * when type variables are involved: Integer is not a subtype of T - * where <T extends Number> but it is not true that Integer cannot + * where {@code <T extends Number>} but it is not true that Integer cannot * possibly be a subtype of T. */ public boolean notSoftSubtype(Type t, Type s) {
--- a/langtools/src/share/classes/com/sun/tools/javac/comp/Attr.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/comp/Attr.java Tue Oct 09 19:31:58 2012 -0700 @@ -740,7 +740,7 @@ * @param env The env for the const value * @param initializer The initializer for the const value * @param type The expected type, or null - * @see VarSymbol#setlazyConstValue + * @see VarSymbol#setLazyConstValue */ public Object attribLazyConstantValue(Env<AttrContext> env, JCTree.JCExpression initializer,
--- a/langtools/src/share/classes/com/sun/tools/javac/comp/Check.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/comp/Check.java Tue Oct 09 19:31:58 2012 -0700 @@ -230,7 +230,6 @@ /** Warn about unsafe vararg method decl. * @param pos Position to be used for error reporting. - * @param sym The deprecated symbol. */ void warnUnsafeVararg(DiagnosticPosition pos, String key, Object... args) { if (lint.isEnabled(LintCategory.VARARGS) && allowSimplifiedVarargs) @@ -397,7 +396,7 @@ **************************************************************************/ /** Return name of local class. - * This is of the form <enclClass> $ n <classname> + * This is of the form {@code <enclClass> $ n <classname> } * where * enclClass is the flat name of the enclosing class, * classname is the simple name of the local class @@ -600,11 +599,10 @@ /** Check that a type is within some bounds. * - * Used in TypeApply to verify that, e.g., X in V<X> is a valid + * Used in TypeApply to verify that, e.g., X in {@code V<X>} is a valid * type argument. - * @param pos Position to be used for error reporting. * @param a The type that should be bounded by bs. - * @param bs The bound. + * @param bound The bound. */ private boolean checkExtends(Type a, Type bound) { if (a.isUnbound()) { @@ -1262,8 +1260,10 @@ * their bounds. This must be done in a second phase after type attributon * since a class might have a subclass as type parameter bound. E.g: * + * <pre>{@code * class B<A extends C> { ... } * class C extends B<C> { ... } + * }</pre> * * and we can't make sure that the bound is already attributed because * of possible cycles. @@ -2574,7 +2574,7 @@ * 'pos'. * * @param s The (annotation)type declaration annotated with a @ContainedBy - * @param containerAnno the @ContainedBy on 's' + * @param containedBy the @ContainedBy on 's' * @param pos where to report errors */ public void validateContainedBy(TypeSymbol s, Attribute.Compound containedBy, DiagnosticPosition pos) { @@ -3181,7 +3181,6 @@ * @param pos Position for error reporting. * @param sym The symbol. * @param s The scope - * @param staticImport Whether or not this was a static import */ boolean checkUniqueStaticImport(DiagnosticPosition pos, Symbol sym, Scope s) { return checkUniqueImport(pos, sym, s, true);
--- a/langtools/src/share/classes/com/sun/tools/javac/comp/Flow.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/comp/Flow.java Tue Oct 09 19:31:58 2012 -0700 @@ -148,7 +148,7 @@ * exception to this [no pun intended] is that checked exceptions that * are known to be caught or declared to be caught in the enclosing * method are not recorded in the queue, but instead are recorded in a - * global variable "Set<Type> thrown" that records the type of all + * global variable "{@code Set<Type> thrown}" that records the type of all * exceptions that can be thrown. * * <p>Other minor issues the treatment of members of other classes
--- a/langtools/src/share/classes/com/sun/tools/javac/comp/Lower.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/comp/Lower.java Tue Oct 09 19:31:58 2012 -0700 @@ -671,7 +671,7 @@ }; /** Look up a synthetic name in a given scope. - * @param scope The scope. + * @param s The scope. * @param name The name. */ private Symbol lookupSynthetic(Name name, Scope s) { @@ -747,7 +747,7 @@ * This numbering scheme is used by the backend to decide whether * to issue an invokevirtual or invokespecial call. * - * @see Gen.visitSelect(Select tree) + * @see Gen#visitSelect(JCFieldAccess tree) */ private static final int DEREFcode = 0,
--- a/langtools/src/share/classes/com/sun/tools/javac/comp/MemberEnter.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/comp/MemberEnter.java Tue Oct 09 19:31:58 2012 -0700 @@ -128,8 +128,7 @@ /** Import all classes of a class or package on demand. * @param pos Position to be used for error reporting. * @param tsym The class or package the members of which are imported. - * @param toScope The (import) scope in which imported classes - * are entered. + * @param env The env in which the imported classes will be entered. */ private void importAll(int pos, final TypeSymbol tsym, @@ -150,8 +149,7 @@ /** Import all static members of a class or package on demand. * @param pos Position to be used for error reporting. * @param tsym The class or package the members of which are imported. - * @param toScope The (import) scope in which imported classes - * are entered. + * @param env The env in which the imported classes will be entered. */ private void importStaticAll(int pos, final TypeSymbol tsym,
--- a/langtools/src/share/classes/com/sun/tools/javac/comp/TransTypes.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/comp/TransTypes.java Tue Oct 09 19:31:58 2012 -0700 @@ -132,17 +132,21 @@ * Then, coerce to some given target type unless target type is null. * This operation is used in situations like the following: * + * <pre>{@code * class Cell<A> { A value; } * ... * Cell<Integer> cell; * Integer x = cell.value; + * }</pre> * * Since the erasure of Cell.value is Object, but the type * of cell.value in the assignment is Integer, we need to * adjust the original type of cell.value to Object, and insert * a cast to Integer. That is, the last assignment becomes: * + * <pre>{@code * Integer x = (Integer)cell.value; + * }</pre> * * @param tree The expression tree whose type might need adjustment. * @param erasedType The expression's type after erasure.
--- a/langtools/src/share/classes/com/sun/tools/javac/file/JavacFileManager.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/file/JavacFileManager.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2012, 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 @@ -805,8 +805,8 @@ } /** - * Enforces the specification of a "relative" URI as used in - * {@linkplain #getFileForInput(Location,String,URI) + * Enforces the specification of a "relative" name as used in + * {@linkplain #getFileForInput(Location,String,String) * getFileForInput}. This method must follow the rules defined in * that method, do not make any changes without consulting the * specification.
--- a/langtools/src/share/classes/com/sun/tools/javac/file/Locations.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/file/Locations.java Tue Oct 09 19:31:58 2012 -0700 @@ -53,13 +53,14 @@ import com.sun.tools.javac.util.Options; import javax.tools.JavaFileManager; +import javax.tools.StandardJavaFileManager; import static javax.tools.StandardLocation.*; import static com.sun.tools.javac.main.Option.*; /** This class converts command line arguments, environment variables * and system properties (in File.pathSeparator-separated String form) * into a boot class path, user class path, and source path (in - * Collection<String> form). + * {@code Collection<String>} form). * * <p><b>This is NOT part of any supported API. * If you write code that depends on this, you do so at your own risk. @@ -342,11 +343,11 @@ } } - /** @see JavaFileManager#handleOption. */ + /** @see JavaFileManager#handleOption */ abstract boolean handleOption(Option option, String value); - /** @see JavaFileManager#getLocation. */ + /** @see StandardJavaFileManager#getLocation */ abstract Collection<File> getLocation(); - /** @see JavaFileManager#setLocation. */ + /** @see StandardJavaFileManager#setLocation */ abstract void setLocation(Iterable<? extends File> files) throws IOException; }
--- a/langtools/src/share/classes/com/sun/tools/javac/file/ZipFileIndex.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/file/ZipFileIndex.java Tue Oct 09 19:31:58 2012 -0700 @@ -59,7 +59,7 @@ * the command line.) * * Location where to look for/generate optimized zip index files can be - * provided using "-XDcachezipindexdir=<directory>". If this flag is not + * provided using "{@code -XDcachezipindexdir=<directory>}". If this flag is not * provided, the default location is the value of the "java.io.tmpdir" system * property. *
--- a/langtools/src/share/classes/com/sun/tools/javac/jvm/Gen.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/jvm/Gen.java Tue Oct 09 19:31:58 2012 -0700 @@ -446,7 +446,7 @@ * Normalizing class-members. *************************************************************************/ - /** Distribute member initializer code into constructors and <clinit> + /** Distribute member initializer code into constructors and {@code <clinit>} * method. * @param defs The list of class member declarations. * @param c The enclosing class. @@ -689,7 +689,7 @@ * should be emitted, if so, put a new entry into CRTable * and call method to generate bytecode. * If not, just call method to generate bytecode. - * @see #genStat(Tree, Env) + * @see #genStat(JCTree, Env) * * @param tree The tree to be visited. * @param env The environment to use. @@ -756,7 +756,7 @@ * should be emitted, if so, put a new entry into CRTable * and call method to generate bytecode. * If not, just call method to generate bytecode. - * @see #genCond(Tree,boolean) + * @see #genCond(JCTree,boolean) * * @param tree The tree to be visited. * @param crtFlags The CharacterRangeTable flags
--- a/langtools/src/share/classes/com/sun/tools/javac/main/JavaCompiler.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/main/JavaCompiler.java Tue Oct 09 19:31:58 2012 -0700 @@ -607,7 +607,7 @@ /** Parse contents of input stream. * @param filename The name of the file from which input stream comes. - * @param input The input stream to be parsed. + * @param content The characters to be parsed. */ protected JCCompilationUnit parse(JavaFileObject filename, CharSequence content) { long msec = now(); @@ -755,8 +755,6 @@ /** Complete compiling a source file that has been accessed * by the class file reader. * @param c The class the source file of which needs to be compiled. - * @param filename The name of the source file. - * @param f An input stream that reads the source file. */ public void complete(ClassSymbol c) throws CompletionFailure { // System.err.println("completing " + c);//DEBUG
--- a/langtools/src/share/classes/com/sun/tools/javac/nio/PathFileManager.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/nio/PathFileManager.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2009, 2012, 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 @@ -27,13 +27,14 @@ import java.io.IOException; import java.nio.file.FileSystem; +import java.nio.file.FileSystems; import java.nio.file.Path; import javax.tools.FileObject; import javax.tools.JavaFileManager; import javax.tools.JavaFileObject; /** - * File manager based on {@linkplain File java.nio.file.Path}. + * File manager based on {@link java.nio.file.Path}. * * Eventually, this should be moved to javax.tools. * Also, JavaCompiler might reasonably provide a method getPathFileManager,
--- a/langtools/src/share/classes/com/sun/tools/javac/parser/JavaTokenizer.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/parser/JavaTokenizer.java Tue Oct 09 19:31:58 2012 -0700 @@ -108,8 +108,7 @@ * {@code input[input.length -1]} is a white space character. * * @param fac the factory which created this Scanner - * @param input the input, might be modified - * @param inputLength the size of the input. + * @param buf the input, might be modified * Must be positive and less than or equal to input.length. */ protected JavaTokenizer(ScannerFactory fac, CharBuffer buf) {
--- a/langtools/src/share/classes/com/sun/tools/javac/parser/Scanner.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/parser/Scanner.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 1999, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1999, 2012, 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 @@ -66,8 +66,7 @@ * {@code input[input.length -1]} is a white space character. * * @param fac the factory which created this Scanner - * @param input the input, might be modified - * @param inputLength the size of the input. + * @param buf the input, might be modified * Must be positive and less than or equal to input.length. */ protected Scanner(ScannerFactory fac, CharBuffer buf) {
--- a/langtools/src/share/classes/com/sun/tools/javac/parser/UnicodeReader.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/parser/UnicodeReader.java Tue Oct 09 19:31:58 2012 -0700 @@ -77,9 +77,8 @@ * that {@code inputLength < input.length} or * {@code input[input.length -1]} is a white space character. * - * @param fac the factory which created this Scanner - * @param input the input, might be modified - * @param inputLength the size of the input. + * @param sf the factory which created this Scanner + * @param buffer the input, might be modified * Must be positive and less than or equal to input.length. */ protected UnicodeReader(ScannerFactory sf, CharBuffer buffer) { @@ -255,16 +254,16 @@ /** * Returns a copy of a character array subset of the input buffer. - * The returned array begins at the <code>beginIndex</code> and - * extends to the character at index <code>endIndex - 1</code>. - * Thus the length of the substring is <code>endIndex-beginIndex</code>. + * The returned array begins at the {@code beginIndex} and + * extends to the character at index {@code endIndex - 1}. + * Thus the length of the substring is {@code endIndex-beginIndex}. * This behavior is like - * <code>String.substring(beginIndex, endIndex)</code>. + * {@code String.substring(beginIndex, endIndex)}. * Unicode escape sequences are not translated. * * @param beginIndex the beginning index, inclusive. * @param endIndex the ending index, exclusive. - * @throws IndexOutOfBounds if either offset is outside of the + * @throws ArrayIndexOutOfBoundsException if either offset is outside of the * array bounds */ public char[] getRawCharacters(int beginIndex, int endIndex) {
--- a/langtools/src/share/classes/com/sun/tools/javac/processing/JavacRoundEnvironment.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/processing/JavacRoundEnvironment.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2012, 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 @@ -105,7 +105,7 @@ * Only type elements <i>included</i> in this round of annotation * processing, or declarations of members, parameters, or type * parameters declared within those, are returned. Included type - * elements are {@linkplain #getSpecifiedTypeElements specified + * elements are {@linkplain #getRootElements specified * types} and any types nested within them. * * @param a annotation type being requested
--- a/langtools/src/share/classes/com/sun/tools/javac/processing/ServiceProxy.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/processing/ServiceProxy.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2006, 2008, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2006, 2012, 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 @@ -72,7 +72,7 @@ * The service class for which providers are being sought; * used to construct error detail strings * - * @param url + * @param u * The URL naming the configuration file to be parsed * * @return true if the name of a service is found
--- a/langtools/src/share/classes/com/sun/tools/javac/tree/JCTree.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/tree/JCTree.java Tue Oct 09 19:31:58 2012 -0700 @@ -464,32 +464,29 @@ } /** - * Everything in one source file is kept in a TopLevel structure. - * @param pid The tree representing the package clause. - * @param sourcefile The source file name. - * @param defs All definitions in this file (ClassDef, Import, and Skip) - * @param packge The package it belongs to. - * @param namedImportScope A scope for all named imports. - * @param starImportScope A scope for all import-on-demands. - * @param lineMap Line starting positions, defined only - * if option -g is set. - * @param docComments A hashtable that stores all documentation comments - * indexed by the tree nodes they refer to. - * defined only if option -s is set. - * @param endPositions An object encapsulating ending positions of source - * ranges indexed by the tree nodes they belong to. - * Defined only if option -Xjcov is set. + * Everything in one source file is kept in a {@linkplain JCCompilationUnit} structure. */ public static class JCCompilationUnit extends JCTree implements CompilationUnitTree { public List<JCAnnotation> packageAnnotations; + /** The tree representing the package clause. */ public JCExpression pid; + /** All definitions in this file (ClassDef, Import, and Skip) */ public List<JCTree> defs; + /* The source file name. */ public JavaFileObject sourcefile; + /** The package to which this compilation unit belongs. */ public PackageSymbol packge; + /** A scope for all named imports. */ public ImportScope namedImportScope; + /** A scope for all import-on-demands. */ public StarImportScope starImportScope; + /** Line starting positions, defined only if option -g is set. */ public Position.LineMap lineMap = null; + /** A table that stores all documentation comments indexed by the tree + * nodes they refer to. defined only if option -s is set. */ public DocCommentTable docComments = null; + /* An object encapsulating ending positions of source ranges indexed by + * the tree nodes they belong to. Defined only if option -Xjcov is set. */ public EndPosTable endPositions = null; protected JCCompilationUnit(List<JCAnnotation> packageAnnotations, JCExpression pid, @@ -550,10 +547,10 @@ /** * An import clause. - * @param qualid The imported class(es). */ public static class JCImport extends JCTree implements ImportTree { public boolean staticImport; + /** The imported class(es). */ public JCTree qualid; protected JCImport(JCTree qualid, boolean importStatic) { this.qualid = qualid; @@ -605,21 +602,21 @@ /** * A class definition. - * @param modifiers the modifiers - * @param name the name of the class - * @param typarams formal class parameters - * @param extending the classes this class extends - * @param implementing the interfaces implemented by this class - * @param defs all variables and methods defined in this class - * @param sym the symbol */ public static class JCClassDecl extends JCStatement implements ClassTree { + /** the modifiers */ public JCModifiers mods; + /** the name of the class */ public Name name; + /** formal class parameters */ public List<JCTypeParameter> typarams; + /** the classes this class extends */ public JCExpression extending; + /** the interfaces implemented by this class */ public List<JCExpression> implementing; + /** all variables and methods defined in this class */ public List<JCTree> defs; + /** the symbol */ public ClassSymbol sym; protected JCClassDecl(JCModifiers mods, Name name, @@ -676,24 +673,25 @@ /** * A method definition. - * @param modifiers method modifiers - * @param name method name - * @param restype type of method return value - * @param typarams type parameters - * @param params value parameters - * @param thrown exceptions thrown by this method - * @param stats statements in the method - * @param sym method symbol */ public static class JCMethodDecl extends JCTree implements MethodTree { + /** method modifiers */ public JCModifiers mods; + /** method name */ public Name name; + /** type of method return value */ public JCExpression restype; + /** type parameters */ public List<JCTypeParameter> typarams; + /** value parameters */ public List<JCVariableDecl> params; + /** exceptions thrown by this method */ public List<JCExpression> thrown; + /** statements in the method */ public JCBlock body; - public JCExpression defaultValue; // for annotation types + /** default value, for annotation types */ + public JCExpression defaultValue; + /** method symbol */ public MethodSymbol sym; protected JCMethodDecl(JCModifiers mods, Name name, @@ -748,17 +746,17 @@ /** * A variable definition. - * @param modifiers variable modifiers - * @param name variable name - * @param vartype type of the variable - * @param init variables initial value - * @param sym symbol */ public static class JCVariableDecl extends JCStatement implements VariableTree { + /** variable modifiers */ public JCModifiers mods; + /** variable name */ public Name name; + /** type of the variable */ public JCExpression vartype; + /** variable's initial value */ public JCExpression init; + /** symbol */ public VarSymbol sym; protected JCVariableDecl(JCModifiers mods, Name name, @@ -815,11 +813,11 @@ /** * A statement block. - * @param stats statements - * @param flags flags */ public static class JCBlock extends JCStatement implements BlockTree { + /** flags */ public long flags; + /** statements */ public List<JCStatement> stats; /** Position of closing brace, optional. */ public int endpos = Position.NOPOS; @@ -1206,9 +1204,9 @@ /** * an expression statement - * @param expr expression structure */ public static class JCExpressionStatement extends JCStatement implements ExpressionStatementTree { + /** expression structure */ public JCExpression expr; protected JCExpressionStatement(JCExpression expr) { @@ -1776,13 +1774,13 @@ /** * Selects through packages and classes - * @param selected selected Tree hierarchie - * @param selector name of field to select thru - * @param sym symbol of the selected class */ public static class JCFieldAccess extends JCExpression implements MemberSelectTree { + /** selected Tree hierarchy */ public JCExpression selected; + /** name of field to select thru */ public Name name; + /** symbol of the selected class */ public Symbol sym; protected JCFieldAccess(JCExpression selected, Name name, Symbol sym) { this.selected = selected; @@ -1885,11 +1883,11 @@ /** * An identifier - * @param idname the name - * @param sym the symbol */ public static class JCIdent extends JCExpression implements IdentifierTree { + /** the name */ public Name name; + /** the symbol */ public Symbol sym; protected JCIdent(Name name, Symbol sym) { this.name = name; @@ -1912,10 +1910,10 @@ /** * A constant value given literally. - * @param value value representation */ public static class JCLiteral extends JCExpression implements LiteralTree { public int typetag; + /** value representation */ public Object value; protected JCLiteral(int typetag, Object value) { this.typetag = typetag; @@ -1978,10 +1976,10 @@ /** * Identifies a basic type. - * @param tag the basic type id * @see TypeTags */ public static class JCPrimitiveTypeTree extends JCExpression implements PrimitiveTypeTree { + /** the basic type id */ public int typetag; protected JCPrimitiveTypeTree(int typetag) { this.typetag = typetag; @@ -2105,11 +2103,11 @@ /** * A formal class parameter. - * @param name name - * @param bounds bounds */ public static class JCTypeParameter extends JCTree implements TypeParameterTree { + /** name */ public Name name; + /** bounds */ public List<JCExpression> bounds; protected JCTypeParameter(Name name, List<JCExpression> bounds) { this.name = name;
--- a/langtools/src/share/classes/com/sun/tools/javac/util/AbstractDiagnosticFormatter.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/util/AbstractDiagnosticFormatter.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2008, 2012, 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 @@ -484,7 +484,7 @@ /** * Tells whether the caret display is active or not. * - * @param caretEnabled if true the caret is enabled + * @return true if the caret is enabled */ public boolean isCaretEnabled() { return caretEnabled;
--- a/langtools/src/share/classes/com/sun/tools/javac/util/AbstractLog.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/util/AbstractLog.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 1999, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1999, 2012, 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 @@ -132,7 +132,6 @@ /** Report a warning, unless suppressed by the -nowarn option or the * maximum number of warnings has been reached. - * @param pos The source position at which to report the warning. * @param key The key for the localized warning message. * @param args Fields of the warning message. */
--- a/langtools/src/share/classes/com/sun/tools/javac/util/BasicDiagnosticFormatter.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/util/BasicDiagnosticFormatter.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2012, 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 @@ -69,7 +69,7 @@ /** * Create a basic formatter based on the supplied options. * - * @param opts list of command-line options + * @param options list of command-line options * @param msgs JavacMessages object used for i18n */ public BasicDiagnosticFormatter(Options options, JavacMessages msgs) { @@ -329,7 +329,7 @@ * Set the indentation level for various element of a given diagnostic - * this might lead to more readable diagnostics * - * @param indentationKind kind of indentation to be set + * @param diagPart * @param nSpaces amount of spaces for the specified diagnostic part */ public void setIndentation(DiagnosticPart diagPart, int nSpaces) { @@ -384,7 +384,7 @@ /** * Get a metachar string for a specific format * - * @param sourcePos a positioning value for source line + * @param kind the format kind for which to get the metachar string */ public String getFormat(BasicFormatKind kind) { return availableFormats.get(kind);
--- a/langtools/src/share/classes/com/sun/tools/javac/util/Context.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/util/Context.java Tue Oct 09 19:31:58 2012 -0700 @@ -44,7 +44,7 @@ * instance method that is overridden in extended components. A base * phase supporting extension would look something like this: * - * <p><pre> + * <p><pre>{@code * public class Phase { * protected static final Context.Key<Phase> phaseKey = * new Context.Key<Phase>(); @@ -62,7 +62,7 @@ * // other intitialization follows... * } * } - * </pre> + * }</pre> * * <p>In the compiler, we simply use Phase.instance(context) to get * the reference to the phase. But in extensions of the compiler, we @@ -70,7 +70,7 @@ * and this must be done before any reference to the phase is accessed * using Phase.instance(). An extended phase might be declared thus: * - * <p><pre> + * <p><pre>{@code * public class NewPhase extends Phase { * protected NewPhase(Context context) { * super(context); @@ -83,7 +83,7 @@ * }); * } * } - * </pre> + * }</pre> * * <p>And is registered early in the extended compiler like this *
--- a/langtools/src/share/classes/com/sun/tools/javac/util/JCDiagnostic.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/util/JCDiagnostic.java Tue Oct 09 19:31:58 2012 -0700 @@ -213,7 +213,6 @@ * Create a new diagnostic of the given kind, which is not mandatory and which has * no lint category. * @param kind The diagnostic kind - * @param ls The lint category, if applicable, or null * @param source The source of the compilation unit, if any, in which to report the message. * @param pos The source position at which to report the message. * @param key The key for the localized message. @@ -228,7 +227,7 @@ * Create a new diagnostic of the given kind. * @param kind The diagnostic kind * @param lc The lint category, if applicable, or null - * @param isMandatory is diagnostic mandatory? + * @param flags The set of flags for the diagnostic * @param source The source of the compilation unit, if any, in which to report the message. * @param pos The source position at which to report the message. * @param key The key for the localized message. @@ -363,7 +362,7 @@ /** * Create a diagnostic object. - * @param fomatter the formatter to use for the diagnostic + * @param formatter the formatter to use for the diagnostic * @param dt the type of diagnostic * @param lc the lint category for the diagnostic * @param source the name of the source file, or null if none.
--- a/langtools/src/share/classes/com/sun/tools/javac/util/Position.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/util/Position.java Tue Oct 09 19:31:58 2012 -0700 @@ -80,11 +80,11 @@ /** Encode line and column numbers in an integer as: * {@code line-number << LINESHIFT + column-number }. - * {@link Position.NOPOS} represents an undefined position. + * {@link Position#NOPOS} represents an undefined position. * * @param line number of line (first is 1) * @param col number of character on line (first is 1) - * @return an encoded position or {@link Position.NOPOS} + * @return an encoded position or {@link Position#NOPOS} * if the line or column number is too big to * represent in the encoded format * @throws IllegalArgumentException if line or col is less than 1
--- a/langtools/src/share/classes/com/sun/tools/javac/util/RawDiagnosticFormatter.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javac/util/RawDiagnosticFormatter.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2008, 2012, 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 @@ -52,7 +52,7 @@ /** * Create a formatter based on the supplied options. - * @param msgs + * @param options */ public RawDiagnosticFormatter(Options options) { super(null, new SimpleConfiguration(options,
--- a/langtools/src/share/classes/com/sun/tools/javadoc/ClassDocImpl.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javadoc/ClassDocImpl.java Tue Oct 09 19:31:58 2012 -0700 @@ -844,7 +844,7 @@ * Note that this is not necessarily what the compiler would do! * * @param methodName the unqualified name to search for. - * @param paramTypeArray the array of Strings for method parameter types. + * @param paramTypes the array of Strings for method parameter types. * @return the first MethodDocImpl which matches, null if not found. */ public MethodDocImpl findMethod(String methodName, String[] paramTypes) { @@ -971,7 +971,7 @@ * Find constructor in this class. * * @param constrName the unqualified name to search for. - * @param paramTypeArray the array of Strings for constructor parameters. + * @param paramTypes the array of Strings for constructor parameters. * @return the first ConstructorDocImpl which matches, null if not found. */ public ConstructorDoc findConstructor(String constrName,
--- a/langtools/src/share/classes/com/sun/tools/javadoc/DocImpl.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javadoc/DocImpl.java Tue Oct 09 19:31:58 2012 -0700 @@ -262,7 +262,7 @@ * <p> * Included so that Doc item are java.lang.Comparable. * - * @param o the <code>Object</code> to be compared. + * @param obj the {@code Object} to be compared. * @return a negative integer, zero, or a positive integer as this Object * is less than, equal to, or greater than the given Object. * @exception ClassCastException the specified Object's type prevents it
--- a/langtools/src/share/classes/com/sun/tools/javadoc/JavadocTool.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javadoc/JavadocTool.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2001, 2012, 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 @@ -386,7 +386,7 @@ /** * Return true if given file name is a valid class name * (including "package-info"). - * @param clazzname the name of the class to check. + * @param s the name of the class to check. * @return true if given class name is a valid class name * and false otherwise. */
--- a/langtools/src/share/classes/com/sun/tools/javadoc/ModifierFilter.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javadoc/ModifierFilter.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2000, 2003, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2000, 2012, 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 @@ -32,7 +32,7 @@ * Filtering is done by returning boolean values. * Classes, methods and fields can be filtered, or filtering * can be done directly on modifier bits. - * @see com.sun.tools.javac.code.Flags; + * @see com.sun.tools.javac.code.Flags * @author Robert Field */
--- a/langtools/src/share/classes/com/sun/tools/javadoc/ParamTagImpl.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javadoc/ParamTagImpl.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1997, 2012, 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 @@ -101,8 +101,8 @@ * TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s). * * @return TagImpl[] Array of tags with inline SeeTagImpls. - * @see TagImpl#inlineTagImpls() - * @see ThrowsTagImpl#inlineTagImpls() + * @see TagImpl#inlineTags() + * @see ThrowsTagImpl#inlineTags() */ @Override public Tag[] inlineTags() {
--- a/langtools/src/share/classes/com/sun/tools/javadoc/ThrowsTagImpl.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javadoc/ThrowsTagImpl.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1997, 2012, 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 @@ -108,8 +108,8 @@ * TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s). * * @return TagImpl[] Array of tags with inline SeeTagImpls. - * @see TagImpl#inlineTagImpls() - * @see ParamTagImpl#inlineTagImpls() + * @see TagImpl#inlineTags() + * @see ParamTagImpl#inlineTags() */ @Override public Tag[] inlineTags() {
--- a/langtools/src/share/classes/com/sun/tools/javah/NativeHeaderTool.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javah/NativeHeaderTool.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2012, 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 @@ -29,11 +29,13 @@ import java.nio.charset.Charset; import java.util.Locale; import java.util.concurrent.Callable; +import javax.tools.Diagnostic; import javax.tools.DiagnosticListener; import javax.tools.JavaFileManager; import javax.tools.JavaFileObject; import javax.tools.OptionChecker; import javax.tools.StandardJavaFileManager; +import javax.tools.StandardLocation; import javax.tools.Tool; /**
--- a/langtools/src/share/classes/com/sun/tools/javap/DisassemblerTool.java Tue Oct 09 19:10:00 2012 -0700 +++ b/langtools/src/share/classes/com/sun/tools/javap/DisassemblerTool.java Tue Oct 09 19:31:58 2012 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2008, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2012, 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 @@ -29,11 +29,13 @@ import java.nio.charset.Charset; import java.util.Locale; import java.util.concurrent.Callable; +import javax.tools.Diagnostic; import javax.tools.DiagnosticListener; import javax.tools.JavaFileManager; import javax.tools.JavaFileObject; import javax.tools.OptionChecker; import javax.tools.StandardJavaFileManager; +import javax.tools.StandardLocation; import javax.tools.Tool; /** @@ -69,9 +71,7 @@ * @param options compiler options, {@code null} means no options * @param classes class names (for annotation processing), {@code * null} means no class names - * @param compilationUnits the compilation units to compile, {@code - * null} means no compilation units - * @return an object representing the compilation + * @return a task to perform the disassembly * @throws RuntimeException if an unrecoverable error * occurred in a user supplied component. The * {@linkplain Throwable#getCause() cause} will be the error in