# HG changeset patch # User avstepan # Date 1436792272 -14400 # Node ID d1e5707cd4ebd1353fcd666dbc642d45043b9acf # Parent 1ec80335c03d0d98e5b9ba737cfea274e3fa17ff 8080880: some docs cleanup for langtools Summary: minor cleanup for docs Reviewed-by: jjg diff -r 1ec80335c03d -r d1e5707cd4eb src/jdk.compiler/share/classes/com/sun/tools/javac/api/JavacTrees.java --- a/src/jdk.compiler/share/classes/com/sun/tools/javac/api/JavacTrees.java Fri Jul 10 12:42:00 2015 +0300 +++ b/src/jdk.compiler/share/classes/com/sun/tools/javac/api/JavacTrees.java Mon Jul 13 16:57:52 2015 +0400 @@ -874,8 +874,8 @@ /** * Returns the original type from the ErrorType object. * @param errorType The errorType for which we want to get the original type. - * @returns TypeMirror corresponding to the original type, replaced by the ErrorType. - * noType (type.tag == NONE) is returned if there is no original type. + * @return TypeMirror corresponding to the original type, replaced by the ErrorType. + * noType (type.tag == NONE) is returned if there is no original type. */ @DefinedBy(Api.COMPILER_TREE) public TypeMirror getOriginalType(javax.lang.model.type.ErrorType errorType) { diff -r 1ec80335c03d -r d1e5707cd4eb src/jdk.compiler/share/classes/com/sun/tools/javac/code/Attribute.java --- a/src/jdk.compiler/share/classes/com/sun/tools/javac/code/Attribute.java Fri Jul 10 12:42:00 2015 +0300 +++ b/src/jdk.compiler/share/classes/com/sun/tools/javac/code/Attribute.java Mon Jul 13 16:57:52 2015 +0400 @@ -230,9 +230,11 @@ /** * Returns a string representation of this annotation. * String is of one of the forms: - * @com.example.foo(name1=val1, name2=val2) - * @com.example.foo(val) - * @com.example.foo + *
+ * {@code @com.example.foo(name1=val1, name2=val2)} + * {@code @com.example.foo(val)} + * {@code @com.example.foo} + ** Omit parens for marker annotations, and omit "value=" when allowed. */ @DefinedBy(Api.LANGUAGE_MODEL) diff -r 1ec80335c03d -r d1e5707cd4eb src/jdk.compiler/share/classes/com/sun/tools/javac/code/TypeAnnotationPosition.java --- a/src/jdk.compiler/share/classes/com/sun/tools/javac/code/TypeAnnotationPosition.java Fri Jul 10 12:42:00 2015 +0300 +++ b/src/jdk.compiler/share/classes/com/sun/tools/javac/code/TypeAnnotationPosition.java Mon Jul 13 16:57:52 2015 +0400 @@ -461,7 +461,7 @@ * * @param location The type path. * @param onLambda The lambda for this parameter. - * @param index The index of the parameter. + * @param parameter_index The index of the parameter. * @param pos The position from the associated tree node. */ public static TypeAnnotationPosition @@ -479,7 +479,7 @@ * Create a {@code TypeAnnotationPosition} for a method formal parameter. * * @param onLambda The lambda for this parameter. - * @param index The index of the parameter. + * @param parameter_index The index of the parameter. * @param pos The position from the associated tree node. */ public static TypeAnnotationPosition @@ -493,7 +493,7 @@ /** * Create a {@code TypeAnnotationPosition} for a method formal parameter. * - * @param index The index of the parameter. + * @param parameter_index The index of the parameter. * @param pos The position from the associated tree node. */ public static TypeAnnotationPosition @@ -506,7 +506,7 @@ * Create a {@code TypeAnnotationPosition} for a method formal parameter. * * @param location The type path. - * @param index The index of the parameter. + * @param parameter_index The index of the parameter. */ public static TypeAnnotationPosition methodParameter(final List
This is NOT part of any supported API. * If you write code that depends on this, you do so at your own risk. diff -r 1ec80335c03d -r d1e5707cd4eb src/jdk.compiler/share/classes/com/sun/tools/javac/util/Context.java --- a/src/jdk.compiler/share/classes/com/sun/tools/javac/util/Context.java Fri Jul 10 12:42:00 2015 +0300 +++ b/src/jdk.compiler/share/classes/com/sun/tools/javac/util/Context.java Mon Jul 13 16:57:52 2015 +0400 @@ -44,7 +44,7 @@ * instance method that is overridden in extended components. A base * phase supporting extension would look something like this: * - *
{@code + *{@code * public class Phase { * protected static final Context.KeyphaseKey = * new Context.Key (); @@ -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: * - * {@code + *{@code * public class NewPhase extends Phase { * protected NewPhase(Context context) { * super(context); @@ -87,7 +87,7 @@ * *And is registered early in the extended compiler like this * - *
+ ** NewPhase.preRegister(context); ** diff -r 1ec80335c03d -r d1e5707cd4eb src/jdk.compiler/share/classes/com/sun/tools/javac/util/IntHashTable.java --- a/src/jdk.compiler/share/classes/com/sun/tools/javac/util/IntHashTable.java Fri Jul 10 12:42:00 2015 +0300 +++ b/src/jdk.compiler/share/classes/com/sun/tools/javac/util/IntHashTable.java Mon Jul 13 16:57:52 2015 +0400 @@ -28,7 +28,7 @@ /** * A hash table that maps Object to int. * - * This is a custom hash table optimised for the Object -> int + * This is a custom hash table optimised for the Object {@literal ->} int * maps. This is done to avoid unnecessary object allocation in the image set. * * @author Charles Turner @@ -43,7 +43,7 @@ private final static Object DELETED = new Object(); /** - * Construct an Object -> int hash table. + * Construct an Object {@literal ->} int hash table. * * The default size of the hash table is 64 mappings. */ @@ -54,7 +54,7 @@ } /** - * Construct an Object -> int hash table with a specified amount of mappings. + * Construct an Object {@literal ->} int hash table with a specified amount of mappings. * @param capacity The number of default mappings in this hash table. */ public IntHashTable(int capacity) { diff -r 1ec80335c03d -r d1e5707cd4eb src/jdk.compiler/share/classes/com/sun/tools/sjavac/BuildState.java --- a/src/jdk.compiler/share/classes/com/sun/tools/sjavac/BuildState.java Fri Jul 10 12:42:00 2015 +0300 +++ b/src/jdk.compiler/share/classes/com/sun/tools/sjavac/BuildState.java Mon Jul 13 16:57:52 2015 +0400 @@ -187,7 +187,7 @@ /** * Verify that the setModules method above did the right thing when - * running through the module->package->source structure. + * running through the {@literal module->package->source} structure. */ public void checkInternalState(String msg, boolean linkedOnly, Mapsrcs) { boolean baad = false; diff -r 1ec80335c03d -r d1e5707cd4eb src/jdk.compiler/share/classes/com/sun/tools/sjavac/Util.java --- a/src/jdk.compiler/share/classes/com/sun/tools/sjavac/Util.java Fri Jul 10 12:42:00 2015 +0300 +++ b/src/jdk.compiler/share/classes/com/sun/tools/sjavac/Util.java Mon Jul 13 16:57:52 2015 +0400 @@ -131,7 +131,7 @@ * do settings = cleanOptions("--server:",Util.set("-portfile"),settings); * now settings equals "--server:portfile=bar" * - * @param allowsSubOptions A set of the allowed sub options, id portfile etc. + * @param allowedSubOptions A set of the allowed sub options, id portfile etc. * @param s The option settings string. */ public static String cleanSubOptions(Set allowedSubOptions, String s) { diff -r 1ec80335c03d -r d1e5707cd4eb src/jdk.compiler/share/classes/com/sun/tools/sjavac/client/SjavacClient.java --- a/src/jdk.compiler/share/classes/com/sun/tools/sjavac/client/SjavacClient.java Fri Jul 10 12:42:00 2015 +0300 +++ b/src/jdk.compiler/share/classes/com/sun/tools/sjavac/client/SjavacClient.java Mon Jul 13 16:57:52 2015 +0400 @@ -128,12 +128,6 @@ /** * Make a request to the server only to get the maximum possible heap size to use for compilations. - * - * @param port_file The port file used to synchronize creation of this server. - * @param id The identify of the compilation. - * @param out Standard out information. - * @param err Standard err information. - * @return The maximum heap size in bytes. */ @Override public SysInfo getSysInfo() { diff -r 1ec80335c03d -r d1e5707cd4eb src/jdk.compiler/share/classes/com/sun/tools/sjavac/options/Options.java --- a/src/jdk.compiler/share/classes/com/sun/tools/sjavac/options/Options.java Fri Jul 10 12:42:00 2015 +0300 +++ b/src/jdk.compiler/share/classes/com/sun/tools/sjavac/options/Options.java Mon Jul 13 16:57:52 2015 +0400 @@ -161,7 +161,7 @@ /** * Get a map which maps suffixes to transformers (for example - * ".java" -> CompileJavaPackages) + * ".java" {@literal ->} CompileJavaPackages) */ public Map getTranslationRules() { return trRules; diff -r 1ec80335c03d -r d1e5707cd4eb src/jdk.compiler/share/classes/com/sun/tools/sjavac/server/PortFile.java --- a/src/jdk.compiler/share/classes/com/sun/tools/sjavac/server/PortFile.java Fri Jul 10 12:42:00 2015 +0300 +++ b/src/jdk.compiler/share/classes/com/sun/tools/sjavac/server/PortFile.java Mon Jul 13 16:57:52 2015 +0400 @@ -78,7 +78,7 @@ /** * Create a new portfile. - * @param filename is the path to the file. + * @param fn is the path to the file. */ public PortFile(String fn) throws FileNotFoundException { filename = fn; diff -r 1ec80335c03d -r d1e5707cd4eb src/jdk.javadoc/share/classes/com/sun/tools/doclets/formats/html/AbstractExecutableMemberWriter.java --- a/src/jdk.javadoc/share/classes/com/sun/tools/doclets/formats/html/AbstractExecutableMemberWriter.java Fri Jul 10 12:42:00 2015 +0300 +++ b/src/jdk.javadoc/share/classes/com/sun/tools/doclets/formats/html/AbstractExecutableMemberWriter.java Mon Jul 13 16:57:52 2015 +0400 @@ -58,7 +58,6 @@ * * @param member the member to write type parameters for. * @param htmltree the content tree to which the parameters will be added. - * @return the display length required to write this information. */ protected void addTypeParameters(ExecutableMemberDoc member, Content htmltree) { Content typeParameters = getTypeParameters(member); diff -r 1ec80335c03d -r d1e5707cd4eb src/jdk.javadoc/share/classes/com/sun/tools/doclets/formats/html/ConfigurationImpl.java --- a/src/jdk.javadoc/share/classes/com/sun/tools/doclets/formats/html/ConfigurationImpl.java Fri Jul 10 12:42:00 2015 +0300 +++ b/src/jdk.javadoc/share/classes/com/sun/tools/doclets/formats/html/ConfigurationImpl.java Mon Jul 13 16:57:52 2015 +0400 @@ -325,7 +325,6 @@ * The options arrive as case-sensitive strings. For options that * are not case-sensitive, use toLowerCase() on the option string * before comparing it. - * * * @return number of arguments + 1 for a option. Zero return means * option not known. Negative value means error occurred. diff -r 1ec80335c03d -r d1e5707cd4eb src/jdk.javadoc/share/classes/com/sun/tools/doclets/formats/html/LinkInfoImpl.java --- a/src/jdk.javadoc/share/classes/com/sun/tools/doclets/formats/html/LinkInfoImpl.java Fri Jul 10 12:42:00 2015 +0300 +++ b/src/jdk.javadoc/share/classes/com/sun/tools/doclets/formats/html/LinkInfoImpl.java Mon Jul 13 16:57:52 2015 +0400 @@ -247,7 +247,7 @@ } /** - * {@inherotDoc} + * {@inheritDoc} */ protected Content newContent() { return new ContentBuilder(); diff -r 1ec80335c03d -r d1e5707cd4eb src/jdk.javadoc/share/classes/com/sun/tools/doclets/formats/html/PackageIndexWriter.java --- a/src/jdk.javadoc/share/classes/com/sun/tools/doclets/formats/html/PackageIndexWriter.java Fri Jul 10 12:42:00 2015 +0300 +++ b/src/jdk.javadoc/share/classes/com/sun/tools/doclets/formats/html/PackageIndexWriter.java Mon Jul 13 16:57:52 2015 +0400 @@ -267,7 +267,7 @@ * navigation bar, and then the title (from the"-title" * option), at the top of page. * - * @body the documentation tree to which the navigation bar header will be added + * @param body the documentation tree to which the navigation bar header will be added */ protected void addNavigationBarHeader(Content body) { Content htmlTree = (configuration.allowTag(HtmlTag.HEADER)) diff -r 1ec80335c03d -r d1e5707cd4eb src/jdk.javadoc/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/TagletWriter.java --- a/src/jdk.javadoc/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/TagletWriter.java Fri Jul 10 12:42:00 2015 +0300 +++ b/src/jdk.javadoc/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/TagletWriter.java Mon Jul 13 16:57:52 2015 +0400 @@ -58,7 +58,7 @@ public abstract Content getOutputInstance(); /** - * Return the output for a {@code...} tag. + * Return the output for a {@code {@code ...}} tag. * * @param tag the tag. * @return the output of the taglet. @@ -80,7 +80,7 @@ protected abstract Content deprecatedTagOutput(Doc doc); /** - * Return the output for a {@literal...} tag. + * Return the output for a {@code {@literal ...}} tag. * * @param tag the tag. * @return the output of the taglet. diff -r 1ec80335c03d -r d1e5707cd4eb src/jdk.javadoc/share/classes/com/sun/tools/javadoc/AnnotationDescImpl.java --- a/src/jdk.javadoc/share/classes/com/sun/tools/javadoc/AnnotationDescImpl.java Fri Jul 10 12:42:00 2015 +0300 +++ b/src/jdk.javadoc/share/classes/com/sun/tools/javadoc/AnnotationDescImpl.java Mon Jul 13 16:57:52 2015 +0400 @@ -100,9 +100,11 @@ /** * Returns a string representation of this annotation. * String is of one of the forms: - * @com.example.foo(name1=val1, name2=val2) - * @com.example.foo(val) - * @com.example.foo + * + * {@code @com.example.foo(name1=val1, name2=val2)} + * {@code @com.example.foo(val)} + * {@code @com.example.foo} + ** Omit parens for marker annotations, and omit "value=" when allowed. */ @Override diff -r 1ec80335c03d -r d1e5707cd4eb src/jdk.javadoc/share/classes/com/sun/tools/javadoc/ClassDocImpl.java --- a/src/jdk.javadoc/share/classes/com/sun/tools/javadoc/ClassDocImpl.java Fri Jul 10 12:42:00 2015 +0300 +++ b/src/jdk.javadoc/share/classes/com/sun/tools/javadoc/ClassDocImpl.java Mon Jul 13 16:57:52 2015 +0400 @@ -1278,8 +1278,8 @@ * each Serializable field defined by anObjectStreamField
* array component ofserialPersistentField
. * - * @returns an array ofFieldDoc
for the Serializable fields - * of this class. + * @return an array of {@code FieldDoc} for the Serializable fields + * of this class. * * @see #definesSerializableFields() * @see SerialFieldTagImpl diff -r 1ec80335c03d -r d1e5707cd4eb src/jdk.jdeps/share/classes/com/sun/tools/classfile/ReferenceFinder.java --- a/src/jdk.jdeps/share/classes/com/sun/tools/classfile/ReferenceFinder.java Fri Jul 10 12:42:00 2015 +0300 +++ b/src/jdk.jdeps/share/classes/com/sun/tools/classfile/ReferenceFinder.java Mon Jul 13 16:57:52 2015 +0400 @@ -36,7 +36,7 @@ /** * A utility class to find where in a ClassFile references * a {@link CONSTANT_Methodref_info method}, - * a {@link CONSTANT_InterfaceMethodref_info interface method, + * a {@link CONSTANT_InterfaceMethodref_info interface method}, * or a {@link CONSTANT_Fieldref_info field}. */ public final class ReferenceFinder {