diff options
| author | Jeff Johnston | 2019-03-22 22:39:22 +0000 |
|---|---|---|
| committer | Manoj Palat | 2019-03-25 08:04:16 +0000 |
| commit | 3ae0f22df2dfdbd07a2f7c334d93801236b377de (patch) | |
| tree | f1da0290207461ce21fc03e646ad1a4b80bb1af8 | |
| parent | dabfef4dcf15b3a6edb09d10c4759084f4ef07cf (diff) | |
| download | eclipse.jdt.core-3ae0f22df2dfdbd07a2f7c334d93801236b377de.tar.gz eclipse.jdt.core-3ae0f22df2dfdbd07a2f7c334d93801236b377de.tar.xz eclipse.jdt.core-3ae0f22df2dfdbd07a2f7c334d93801236b377de.zip | |
Bug 545691 - Javadoc errors in jdt.core bundles
- fix javadoc errors/warnings in jdt.core classes
Change-Id: I4708bb425398235675948df94280263982184a98
Signed-off-by: Jeff Johnston <jjohnstn@redhat.com>
101 files changed, 379 insertions, 513 deletions
diff --git a/org.eclipse.jdt.annotation/src/org/eclipse/jdt/annotation/Checks.java b/org.eclipse.jdt.annotation/src/org/eclipse/jdt/annotation/Checks.java index 8d9b22d385..2911cc3e6f 100644 --- a/org.eclipse.jdt.annotation/src/org/eclipse/jdt/annotation/Checks.java +++ b/org.eclipse.jdt.annotation/src/org/eclipse/jdt/annotation/Checks.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2016 Stephan Herrmann and others. + * Copyright (c) 2016, 2019 Stephan Herrmann and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -83,8 +83,8 @@ import java.util.function.Supplier; * <dt>computations</dt> * <dd>Methods {@link #ifNonNull(Object, Consumer)}, {@link #applyIfNonNull(Object, Function)}, * {@link #applyIfNonNullElse(Object, Function, Object)} and {@link #applyIfNonNullElseGet(Object, Function, Supplier)} - * feed unsafe values into a given functional expression in a null-safe way. - * <dl> + * feed unsafe values into a given functional expression in a null-safe way.</dd> + * </dl> * * @since 2.1 */ diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/AnnotationProcessorEnvironment.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/AnnotationProcessorEnvironment.java index 24d75a363f..b1583b8ae7 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/AnnotationProcessorEnvironment.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/AnnotationProcessorEnvironment.java @@ -46,7 +46,7 @@ import com.sun.mirror.util.*; * * <p> When an annotation processing tool is invoked, it is given a * set of type declarations on which to operate. These - * are refered to as the <i>specified</i> types. + * are referred to as the <i>specified</i> types. * The type declarations said to be <i>included</i> in this invocation * consist of the specified types and any types nested within them. * @@ -65,11 +65,11 @@ public interface AnnotationProcessorEnvironment { /** * Returns the options passed to the annotation processing tool. * Options are returned in the form of a map from option name - * (such as <tt>"-encoding"</tt>) to option value. - * For an option with no value (such as <tt>"-help"</tt>), the - * corresponding value in the map is <tt>null</tt>. + * (such as <code>"-encoding"</code>) to option value. + * For an option with no value (such as <code>"-help"</code>), the + * corresponding value in the map is <code>null</code>. * - * <p> Options beginning with <tt>"-A"</tt> are <i>processor-specific.</i> + * <p> Options beginning with <code>"-A"</code> are <i>processor-specific.</i> * Such options are unrecognized by the tool, but intended to be used by * some annotation processor. * diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/AnnotationProcessorFactory.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/AnnotationProcessorFactory.java index 203007c445..9171723094 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/AnnotationProcessorFactory.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/AnnotationProcessorFactory.java @@ -44,7 +44,7 @@ import com.sun.mirror.declaration.AnnotationTypeDeclaration; * annotation types. * The factory is said to <i>support</i> these types. * - * <p> Each implementation of an <tt>AnnotationProcessorFactory</tt> + * <p> Each implementation of an <code>AnnotationProcessorFactory</code> * must provide a public no-argument constructor to be used by tools to * instantiate the factory. * @@ -61,9 +61,9 @@ public interface AnnotationProcessorFactory { * processors it may create. * Only {@linkplain AnnotationProcessorEnvironment#getOptions() * processor-specific} options are included, each of which begins - * with <tt>"-A"</tt>. For example, if this factory recognizes - * options such as <tt>-Adebug -Aloglevel=3</tt>, it will - * return the strings <tt>"-Adebug"</tt> and <tt>"-Aloglevel"</tt>. + * with <code>"-A"</code>. For example, if this factory recognizes + * options such as <code>-Adebug -Aloglevel=3</code>, it will + * return the strings <code>"-Adebug"</code> and <code>"-Aloglevel"</code>. * * <p> A tool might use this information to determine if any * options provided by a user are unrecognized by any processor, @@ -78,10 +78,10 @@ public interface AnnotationProcessorFactory { * Returns the names of the annotation types supported by this factory. * An element of the result may be the canonical (fully qualified) name * of a supported annotation type. Alternately it may be of the form - * <tt>"<i>name</i>.*"</tt> + * <code>"<i>name</i>.*"</code> * representing the set of all annotation types - * with canonical names beginning with <tt>"<i>name</i>."</tt> - * Finally, <tt>"*"</tt> by itself represents the set of all + * with canonical names beginning with <code>"<i>name</i>."</code> + * Finally, <code>"*"</code> by itself represents the set of all * annotation types. * * @return the names of the annotation types supported by this factory @@ -91,18 +91,18 @@ public interface AnnotationProcessorFactory { /** * Returns an annotation processor for a set of annotation * types. The set will be empty if the factory supports - * "<tt>*</tt>" and the specified type declarations have + * "<code>*</code>" and the specified type declarations have * no annotations. Note that the set of annotation types may be * empty for other reasons, such as giving the factory an * opportunity to register a listener. An - * <tt>AnnotationProcessorFactory</tt> must gracefully handle an + * <code>AnnotationProcessorFactory</code> must gracefully handle an * empty set of annotations; an appropriate response to an empty * set will often be returning {@link AnnotationProcessors#NO_OP}. * * @param atds type declarations of the annotation types to be processed * @param env environment to use during processing * @return an annotation processor for the given annotation types, - * or <tt>null</tt> if the types are not supported or the + * or <code>null</code> if the types are not supported or the * processor cannot be created */ AnnotationProcessor getProcessorFor(Set<AnnotationTypeDeclaration> atds, diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/Filer.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/Filer.java index f7ee38159d..2cb07a53a4 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/Filer.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/Filer.java @@ -48,7 +48,7 @@ import java.io.*; * file system) where newly created files are placed: * one for new source files, and one for new class files. * (These might be specified on a tool's command line, for example, - * using flags such as <tt>-s</tt> and <tt>-d</tt>.) + * using flags such as <code>-s</code> and <code>-d</code>.) * Auxiliary files may be created in either location. * * <p> During each run of an annotation processing tool, a file @@ -74,7 +74,7 @@ public interface Filer { * * <p> The {@linkplain java.nio.charset.Charset charset} used to * encode the file is determined by the implementation. - * An annotation processing tool may have an <tt>-encoding</tt> + * An annotation processing tool may have an <code>-encoding</code> * flag or the like for specifying this. It will typically use * the platform's default encoding if none is specified. * @@ -103,7 +103,7 @@ public interface Filer { * named relative to some package (as are source and binary files), * and from there by an arbitrary pathname. In a loose sense, the * pathname of the new file will be the concatenation of - * <tt>loc</tt>, <tt>pkg</tt>, and <tt>relPath</tt>. + * <code>loc</code>, <code>pkg</code>, and <code>relPath</code>. * * <p> A {@linkplain java.nio.charset.Charset charset} for * encoding the file may be provided. If none is given, the @@ -131,7 +131,7 @@ public interface Filer { * named relative to some package (as are source and binary files), * and from there by an arbitrary pathname. In a loose sense, the * pathname of the new file will be the concatenation of - * <tt>loc</tt>, <tt>pkg</tt>, and <tt>relPath</tt>. + * <code>loc</code>, <code>pkg</code>, and <code>relPath</code>. * * @param loc location of the new file * @param pkg package relative to which the file should be named, diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/Messager.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/Messager.java index 0539124659..c353306f5c 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/Messager.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/Messager.java @@ -36,7 +36,7 @@ import com.sun.mirror.util.SourcePosition; /** - * A <tt>Messager</tt> provides the way for + * A <code>Messager</code> provides the way for * an annotation processor to report error messages, warnings, and * other notices. * @@ -50,7 +50,7 @@ public interface Messager { /** * Prints an error message. - * Equivalent to <tt>printError(null, msg)</tt>. + * Equivalent to <code>printError(null, msg)</code>. * @param msg the message, or an empty string if none */ void printError(String msg); @@ -65,7 +65,7 @@ public interface Messager { /** * Prints a warning message. - * Equivalent to <tt>printWarning(null, msg)</tt>. + * Equivalent to <code>printWarning(null, msg)</code>. * @param msg the message, or an empty string if none */ void printWarning(String msg); @@ -80,7 +80,7 @@ public interface Messager { /** * Prints a notice. - * Equivalent to <tt>printNotice(null, msg)</tt>. + * Equivalent to <code>printNotice(null, msg)</code>. * @param msg the message, or an empty string if none */ void printNotice(String msg); diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/RoundCompleteEvent.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/RoundCompleteEvent.java index 890ca1c663..223cdc1434 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/RoundCompleteEvent.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/RoundCompleteEvent.java @@ -34,7 +34,7 @@ package com.sun.mirror.apt; /** * Event for the completion of a round of annotation processing. * - * <p>While this class extends the serializable <tt>EventObject</tt>, it + * <p>While this class extends the serializable <code>EventObject</code>, it * cannot meaningfully be serialized because all of the annotation * processing tool's internal state would potentially be needed. * @@ -48,7 +48,7 @@ public abstract class RoundCompleteEvent extends java.util.EventObject { private RoundState rs; /** - * The current <tt>AnnotationProcessorEnvironment</tt> is regarded + * The current <code>AnnotationProcessorEnvironment</code> is regarded * as the source of events. * * @param source The source of events diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/RoundState.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/RoundState.java index f97462640a..8689ab294b 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/RoundState.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/apt/RoundState.java @@ -41,26 +41,26 @@ package com.sun.mirror.apt; */ public interface RoundState { /** - * Returns <tt>true</tt> if this was the last round of annotation - * processing; returns <tt>false</tt> if there will be a subsequent round. + * Returns <code>true</code> if this was the last round of annotation + * processing; returns <code>false</code> if there will be a subsequent round. */ boolean finalRound(); /** - * Returns <tt>true</tt> if an error was raised in this round of processing; - * returns <tt>false</tt> otherwise. + * Returns <code>true</code> if an error was raised in this round of processing; + * returns <code>false</code> otherwise. */ boolean errorRaised(); /** - * Returns <tt>true</tt> if new source files were created in this round of - * processing; returns <tt>false</tt> otherwise. + * Returns <code>true</code> if new source files were created in this round of + * processing; returns <code>false</code> otherwise. */ boolean sourceFilesCreated(); /** - * Returns <tt>true</tt> if new class files were created in this round of - * processing; returns <tt>false</tt> otherwise. + * Returns <code>true</code> if new class files were created in this round of + * processing; returns <code>false</code> otherwise. */ boolean classFilesCreated(); } diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/AnnotationMirror.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/AnnotationMirror.java index 7b193d0235..0fa017d441 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/AnnotationMirror.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/AnnotationMirror.java @@ -41,7 +41,7 @@ import com.sun.mirror.util.SourcePosition; * each element of an annotation type. * * <p> Annotations should not be compared using reference-equality - * ("<tt>==</tt>"). There is no guarantee that any particular + * ("<code>==</code>"). There is no guarantee that any particular * annotation will always be represented by the same object. * * @author Joseph D. Darcy diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/ClassDeclaration.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/ClassDeclaration.java index 224710e5a2..da427dddad 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/ClassDeclaration.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/ClassDeclaration.java @@ -44,7 +44,7 @@ import com.sun.mirror.type.ClassType; * its constructors. * Note that an {@linkplain EnumDeclaration enum} is a kind of class. * - * <p> While a <tt>ClassDeclaration</tt> represents the <i>declaration</i> + * <p> While a <code>ClassDeclaration</code> represents the <i>declaration</i> * of a class, a {@link ClassType} represents a class <i>type</i>. * See {@link TypeDeclaration} for more on this distinction. * @@ -64,7 +64,7 @@ public interface ClassDeclaration extends TypeDeclaration { /** * Returns the class type directly extended by this class. - * The only class with no superclass is <tt>java.lang.Object</tt>, + * The only class with no superclass is <code>java.lang.Object</code>, * for which this method returns null. * * @return the class type directly extended by this class, or null diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/Declaration.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/Declaration.java index a035b55149..fd7a6888bc 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/Declaration.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/Declaration.java @@ -65,7 +65,7 @@ public interface Declaration { * Tests whether an object represents the same declaration as this. * * @param obj the object to be compared with this declaration - * @return <tt>true</tt> if the specified object represents the same + * @return <code>true</code> if the specified object represents the same * declaration as this */ @Override @@ -75,7 +75,7 @@ public interface Declaration { * Returns the text of the documentation ("javadoc") comment of * this declaration. * - * @return the documentation comment of this declaration, or <tt>null</tt> + * @return the documentation comment of this declaration, or <code>null</code> * if there is none */ String getDocComment(); @@ -94,15 +94,15 @@ public interface Declaration { * present on this declaration. * * <p> The annotation returned by this method could contain an element - * whose value is of type <tt>Class</tt>. + * whose value is of type <code>Class</code>. * This value cannot be returned directly: information necessary to * locate and load a class (such as the class loader to use) is * not available, and the class might not be loadable at all. - * Attempting to read a <tt>Class</tt> object by invoking the relevant + * Attempting to read a <code>Class</code> object by invoking the relevant * method on the returned annotation * will result in a {@link MirroredTypeException}, * from which the corresponding {@link TypeMirror} may be extracted. - * Similarly, attempting to read a <tt>Class[]</tt>-valued element + * Similarly, attempting to read a <code>Class[]</code>-valued element * will result in a {@link MirroredTypesException}. * * <blockquote> @@ -116,7 +116,7 @@ public interface Declaration { * </blockquote> * * @param <A> the annotation type - * @param annotationType the <tt>Class</tt> object corresponding to + * @param annotationType the <code>Class</code> object corresponding to * the annotation type * @return the annotation of this declaration having the specified type * @@ -126,7 +126,7 @@ public interface Declaration { /** * Returns the modifiers of this declaration, excluding annotations. - * Implicit modifiers, such as the <tt>public</tt> and <tt>static</tt> + * Implicit modifiers, such as the <code>public</code> and <code>static</code> * modifiers of interface members, are included. * * @return the modifiers of this declaration in undefined order; @@ -139,7 +139,7 @@ public interface Declaration { * The name of a generic type does not include any reference * to its formal type parameters. * For example, the simple name of the interface declaration - * {@code java.util.Set<E>} is <tt>"Set"</tt>. + * {@code java.util.Set<E>} is <code>"Set"</code>. * If this declaration represents the empty package, an empty * string is returned. * If it represents a constructor, the simple name of its @@ -151,7 +151,7 @@ public interface Declaration { /** * Returns the source position of the beginning of this declaration. - * Returns <tt>null</tt> if the position is unknown or not applicable. + * Returns <code>null</code> if the position is unknown or not applicable. * * <p> This source position is intended for use in providing * diagnostics, and indicates only approximately where a declaration diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/ExecutableDeclaration.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/ExecutableDeclaration.java index 02e3de863f..989435e1b0 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/ExecutableDeclaration.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/ExecutableDeclaration.java @@ -49,10 +49,10 @@ import com.sun.mirror.type.ReferenceType; public interface ExecutableDeclaration extends MemberDeclaration { /** - * Returns <tt>true</tt> if this method or constructor accepts a variable + * Returns <code>true</code> if this method or constructor accepts a variable * number of arguments. * - * @return <tt>true</tt> if this method or constructor accepts a variable + * @return <code>true</code> if this method or constructor accepts a variable * number of arguments */ boolean isVarArgs(); @@ -77,10 +77,10 @@ public interface ExecutableDeclaration extends MemberDeclaration { /** * Returns the exceptions and other throwables listed in this - * method or constructor's <tt>throws</tt> clause. + * method or constructor's <code>throws</code> clause. * * @return the exceptions and other throwables listed in the - * <tt>throws</tt> clause, or an empty collection if there are none + * <code>throws</code> clause, or an empty collection if there are none */ Collection<ReferenceType> getThrownTypes(); } diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/FieldDeclaration.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/FieldDeclaration.java index 1c248ad6f8..74c05dd7fc 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/FieldDeclaration.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/FieldDeclaration.java @@ -55,26 +55,26 @@ public interface FieldDeclaration extends MemberDeclaration { /** * Returns the value of this field if this field is a compile-time - * constant. Returns <tt>null</tt> otherwise. - * The value will be of a primitive type or <tt>String</tt>. + * constant. Returns <code>null</code> otherwise. + * The value will be of a primitive type or <code>String</code>. * If the value is of a primitive type, it is wrapped in the * appropriate wrapper class (such as {@link Integer}). * * @return the value of this field if this field is a compile-time - * constant, or <tt>null</tt> otherwise + * constant, or <code>null</code> otherwise */ Object getConstantValue(); /** * Returns the text of a <i>constant expression</i> representing the * value of this field if this field is a compile-time constant. - * Returns <tt>null</tt> otherwise. - * The value will be of a primitive type or <tt>String</tt>. + * Returns <code>null</code> otherwise. + * The value will be of a primitive type or <code>String</code>. * The text returned is in a form suitable for representing the value * in source code. * * @return the text of a constant expression if this field is a - * compile-time constant, or <tt>null</tt> otherwise + * compile-time constant, or <code>null</code> otherwise */ String getConstantExpression(); } diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/InterfaceDeclaration.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/InterfaceDeclaration.java index c20b374d8d..d1027fa833 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/InterfaceDeclaration.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/InterfaceDeclaration.java @@ -41,7 +41,7 @@ import com.sun.mirror.type.InterfaceType; * Note that an {@linkplain AnnotationTypeDeclaration annotation type} is * a kind of interface. * - * <p> While an <tt>InterfaceDeclaration</tt> represents the + * <p> While an <code>InterfaceDeclaration</code> represents the * <i>declaration</i> of an interface, an {@link InterfaceType} * represents an interface <i>type</i>. * See {@link TypeDeclaration} for more on this distinction. diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/Modifier.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/Modifier.java index ee88b464f6..a8ffc23d74 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/Modifier.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/Modifier.java @@ -52,17 +52,17 @@ public enum Modifier { // See JLS2 sections 8.1.1, 8.3.1, 8.4.3, 8.8.3, and 9.1.1. // java.lang.reflect.Modifier includes INTERFACE, but that's a VMism. - /** The modifier <tt>public</tt> */ PUBLIC, - /** The modifier <tt>protected</tt> */ PROTECTED, - /** The modifier <tt>private</tt> */ PRIVATE, - /** The modifier <tt>abstract</tt> */ ABSTRACT, - /** The modifier <tt>static</tt> */ STATIC, - /** The modifier <tt>final</tt> */ FINAL, - /** The modifier <tt>transient</tt> */ TRANSIENT, - /** The modifier <tt>volatile</tt> */ VOLATILE, - /** The modifier <tt>synchronized</tt> */ SYNCHRONIZED, - /** The modifier <tt>native</tt> */ NATIVE, - /** The modifier <tt>strictfp</tt> */ STRICTFP; + /** The modifier <code>public</code> */ PUBLIC, + /** The modifier <code>protected</code> */ PROTECTED, + /** The modifier <code>private</code> */ PRIVATE, + /** The modifier <code>abstract</code> */ ABSTRACT, + /** The modifier <code>static</code> */ STATIC, + /** The modifier <code>final</code> */ FINAL, + /** The modifier <code>transient</code> */ TRANSIENT, + /** The modifier <code>volatile</code> */ VOLATILE, + /** The modifier <code>synchronized</code> */ SYNCHRONIZED, + /** The modifier <code>native</code> */ NATIVE, + /** The modifier <code>strictfp</code> */ STRICTFP; private String lowercase = null; // modifier name in lowercase diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/TypeDeclaration.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/TypeDeclaration.java index 24db97e939..84bbb73dbc 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/TypeDeclaration.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/TypeDeclaration.java @@ -44,8 +44,8 @@ import com.sun.mirror.type.*; * and an {@linkplain AnnotationTypeDeclaration annotation type} is * a kind of interface. * - * <p> <a name="DECL_VS_TYPE"></a> - * While a <tt>TypeDeclaration</tt> represents the <i>declaration</i> + * <p> <a id="DECL_VS_TYPE"></a> + * While a <code>TypeDeclaration</code> represents the <i>declaration</i> * of a class or interface, a {@link DeclaredType} represents a class * or interface <i>type</i>, the latter being a use * (or <i>invocation</i>) of the former. @@ -84,7 +84,7 @@ public interface TypeDeclaration extends MemberDeclaration { * The name of a generic type does not include any reference * to its formal type parameters. * For example, the the fully qualified name of the interface declaration - * {@code java.util.Set<E>} is <tt>"java.util.Set"</tt>. + * {@code java.util.Set<E>} is <code>"java.util.Set"</code>. * * @return the fully qualified name of this class or interface declaration */ @@ -124,8 +124,8 @@ public interface TypeDeclaration extends MemberDeclaration { * Returns the methods that are directly declared by this class or * interface. Includes annotation type elements. Excludes * implicitly declared methods of an interface, such as - * <tt>toString</tt>, that correspond to the methods of - * <tt>java.lang.Object</tt>. + * <code>toString</code>, that correspond to the methods of + * <code>java.lang.Object</code>. * * @return the methods that are directly declared, * or an empty collection if there are none diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/TypeParameterDeclaration.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/TypeParameterDeclaration.java index 9feb0cd216..b0fd698dab 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/TypeParameterDeclaration.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/declaration/TypeParameterDeclaration.java @@ -54,7 +54,7 @@ public interface TypeParameterDeclaration extends Declaration { * Returns the bounds of this type parameter. * These are the types given by the <i>extends</i> clause. * If there is no explicit <i>extends</i> clause, then - * <tt>java.lang.Object</tt> is considered to be the sole bound. + * <code>java.lang.Object</code> is considered to be the sole bound. * * @return the bounds of this type parameter */ diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/ClassType.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/ClassType.java index a622cac883..118d79519d 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/ClassType.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/ClassType.java @@ -41,7 +41,7 @@ import com.sun.mirror.declaration.*; * Note that an {@linkplain EnumType enum} is a kind of class. * * <p> While a {@link ClassDeclaration} represents the <i>declaration</i> - * of a class, a <tt>ClassType</tt> represents a class <i>type</i>. + * of a class, a <code>ClassType</code> represents a class <i>type</i>. * See {@link TypeDeclaration} for more on this distinction. * * @author Joseph D. Darcy @@ -62,15 +62,15 @@ public interface ClassType extends DeclaredType { * Returns the class type that is a direct supertype of this one. * This is the superclass of this type's declaring class, with any * type arguments substituted in. - * The only class with no superclass is <tt>java.lang.Object</tt>, - * for which this method returns <tt>null</tt>. + * The only class with no superclass is <code>java.lang.Object</code>, + * for which this method returns <code>null</code>. * * <p> For example, the class type extended by * {@code java.util.TreeSet<String>} is * {@code java.util.AbstractSet<String>}. * * @return the class type that is a direct supertype of this one, - * or <tt>null</tt> if there is none + * or <code>null</code> if there is none */ ClassType getSuperclass(); } diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/DeclaredType.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/DeclaredType.java index 7ebff111b6..4ffa5ca704 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/DeclaredType.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/DeclaredType.java @@ -42,15 +42,15 @@ import com.sun.mirror.declaration.TypeDeclaration; * This includes parameterized types such as {@code java.util.Set<String>} * as well as raw types. * - * <p> While a <tt>TypeDeclaration</tt> represents the <i>declaration</i> - * of a class or interface, a <tt>DeclaredType</tt> represents a class + * <p> While a <code>TypeDeclaration</code> represents the <i>declaration</i> + * of a class or interface, a <code>DeclaredType</code> represents a class * or interface <i>type</i>, the latter being a use of the former. * See {@link TypeDeclaration} for more on this distinction. * - * <p> A <tt>DeclaredType</tt> may represent a type + * <p> A <code>DeclaredType</code> may represent a type * for which details (declaration, supertypes, <i>etc.</i>) are unknown. * This may be the result of a processing error, such as a missing class file, - * and is indicated by {@link #getDeclaration()} returning <tt>null</tt>. + * and is indicated by {@link #getDeclaration()} returning <code>null</code>. * Other method invocations on such an unknown type will not, in general, * return meaningful results. * @@ -74,14 +74,14 @@ public interface DeclaredType extends ReferenceType { /** * Returns the type that contains this type as a member. - * Returns <tt>null</tt> if this is a top-level type. + * Returns <code>null</code> if this is a top-level type. * * <p> For example, the containing type of {@code O.I<S>} * is the type {@code O}, and the containing type of * {@code O<T>.I<S>} is the type {@code O<T>}. * * @return the type that contains this type, - * or <tt>null</tt> if this is a top-level type + * or <code>null</code> if this is a top-level type */ DeclaredType getContainingType(); diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/InterfaceType.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/InterfaceType.java index 44356755f6..bd11d84cf1 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/InterfaceType.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/InterfaceType.java @@ -41,7 +41,7 @@ import com.sun.mirror.declaration.*; * a kind of interface. * * <p> While an {@link InterfaceDeclaration} represents the - * <i>declaration</i> of an interface, an <tt>InterfaceType</tt> + * <i>declaration</i> of an interface, an <code>InterfaceType</code> * represents an interface <i>type</i>. * See {@link TypeDeclaration} for more on this distinction. * diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/MirroredTypeException.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/MirroredTypeException.java index 2c59980671..c21b7f0642 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/MirroredTypeException.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/MirroredTypeException.java @@ -65,7 +65,7 @@ public class MirroredTypeException extends RuntimeException { * The type mirror may be unavailable if this exception has been * serialized and then read back in. * - * @return the type mirror, or <tt>null</tt> if unavailable + * @return the type mirror, or <code>null</code> if unavailable */ public TypeMirror getTypeMirror() { return type; @@ -74,8 +74,8 @@ public class MirroredTypeException extends RuntimeException { /** * Returns the fully qualified name of the type being accessed. * More precisely, returns the canonical name of a class, - * interface, array, or primitive, and returns <tt>"void"</tt> for - * the pseudo-type representing the type of <tt>void</tt>. + * interface, array, or primitive, and returns <code>"void"</code> for + * the pseudo-type representing the type of <code>void</code>. * * @return the fully qualified name of the type being accessed */ diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/MirroredTypesException.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/MirroredTypesException.java index 104211a7ba..64ae8c3221 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/MirroredTypesException.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/MirroredTypesException.java @@ -72,7 +72,7 @@ public class MirroredTypesException extends RuntimeException { * The type mirrors may be unavailable if this exception has been * serialized and then read back in. * - * @return the type mirrors in order, or <tt>null</tt> if unavailable + * @return the type mirrors in order, or <code>null</code> if unavailable */ public Collection<TypeMirror> getTypeMirrors() { return (types != null) @@ -83,8 +83,8 @@ public class MirroredTypesException extends RuntimeException { /** * Returns the fully qualified names of the types being accessed. * More precisely, returns the canonical names of each class, - * interface, array, or primitive, and <tt>"void"</tt> for - * the pseudo-type representing the type of <tt>void</tt>. + * interface, array, or primitive, and <code>"void"</code> for + * the pseudo-type representing the type of <code>void</code>. * * @return the fully qualified names, in order, of the types being * accessed diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/PrimitiveType.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/PrimitiveType.java index 645aef3991..d5bf267cf5 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/PrimitiveType.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/PrimitiveType.java @@ -34,8 +34,8 @@ package com.sun.mirror.type; /** * Represents a primitive type. These include - * <tt>boolean</tt>, <tt>byte</tt>, <tt>short</tt>, <tt>int</tt>, - * <tt>long</tt>, <tt>char</tt>, <tt>float</tt>, and <tt>double</tt>. + * <code>boolean</code>, <code>byte</code>, <code>short</code>, <code>int</code>, + * <code>long</code>, <code>char</code>, <code>float</code>, and <code>double</code>. * * @author Joseph D. Darcy * @author Scott Seligman @@ -56,13 +56,13 @@ public interface PrimitiveType extends TypeMirror { * An enumeration of the different kinds of primitive types. */ enum Kind { - /** The primitive type <tt>boolean</tt> */ BOOLEAN, - /** The primitive type <tt>byte</tt> */ BYTE, - /** The primitive type <tt>short</tt> */ SHORT, - /** The primitive type <tt>int</tt> */ INT, - /** The primitive type <tt>long</tt> */ LONG, - /** The primitive type <tt>char</tt> */ CHAR, - /** The primitive type <tt>float</tt> */ FLOAT, - /** The primitive type <tt>double</tt> */ DOUBLE + /** The primitive type <code>boolean</code> */ BOOLEAN, + /** The primitive type <code>byte</code> */ BYTE, + /** The primitive type <code>short</code> */ SHORT, + /** The primitive type <code>int</code> */ INT, + /** The primitive type <code>long</code> */ LONG, + /** The primitive type <code>char</code> */ CHAR, + /** The primitive type <code>float</code> */ FLOAT, + /** The primitive type <code>double</code> */ DOUBLE } } diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/TypeMirror.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/TypeMirror.java index 24578c1b2c..10849edfe3 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/TypeMirror.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/TypeMirror.java @@ -41,7 +41,7 @@ import com.sun.mirror.util.TypeVisitor; * Represents a type in the Java programming language. * Types include primitive types, class and interface types, array * types, and type variables. Wildcard type arguments, and the - * pseudo-type representing the type of <tt>void</tt>, are represented + * pseudo-type representing the type of <code>void</code>, are represented * by type mirrors as well. * * <p> Types may be compared using the utility methods in @@ -73,7 +73,7 @@ public interface TypeMirror { * Tests whether two types represent the same type. * * @param obj the object to be compared with this type - * @return <tt>true</tt> if the specified object represents the same + * @return <code>true</code> if the specified object represents the same * type as this. */ @Override diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/VoidType.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/VoidType.java index 005ba5f0b7..b8d41f2ba0 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/VoidType.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/VoidType.java @@ -36,7 +36,7 @@ import com.sun.mirror.declaration.MethodDeclaration; /** - * A pseudo-type representing the type of <tt>void</tt>. + * A pseudo-type representing the type of <code>void</code>. * * @author Joseph D. Darcy * @author Scott Seligman diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/WildcardType.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/WildcardType.java index 2d47000a92..cdb3491edf 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/WildcardType.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/type/WildcardType.java @@ -37,15 +37,16 @@ import java.util.Collection; /** * Represents a wildcard type argument. - * Examples include: <pre><tt> + * Examples include: <pre><code> * ? * ? extends Number * ? super T - * </tt></pre> + * </code></pre> * * <p> A wildcard may have its upper bound explicitly set by an - * <tt>extends</tt> clause, its lower bound explicitly set by a - * <tt>super</tt> clause, or neither (but not both). + * <code>extends</code> clause, its lower bound explicitly set by a + * <code>super</code> clause, or neither (but not both). + * </p> * * @author Joseph D. Darcy * @author Scott Seligman diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/DeclarationFilter.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/DeclarationFilter.java index c3bf7abd7a..358278efc9 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/DeclarationFilter.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/DeclarationFilter.java @@ -54,7 +54,7 @@ import static com.sun.mirror.declaration.Modifier.*; * the {@link #matches(Declaration)} method. * * <p> Examples. - * <p> Selecting the <tt>public</tt> declarations from a collection: + * <p> Selecting the <code>public</code> declarations from a collection: * <blockquote><pre> * result = FILTER_PUBLIC.filter(decls); </pre></blockquote> * Selecting class declarations (including enums): @@ -86,19 +86,19 @@ public class DeclarationFilter { // Predefined filters for convenience. /** - * A filter that selects only <tt>public</tt> declarations. + * A filter that selects only <code>public</code> declarations. */ public static final DeclarationFilter FILTER_PUBLIC = new AccessFilter(PUBLIC); /** - * A filter that selects only <tt>protected</tt> declarations. + * A filter that selects only <code>protected</code> declarations. */ public static final DeclarationFilter FILTER_PROTECTED = new AccessFilter(PROTECTED); /** - * A filter that selects only <tt>public</tt> or <tt>protected</tt> + * A filter that selects only <code>public</code> or <code>protected</code> * declarations. */ public static final DeclarationFilter FILTER_PUBLIC_OR_PROTECTED = @@ -112,7 +112,7 @@ public class DeclarationFilter { new AccessFilter(); /** - * A filter that selects only <tt>private</tt> declarations. + * A filter that selects only <code>private</code> declarations. */ public static final DeclarationFilter FILTER_PRIVATE = new AccessFilter(PRIVATE); @@ -133,7 +133,7 @@ public class DeclarationFilter { * collection of modifiers. * * @param mods the modifiers to match (non-null) - * @return a filter that matches declarations containing <tt>mods</tt> + * @return a filter that matches declarations containing <code>mods</code> */ public static DeclarationFilter getFilter( final Collection<Modifier> mods) { @@ -226,11 +226,11 @@ public class DeclarationFilter { /** * Tests whether this filter matches a given declaration. - * The default implementation always returns <tt>true</tt>; + * The default implementation always returns <code>true</code>; * subclasses should override this. * * @param decl the declaration to match - * @return <tt>true</tt> if this filter matches the given declaration + * @return <code>true</code> if this filter matches the given declaration */ public boolean matches(Declaration decl) { return true; @@ -240,7 +240,7 @@ public class DeclarationFilter { * Returns the declarations matched by this filter. * The result is a collection of the same type as the argument; * the {@linkplain #filter(Collection, Class) two-parameter version} - * of <tt>filter</tt> offers control over the result type. + * of <code>filter</code> offers control over the result type. * * @param <D> type of the declarations being filtered * @param decls declarations being filtered @@ -261,12 +261,12 @@ public class DeclarationFilter { * being restricted to declarations of a given kind. * Similar to the simpler * {@linkplain #filter(Collection) single-parameter version} - * of <tt>filter</tt>, but the result type is specified explicitly. + * of <code>filter</code>, but the result type is specified explicitly. * * @param <D> type of the declarations being returned * @param decls declarations being filtered * @param resType type of the declarations being returned -- - * the reflective view of <tt>D</tt> + * the reflective view of <code>D</code> * @return the declarations matched by this filter, restricted to those * of the specified type */ diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/DeclarationVisitor.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/DeclarationVisitor.java index d400edc6fe..1e701cebf4 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/DeclarationVisitor.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/DeclarationVisitor.java @@ -40,7 +40,7 @@ import com.sun.mirror.declaration.*; * operate on a declaration when the kind of declaration is unknown at * compile time. When a visitor is passed to a declaration's {@link * Declaration#accept accept} method, the most specific - * <tt>visit<i>Xxx</i></tt> method applicable to that declaration is + * <code>visitXxx</code> method applicable to that declaration is * invoked. * * @author Joseph D. Darcy diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/DeclarationVisitors.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/DeclarationVisitors.java index ca6024f827..56d4eda98d 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/DeclarationVisitors.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/DeclarationVisitors.java @@ -32,7 +32,7 @@ package com.sun.mirror.util; /** - * Utilities to create specialized <tt>DeclarationVisitor</tt> instances. + * Utilities to create specialized <code>DeclarationVisitor</code> instances. * * @author Joseph D. Darcy * @author Scott Seligman @@ -48,15 +48,15 @@ public class DeclarationVisitors { public static final DeclarationVisitor NO_OP = new SimpleDeclarationVisitor(); /** - * Return a <tt>DeclarationVisitor</tt> that will scan the + * Return a <code>DeclarationVisitor</code> that will scan the * declaration structure, visiting declarations contained in * another declaration. For example, when visiting a class, the * fields, methods, constructors, etc. of the class are also * visited. The order in which the contained declarations are scanned is * not specified. * - * <p>The <tt>pre</tt> and <tt>post</tt> - * <tt>DeclarationVisitor</tt> parameters specify, + * <p>The <code>pre</code> and <code>post</code> + * <code>DeclarationVisitor</code> parameters specify, * respectively, the processing the scanner will do before or * after visiting the contained declarations. If only one of pre * and post processing is needed, use {@link @@ -75,7 +75,7 @@ public class DeclarationVisitors { } /** - * Return a <tt>DeclarationVisitor</tt> that will scan the + * Return a <code>DeclarationVisitor</code> that will scan the * declaration structure, visiting declarations contained in * another declaration in source code order. For example, when * visiting a class, the fields, methods, constructors, etc. of @@ -84,8 +84,8 @@ public class DeclarationVisitors { * possible; declaration mirrors created from class files instead * of source code will not have source position information. * - * <p>The <tt>pre</tt> and <tt>post</tt> - * <tt>DeclarationVisitor</tt> parameters specify, + * <p>The <code>pre</code> and <code>post</code> + * <code>DeclarationVisitor</code> parameters specify, * respectively, the processing the scanner will do before or * after visiting the contained declarations. If only one of pre * and post processing is needed, use {@link diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/Declarations.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/Declarations.java index 62ff127c02..3a666c1fe5 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/Declarations.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/Declarations.java @@ -51,7 +51,7 @@ public interface Declarations { * * @param sub the first member * @param sup the second member - * @return <tt>true</tt> if and only if the first member hides + * @return <code>true</code> if and only if the first member hides * the second */ boolean hides(MemberDeclaration sub, MemberDeclaration sup); @@ -63,7 +63,7 @@ public interface Declarations { * * @param sub the first method * @param sup the second method - * @return <tt>true</tt> if and only if the first method overrides + * @return <code>true</code> if and only if the first method overrides * the second */ boolean overrides(MethodDeclaration sub, MethodDeclaration sup); diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/SimpleDeclarationVisitor.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/SimpleDeclarationVisitor.java index 0a42c81a0a..5e54fc58a7 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/SimpleDeclarationVisitor.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/SimpleDeclarationVisitor.java @@ -52,7 +52,7 @@ import com.sun.mirror.declaration.*; public class SimpleDeclarationVisitor implements DeclarationVisitor { /** - * Creates a new <tt>SimpleDeclarationVisitor</tt>. + * Creates a new <code>SimpleDeclarationVisitor</code>. */ public SimpleDeclarationVisitor(){} diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/SimpleTypeVisitor.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/SimpleTypeVisitor.java index c61f711f45..97cb862e2c 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/SimpleTypeVisitor.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/SimpleTypeVisitor.java @@ -52,7 +52,7 @@ import com.sun.mirror.type.*; public class SimpleTypeVisitor implements TypeVisitor { /** - * Creates a new <tt>SimpleTypeVisitor</tt>. + * Creates a new <code>SimpleTypeVisitor</code>. */ public SimpleTypeVisitor() {} diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/TypeVisitor.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/TypeVisitor.java index 9ba7670c8f..e82850ccf5 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/TypeVisitor.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/TypeVisitor.java @@ -41,7 +41,7 @@ import com.sun.mirror.type.*; * of type is unknown at compile time. * When a visitor is passed to a type's * {@link TypeMirror#accept accept} method, - * the most specific <tt>visit<i>Xxx</i></tt> method applicable to + * the most specific <code>visitXxx</code> method applicable to * that type is invoked. * * @author Joseph D. Darcy diff --git a/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/Types.java b/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/Types.java index e084c68239..77a31f8ede 100644 --- a/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/Types.java +++ b/org.eclipse.jdt.apt.core/src/com/sun/mirror/util/Types.java @@ -55,7 +55,7 @@ public interface Types { * * @param t1 the first type * @param t2 the second type - * @return <tt>true</tt> if and only if the first type is a subtype + * @return <code>true</code> if and only if the first type is a subtype * of the second */ boolean isSubtype(TypeMirror t1, TypeMirror t2); @@ -65,7 +65,7 @@ public interface Types { * * @param t1 the first type * @param t2 the second type - * @return <tt>true</tt> if and only if the first type is assignable + * @return <code>true</code> if and only if the first type is assignable * to the second */ boolean isAssignable(TypeMirror t1, TypeMirror t2); @@ -87,9 +87,9 @@ public interface Types { PrimitiveType getPrimitiveType(PrimitiveType.Kind kind); /** - * Returns the pseudo-type representing the type of <tt>void</tt>. + * Returns the pseudo-type representing the type of <code>void</code>. * - * @return the pseudo-type representing the type of <tt>void</tt> + * @return the pseudo-type representing the type of <code>void</code> */ VoidType getVoidType(); @@ -129,9 +129,9 @@ public interface Types { /** * Returns the type corresponding to a type declaration and * actual type arguments. - * Given the declaration for <tt>String</tt>, for example, this - * method may be used to get the <tt>String</tt> type. It may - * then be invoked a second time, with the declaration for <tt>Set</tt>, + * Given the declaration for <code>String</code>, for example, this + * method may be used to get the <code>String</code> type. It may + * then be invoked a second time, with the declaration for <code>Set</code>, * to make the parameterized type {@code Set<String>}. * * <p> The number of type arguments must either equal the @@ -171,10 +171,10 @@ public interface Types { * <p> If the containing type is a parameterized type, * the number of type arguments must equal the * number of the declaration's formal type parameters. - * If it is not parameterized or if it is <tt>null</tt>, this method is - * equivalent to <tt>getDeclaredType(decl, typeArgs)</tt>. + * If it is not parameterized or if it is <code>null</code>, this method is + * equivalent to <code>getDeclaredType(decl, typeArgs)</code>. * - * @param containing the containing type, or <tt>null</tt> if none + * @param containing the containing type, or <code>null</code> if none * @param decl the type declaration * @param typeArgs the actual type arguments * @return the type corresponding to the type declaration and diff --git a/org.eclipse.jdt.apt.core/src/org/eclipse/jdt/apt/core/util/AptPreferenceConstants.java b/org.eclipse.jdt.apt.core/src/org/eclipse/jdt/apt/core/util/AptPreferenceConstants.java index 5f3e6438d0..6af9091c0e 100644 --- a/org.eclipse.jdt.apt.core/src/org/eclipse/jdt/apt/core/util/AptPreferenceConstants.java +++ b/org.eclipse.jdt.apt.core/src/org/eclipse/jdt/apt/core/util/AptPreferenceConstants.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2005, 2018 BEA Systems, Inc. and others + * Copyright (c) 2005, 2019 BEA Systems, Inc. and others * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -61,7 +61,7 @@ public class AptPreferenceConstants { * in order to disable processing while editing, that is, during reconcile. If this option is set, ie if processing * is disabled, then the value of {@link #RTTG_ENABLED_OPTION} will be ignored. Whether a processor is called * during reconcile is also influenced by the project settings and the project factory path. - * <p> + * * @see AptConfig#setProcessDuringReconcile(org.eclipse.jdt.core.IJavaProject, boolean) */ public static final String PROCESSING_IN_EDITOR_DISABLED_OPTION = "disableProcessingInEditor"; //$NON-NLS-1$ diff --git a/org.eclipse.jdt.core/batch/org/eclipse/jdt/core/compiler/batch/BatchCompiler.java b/org.eclipse.jdt.core/batch/org/eclipse/jdt/core/compiler/batch/BatchCompiler.java index 65d20e6dcf..7e4ca11bf2 100644 --- a/org.eclipse.jdt.core/batch/org/eclipse/jdt/core/compiler/batch/BatchCompiler.java +++ b/org.eclipse.jdt.core/batch/org/eclipse/jdt/core/compiler/batch/BatchCompiler.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2008, 2010 IBM Corporation and others. + * Copyright (c) 2008, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -43,7 +43,6 @@ public final class BatchCompiler { * <p> * The specification of the command line arguments is defined by running the batch compiler's help * <pre>BatchCompiler.compile("-help", new PrintWriter(System.out), new PrintWriter(System.err), null);</pre> - * </p> * * @param commandLine the command line arguments passed to the compiler * @param outWriter the writer used to print standard messages @@ -69,7 +68,7 @@ public final class BatchCompiler { * <p> * The specification of the command line arguments is defined by running the batch compiler's help * <pre>BatchCompiler.compile("-help", new PrintWriter(System.out), new PrintWriter(System.err), null);</pre> - * </p> + * <p> * Note that a <code>true</code> returned value indicates that no errors were reported, no runtime exceptions * occurred and that the compilation was not canceled. * diff --git a/org.eclipse.jdt.core/compiler/org/eclipse/jdt/core/compiler/CategorizedProblem.java b/org.eclipse.jdt.core/compiler/org/eclipse/jdt/core/compiler/CategorizedProblem.java index 881870b887..41add2dcf4 100644 --- a/org.eclipse.jdt.core/compiler/org/eclipse/jdt/core/compiler/CategorizedProblem.java +++ b/org.eclipse.jdt.core/compiler/org/eclipse/jdt/core/compiler/CategorizedProblem.java @@ -157,7 +157,7 @@ public String[] getExtraMarkerAttributeNames() { * Returns the respective values for the extra marker attributes associated to this problem when persisted into * a marker by the JavaBuilder. Each value must correspond to a matching attribute name, as defined by * {@link #getExtraMarkerAttributeNames()}. - * The values must be eligible for marker creation, as defined by <code> IMarker#setAttributes(String[], Object[])}. + * The values must be eligible for marker creation, as defined by <code> IMarker#setAttributes(String[], Object[])}</code>. * @return the values of the corresponding extra marker attributes */ public Object[] getExtraMarkerAttributeValues() { diff --git a/org.eclipse.jdt.core/compiler/org/eclipse/jdt/core/compiler/CharOperation.java b/org.eclipse.jdt.core/compiler/org/eclipse/jdt/core/compiler/CharOperation.java index 21556a1ef7..25b704fd3d 100644 --- a/org.eclipse.jdt.core/compiler/org/eclipse/jdt/core/compiler/CharOperation.java +++ b/org.eclipse.jdt.core/compiler/org/eclipse/jdt/core/compiler/CharOperation.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2017 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -296,8 +296,8 @@ public static final char[][] arrayConcat(char[][] first, char[][] second) { * For instance, 'HM' , 'HaMa' and 'HMap' patterns will match 'HashMap', * 'HatMapper' <b>and also</b> 'HashMapEntry'. * <p> - * <pre> - * Examples:<ol> + * Examples: + * <ol> * <li> pattern = "NPE".toCharArray() * name = "NullPointerException".toCharArray() * result => true</li> @@ -319,7 +319,7 @@ public static final char[][] arrayConcat(char[][] first, char[][] second) { * <li> pattern = "HM".toCharArray() * name = "HashMapEntry".toCharArray() * result => true</li> - * </ol></pre> + * </ol> * * @param pattern the given pattern * @param name the given name @@ -366,7 +366,6 @@ public static final boolean camelCaseMatch(char[] pattern, char[] name) { * For instance, 'HM' , 'HaMa' and 'HMap' patterns will match 'HashMap' and * 'HatMapper' <b>but not</b> 'HashMapEntry'. * <p> - * <pre> * Examples:<ol> * <li> pattern = "NPE".toCharArray() * name = "NullPointerException".toCharArray() @@ -389,7 +388,7 @@ public static final boolean camelCaseMatch(char[] pattern, char[] name) { * <li> pattern = "HM".toCharArray() * name = "HashMapEntry".toCharArray() * result => (samePartCount == false)</li> - * </ol></pre> + * </ol> * * @param pattern the given pattern * @param name the given name @@ -550,7 +549,6 @@ public static final boolean camelCaseMatch(char[] pattern, int patternStart, int * For instance, 'HM' , 'HaMa' and 'HMap' patterns will match 'HashMap' and * 'HatMapper' <b>but not</b> 'HashMapEntry'. * <p> - * <pre> * Examples: * <ol> * <li> pattern = "NPE".toCharArray() @@ -603,7 +601,6 @@ public static final boolean camelCaseMatch(char[] pattern, int patternStart, int * nameEnd = 12 * result => (samePartCount == false)</li> * </ol> - * </pre> * * @param pattern the given pattern * @param patternStart the start index of the pattern, inclusive @@ -1026,7 +1023,6 @@ public static final int compareTo(char[] array1, char[] array2, int start, int e * </pre> * </li> * </ol> - * </p> * * @param array the given array * @param prefix the given prefix @@ -1414,7 +1410,7 @@ public static final char[] concat( * => result = { ' a' , '/', 'b' } * </pre> * </li> - * * <li><pre> + * <li><pre> * first = { ' a' } * second = { } * separator = '/' diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/AST.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/AST.java index 6200f6db22..f2b6bc5d6e 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/AST.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/AST.java @@ -69,6 +69,7 @@ import org.eclipse.text.edits.TextEdit; * Compilation units created by <code>ASTParser</code> from a * source document can be serialized after arbitrary modifications * with minimal loss of original formatting. Here is an example: + * </p> * <pre> * Document doc = new Document("import java.util.List;\nclass X {}\n"); * ASTParser parser = ASTParser.newParser(AST.JLS3); @@ -82,6 +83,7 @@ import org.eclipse.text.edits.TextEdit; * TextEdit edits = cu.rewrite(document, null); * UndoEdit undo = edits.apply(document); * </pre> + * <p> * See also {@link org.eclipse.jdt.core.dom.rewrite.ASTRewrite} for * an alternative way to describe and serialize changes to a * read-only AST. @@ -907,6 +909,7 @@ public final class AST { * <code>"1.7"</code> means the source code is as per JDK 1.7; * additional legal values may be added later. </li> * </ul> + * <p> * Options other than the above are ignored. * </p> * @@ -1123,9 +1126,10 @@ public final class AST { * <li>removing a child from a node owned by this AST,</li> * <li>setting a non-node attribute of a node owned by this AST.</li> * </ul> - * </p> + * <p> * Operations which do not entail creating or modifying existing nodes * do not increase the modification count. + * </p> * <p> * N.B. This method may be called several times in the course * of a single client operation. The only promise is that the modification @@ -1150,7 +1154,6 @@ public final class AST { * <li>removing a child from a node owned by this AST</li> * <li>setting a non-node attribute of a node owned by this AST</li>. * </ul> - * </p> * <p> * N.B. This method may be called several times in the course * of a single client operation. @@ -1235,8 +1238,8 @@ public final class AST { * array initializer. * <p> * Examples: - * <code> * <pre> + * <code> * // new String[len] * ArrayCreation ac1 = ast.newArrayCreation(); * ac1.setType( @@ -1261,9 +1264,8 @@ public final class AST { * ac3.setInitializer(ai); * ai.expressions().add(ast.newNumberLiteral("1")); * ai.expressions().add(ast.newNumberLiteral("2")); - * </pre> * </code> - * </p> + * </pre> * * @return a new unparented array creation expression node */ @@ -1289,6 +1291,7 @@ public final class AST { * By default, the array type has one non-annotated dimension. * <p> * For JLS4 and before, the given component type may be another array type. + * </p> * * @param elementType element type for API level JLS8 and later, or the * component type (possibly another array type) for levels less than JLS8 @@ -1427,14 +1430,13 @@ public final class AST { * <p> * For example, the assignment expression <code>foo = true</code> * is generated by the following snippet: - * <code> * <pre> + * <code> * Assignment e= ast.newAssignment(); * e.setLeftHandSide(ast.newSimpleName("foo")); * e.setRightHandSide(ast.newBooleanLiteral(true)); - * </pre> * </code> - * </p> + * </pre> * * @param value the boolean value * @return a new unparented boolean literal node @@ -3311,7 +3313,6 @@ public final class AST { * <li><code>"java.lang.Void"</code> (since 3.1)</li> * <li><code>"java.io.Serializable"</code></li> * </ul> - * </p> * * @param name the name of a well known type * @return the corresponding type binding, or <code>null</code> if the diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ASTNode.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ASTNode.java index a635cbdc15..40dbea9573 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ASTNode.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ASTNode.java @@ -70,7 +70,6 @@ import org.eclipse.jdt.internal.core.dom.NaiveASTFlattener; * <li>types - <code>Type</code></li> * <li>type body declarations - <code>BodyDeclaration</code></li> * </ul> - * </p> * <p> * Abstract syntax trees may be hand constructed by clients, using the * <code>new<i>TYPE</i></code> factory methods (see <code>AST</code>) to @@ -1677,7 +1676,6 @@ public abstract class ASTNode { /** * Returns the location of this node within its parent, * or <code>null</code> if this is a root node. - * <p> * <pre> * ASTNode node = ...; * ASTNode parent = node.getParent(); @@ -1688,7 +1686,6 @@ public abstract class ASTNode { * if ((location != null) && location.isChildListProperty()) * assert ((List) parent.getStructuralProperty(location)).contains(node); * </pre> - * </p> * <p> * Note that the relationship between an AST node and its parent node * may change over the lifetime of a node. @@ -2576,7 +2573,6 @@ public abstract class ASTNode { * is recovered from source that contains a syntax error</li> * </ul> * Other bit positions are reserved for future use. - * </p> * * @return the bitwise-or of individual flags * @see #setFlags(int) @@ -2601,7 +2597,6 @@ public abstract class ASTNode { * is recovered from source that contains a syntax error</li> * </ul> * Other bit positions are reserved for future use. - * </p> * <p> * Note that the flags are <em>not</em> considered a structural * property of the node, and can be changed even if the diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ASTParser.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ASTParser.java index 67c634c634..c90c963674 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ASTParser.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ASTParser.java @@ -63,6 +63,7 @@ import org.eclipse.jdt.internal.core.util.Util; * parser.setCompilerOptions(options); * CompilationUnit result = (CompilationUnit) parser.createAST(null); * </pre> + * <p> * Once a configured parser instance has been used to create an AST, * the settings are automatically reset to their defaults, * ready for the parser instance to be reused. @@ -90,7 +91,6 @@ import org.eclipse.jdt.internal.core.util.Util; * <li>Whether to return a {@linkplain #setFocalPosition(int) abridged AST} * focused on the declaration containing a given source position.</li> * </ul> - * </p> * * @since 3.0 * @noinstantiate This class is not intended to be instantiated by clients. @@ -512,10 +512,12 @@ public class ASTParser { * <li>{@link #K_EXPRESSION K_EXPRESSION}: The result node is a subclass of * {@link Expression Expression}. Other aspects of the expression are unspecified.</li> * </ul> + * <p> * The resulting AST node is rooted under (possibly contrived) * {@link CompilationUnit CompilationUnit} node, to allow the * client to retrieve the following pieces of information * available there: + * </p> * <ul> * <li>{@linkplain CompilationUnit#getLineNumber(int) Line number map}. Line * numbers start at 1 and only cover the subrange scanned @@ -527,6 +529,7 @@ public class ASTParser { * <li>{@linkplain CompilationUnit#getCommentList() Comment list} * for the subrange scanned.</li> * </ul> + * <p> * The contrived nodes do not have source positions. Other aspects of the * {@link CompilationUnit CompilationUnit} node are unspecified, including * the exact arrangement of intervening nodes. @@ -852,6 +855,7 @@ public class ASTParser { * is called passing the compilation unit and the corresponding AST to <code>requestor</code>. * </li> * </ul> + * <p> * Note only ASTs from the given compilation units are reported * to the requestor. If additional compilation units are required to * resolve the original ones, the corresponding ASTs are <b>not</b> @@ -865,7 +869,6 @@ public class ASTParser { * <li>The {@linkplain #setSourceRange(int,int) source range} is <code>(0, -1)</code></li> * <li>The {@linkplain #setFocalPosition(int) focal position} is not set</li> * </ul> - * </p> * <p> * The <code>bindingKeys</code> parameter specifies bindings keys * ({@link IBinding#getKey()}) that are to be looked up. These keys may @@ -941,6 +944,7 @@ public class ASTParser { * path that is passed into the given <code>sourceFilePaths</code> parameter. * </li> * </ul> + * <p> * Note only ASTs from the given compilation units are reported * to the requestor. If additional compilation units are required to * resolve the original ones, the corresponding ASTs are <b>not</b> @@ -949,12 +953,12 @@ public class ASTParser { * <p> * Note also the following parser parameters are used, regardless of what * may have been specified: + * </p> * <ul> * <li>The {@linkplain #setKind(int) parser kind} is <code>K_COMPILATION_UNIT</code></li> * <li>The {@linkplain #setSourceRange(int,int) source range} is <code>(0, -1)</code></li> * <li>The {@linkplain #setFocalPosition(int) focal position} is not set</li> * </ul> - * </p> * <p> * The <code>bindingKeys</code> parameter specifies bindings keys * ({@link IBinding#getKey()}) that are to be looked up. These keys may @@ -1042,7 +1046,6 @@ public class ASTParser { * <li>The {@linkplain #setSourceRange(int,int) source range} is <code>(0, -1)</code></li> * <li>The {@linkplain #setFocalPosition(int) focal position} is not set</li> * </ul> - * </p> * <p> * A successful call to this method returns all settings to their * default values so the object is ready to be reused. @@ -1291,6 +1294,7 @@ public class ASTParser { * <li>{@linkplain CompilationUnit#getCommentList() Comment list} * for the subrange scanned.</li> * </ul> + * <p> * The contrived nodes do not have source positions. Other aspects of the * {@link CompilationUnit CompilationUnit} node are unspecified, including * the exact arrangment of intervening nodes. diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ASTVisitor.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ASTVisitor.java index 69774d3542..a7eb1fc1a3 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ASTVisitor.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ASTVisitor.java @@ -35,7 +35,7 @@ package org.eclipse.jdt.core.dom; * <code>false</code>). The default implementation provided by this class does * nothing. Subclasses may reimplement this method as needed.</li> * </ul> - * </p> + * <p> * In addition, there are a pair of methods for visiting AST nodes in the * abstract, regardless of node type: * <ul> diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Annotation.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Annotation.java index 24e611f28f..0db7956956 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Annotation.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Annotation.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2013 IBM Corporation and others. + * Copyright (c) 2004, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -15,14 +15,12 @@ package org.eclipse.jdt.core.dom; /** * Abstract base class of AST nodes that represent annotations. - * <p> * <pre> * Annotation: * NormalAnnotation * MarkerAnnotation * SingleMemberAnnotation * </pre> - * </p> * @since 3.1 */ @SuppressWarnings("rawtypes") diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ArrayCreation.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ArrayCreation.java index 493b1724ce..6cfde67889 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ArrayCreation.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ArrayCreation.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2013 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -35,7 +35,6 @@ import java.util.List; * <li>the dimension expressions are collected into the <code>dimensions</code> * list.</li> * </ul> - * </p> * * @since 2.0 * @noinstantiate This class is not intended to be instantiated by clients. diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/BodyDeclaration.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/BodyDeclaration.java index 3e21d5c971..6b48ec3f94 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/BodyDeclaration.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/BodyDeclaration.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2013 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -22,7 +22,6 @@ import java.util.List; * that may appear in the body of some kind of class or interface declaration, * including anonymous class declarations, enumeration declarations, and * enumeration constant declarations. - * <p> * <pre> * BodyDeclaration: * {@link AbstractTypeDeclaration} @@ -35,7 +34,6 @@ import java.util.List; * {@link Initializer} * {@link MethodDeclaration} (for methods and constructors) * </pre> - * </p> * <p> * All types of body declarations carry modifiers (and annotations), although they differ in * which modifiers are allowed. Most types of body declarations can carry a diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/CharacterLiteral.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/CharacterLiteral.java index 86f83d548f..786e83a644 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/CharacterLiteral.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/CharacterLiteral.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2014 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -200,7 +200,6 @@ public class CharacterLiteral extends Expression { * s.setEscapedValue("\'x\'"); * assert s.charValue() == 'x'; * </pre> - * </p> * * @return the character value without enclosing quotes and embedded * escapes @@ -300,7 +299,6 @@ public class CharacterLiteral extends Expression { * assert s.charValue() == 'x'; * assert s.getEscapedValue().equals("\'x\'"); * </pre> - * </p> * * @param value the character value */ diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ClassInstanceCreation.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ClassInstanceCreation.java index 1bfaeb66e1..8d27af0053 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ClassInstanceCreation.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ClassInstanceCreation.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2014 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -399,7 +399,7 @@ public class ClassInstanceCreation extends Expression { * @exception IllegalArgumentException if: * <ul> * <li>the node belongs to a different AST</li> - * <li>the node already has a parent</li>` + * <li>the node already has a parent</li> * </ul> * @exception UnsupportedOperationException if this operation is used in * an AST later than JLS2 @@ -459,7 +459,7 @@ public class ClassInstanceCreation extends Expression { * @exception IllegalArgumentException if: * <ul> * <li>the node belongs to a different AST</li> - * <li>the node already has a parent</li>` + * <li>the node already has a parent</li> * </ul> * @exception UnsupportedOperationException if this operation is used in * a JLS2 AST diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Comment.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Comment.java index 75020d9496..4b44887a17 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Comment.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Comment.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2009 IBM Corporation and others. + * Copyright (c) 2004, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -19,14 +19,12 @@ package org.eclipse.jdt.core.dom; * line comments ({@link LineComment}), * block comments ({@link BlockComment}), and * doc comments ({@link Javadoc}). - * <p> * <pre> * Comment: * LineComment * BlockComment * Javadoc * </pre> - * </p> * * @since 3.0 */ @@ -109,8 +107,6 @@ public abstract class Comment extends ASTNode { /** * Returns the root AST node that this comment occurs * within, or <code>null</code> if none (or not recorded). - * <p> - * </p> * * @param root the alternate root node, or <code>null</code> * if none diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/CompilationUnit.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/CompilationUnit.java index 9ba5b47e23..476435d902 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/CompilationUnit.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/CompilationUnit.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2018 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -349,6 +349,7 @@ public class CompilationUnit extends ASTNode { * <li>member value pair binding - an <code>MemberValuePair</code>, * or <code>null</code> if it represents a default value or a single member value</li> * </ul> + * <p> * For parameterized or raw type bindings, the declaring node is * that of the corresponding generic type. And for parameterized or raw * method bindings, the declaring node is that of the corresponding @@ -407,7 +408,6 @@ public class CompilationUnit extends ASTNode { * that of the corresponding generic type. And for parameterized or raw * method bindings, the declaring node is that of the corresponding * generic method. - * </p> * * @param key the binding key, or <code>null</code> * @return the corresponding node where a binding with the given diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Expression.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Expression.java index eccf166d2d..d0c40e2b05 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Expression.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Expression.java @@ -17,7 +17,6 @@ package org.eclipse.jdt.core.dom; /** * Abstract base class of AST nodes that represent expressions. * There are several kinds of expressions. - * <p> * <pre> * Expression: * {@link Annotation}, @@ -54,7 +53,6 @@ package org.eclipse.jdt.core.dom; * {@link TypeMethodReference}, * {@link VariableDeclarationExpression} * </pre> - * </p> * * @since 2.0 */ diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/FieldAccess.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/FieldAccess.java index 67fcc0bc40..1b72377c63 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/FieldAccess.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/FieldAccess.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2013 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -29,6 +29,7 @@ import java.util.List; * Note that there are several kinds of expressions that resemble field access * expressions: qualified names, this expressions, and super field access * expressions. The following guidelines help with correct usage: + * </p> * <ul> * <li>An expression like "foo.this" can only be represented as a this * expression (<code>ThisExpression</code>) containing a simple name. @@ -50,7 +51,6 @@ import java.util.List; * only be represented as field access expressions * (<code>FieldAccess</code>).</li> * </ul> - * </p> * * @see QualifiedName * @see ThisExpression diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/IBinding.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/IBinding.java index d18d7d55e9..bb33f37ee3 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/IBinding.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/IBinding.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2017 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -295,7 +295,6 @@ public interface IBinding { * <li>annotations - the key of the annotated element and the key of * the annotation type</li> * </ul> - * </p> * <p> * The key for a type binding does <em>not</em> contain {@link ITypeBinding#getTypeAnnotations() type annotations}, * so type bindings with different type annotations may have the same key (iff they denote the same un-annotated type). diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ITypeBinding.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ITypeBinding.java index d2f7188252..5a6ea7ab43 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ITypeBinding.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ITypeBinding.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2017 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -581,7 +581,6 @@ public interface ITypeBinding extends IBinding { * <li>java.lang.@Marker2 String</li> * <li>java.lang.String</li> * </ul> - * </p> * To get the type annotations on dimensions, clients should repeatedly call * {@link #getComponentType()} and get the type annotations from there. diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/IntersectionType.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/IntersectionType.java index 31030bf4d6..5d45767cda 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/IntersectionType.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/IntersectionType.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2013, 2014 IBM Corporation and others. + * Copyright (c) 2013, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -21,7 +21,7 @@ import java.util.List; * Type node for an intersection type in a cast expression (added in JLS8 API). * <pre> * IntersectionType: - * Type <b>&</b> Type { <b>&</b> Type } + * Type <b>&</b> Type { <b>&</b> Type } * </pre> * <p> * This kind of node is used only inside a cast expression. diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/MarkerAnnotation.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/MarkerAnnotation.java index 89b6637057..bd7a51fb84 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/MarkerAnnotation.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/MarkerAnnotation.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2013 IBM Corporation and others. + * Copyright (c) 2004, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -19,12 +19,10 @@ import java.util.List; /** * Marker annotation node (added in JLS3 API). The marker annotation * "@foo" is equivalent to the normal annotation "@foo()". - * <p> * <pre> * MarkerAnnotation: * <b>@</b> TypeName * </pre> - * </p> * * @since 3.1 * @noinstantiate This class is not intended to be instantiated by clients. diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/MemberValuePair.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/MemberValuePair.java index c1459ff7d3..b988b7d6f4 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/MemberValuePair.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/MemberValuePair.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2013 IBM Corporation and others. + * Copyright (c) 2004, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -19,11 +19,11 @@ import java.util.List; /** * Member value pair node (added in JLS3 API). Member value pairs appear in annotations. - * <p> * <pre> * MemberValuePair: * SimpleName <b>=</b> Expression * </pre> + * <p> * Within annotations, only certain kinds of expressions are meaningful, * including other annotations. * </p> diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ModuleDeclaration.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ModuleDeclaration.java index bdad064c85..eace44eeda 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ModuleDeclaration.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ModuleDeclaration.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2016, 2017 IBM Corporation and others. + * Copyright (c) 2016, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -24,8 +24,6 @@ import java.util.List; * { RequiresDirective | ExportsDirective | OpensDirective | UsesDirective | ProvidesDirective } * <b>}</b> * </pre> - * <p> - * </p> * * @since 3.14 * diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Name.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Name.java index 4e41ffafbc..eeb937b5dc 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Name.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Name.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2008 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -18,13 +18,11 @@ package org.eclipse.jdt.core.dom; * Abstract base class for all AST nodes that represent names. * There are exactly two kinds of name: simple ones * (<code>SimpleName</code>) and qualified ones (<code>QualifiedName</code>). - * <p> * <pre> * Name: * SimpleName * QualifiedName * </pre> - * </p> * * @since 2.0 * @noextend This class is not intended to be subclassed by clients. diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/NormalAnnotation.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/NormalAnnotation.java index f3c1228c75..4efea1700f 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/NormalAnnotation.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/NormalAnnotation.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2013 IBM Corporation and others. + * Copyright (c) 2004, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -18,12 +18,10 @@ import java.util.List; /** * Normal annotation node (added in JLS3 API). - * <p> * <pre> * NormalAnnotation: * <b>@</b> TypeName <b>(</b> [ MemberValuePair { <b>,</b> MemberValuePair } ] <b>)</b> * </pre> - * </p> * * @since 3.1 * @noinstantiate This class is not intended to be instantiated by clients. diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/SingleMemberAnnotation.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/SingleMemberAnnotation.java index d03a445fa4..5ec2ffe001 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/SingleMemberAnnotation.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/SingleMemberAnnotation.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2013 IBM Corporation and others. + * Copyright (c) 2004, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -19,11 +19,11 @@ import java.util.List; /** * Single member annotation node (added in JLS3 API). The single member annotation * "@foo(bar)" is equivalent to the normal annotation "@foo(value=bar)". - * <p> * <pre> * SingleMemberAnnotation: * <b>@</b> TypeName <b>(</b> Expression <b>)</b> * </pre> + * <p> * Within annotations, only certain kinds of expressions are meaningful, * including other annotations. * </p> diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Statement.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Statement.java index e81e2dd793..ecb61a56a0 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Statement.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Statement.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2013 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -112,8 +112,8 @@ public abstract class Statement extends ASTNode { * </p> * <p> * Examples: - * <code> * <pre> + * <code> * setLeadingComment("/* traditional comment */"); // correct * setLeadingComment("missing comment delimiters"); // wrong * setLeadingComment("/* unterminated traditional comment "); // wrong @@ -121,9 +121,8 @@ public abstract class Statement extends ASTNode { * setLeadingComment("// end-of-line comment\n"); // correct * setLeadingComment("// end-of-line comment without line terminator"); // correct * setLeadingComment("// broken\n end-of-line comment\n"); // wrong - * </pre> * </code> - * </p> + * </pre> * * @param comment the comment string, or <code>null</code> if none * @exception IllegalArgumentException if the comment string is invalid diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/StringLiteral.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/StringLiteral.java index 8541b6d837..fb7212264c 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/StringLiteral.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/StringLiteral.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2014 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -201,7 +201,6 @@ public class StringLiteral extends Expression { * s.setEscapedValue("\"hello\\nworld\""); * assert s.getLiteralValue().equals("hello\nworld"); * </pre> - * </p> * <p> * Note that this is a convenience method that converts from the stored * string literal token returned by <code>getEscapedLiteral</code>. @@ -245,7 +244,6 @@ public class StringLiteral extends Expression { * assert s.getEscapedValue().equals("\"hello\\nworld\""); * assert s.getLiteralValue().equals("hello\nworld"); * </pre> - * </p> * <p> * Note that this is a convenience method that converts to the stored * string literal token acceptable to <code>setEscapedLiteral</code>. diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/SwitchCase.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/SwitchCase.java index 444a0ef7ef..94404ed180 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/SwitchCase.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/SwitchCase.java @@ -20,7 +20,6 @@ import java.util.List; /** * Switch case AST node type. A switch case is a special kind of node used only * in switch statements. It is a <code>Statement</code> in name only. - * <p> * <pre> * SwitchCase: * <b>case</b> Expression <b>:</b> @@ -30,7 +29,6 @@ import java.util.List; * <b>case</b> [ Expression { <b>,</b> Expression } ] <b>{ : | ->}</b> * <b>default</b> <b>{ : | ->}</b> * </pre> - * </p> * * @since 2.0 * @noinstantiate This class is not intended to be instantiated by clients. diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/SwitchStatement.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/SwitchStatement.java index f3d05950e4..f248dd428c 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/SwitchStatement.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/SwitchStatement.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2014 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -19,7 +19,6 @@ import java.util.List; /** * Switch statement AST node type. - * <p> * <pre> * SwitchStatement: * <b>switch</b> <b>(</b> Expression <b>)</b> @@ -30,7 +29,6 @@ import java.util.List; * </pre> * <code>SwitchCase</code> nodes are treated as a kind of * <code>Statement</code>. - * </p> * * @since 2.0 * @noinstantiate This class is not intended to be instantiated by clients. diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/TagElement.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/TagElement.java index 71463bcf61..01ebce7ea7 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/TagElement.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/TagElement.java @@ -363,7 +363,6 @@ public final class TagElement extends ASTNode implements IDocElement { * The use of Name, MethodRef, and MemberRef nodes within * tag elements allows these fragments to be queried for * binding information. - * </p> * <p> * Adding and removing nodes from this list affects this node * dynamically. The nodes in this list may be of various diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Type.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Type.java index 5310e54b22..a5637bed80 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Type.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/Type.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2018 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -24,7 +24,6 @@ package org.eclipse.jdt.core.dom; * meaningful in the type argument position of a parameterized type. * UnionType got introduced in JLS4 to support common catch blocks for disjunctive types. * For JLS8, optional annotations indicated by {Annotation} got added. - * <p> * <pre> * Type: * AnnotatableType: @@ -63,9 +62,8 @@ package org.eclipse.jdt.core.dom; * {@link UnionType}: * Type <b>|</b> Type { <b>|</b> Type } * {@link IntersectionType}: - * Type <b>&</b> Type { <b>&</b> Type } + * Type <b>&</b> Type { <b>&</b> Type } * </pre> - * </p> * * @since 2.0 */ @@ -158,7 +156,6 @@ public abstract class Type extends ASTNode { * either rather than make assumptions. (Note also that the first form * became possible as of JLS3; only the second form existed in the * JLS2 API.) - * </p> * * @return <code>true</code> if this is a qualified type, and * <code>false</code> otherwise diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/TypeParameter.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/TypeParameter.java index 1dc8398846..19b450d1ef 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/TypeParameter.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/TypeParameter.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2003, 2014 IBM Corporation and others. + * Copyright (c) 2003, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -22,7 +22,7 @@ import java.util.List; * * <pre> * TypeParameter: - * { ExtendedModifier } Identifier [ <b>extends</b> Type { <b>&</b> Type } ] + * { ExtendedModifier } Identifier [ <b>extends</b> Type { <b>&</b> Type } ] * </pre> * * @since 3.1 diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/VariableDeclaration.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/VariableDeclaration.java index 98849f4c2a..053ae77a7e 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/VariableDeclaration.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/VariableDeclaration.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2014 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -19,13 +19,11 @@ import java.util.List; /** * Abstract base class of all AST node types that declare a single * variable. - * <p> * <pre> * VariableDeclaration: * SingleVariableDeclaration * VariableDeclarationFragment * </pre> - * </p> * * @see SingleVariableDeclaration * @see VariableDeclarationFragment diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/rewrite/ImportRewrite.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/rewrite/ImportRewrite.java index 1e01c1214f..45c8408f6a 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/rewrite/ImportRewrite.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/rewrite/ImportRewrite.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2018 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -97,7 +97,8 @@ import org.eclipse.text.edits.TextEdit; * <ul><li>{@link #setImportOrder(String[])} specifies the import groups and their preferred order</li> * <li>{@link #setOnDemandImportThreshold(int)} specifies the number of imports in a group needed for a on-demand import statement (star import)</li> * <li>{@link #setStaticOnDemandImportThreshold(int)} specifies the number of static imports in a group needed for a on-demand import statement (star import)</li> - *</ul> + * </ul> + * <p> * This class is not intended to be subclassed. * </p> * @since 3.2 diff --git a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/rewrite/TargetSourceRangeComputer.java b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/rewrite/TargetSourceRangeComputer.java index 26e41a0552..991bf9b338 100644 --- a/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/rewrite/TargetSourceRangeComputer.java +++ b/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/rewrite/TargetSourceRangeComputer.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2005, 2009 IBM Corporation and others. + * Copyright (c) 2005, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -107,11 +107,10 @@ public class TargetSourceRangeComputer { * immediately before or after the normal source range for the node. * <p> * The returned source ranges must satisfy the following conditions: - * <dl> + * <ul> * <li>no two source ranges in an AST may be overlapping</li> * <li>a source range of a parent node must fully cover the source ranges of its children</li> - * </dl> - * </p> + * </ul> * <p> * The default implementation uses * {@link CompilationUnit#getExtendedStartPosition(ASTNode)} diff --git a/org.eclipse.jdt.core/formatter/org/eclipse/jdt/core/formatter/CodeFormatter.java b/org.eclipse.jdt.core/formatter/org/eclipse/jdt/core/formatter/CodeFormatter.java index dc924d0826..3ca804cb2f 100644 --- a/org.eclipse.jdt.core/formatter/org/eclipse/jdt/core/formatter/CodeFormatter.java +++ b/org.eclipse.jdt.core/formatter/org/eclipse/jdt/core/formatter/CodeFormatter.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2017 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -142,7 +142,7 @@ public abstract class CodeFormatter { * <li>{@link #K_STATEMENTS} <i>(since 3.6)</i></li> * <li>{@link #K_MODULE_INFO} <i>(since 3.14)</i></li> * </ul> - * </p><p> + * <p> * Note also that it has an effect only when one or several format comments * options for * {@link DefaultCodeFormatterConstants#FORMATTER_COMMENT_FORMAT_JAVADOC_COMMENT javadoc} @@ -193,7 +193,7 @@ public abstract class CodeFormatter { * } * } * </pre> - * </p><p> + * <p> * <i><u>Note</u>: Although we're convinced that the formatter should * always include the comments while processing a * {@link #K_COMPILATION_UNIT kind of compilation unit}, we diff --git a/org.eclipse.jdt.core/formatter/org/eclipse/jdt/core/formatter/DefaultCodeFormatterConstants.java b/org.eclipse.jdt.core/formatter/org/eclipse/jdt/core/formatter/DefaultCodeFormatterConstants.java index 638d139f8d..5a977cb20f 100644 --- a/org.eclipse.jdt.core/formatter/org/eclipse/jdt/core/formatter/DefaultCodeFormatterConstants.java +++ b/org.eclipse.jdt.core/formatter/org/eclipse/jdt/core/formatter/DefaultCodeFormatterConstants.java @@ -1203,9 +1203,11 @@ public class DefaultCodeFormatterConstants { * </pre> * * Note that at most one of these options can be set to {@code TRUE}: + * <ul> * <li>{@code FORMATTER_COMMENT_INDENT_ROOT_TAGS}, * <li>{@code FORMATTER_COMMENT_ALIGN_TAGS_NAMES_DESCRIPTIONS}, * <li>{@code FORMATTER_COMMENT_ALIGN_TAGS_DESCREIPTIONS_GROUPED}. + * </ul> * * @see #TRUE * @see #FALSE @@ -1224,9 +1226,11 @@ public class DefaultCodeFormatterConstants { * </pre> * * Note that at most one of these options can be set to {@code TRUE}: + * <ul> * <li>{@code FORMATTER_COMMENT_INDENT_ROOT_TAGS}, * <li>{@code FORMATTER_COMMENT_ALIGN_TAGS_NAMES_DESCRIPTIONS}, * <li>{@code FORMATTER_COMMENT_ALIGN_TAGS_DESCREIPTIONS_GROUPED}. + * </ul> * * @see #TRUE * @see #FALSE @@ -1245,9 +1249,11 @@ public class DefaultCodeFormatterConstants { * </pre> * * Note that at most one of these options can be set to {@code TRUE}: + * <ul> * <li>{@code FORMATTER_COMMENT_INDENT_ROOT_TAGS}, * <li>{@code FORMATTER_COMMENT_ALIGN_TAGS_NAMES_DESCRIPTIONS}, * <li>{@code FORMATTER_COMMENT_ALIGN_TAGS_DESCREIPTIONS_GROUPED}. + * </ul> * * @see #TRUE * @see #FALSE @@ -1419,7 +1425,7 @@ public class DefaultCodeFormatterConstants { * void bar1() {} * void bar2() {} * } - * </pre></p> + * </pre> * </li> * <li>If no enabling tag is found by the formatter after the disabling tag, then * the end of the snippet won't be formatted.<br> @@ -1497,7 +1503,6 @@ public class DefaultCodeFormatterConstants { * </pre> * </li> * </ol> - * </p> * @since 3.6 */ public static final String FORMATTER_DISABLING_TAG = JavaCore.PLUGIN_ID + ".formatter.disabling_tag"; //$NON-NLS-1$ @@ -1556,7 +1561,7 @@ public class DefaultCodeFormatterConstants { * // @formatter:on * void bar2() {} * } - * </pre></p> + * </pre> * </li> * <li>If a mix of disabling and enabling tags is done in the same comment, then * the formatter will only take into account the last encountered tag in the @@ -1627,7 +1632,6 @@ public class DefaultCodeFormatterConstants { * </pre> * </li> * </ol> - * </p> * @since 3.6 */ public static final String FORMATTER_ENABLING_TAG = JavaCore.PLUGIN_ID + ".formatter.enabling_tag"; //$NON-NLS-1$ @@ -4896,8 +4900,6 @@ public class DefaultCodeFormatterConstants { * } * } * </pre> - * <p> - * </p> * <p><b><u>Important notes</u></b>:</p> * <ol> * <li>This new behavior is automatically activated (i.e. the default value for this preference is {@link #TRUE}). diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/BindingKey.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/BindingKey.java index 6921a6826c..3f9094d987 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/BindingKey.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/BindingKey.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2005, 2011 IBM Corporation and others. + * Copyright (c) 2005, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -49,7 +49,6 @@ public final class BindingKey { * createArrayTypeBindingKey("I", 2) -> "[[I" * </code> * </pre> - * </p> * * @param typeKey the binding key of the given type * @param arrayDimension the given array dimension @@ -80,7 +79,6 @@ public final class BindingKey { * "Ljava/util/List<>;" * </code> * </pre> - * </p> * * @param genericTypeKey the binding key of the generic type * @param argumentTypeKeys the possibly empty list of binding keys of argument types @@ -113,7 +111,6 @@ public final class BindingKey { * createTypeBindingKey("boolean[]") -> "[Z" * </code> * </pre> - * </p> * * @param typeName the possibly qualified type name * @return a new type binding key @@ -136,7 +133,6 @@ public final class BindingKey { * "Lp/X;.foo()V:TSomeTypeVariable;" * </code> * </pre> - * </p> * * @param typeVariableName the name of the given type variable * @param declaringKey the binding key of the type or method the type variable belongs to @@ -168,7 +164,6 @@ public final class BindingKey { * "+Ljava/util/ArrayList;" * </code> * </pre> - * </p> * * @param typeKey the binding key of the given type * @param kind one of {@link Signature#C_STAR}, {@link Signature#C_SUPER}, or {@link Signature#C_EXTENDS} @@ -205,7 +200,6 @@ public final class BindingKey { * "Ljava/util/HashMap;{1}+Ljava/lang/String;" * </code> * </pre> - * </p> * * @param genericTypeKey the binding key of the generic type * @param boundKind one of {@link Signature#C_STAR}, {@link Signature#C_SUPER}, or {@link Signature#C_EXTENDS} diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/ClasspathContainerInitializer.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/ClasspathContainerInitializer.java index a087d856dd..e70ca2a531 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/ClasspathContainerInitializer.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/ClasspathContainerInitializer.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -120,7 +120,6 @@ public abstract class ClasspathContainerInitializer { * <li>Java element operations marked as "handle-only"</li> * </ul> * The effects of using other Java model APIs are unspecified. - * </p> * * @param containerPath a two-segment path (ID/hint) identifying the container that needs * to be resolved @@ -275,7 +274,7 @@ public abstract class ClasspathContainerInitializer { * respectively the {@link #ATTRIBUTE_NOT_SUPPORTED} value * or the {@link #ATTRIBUTE_READ_ONLY} value.</li> * </ul> - * </p><p> + * <p> * The status message can contain more information. * </p><p> * If the subclass does not override this method, then the default behavior is @@ -311,7 +310,7 @@ public abstract class ClasspathContainerInitializer { * respectively the {@link #ATTRIBUTE_NOT_SUPPORTED} value * or the {@link #ATTRIBUTE_READ_ONLY} value.</li> * </ul> - * </p><p> + * <p> * The status message can contain more information. * </p><p> * If the subclass does not override this method, then the default behavior is @@ -349,7 +348,7 @@ public abstract class ClasspathContainerInitializer { * respectively the {@link #ATTRIBUTE_NOT_SUPPORTED} value * or the {@link #ATTRIBUTE_READ_ONLY} value.</li> * </ul> - * </p><p> + * <p> * The status message can contain more information. * </p><p> * If the subclass does not override this method, then the default behavior is diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/CompletionProposal.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/CompletionProposal.java index 1579992681..f013e76702 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/CompletionProposal.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/CompletionProposal.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2018 IBM Corporation and others. + * Copyright (c) 2004, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -81,7 +81,6 @@ public class CompletionProposal { * the modifiers flags of the constructor that is referenced * </li> * </ul> - * </p> * * @see #getKind() */ @@ -111,7 +110,6 @@ public class CompletionProposal { * is declared) * </li> * </ul> - * </p> * * @see #getKind() */ @@ -133,7 +131,6 @@ public class CompletionProposal { * the corresponding modifier flags if the keyword is a modifier * </li> * </ul> - * </p> * * @see #getKind() */ @@ -152,7 +149,6 @@ public class CompletionProposal { * the simple name of the label that is referenced * </li> * </ul> - * </p> * * @see #getKind() */ @@ -177,7 +173,6 @@ public class CompletionProposal { * the type signature of the local variable's type * </li> * </ul> - * </p> * * @see #getKind() */ @@ -205,7 +200,6 @@ public class CompletionProposal { * the method signature of the method that is referenced * </li> * </ul> - * </p> * * @see #getKind() */ @@ -245,7 +239,6 @@ public class CompletionProposal { * overridden or implemented * </li> * </ul> - * </p> * * @see #getKind() */ @@ -264,7 +257,6 @@ public class CompletionProposal { * the dot-based package name of the package that is referenced * </li> * </ul> - * </p> * * @see #getKind() */ @@ -293,7 +285,6 @@ public class CompletionProposal { * and AccAnnotation) of the type that is referenced * </li> * </ul> - * </p> * * @see #getKind() */ @@ -317,7 +308,6 @@ public class CompletionProposal { * the modifiers flags of the variable being declared * </li> * </ul> - * </p> * @see #getKind() */ public static final int VARIABLE_DECLARATION = 10; @@ -347,7 +337,6 @@ public class CompletionProposal { * created * </li> * </ul> - * </p> * * @see #getKind() * @since 3.1 @@ -362,6 +351,7 @@ public class CompletionProposal { * <p> * The following additional context information is available * for this kind of completion proposal at little extra cost: + * </p> * <ul> * <li>{@link #getDeclarationSignature()} - * the type signature of the type that declares the method that is referenced @@ -376,7 +366,6 @@ public class CompletionProposal { * the method signature of the method that is referenced * </li> * </ul> - * </p> * * @see #getKind() * @since 3.1 @@ -407,7 +396,6 @@ public class CompletionProposal { * is declared) * </li> * </ul> - * </p> * * @see #getKind() * @since 3.1 @@ -438,7 +426,6 @@ public class CompletionProposal { * is declared) * </li> * </ul> - * </p> * * @see #getKind() * @since 3.2 @@ -467,7 +454,6 @@ public class CompletionProposal { * the method signature of the method that is referenced * </li> * </ul> - * </p> * * @see #getKind() * @since 3.2 @@ -497,7 +483,6 @@ public class CompletionProposal { * and AccAnnotation) of the type that is referenced * </li> * </ul> - * </p> * * @see #getKind() * @since 3.2 @@ -528,7 +513,6 @@ public class CompletionProposal { * is declared) * </li> * </ul> - * </p> * * @see #getKind() * @since 3.2 @@ -563,7 +547,6 @@ public class CompletionProposal { * is declared) * </li> * </ul> - * </p> * * @see #getKind() * @since 3.2 @@ -594,7 +577,6 @@ public class CompletionProposal { * is declared) * </li> * </ul> - * </p> * * @see #getKind() * @since 3.2 @@ -625,7 +607,6 @@ public class CompletionProposal { * is declared) * </li> * </ul> - * </p> * * @see #getKind() * @since 3.2 @@ -657,7 +638,6 @@ public class CompletionProposal { * of the proposed import * </li> * </ul> - * </p> * * @see #getKind() * @@ -688,7 +668,6 @@ public class CompletionProposal { * of the proposed import * </li> * </ul> - * </p> * * @see #getKind() * @@ -719,7 +698,6 @@ public class CompletionProposal { * of the proposed import * </li> * </ul> - * </p> * * @see #getKind() * @@ -752,7 +730,6 @@ public class CompletionProposal { * the method signature of the method that is referenced * </li> * </ul> - * </p> * * @see #getKind() * @@ -788,7 +765,6 @@ public class CompletionProposal { * </li> * * </ul> - * </p> * * @see #getKind() * @@ -818,7 +794,6 @@ public class CompletionProposal { * the method signature of the constructor that is referenced * </li> * </ul> - * </p> * <p> * This kind of proposal could require a long computation, so they are computed only if completion operation is called with a {@link IProgressMonitor} * (e.g. {@link ICodeAssist#codeComplete(int, CompletionRequestor, IProgressMonitor)}).<br> @@ -859,7 +834,6 @@ public class CompletionProposal { * the modifiers flags of the constructor that is referenced * </li> * </ul> - * </p> * <p> * This kind of proposal could require a long computation, so they are computed only if completion operation is called with a {@link IProgressMonitor} * (e.g. {@link ICodeAssist#codeComplete(int, CompletionRequestor, IProgressMonitor)})<br> @@ -948,7 +922,6 @@ public class CompletionProposal { * </ul> * For other kinds of completion proposals, this method returns * <code>CompletionFlags.Default</code>. - * </p> * * @return the completion flags, or * <code>CompletionFlags.Default</code> if none @@ -1223,7 +1196,6 @@ public class CompletionProposal { * For kinds of completion proposals, this method returns * <code>null</code>. Clients must not modify the array * returned. - * </p> * * @return a type signature or a package name or module name (9) (depending * on the kind of completion), or <code>null</code> if none @@ -1250,7 +1222,6 @@ public class CompletionProposal { * For kinds of completion proposals, this method returns * <code>null</code>. Clients must not modify the array * returned. - * </p> * * @return a key, or <code>null</code> if none * @see org.eclipse.jdt.core.dom.ASTParser#createASTs(ICompilationUnit[], String[], org.eclipse.jdt.core.dom.ASTRequestor, IProgressMonitor) @@ -1322,7 +1293,6 @@ public class CompletionProposal { * For kinds of completion proposals, this method returns * <code>null</code>. Clients must not modify the array * returned. - * </p> * * @return the keyword, field, method, local variable, or member * name, or <code>null</code> if none @@ -1390,7 +1360,6 @@ public class CompletionProposal { * For kinds of completion proposals, this method returns * <code>null</code>. Clients must not modify the array * returned. - * </p> * * @return the signature, or <code>null</code> if none * @see Signature @@ -1415,7 +1384,6 @@ public class CompletionProposal { * For kinds of completion proposals, this method returns * <code>null</code>. Clients must not modify the array * returned. - * </p> * * @return the key, or <code>null</code> if none * @see org.eclipse.jdt.core.dom.ASTParser#createASTs(ICompilationUnit[], String[], org.eclipse.jdt.core.dom.ASTRequestor, IProgressMonitor) @@ -1516,7 +1484,6 @@ public class CompletionProposal { * </ul> * For other kinds of completion proposals, this method returns * <code>Flags.AccDefault</code>. - * </p> * * @return the modifier flags, or * <code>Flags.AccDefault</code> if none @@ -1565,7 +1532,6 @@ public class CompletionProposal { * <li><code>TYPE_IMPORT</code></li> * <li><code>METHOD_IMPORT</code></li> * </ul> - * </li> * </li> * <li><code>TYPE_REF</code> - The allowed required proposals for this kind are: * <ul> @@ -1588,7 +1554,6 @@ public class CompletionProposal { * </ul> * </li> * </ul> - * </p> * <p> * Other kinds of required proposals will be returned in the future, therefore clients of this * API must allow with {@link CompletionRequestor#setAllowsRequiredProposals(int, int, boolean)} @@ -1679,7 +1644,6 @@ public class CompletionProposal { * {@link IAccessRule#K_ACCESSIBLE} or {@link IAccessRule#K_DISCOURAGED} * or {@link IAccessRule#K_NON_ACCESSIBLE}. * By default this method return {@link IAccessRule#K_ACCESSIBLE}. - * </p> * * @see IAccessRule * @@ -1704,7 +1668,6 @@ public class CompletionProposal { * </ul> * For kinds of completion proposals, this method returns * <code>false</code>. - * </p> * * @return <code>true</code> if the proposal is a constructor. * @since 3.1 @@ -1728,7 +1691,6 @@ public class CompletionProposal { * For kinds of completion proposals, this method returns * <code>null</code>. Clients must not modify the array * returned. - * </p> * * @return a type signature or a package name (depending * on the kind of completion), or <code>null</code> if none @@ -1754,7 +1716,6 @@ public class CompletionProposal { * <li><code>METHOD_REF_WITH_CASTED_RECEIVER</code></li> * </ul> * For kinds of completion proposals, this method returns <code>0</code>. - * </p> * * @return character index of receiver start position (inclusive) * @@ -1777,7 +1738,6 @@ public class CompletionProposal { * <li><code>METHOD_REF_WITH_CASTED_RECEIVER</code></li> * </ul> * For kinds of completion proposals, this method returns <code>0</code>. - * </p> * * @return character index of receiver end position (exclusive) * diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/CompletionRequestor.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/CompletionRequestor.java index 8f10c24205..fb29721cfb 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/CompletionRequestor.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/CompletionRequestor.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2008 IBM Corporation and others. + * Copyright (c) 2004, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -32,6 +32,7 @@ import org.eclipse.jdt.core.compiler.IProblem; * ... * requestor.endReporting(); * </pre> + * <p> * If, however, the engine is unable to offer completion proposals * for whatever reason, <code>completionFailure</code> is called * with a problem object describing why completions were unavailable. @@ -42,6 +43,7 @@ import org.eclipse.jdt.core.compiler.IProblem; * requestor.completionFailure(problem); * requestor.endReporting(); * </pre> + * <p> * In either case, the bracketing <code>beginReporting</code> * <code>endReporting</code> calls are always made as well as * <code>acceptContext</code> call. diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/Flags.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/Flags.java index 7a44dc79ee..dd4ea0869e 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/Flags.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/Flags.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2017 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -449,14 +449,12 @@ public final class Flags { * int flags = method.getFlags() & ~Flags.AccVarargs; * return Flags.toString(flags); * </pre> - * </p> * <p> * Examples results: * <pre> * <code>"public static final"</code> * <code>"private native"</code> * </pre> - * </p> * * @param flags the flags * @return the standard string representation of the given flags diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IClasspathAttribute.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IClasspathAttribute.java index 24c1883025..c841fb8601 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IClasspathAttribute.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IClasspathAttribute.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2005, 2017 IBM Corporation and others. + * Copyright (c) 2005, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -219,7 +219,7 @@ public interface IClasspathAttribute { * <code>"false"</code> is assumed. If the value of this attribute is <code>"true"</code>, and the classpath entry * is a source folder, it is assumed to contain test sources, otherwise main sources. * </p> - * </p> + * <p> * During the compilation of main sources, only code is visible, that is reachable via classpath entries which do * not have the test attribute set to to "true". During the compilation of test sources, all code is visible as if * this attribute didn't exist at all. diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IClasspathContainer.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IClasspathContainer.java index 93a331723a..4b2c563adb 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IClasspathContainer.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IClasspathContainer.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2010 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IClasspathEntry.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IClasspathEntry.java index bbe602970a..dd61c54449 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IClasspathEntry.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IClasspathEntry.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2015 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -22,7 +22,7 @@ import org.eclipse.core.runtime.IPath; * by each package fragment root and package fragment associated with the entry. * <p> * A classpath entry can refer to any of the following:<ul> - * + * </p> * <li>Source code in the current project. In this case, the entry identifies a * root folder in the current project containing package fragments and * source files with one of the {@link JavaCore#getJavaLikeExtensions() @@ -91,7 +91,6 @@ import org.eclipse.core.runtime.IPath; * <br> Also note that the container resolution APIs include an IJavaProject argument, so as to allow the same * container path to be interpreted in different ways for different projects. </li> * </ul> - * </p> * The result of {@link IJavaProject#getResolvedClasspath} will have all entries of type * {@link #CPE_VARIABLE} and {@link #CPE_CONTAINER} resolved to a set of * {@link #CPE_SOURCE}, {@link #CPE_LIBRARY} or {@link #CPE_PROJECT} @@ -275,7 +274,6 @@ public interface IClasspathEntry { * <code>tests</code>). * </li> * </ul> - * </p> * * @return the possibly empty list of resource exclusion patterns * associated with this classpath entry, or <code>null</code> if this kind @@ -335,7 +333,6 @@ public interface IClasspathEntry { * named <code>Foo.java</code>. * </li> * </ul> - * </p> * * @return the possibly empty list of resource inclusion patterns * associated with this classpath entry, or <code>null</code> if this kind diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/ICodeAssist.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/ICodeAssist.java index 2f7c535b4b..0e0a5f5954 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/ICodeAssist.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/ICodeAssist.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2009 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -95,7 +95,6 @@ public interface ICodeAssist { * An <code>offset</code> of -1 indicates to code assist at the beginning of this * compilation unit. * <p> - * <p> * If {@link IProgressMonitor} is not <code>null</code> then some proposals which * can be very long to compute are proposed. To avoid that the code assist operation * take too much time a {@link IProgressMonitor} which automatically cancel the code diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/ICompilationUnit.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/ICompilationUnit.java index 5f2c667a86..2530489df4 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/ICompilationUnit.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/ICompilationUnit.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2015 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -418,11 +418,11 @@ IImportDeclaration[] getImports() throws JavaModelException; */ ICompilationUnit getPrimary(); /** - * Returns <tt>null</tt> if this <code>ICompilationUnit</code> is the primary + * Returns <code>null</code> if this <code>ICompilationUnit</code> is the primary * working copy, or this <code>ICompilationUnit</code> is not a working copy, * otherwise the <code>WorkingCopyOwner</code> * - * @return <tt>null</tt> if this <code>ICompilationUnit</code> is the primary + * @return <code>null</code> if this <code>ICompilationUnit</code> is the primary * working copy, or this <code>ICompilationUnit</code> is not a working copy, * otherwise the <code>WorkingCopyOwner</code> * @since 3.0 @@ -736,7 +736,6 @@ CompilationUnit reconcile(int astLevel, boolean forceProblemDetection, boolean e * <li>the requested level of AST API is not supported</li> * <li>the working copy was already consistent and problem detection is not forced</li> * </ul> - * </p> * * <p> * If statements recovery is enabled by passing the {@link #ENABLE_STATEMENTS_RECOVERY} bit in the given reconcile flag diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IJavaElementDelta.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IJavaElementDelta.java index 3861963644..0ab4326b77 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IJavaElementDelta.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IJavaElementDelta.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2011 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -23,7 +23,7 @@ import org.eclipse.jdt.core.dom.CompilationUnit; * <p> * Deltas have a different status depending on the kind of change they represent. * The list below summarizes each status (as returned by {@link #getKind}) - * and its meaning (see individual constants for a more detailled description): + * and its meaning (see individual constants for a more detailed description): * <ul> * <li>{@link #ADDED} - The element described by the delta has been added.</li> * <li>{@link #REMOVED} - The element described by the delta has been removed.</li> @@ -60,11 +60,10 @@ import org.eclipse.jdt.core.dom.CompilationUnit; * <li>{@link #F_SOURCEDETACHED} - The source attachment path or the source attachment root path * of a classpath entry corresponding to the element was removed. This flag is only valid if the element is an * {@link IPackageFragmentRoot}.</li> - * <li>{@link #F_SUPER_TYPES} - One of the supertypes of an {@link IType} has changed</li>. + * <li>{@link #F_SUPER_TYPES} - One of the supertypes of an {@link IType} has changed.</li> * </ul> * </li> * </ul> - * </p> * <p> * Move operations are indicated by other change flags, layered on top * of the change flags described above. If element A is moved to become B, @@ -369,7 +368,7 @@ public interface IJavaElementDelta { /** * Returns flags that describe how an element has changed. - * Such flags should be tested using the <code>&</code> operand. For example: + * Such flags should be tested using the <code>&</code> operand. For example: * <pre> * if ((delta.getFlags() & IJavaElementDelta.F_CONTENT) != 0) { * // the delta indicates a content change diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IJavaProject.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IJavaProject.java index d0e384d1f4..9c9c818f6b 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IJavaProject.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IJavaProject.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2018 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -49,14 +49,13 @@ import org.eclipse.jdt.core.eval.IEvaluationContext; * the corresponding generated class files from the required project's output * location(s)). The classpath format is a sequence of classpath entries * describing the location and contents of package fragment roots. - * </p> + * <p> * Java project elements need to be opened before they can be navigated or manipulated. * The children of a Java project are the package fragment roots that are * defined by the classpath and contained in this project (in other words, it * does not include package fragment roots for other projects). The children * (i.e. the package fragment roots) appear in the order they are defined by * the classpath. - * </p> * <p> * An instance of one of these handles can be created via * <code>JavaCore.create(project)</code>. @@ -172,7 +171,7 @@ public interface IJavaProject extends IParent, IJavaElement, IOpenable { * variable}</li> * <li>{@link IAnnotation} for a binding key from an * {@link IAnnotationBinding}</li> - * </ul></p> + * </ul> * <p>Note: if two methods correspond to the binding key because their * parameter types' simple names are the same, then the first one is returned. * For example, if a class defines two methods <code>foo(p1.Y, String)</code> @@ -649,7 +648,7 @@ public interface IJavaProject extends IParent, IJavaElement, IOpenable { * </p> * <p> * Note that in case the project isn't yet opened, the classpath will - * be read directly from the associated <tt>.classpath</tt> file. + * be read directly from the associated <code>.classpath</code> file. * </p> * * @return the raw classpath for the project, as a list of classpath entries @@ -1218,7 +1217,7 @@ public interface IJavaProject extends IParent, IJavaElement, IOpenable { * * @param path * IPath - * @return the classpath entry or <code>null</null>. + * @return the classpath entry or <code>null</code>. * @throws JavaModelException * @since 3.14 */ diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IType.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IType.java index a0466b1b69..630f40cc73 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IType.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IType.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2016 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -348,10 +348,11 @@ public interface IType extends IMember, IAnnotatable { * * <p>It is possible that a field with the same name already exists in this type. * The value of the <code>force</code> parameter affects the resolution of - * such a conflict:<ul> + * such a conflict: + * <ul> * <li> <code>true</code> - in this case the field is created with the new contents</li> * <li> <code>false</code> - in this case a <code>JavaModelException</code> is thrown</li> - * </ul></p> + * </ul> * * @param contents the given contents * @param sibling the given sibling @@ -406,10 +407,11 @@ public interface IType extends IMember, IAnnotatable { * * <p>It is possible that a method with the same signature already exists in this type. * The value of the <code>force</code> parameter affects the resolution of - * such a conflict:<ul> + * such a conflict: + * <ul> * <li> <code>true</code> - in this case the method is created with the new contents</li> * <li> <code>false</code> - in this case a <code>JavaModelException</code> is thrown</li> - * </ul></p> + * </ul> * * @param contents the given contents * @param sibling the given sibling @@ -440,10 +442,11 @@ public interface IType extends IMember, IAnnotatable { * * <p>It is possible that a type with the same name already exists in this type. * The value of the <code>force</code> parameter affects the resolution of - * such a conflict:<ul> + * such a conflict: + * <ul> * <li> <code>true</code> - in this case the type is created with the new contents</li> * <li> <code>false</code> - in this case a <code>JavaModelException</code> is thrown</li> - * </ul></p> + * </ul> * * @param contents the given contents * @param sibling the given sibling diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/JavaConventions.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/JavaConventions.java index ac1f1e05ae..10703a8d32 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/JavaConventions.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/JavaConventions.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2018 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -113,7 +113,6 @@ public final class JavaConventions { * <li> it must not contain any characters or substrings that are not valid * on the file system on which workspace root is located. * </ul> - * </p> * @param name the name of a compilation unit * @return a status object with code <code>IStatus.OK</code> if * the given name is valid as a compilation unit name, otherwise a status @@ -136,7 +135,6 @@ public final class JavaConventions { * <li> it must not contain any characters or substrings that are not valid * on the file system on which workspace root is located. * </ul> - * </p> * @param name the name of a compilation unit * @param sourceLevel the source level * @param complianceLevel the compliance level @@ -187,7 +185,6 @@ public final class JavaConventions { * <li> it must not contain any characters or substrings that are not valid * on the file system on which workspace root is located. * </ul> - * </p> * @param name the name of a .class file * @return a status object with code <code>IStatus.OK</code> if * the given name is valid as a .class file name, otherwise a status @@ -210,7 +207,6 @@ public final class JavaConventions { * <li> it must not contain any characters or substrings that are not valid * on the file system on which workspace root is located. * </ul> - * </p> * @param name the name of a .class file * @param sourceLevel the source level * @param complianceLevel the compliance level diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/NamingConventions.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/NamingConventions.java index a02a4a667e..f2be556ad7 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/NamingConventions.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/NamingConventions.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2009 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -42,7 +42,6 @@ import org.eclipse.jdt.internal.core.InternalNamingConventions; * <li> {@link JavaCore#CODEASSIST_ARGUMENT_PREFIXES} : Define the Prefixes for Argument Name.</li> * <li> {@link JavaCore#CODEASSIST_ARGUMENT_SUFFIXES} : Define the Suffixes for Argument Name.</li> * </ul> - * </p> * <p> * For a complete description of the configurable options, see {@link JavaCore#getDefaultOptions()}. * To programmatically change these options, see {@link JavaCore#setOptions(java.util.Hashtable)}. @@ -518,7 +517,6 @@ public final class NamingConventions { * <li>{@link #VK_STATIC_FIELD}: {@link JavaCore#CODEASSIST_STATIC_FIELD_PREFIXES} and {@link JavaCore#CODEASSIST_STATIC_FIELD_SUFFIXES}</li> * <li>{@link #VK_STATIC_FINAL_FIELD}: {@link JavaCore#CODEASSIST_STATIC_FINAL_FIELD_PREFIXES} and {@link JavaCore#CODEASSIST_STATIC_FINAL_FIELD_SUFFIXES}</li> * </ul> - * </p> * <p> * e.g.<br> * If the variable is a {@link #VK_LOCAL}, the variable name is <code>preVariableNamesuf</code>, a possible prefix is <code>pre</code> and a possible suffix is <code>suf</code> @@ -1083,7 +1081,6 @@ public final class NamingConventions { * </ul></li> * </ul> * Some other kinds could be added in the future. - * </p> * <p> * Each variable kind is affected by the following JavaCore options: * <ul> @@ -1093,7 +1090,6 @@ public final class NamingConventions { * <li>{@link #VK_STATIC_FIELD}: {@link JavaCore#CODEASSIST_STATIC_FIELD_PREFIXES} and {@link JavaCore#CODEASSIST_STATIC_FIELD_SUFFIXES}</li> * <li>{@link #VK_STATIC_FINAL_FIELD}: {@link JavaCore#CODEASSIST_STATIC_FINAL_FIELD_PREFIXES} and {@link JavaCore#CODEASSIST_STATIC_FINAL_FIELD_SUFFIXES}</li> * </ul> - * </p> * <p> * For a complete description of these configurable options, see {@link JavaCore#getDefaultOptions()}. * To programmatically change these options, see {@link JavaCore#setOptions(java.util.Hashtable)} and {@link IJavaProject#setOptions(java.util.Map)} @@ -1107,7 +1103,6 @@ public final class NamingConventions { * <li>Names with suffix. Longer names are proposed first</li> * <li>Names without prefix and suffix. Longer names are proposed first</li> * </ol> - * </p> * * @param variableKind specifies what type the variable is: {@link #VK_LOCAL}, {@link #VK_PARAMETER}, {@link #VK_STATIC_FIELD}, * {@link #VK_INSTANCE_FIELD} or {@link #VK_STATIC_FINAL_FIELD}. diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/Signature.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/Signature.java index 70a348ba50..13b1f94669 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/Signature.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/Signature.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2018 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -95,7 +95,6 @@ import org.eclipse.jdt.internal.compiler.util.Util; * "<" + FormalTypeParameterSignature+ + ">" * | * </pre> - * </p> * <p> * Examples: * <ul> @@ -105,10 +104,9 @@ import org.eclipse.jdt.internal.compiler.util.Util; * <li><code>"Qjava.lang.String;"</code> denotes <code>java.lang.String</code> in source code</li> * <li><code>"[QString;"</code> denotes <code>String[]</code> in source code</li> * <li><code>"QMap<QString;*>;"</code> denotes <code>Map<String,?></code> in source code</li> - * <li><code>"Qjava.util.List<TV;>;"</code> denotes <code>java.util.List<V></code> in source code</li> - * <li><code>"<E;>Ljava.util.List;"</code> denotes <code><E>java.util.List</code> in source code</li> + * <li><code>"Qjava.util.List<V>;"</code> denotes <code>java.util.List<V></code> in source code</li> + * <li><code>"<E>Ljava.util.List;"</code> denotes <code><E>java.util.List</code> in source code</li> * </ul> - * </p> * <p> * The syntax for a method signature is: * <pre> @@ -123,7 +121,6 @@ import org.eclipse.jdt.internal.compiler.util.Util; * <li><code>"([Ljava.lang.String;)V"</code> denotes <code>void foo(java.lang.String[])</code> in compiled code</li> * <li><code>"(QString;)QObject;"</code> denotes <code>Object foo(String)</code> in source code</li> * </ul> - * </p> * <p> * The syntax for a formal type parameter signature is: * <pre> @@ -143,7 +140,6 @@ import org.eclipse.jdt.internal.compiler.util.Util; * <li><code>"X:QReader;"</code> denotes <code>X extends Reader</code> in source code</li> * <li><code>"X:QReader;:QSerializable;"</code> denotes <code>X extends Reader & Serializable</code> in source code</li> * </ul> - * </p> * <p> * This class provides static methods and constants only. * </p> @@ -1311,7 +1307,6 @@ public static String createTypeSignature(char[] typeName, boolean isResolved) { * createTypeSignature("int []", false) -> "[I" * </code> * </pre> - * </p> * * @param typeName the possibly qualified type name * @param isResolved <code>true</code> if the type name is to be considered @@ -1566,7 +1561,6 @@ public static int getArrayCount(String typeSignature) throws IllegalArgumentExce * getElementType({'[', '[', 'I'}) --> {'I'}. * </code> * </pre> - * </p> * * @param typeSignature the type signature * @return the type signature without arrays @@ -1593,7 +1587,6 @@ public static char[] getElementType(char[] typeSignature) throws IllegalArgument * getElementType("[[I") --> "I". * </code> * </pre> - * </p> * * @param typeSignature the type signature * @return the type signature without arrays @@ -1805,7 +1798,6 @@ public static String[] getParameterTypes(String methodSignature) throws IllegalA * getQualifier({'j', 'a', 'v', 'a', '.', 'u', 't', 'i', 'l', '.', 'L', 'i', 's', 't', '<', 'j', 'a', 'v', 'a', '.', 'l', 'a', 'n', 'g', '.', 'S', 't', 'r', 'i', 'n', 'g', '>'}) -> {'j', 'a', 'v', 'a', '.', 'u', 't', 'i', 'l'} * </code> * </pre> - * </p> * * @param name the name * @return the qualifier prefix, or the empty char array if the name contains no @@ -1834,7 +1826,6 @@ public static char[] getQualifier(char[] name) { * getQualifier("java.util.List<java.lang.String>") -> "java.util" * </code> * </pre> - * </p> * * @param name the name * @return the qualifier prefix, or the empty string if the name contains no @@ -1892,7 +1883,6 @@ public static String getReturnType(String methodSignature) throws IllegalArgumen * getSignatureQualifier({'L', 'j', 'a', 'v', 'a', '.', 'u', 't', 'i', 'l', '.', 'M', 'a', 'p', '$', 'E', 'n', 't', 'r', 'y', ';'}) -> {'j', 'a', 'v', 'a', '.', 'u', 't', 'i', 'l'} * </code> * </pre> - * </p> * * @param typeSignature the type signature * @return the package fragment (separators are '.') @@ -1938,7 +1928,6 @@ public static char[] getSignatureQualifier(char[] typeSignature) { * getSignatureQualifier("Ljava.util.Map$Entry") -> "java.util" * </code> * </pre> - * </p> * * @param typeSignature the type signature * @return the package fragment (separators are '.') @@ -1957,7 +1946,6 @@ public static String getSignatureQualifier(String typeSignature) { * getSignatureSimpleName({'L', 'j', 'a', 'v', 'a', '.', 'u', 't', 'i', 'l', '.', 'M', 'a', 'p', '$', 'E', 'n', 't', 'r', 'y', ';'}) -> {'M', 'a', 'p', '.', 'E', 'n', 't', 'r', 'y'} * </code> * </pre> - * </p> * * @param typeSignature the type signature * @return the type fragment (separators are '.') @@ -2012,7 +2000,6 @@ public static char[] getSignatureSimpleName(char[] typeSignature) { * getSignatureSimpleName("Ljava.util.Map$Entry") -> "Map.Entry" * </code> * </pre> - * </p> * * @param typeSignature the type signature * @return the type fragment (separators are '.') @@ -2031,7 +2018,6 @@ public static String getSignatureSimpleName(String typeSignature) { * getSimpleName({'j', 'a', 'v', 'a', '.', 'l', 'a', 'n', 'g', '.', 'O', 'b', 'j', 'e', 'c', 't'}) -> {'O', 'b', 'j', 'e', 'c', 't'} * </code> * </pre> - * </p> * * @param name the name * @return the last segment of the qualified name @@ -2089,7 +2075,6 @@ public static char[] getSimpleName(char[] name) { * getSimpleName("java.util.Map<java.lang.String, java.lang.Object>") -> "Map<String,Object>" * </code> * </pre> - * </p> * * @param name the name * @return the last segment of the qualified name @@ -2674,7 +2659,6 @@ public static String getTypeVariable(String formalTypeParameterSignature) throws * will return: "LTest<+Ljava.lang.Throwable;>;" * </code> * </pre> - * </p> * * @param methodOrTypeSignature the signature which may have been captured * @return a new signature without capture information or the signature itself @@ -2699,7 +2683,6 @@ public static char[] removeCapture(char[] methodOrTypeSignature) { * will return: "LTest<+Ljava.lang.Throwable;>;" * </code> * </pre> - * </p> * * @param methodOrTypeSignature the signature which may have been captured * @return a new signature without capture information or the signature itself @@ -2727,7 +2710,6 @@ public static String removeCapture(String methodOrTypeSignature) { * toString({'+', 'L', 'O', 'b', 'j', 'e', 'c', 't', ';'}) -> {'?', ' ', 'e', 'x', 't', 'e', 'n', 'd', 's', ' ', 'O', 'b', 'j', 'e', 'c', 't'} * </code> * </pre> - * </p> * <p> * Note: This method assumes that a type signature containing a <code>'$'</code> * is an inner type signature. While this is correct in most cases, someone could @@ -2767,7 +2749,6 @@ public static char[] toCharArray(char[] signature) throws IllegalArgumentExcepti * toString("([Ljava.lang.String;)V", "main", new String[] {"args"}, false, true) -> "void main(String[] args)" * </code> * </pre> - * </p> * * @param methodSignature the method signature to convert * @param methodName the name of the method to insert in the result, or @@ -2797,7 +2778,6 @@ public static char[] toCharArray(char[] methodSignature, char[] methodName, char * toString("([Ljava.lang.String;)V", "main", new String[] {"args"}, false, true) -> "void main(String[] args)" * </code> * </pre> - * </p> * * @param methodSignature the method signature to convert * @param methodName the name of the method to insert in the result, or @@ -2880,7 +2860,6 @@ public static char[] toCharArray(char[] methodSignature, char[] methodName, char * toQualifiedName({{}}) -> {} * </code> * </pre> - * </p> * * @param segments the list of name segments, possibly empty * @return the dot-separated qualified name, or the empty string @@ -2922,7 +2901,6 @@ public static char[] toQualifiedName(char[][] segments) { * toQualifiedName(new String[0]) -> "" * </code> * </pre> - * </p> * * @param segments the list of name segments, possibly empty * @return the dot-separated qualified name, or the empty string @@ -2948,7 +2926,6 @@ public static String toQualifiedName(String[] segments) { * toString("+QObject;") -> "? extends Object" * </code> * </pre> - * </p> * <p> * Note: This method assumes that a type signature containing a <code>'$'</code> * is an inner type signature. While this is correct in most cases, someone could diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/ToolFactory.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/ToolFactory.java index a9d4c7a0ff..dfe106164a 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/ToolFactory.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/ToolFactory.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2018 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -411,8 +411,8 @@ public class ToolFactory { * used to tokenize some source in a Java aware way. * Here is a typical scanning loop: * - * <code> * <pre> + * <code> * IScanner scanner = ToolFactory.createScanner(false, false, false, false); * scanner.setSource("int i = 0;".toCharArray()); * while (true) { @@ -420,8 +420,8 @@ public class ToolFactory { * if (token == ITerminalSymbols.TokenNameEOF) break; * System.out.println(token + " : " + new String(scanner.getCurrentTokenSource())); * } - * </pre> * </code> + * </pre> * * <p>By default the compliance used to create the scanner is the workspace's compliance when running inside the IDE * or 1.4 if running from outside of a headless eclipse. @@ -465,8 +465,8 @@ public class ToolFactory { * used to tokenize some source in a Java aware way. * Here is a typical scanning loop: * - * <code> * <pre> + * <code> * IScanner scanner = ToolFactory.createScanner(false, false, false, false); * scanner.setSource("int i = 0;".toCharArray()); * while (true) { @@ -474,8 +474,8 @@ public class ToolFactory { * if (token == ITerminalSymbols.TokenNameEOF) break; * System.out.println(token + " : " + new String(scanner.getCurrentTokenSource())); * } - * </pre> * </code> + * </pre> * * <p>By default the compliance used to create the scanner is the workspace's compliance when running inside the IDE * or 1.4 if running from outside of a headless eclipse. @@ -522,8 +522,8 @@ public class ToolFactory { * used to tokenize some source in a Java aware way. * Here is a typical scanning loop: * - * <code> * <pre> + * <code> * IScanner scanner = ToolFactory.createScanner(false, false, false, false); * scanner.setSource("int i = 0;".toCharArray()); * while (true) { @@ -531,8 +531,8 @@ public class ToolFactory { * if (token == ITerminalSymbols.TokenNameEOF) break; * System.out.println(token + " : " + new String(scanner.getCurrentTokenSource())); * } - * </pre> * </code> + * </pre> * * @param tokenizeComments if set to <code>false</code>, comments will be silently consumed * @param tokenizeWhiteSpace if set to <code>false</code>, white spaces will be silently consumed, diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/WorkingCopyOwner.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/WorkingCopyOwner.java index 9496e385ac..ba7a912ebc 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/WorkingCopyOwner.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/WorkingCopyOwner.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2009 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -136,7 +136,6 @@ public abstract class WorkingCopyOwner { * CompilationUnit cu = (CompilationUnit) parser.createAST(null); * assert cu.getProblems().length == 0; * </pre> - * </p> * * @param typeName the simple name of the type to lookup * @param packageName the dot-separated name of the package of type @@ -178,7 +177,7 @@ public abstract class WorkingCopyOwner { * </p><p> * A DOM AST created using this working copy will have bindings resolved using the given * classpath, and problem are reported to the given problem requestor. - * <p></p> + * </p><p> * <code>JavaCore#getOptions()</code> is used to create the DOM AST as it is not * possible to set the options on the non-existing Java project. * </p><p> @@ -231,7 +230,7 @@ public abstract class WorkingCopyOwner { * If a DOM AST is created using this working copy, then given classpath will be used * if bindings need to be resolved. Problems will be reported to the problem requestor * of the current working copy owner problem if it is not <code>null</code>. - * <p></p> + * </p><p> * Options used to create the DOM AST are got from {@link JavaCore#getOptions()} * as it is not possible to set the options on a non-existing Java project. * </p><p> diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/compiler/CompilationParticipant.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/compiler/CompilationParticipant.java index d4788a8e2a..f996bc5744 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/compiler/CompilationParticipant.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/compiler/CompilationParticipant.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2005, 2016 IBM Corporation and others. + * Copyright (c) 2005, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -109,7 +109,6 @@ public void cleanStarting(IJavaProject project) { * <pre> * javaProject.getProject().isOpen(); * </pre> - * </p> * @param project the project to participate in * @return whether this participant is active for a given project */ diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/eval/ICodeSnippetRequestor.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/eval/ICodeSnippetRequestor.java index 435e2880fa..9ae7369b5b 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/eval/ICodeSnippetRequestor.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/eval/ICodeSnippetRequestor.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2009 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -153,7 +153,6 @@ public boolean acceptClassFiles(byte[][] classFileBytes, String[][] classFileCom /** * Notifies of an evaluation problem. * Problems can arise for source of the following kinds: - * <p> * <ul> * <li>global variable (<code>VARIABLE</code>) - fragment source is name of * variable</li> @@ -165,7 +164,6 @@ public boolean acceptClassFiles(byte[][] classFileBytes, String[][] classFileCom * package declaration</li> * <li>other (<code>INTERNAL</code>) - no fragment source is involved, internal error occurred.</li> * </ul> - * </p> * @param problemMarker the problem marker (cannot be null) * @param fragmentSource the fragment source * @param fragmentKind the kind of source fragment; one of: diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/eval/IEvaluationContext.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/eval/IEvaluationContext.java index a5f800144d..4f14cd522a 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/eval/IEvaluationContext.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/eval/IEvaluationContext.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2009 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -26,6 +26,7 @@ import org.eclipse.jdt.core.JavaModelException; * A code snippet is pretty much any valid piece of Java code that could be * pasted into the body of a method and compiled. However, there are two * areas where the rules are slightly more liberal. + * </p> * <p> * First, a code snippet can return heterogeneous types. Inside the same code * snippet an <code>int</code> could be returned on one line, and a @@ -42,7 +43,6 @@ import org.eclipse.jdt.core.JavaModelException; * } * </code> * </pre> - * </p> * <p> * Second, if the last statement is only an expression, the <code>return</code> * keyword is implied. For example, the following returns <code>false</code>: @@ -52,7 +52,6 @@ import org.eclipse.jdt.core.JavaModelException; * i == 2 * </code> * </pre> - * </p> * <p> * Global variables are an additional feature of evaluation contexts. Within an * evaluation context, global variables maintain their value across evaluations. @@ -80,7 +79,6 @@ import org.eclipse.jdt.core.JavaModelException; * context.evaluateCodeSnippet(codeSnippet, requestor, progressMonitor); * </code> * </pre> - * </p> * <p> * <code>IJavaProject.newEvaluationContext</code> can be used to obtain an * instance. @@ -187,7 +185,6 @@ public interface IEvaluationContext { * <p> * Note that code completion does not involve evaluation. * <p> - * <p> * If {@link IProgressMonitor} is not <code>null</code> then some proposals which * can be very long to compute are proposed. To avoid that the code assist operation * take too much time a {@link IProgressMonitor} which automatically cancel the code @@ -275,7 +272,6 @@ public interface IEvaluationContext { * <p> * Note that code completion does not involve evaluation. * <p> - * <p> * If {@link IProgressMonitor} is not <code>null</code> then some proposals which * can be very long to compute are proposed. To avoid that the code assist operation * take too much time a {@link IProgressMonitor} which automatically cancel the code @@ -395,7 +391,6 @@ public interface IEvaluationContext { * <li>retrieve the values of the local variables, * <li>retrieve the returned value of the code snippet * </ol> - * </p> * <p> * This method is long-running; progress and cancellation are provided * by the given progress monitor. diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/jdom/IDOMNode.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/jdom/IDOMNode.java index 9ca9be23c7..2bf5fa5dc6 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/jdom/IDOMNode.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/jdom/IDOMNode.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2013 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -48,7 +48,6 @@ import org.eclipse.jdt.core.IJavaElement; * <li>add/insert - this splices an un-parented DF (one that has been cloned, removed, or created stand-alone), * into an existing DF such that the newly inserted DF is only dependent on its new host.</li> * </ul> - * </p> * <p> * Wherever types are specified in DOM APIs, type names must be specified as they would appear * in source code. The DOM does not have a notion of type signatures, only raw text. Example type diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/util/CompilationUnitSorter.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/util/CompilationUnitSorter.java index 23f8014536..cc696c22c5 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/util/CompilationUnitSorter.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/util/CompilationUnitSorter.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2018 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -84,7 +84,6 @@ public final class CompilationUnitSorter { * Integer i2 = (Integer) b2.getProperty(RELATIVE_ORDER); * return i1.intValue() - i2.intValue(); // preserve original order * </pre> - * </p> * * @see #sort(ICompilationUnit, int[], Comparator, int, IProgressMonitor) * @see org.eclipse.jdt.core.dom.BodyDeclaration @@ -127,31 +126,31 @@ public final class CompilationUnitSorter { * The body declarations passed as parameters to the comparator * always carry at least the following minimal signature information: * <br> - * <table border="1" width="80%" cellpadding="5"> + * <table border="1"> * <tr> - * <td width="20%"><code>TypeDeclaration</code></td> - * <td width="50%"><code>modifiers, isInterface, name, superclass, + * <td><code>TypeDeclaration</code></td> + * <td><code>modifiers, isInterface, name, superclass, * superInterfaces<br> * RELATIVE_ORDER property</code></td> * </tr> * <tr> - * <td width="20%"><code>FieldDeclaration</code></td> - * <td width="50%"><code>modifiers, type, fragments + * <td><code>FieldDeclaration</code></td> + * <td><code>modifiers, type, fragments * (VariableDeclarationFragments * with name only)<br> * RELATIVE_ORDER property</code></td> * </tr> * <tr> - * <td width="20%"><code>MethodDeclaration</code></td> - * <td width="50%"><code>modifiers, isConstructor, returnType, name, + * <td><code>MethodDeclaration</code></td> + * <td><code>modifiers, isConstructor, returnType, name, * parameters * (SingleVariableDeclarations with name and type only), * thrownExceptions<br> * RELATIVE_ORDER property</code></td> * </tr> * <tr> - * <td width="20%"><code>Initializer</code></td> - * <td width="50%"><code>modifiers<br> + * <td><code>Initializer</code></td> + * <td><code>modifiers<br> * RELATIVE_ORDER property</code></td> * </tr> * </table> @@ -242,51 +241,51 @@ public final class CompilationUnitSorter { * The body declarations passed as parameters to the comparator * always carry at least the following minimal signature information: * <br> - * <table border="1" width="80%" cellpadding="5"> + * <table border="1"> * <tr> - * <td width="20%"><code>TypeDeclaration</code></td> - * <td width="50%"><code>modifiers, isInterface, name, superclass, + * <td><code>TypeDeclaration</code></td> + * <td><code>modifiers, isInterface, name, superclass, * superInterfaces, typeParameters<br> * RELATIVE_ORDER property</code></td> * </tr> * <tr> - * <td width="20%"><code>FieldDeclaration</code></td> - * <td width="50%"><code>modifiers, type, fragments + * <td><code>FieldDeclaration</code></td> + * <td><code>modifiers, type, fragments * (VariableDeclarationFragments * with name only)<br> * RELATIVE_ORDER property</code></td> * </tr> * <tr> - * <td width="20%"><code>MethodDeclaration</code></td> - * <td width="50%"><code>modifiers, isConstructor, returnType, name, + * <td><code>MethodDeclaration</code></td> + * <td><code>modifiers, isConstructor, returnType, name, * typeParameters, parameters * (SingleVariableDeclarations with name, type, and modifiers only), * thrownExceptions<br> * RELATIVE_ORDER property</code></td> * </tr> * <tr> - * <td width="20%"><code>Initializer</code></td> - * <td width="50%"><code>modifiers<br> + * <td><code>Initializer</code></td> + * <td><code>modifiers<br> * RELATIVE_ORDER property</code></td> * </tr> * <tr> - * <td width="20%"><code>AnnotationTypeDeclaration</code></td> - * <td width="50%"><code>modifiers, name<br> + * <td><code>AnnotationTypeDeclaration</code></td> + * <td><code>modifiers, name<br> * RELATIVE_ORDER property</code></td> * </tr> * <tr> - * <td width="20%"><code>AnnotationTypeMemberDeclaration</code></td> - * <td width="50%"><code>modifiers, name, type, default<br> + * <td><code>AnnotationTypeMemberDeclaration</code></td> + * <td><code>modifiers, name, type, default<br> * RELATIVE_ORDER property</code></td> * </tr> * <tr> - * <td width="20%"><code>EnumDeclaration</code></td> - * <td width="50%"><code>modifiers, name, superInterfaces<br> + * <td><code>EnumDeclaration</code></td> + * <td><code>modifiers, name, superInterfaces<br> * RELATIVE_ORDER property</code></td> * </tr> * <tr> - * <td width="20%"><code>EnumConstantDeclaration</code></td> - * <td width="50%"><code>modifiers, name, arguments<br> + * <td><code>EnumConstantDeclaration</code></td> + * <td><code>modifiers, name, arguments<br> * RELATIVE_ORDER property</code></td> * </tr> * </table> @@ -294,7 +293,6 @@ public final class CompilationUnitSorter { * having source range information. (Future releases may provide options * for requesting additional information like source positions, full ASTs, * non-recursive sorting, etc.) - * </p> * * @param level the AST level; one of the <code>{@link AST}.JLS*</code> constants * @param compilationUnit the given compilation unit, which must be a @@ -371,55 +369,54 @@ public final class CompilationUnitSorter { * <p> * The body declarations passed as parameters to the comparator always carry * at least the following minimal signature information: <br> - * <table border="1" width="80%" cellpadding="5"> + * <table border="1"> * <tr> - * <td width="20%"><code>TypeDeclaration</code></td> - * <td width="50%"><code>modifiers, isInterface, name, superclass, + * <td><code>TypeDeclaration</code></td> + * <td><code>modifiers, isInterface, name, superclass, * superInterfaces, typeParameters<br> * RELATIVE_ORDER property</code></td> * </tr> * <tr> - * <td width="20%"><code>FieldDeclaration</code></td> - * <td width="50%"><code>modifiers, type, fragments + * <td><code>FieldDeclaration</code></td> + * <td><code>modifiers, type, fragments * (VariableDeclarationFragments * with name only)<br> * RELATIVE_ORDER property</code></td> * </tr> * <tr> - * <td width="20%"><code>MethodDeclaration</code></td> - * <td width="50%"><code>modifiers, isConstructor, returnType, name, + * <td><code>MethodDeclaration</code></td> + * <td><code>modifiers, isConstructor, returnType, name, * typeParameters, parameters * (SingleVariableDeclarations with name, type, and modifiers only), * thrownExceptions<br> * RELATIVE_ORDER property</code></td> * </tr> * <tr> - * <td width="20%"><code>Initializer</code></td> - * <td width="50%"><code>modifiers<br> + * <td><code>Initializer</code></td> + * <td><code>modifiers<br> * RELATIVE_ORDER property</code></td> * </tr> * <tr> - * <td width="20%"><code>AnnotationTypeDeclaration</code></td> - * <td width="50%"><code>modifiers, name<br> + * <td><code>AnnotationTypeDeclaration</code></td> + * <td><code>modifiers, name<br> * RELATIVE_ORDER property</code></td> * </tr> * <tr> - * <td width="20%"><code>AnnotationTypeMemberDeclaration</code></td> - * <td width="50%"><code>modifiers, name, type, default<br> + * <td><code>AnnotationTypeMemberDeclaration</code></td> + * <td><code>modifiers, name, type, default<br> * RELATIVE_ORDER property</code></td> * </tr> * <tr> - * <td width="20%"><code>EnumDeclaration</code></td> - * <td width="50%"><code>modifiers, name, superInterfaces<br> + * <td><code>EnumDeclaration</code></td> + * <td><code>modifiers, name, superInterfaces<br> * RELATIVE_ORDER property</code></td> * </tr> * <tr> - * <td width="20%"><code>EnumConstantDeclaration</code></td> - * <td width="50%"><code>modifiers, name, arguments<br> + * <td><code>EnumConstantDeclaration</code></td> + * <td><code>modifiers, name, arguments<br> * RELATIVE_ORDER property</code></td> * </tr> * </table> - * </p> * * @param unit * the CompilationUnit to sort diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/util/ExternalAnnotationUtil.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/util/ExternalAnnotationUtil.java index 53d63ea1f4..301b4e5bd5 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/util/ExternalAnnotationUtil.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/util/ExternalAnnotationUtil.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2015, 2016 GK Software AG. + * Copyright (c) 2015, 2019 GK Software AG. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -612,7 +612,7 @@ public final class ExternalAnnotationUtil { * <li>prefix up-to the changed type</li> * <li>original type</li> * <li>changed type</li> - * <li>postfix after the changed type <em>(here: empty string)</li> + * <li>postfix after the changed type <em>(here: empty string)</em></li> * </ul> */ public static String[] annotateType(String originalSignature, String annotatedType, MergeStrategy mergeStrategy) @@ -639,7 +639,7 @@ public final class ExternalAnnotationUtil { * <li>prefix up-to the changed type</li> * <li>original type</li> * <li>changed type</li> - * <li>postfix after the changed type <em>(here: empty string)</li> + * <li>postfix after the changed type <em>(here: empty string)</em></li> * </ul> */ public static String[] annotateReturnType(String originalSignature, String annotatedType, MergeStrategy mergeStrategy) diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/util/IStackMapFrame.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/util/IStackMapFrame.java index e6033f6841..0f2534c60f 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/util/IStackMapFrame.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/util/IStackMapFrame.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2009 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -26,8 +26,8 @@ public interface IStackMapFrame { * Answer back the frame type for this entry. * <table> * <tr> - * <th align="left">Type</th> - * <th align="left">Range</th> + * <th>Type</th> + * <th>Range</th> * </tr> * <tr> * <td>SAME</td> diff --git a/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/IJavaSearchConstants.java b/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/IJavaSearchConstants.java index d79b9d9e57..b52465ffb7 100644 --- a/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/IJavaSearchConstants.java +++ b/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/IJavaSearchConstants.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2017 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -328,7 +328,7 @@ public interface IJavaSearchConstants { *</pre> * Searching references to the type <code>Test</code> using this flag in the * above snippet will match only the reference in italic. - * </p><p> + * <p> * Note that array creations are not returned when using this flag. * </p> * @since 3.4 @@ -427,7 +427,6 @@ public interface IJavaSearchConstants { * <li>for the {@link #METHOD} nature, only {@link MethodReferenceMatch} * matches will be returned.</li> * </ul> - *</p> * @since 3.4 * @category limitTo */ @@ -444,7 +443,6 @@ public interface IJavaSearchConstants { * <li>for the {@link #METHOD} nature, only {@link MethodReferenceMatch} * matches will be returned.</li> * </ul> - *</p> * @since 3.4 * @category limitTo */ @@ -462,7 +460,6 @@ public interface IJavaSearchConstants { * <li>for the {@link #METHOD} nature, only {@link MethodReferenceMatch} * matches will be returned.</li> * </ul> - *</p> * @since 3.4 * @category limitTo */ @@ -479,7 +476,6 @@ public interface IJavaSearchConstants { * <li>for the {@link #METHOD} nature, only {@link MethodReferenceMatch} * matches will be returned.</li> * </ul> - *</p> * @since 3.4 * @category limitTo */ diff --git a/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/ReferenceMatch.java b/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/ReferenceMatch.java index d88af160a2..0a55569b7d 100644 --- a/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/ReferenceMatch.java +++ b/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/ReferenceMatch.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2009 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -87,7 +87,7 @@ public ReferenceMatch(IJavaElement enclosingElement, int accuracy, int offset, i * is the {@link IAnnotation} '<code>Num</code>'.<br><br> * </li> * </ul> - * </p><p> + * <p> * A local element may also be a {@link ILocalVariable} whose type is the referenced * type. For example, * <ul> @@ -112,7 +112,6 @@ public ReferenceMatch(IJavaElement enclosingElement, int accuracy, int offset, i * will return one {@link TypeReferenceMatch} match whose local element * is the {@link ITypeParameter} '<code>T</code>'.<br><br> * </ul> - * </p> * * @return the local element of this search match, or <code>null</code> if none. * diff --git a/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/SearchEngine.java b/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/SearchEngine.java index 54e2601891..19d37e3bd9 100644 --- a/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/SearchEngine.java +++ b/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/SearchEngine.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2016 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -1440,8 +1440,8 @@ public class SearchEngine { * Reports the field declarations using the given requestor. * <p> * Consider the following code: - * <code> * <pre> + * <code> * class A { * int field1; * } @@ -1454,8 +1454,9 @@ public class SearchEngine { * System.out.println(b.value + b.field1); * }; * } - * </pre> * </code> + * </pre> + * <p> * then searching for declarations of accessed fields in method * <code>X.test()</code> would collect the fields * <code>B.value</code> and <code>A.field1</code>. @@ -1482,8 +1483,8 @@ public class SearchEngine { * Reports the field declarations using the given collector. * <p> * Consider the following code: - * <code> * <pre> + * <code> * class A { * int field1; * } @@ -1496,8 +1497,9 @@ public class SearchEngine { * System.out.println(b.value + b.field1); * }; * } - * </pre> * </code> + * </pre> + * <p> * then searching for declarations of accessed fields in method * <code>X.test()</code> would collect the fields * <code>B.value</code> and <code>A.field1</code>. @@ -1524,8 +1526,8 @@ public class SearchEngine { * Reports the type declarations using the given requestor. * <p> * Consider the following code: - * <code> * <pre> + * <code> * class A { * } * class B extends A { @@ -1539,8 +1541,9 @@ public class SearchEngine { * this.foo(b, I.VALUE); * }; * } - * </pre> * </code> + * </pre> + * <p> * then searching for declarations of referenced types in method <code>X.test()</code> * would collect the class <code>B</code> and the interface <code>I</code>. * </p> @@ -1566,8 +1569,8 @@ public class SearchEngine { * Reports the type declarations using the given collector. * <p> * Consider the following code: - * <code> * <pre> + * <code> * class A { * } * class B extends A { @@ -1581,8 +1584,9 @@ public class SearchEngine { * this.foo(b, I.VALUE); * }; * } - * </pre> * </code> + * </pre> + * <p> * then searching for declarations of referenced types in method <code>X.test()</code> * would collect the class <code>B</code> and the interface <code>I</code>. * </p> @@ -1608,8 +1612,8 @@ public class SearchEngine { * Reports the method declarations using the given requestor. * <p> * Consider the following code: - * <code> * <pre> + * <code> * class A { * void foo() {}; * void bar() {}; @@ -1625,8 +1629,9 @@ public class SearchEngine { * b.bar(); * }; * } - * </pre> * </code> + * </pre> + * <p> * then searching for declarations of sent messages in method * <code>X.test()</code> would collect the methods * <code>A.foo()</code>, <code>B.foo()</code>, and <code>A.bar()</code>. @@ -1653,8 +1658,8 @@ public class SearchEngine { * Reports the method declarations using the given collector. * <p> * Consider the following code: - * <code> * <pre> + * <code> * class A { * void foo() {}; * void bar() {}; @@ -1670,8 +1675,9 @@ public class SearchEngine { * b.bar(); * }; * } - * </pre> * </code> + * </pre> + * <p> * then searching for declarations of sent messages in method * <code>X.test()</code> would collect the methods * <code>A.foo()</code>, <code>B.foo()</code>, and <code>A.bar()</code>. diff --git a/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/SearchParticipant.java b/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/SearchParticipant.java index 8df4e34007..5a9b19ee42 100644 --- a/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/SearchParticipant.java +++ b/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/SearchParticipant.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2014 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -42,13 +42,13 @@ import org.eclipse.jdt.internal.core.search.indexing.IndexManager; * <li>{@link #scheduleDocumentIndexing(SearchDocument, IPath)}</li> * <li>{@link #indexDocument(SearchDocument, IPath)}</li> * </ul> + * <p> * During the search phase, a subclass will be called with the following requests in order: * <ul> * <li>{@link #selectIndexes(SearchPattern, IJavaSearchScope)}</li> * <li>one or more {@link #getDocument(String)}</li> * <li>{@link #locateMatches(SearchDocument[], SearchPattern, IJavaSearchScope, SearchRequestor, IProgressMonitor)}</li> * </ul> - * </p> * * @since 3.0 */ diff --git a/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/SearchPattern.java b/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/SearchPattern.java index 6a13f14959..fcfed80bd8 100644 --- a/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/SearchPattern.java +++ b/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/SearchPattern.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2017 IBM Corporation and others. + * Copyright (c) 2000, 2019 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 @@ -375,7 +375,6 @@ public SearchPattern currentPattern() { * For instance, 'HM' , 'HaMa' and 'HMap' patterns will match 'HashMap', * 'HatMapper' <b>and also</b> 'HashMapEntry'. * <p> - * <pre> * Examples: * <ol><li> pattern = "NPE" * name = NullPointerException / NoPermissionException @@ -395,7 +394,7 @@ public SearchPattern currentPattern() { * <li> pattern = "HMap" * name = "HatMapper" * result => true</li> - * </ol></pre> + * </ol> * * @see #camelCaseMatch(String, int, int, String, int, int, boolean) for algorithm * implementation @@ -445,7 +444,6 @@ public static final boolean camelCaseMatch(String pattern, String name) { * For instance, 'HM' , 'HaMa' and 'HMap' patterns will match 'HashMap' and * 'HatMapper' <b>but not</b> 'HashMapEntry'. * <p> - * <pre> * Examples: * <ol><li> pattern = "NPE" * name = NullPointerException / NoPermissionException @@ -462,7 +460,7 @@ public static final boolean camelCaseMatch(String pattern, String name) { * <li> pattern = "HM" * name = "HashMapEntry" * result => (samePartCount == false)</li> - * </ol></pre> + * </ol> * * @see #camelCaseMatch(String, int, int, String, int, int, boolean) for algorithm * implementation @@ -526,7 +524,7 @@ public static final boolean camelCaseMatch(String pattern, String name, boolean * For instance, 'HM' , 'HaMa' and 'HMap' patterns will match 'HashMap', * 'HatMapper' <b>and also</b> 'HashMapEntry'. * <p> - * <pre>Examples:<ol> + * <ol> * <li> pattern = "NPE" * patternStart = 0 * patternEnd = 3 @@ -583,7 +581,7 @@ public static final boolean camelCaseMatch(String pattern, String name, boolean * nameStart = 0 * nameEnd = 9 * result => true</li> - * </ol></pre> + * </ol> * * @param pattern the given pattern * @param patternStart the start index of the pattern, inclusive @@ -632,7 +630,8 @@ public static final boolean camelCaseMatch(String pattern, int patternStart, int * For instance, 'HM' , 'HaMa' and 'HMap' patterns will match 'HashMap' and * 'HatMapper' <b>but not</b> 'HashMapEntry'. * <p> - * <pre>Examples:<ol> + * Examples: + * <ol> * <li> pattern = "NPE" * patternStart = 0 * patternEnd = 3 @@ -682,7 +681,7 @@ public static final boolean camelCaseMatch(String pattern, int patternStart, int * nameStart = 0 * nameEnd = 12 * result => (samePartCount == false)</li> - * </ol></pre> + * </ol> * * @see CharOperation#camelCaseMatch(char[], int, int, char[], int, int, boolean) * from which algorithm implementation has been entirely copied. @@ -735,7 +734,7 @@ public static final boolean camelCaseMatch(String pattern, int patternStart, int * Each of these rules may be combined with the * {@link #R_CASE_SENSITIVE case sensitive flag} if the match comparison * should respect the case. - * <pre> + * <p> * Examples: * <ol><li> pattern = "NPE" * name = NullPointerException / NoPermissionException @@ -761,7 +760,7 @@ public static final boolean camelCaseMatch(String pattern, int patternStart, int * name = "HashMapEntry" * matchRule = {@link #R_PATTERN_MATCH} * result: { 0, 2, 4, 1, 7, 3 }</li> - * </ol></pre> + * </ol> * * @see #camelCaseMatch(String, String, boolean) for more details on the * camel case behavior @@ -1546,10 +1545,10 @@ private static SearchPattern createPackagePattern(String patternString, int limi * </li> * <li>All other fine grain constants defined in the <b>limitTo</b> category * of the {@link IJavaSearchConstants} are also accepted nature: - * <table border=0> + * <table> * <tr> - * <th align=left>Fine grain constant - * <th align=left>Meaning + * <th>Fine grain constant + * <th>Meaning * <tr> * <td>{@link IJavaSearchConstants#FIELD_DECLARATION_TYPE_REFERENCE FIELD_DECLARATION_TYPE_REFERENCE} * <td>Return only type references used as the type of a field declaration. @@ -1732,10 +1731,10 @@ public static SearchPattern createPattern(String stringPattern, int searchFor, i * </li> * <li>All other fine grain constants defined in the <b>limitTo</b> category * of the {@link IJavaSearchConstants} are also accepted nature: - * <table border=0> + * <table> * <tr> - * <th align=left>Fine grain constant - * <th align=left>Meaning + * <th>Fine grain constant + * <th>Meaning * <tr> * <td>{@link IJavaSearchConstants#FIELD_DECLARATION_TYPE_REFERENCE FIELD_DECLARATION_TYPE_REFERENCE} * <td>Return only type references used as the type of a field declaration. @@ -1844,10 +1843,10 @@ public static SearchPattern createPattern(IJavaElement element, int limitTo) { * </li> * <li>All other fine grain constants defined in the <b>limitTo</b> category * of the {@link IJavaSearchConstants} are also accepted nature: - * <table border=0> + * <table> * <tr> - * <th align=left>Fine grain constant - * <th align=left>Meaning + * <th>Fine grain constant + * <th>Meaning * <tr> * <td>{@link IJavaSearchConstants#FIELD_DECLARATION_TYPE_REFERENCE FIELD_DECLARATION_TYPE_REFERENCE} * <td>Return only type references used as the type of a field declaration. |