jdt.core: fix javadoc

org.eclipse.jdt.core.formatterapp/src/org/eclipse/jdt/core/formatterapp/CodeFormatterApplicationWrapper.java

@@ -27,7 +27,6 @@
 /**
  * Wraps original {@code CodeFormatterApplication} for better error diagnostic message if user does not specify workspace location.
  *
- * @author Jonah Graham <jonah@kichwacoders.com>
  * @since 1.0
  * @noinstantiate This class is not intended to be instantiated by clients.
  * @noextend This class is not intended to be subclassed by clients.

org.eclipse.jdt.core/codeassist/org/eclipse/jdt/internal/codeassist/InternalCompletionProposal.java

@@ -655,7 +655,6 @@ public void setName(char[] name) {
 	 * of the method or constructor being proposed</li>
 	 * </ul>
 	 * For other kinds of completion proposals, this method returns <code>null</code>.
-	 * </p>
 	 *
 	 * @return the binding corresponding to this proposal (if available), or <code>null</code> if none
 	 */

org.eclipse.jdt.core/dom/org/eclipse/jdt/internal/core/dom/NaiveASTFlattener.java

@@ -28,16 +28,13 @@
  * fine for generating debug print strings.
  * <p>
  * Example usage:
- * <code>
- * <pre>
+ * <pre>{@code
  *    NaiveASTFlattener p = new NaiveASTFlattener();
  *    node.accept(p);
  *    String result = p.getResult();
- * </pre>
- * </code>
+ * }</pre>
  * Call the <code>reset</code> method to clear the previous result before reusing an
  * existing instance.
- * </p>
  *
  * @since 2.0
  */

org.eclipse.jdt.core/eval/org/eclipse/jdt/internal/eval/CodeSnippetQualifiedNameReference.java

@@ -542,7 +542,7 @@ public TypeBinding getOtherFieldBindings(BlockScope scope) {
 }
 
 /**
- * index is <0 to denote write access emulation
+ * index is {@code <0} to denote write access emulation
  */
 @Override
 public void manageSyntheticAccessIfNecessary(BlockScope currentScope, FieldBinding fieldBinding, int index, FlowInfo flowInfo) {

org.eclipse.jdt.core/model/org/eclipse/jdt/core/ITypeRoot.java

@@ -20,9 +20,9 @@
  * Represents an entire Java type root (either an <code>ICompilationUnit</code>
  * or an <code>IClassFile</code>).
  *
- * @see ICompilationUnit Note that methods {@link #findPrimaryType()} and {@link #getElementAt(int)}
+ * <p>See {@link ICompilationUnit} Note that methods {@link #findPrimaryType()} and {@link #getElementAt(int)}
  * 	were already implemented in this interface respectively since version 3.0 and version 1.0.
- * @see IClassFile Note that method {@link #getWorkingCopy(WorkingCopyOwner, IProgressMonitor)}
+ * <p>See {@link IClassFile} Note that method {@link #getWorkingCopy(WorkingCopyOwner, IProgressMonitor)}
  * 	was already implemented in this interface since version 3.0.
  * @since 3.3
  * @noimplement This interface is not intended to be implemented by clients.

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/compiler/IDocumentElementRequestor.java

@@ -28,18 +28,22 @@
  * - methods
  *
  * If reference information is requested, then all source constructs are
- * investigated and type, field & method references are provided as well.
+ * investigated and type, field and method references are provided as well.
  *
  * Any (parsing) problem encountered is also provided.
  *
  * All positions are relative to the exact source fed to the parser.
  *
  * Elements which are complex are notified in two steps:
+ * <pre>{@code
  * - enter<Element> : once the element header has been identified
  * - exit<Element> : once the element has been fully consumed
+ * }</pre>
  *
  * other simpler elements (package, import) are read all at once:
+ * <pre>{@code
  * - accept<Element>
+ * }</pre>
  */
 
 public interface IDocumentElementRequestor {
@@ -80,7 +84,7 @@ void acceptImport(
  * The array is equals to null if there are no javadoc comments
  * @param modifiers - the modifiers for this initializer
  * @param modifiersStart - a source position corresponding to the start
- *  of the textual modifiers, is < 0 if there are no textual modifiers
+ *  of the textual modifiers, is {@code < 0} if there are no textual modifiers
  * @param bodyStart - the position of the '{'
  * @param bodyEnd - the position of the '}'
  */
@@ -135,7 +139,7 @@ void acceptPackage(
  * The array is equals to null if there are no javadoc comments
  * @param modifiers - the modifiers for this class
  * @param modifiersStart - a source position corresponding to the start
- *  of the textual modifiers, is < 0 if there are no textual modifiers
+ *  of the textual modifiers, is {@code < 0} if there are no textual modifiers
  * @param classStart - a source position corresponding to the start
  *  of the keyword 'class'
  * @param name - the name of the class
@@ -271,7 +275,7 @@ void enterField(
  * The array is equals to null if there are no javadoc comments
  * @param modifiers - the modifiers for this class
  * @param modifiersStart - a source position corresponding to the start
- *  of the textual modifiers, is < 0 if there are no textual modifiers
+ *  of the textual modifiers, is {@code < 0} if there are no textual modifiers
  * @param interfaceStart - a source position corresponding to the start
  *  of the keyword 'interface'
  * @param name - the name of the class

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/compiler/SourceElementParser.java

@@ -44,7 +44,7 @@
  * - methods
  *
  * If reference information is requested, then all source constructs are
- * investigated and type, field & method references are provided as well.
+ * investigated and type, field and method references are provided as well.
  *
  * Any (parsing) problem encountered is also provided.
  */

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/AbstractClassFile.java

@@ -138,7 +138,7 @@ protected int calculateHashCode() {
 
 	/**
 	 * Finds the deepest <code>IJavaElement</code> in the hierarchy of
-	 * <code>elt</elt>'s children (including <code>elt</code> itself)
+	 * <code>elt</code>'s children (including <code>elt</code> itself)
 	 * which has a source range that encloses <code>position</code>
 	 * according to <code>mapper</code>.
 	 */

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/BinaryField.java

@@ -112,7 +112,7 @@ public JavaElement resolved(Binding binding) {
 	return resolvedHandle;
 }
 /*
- * @private Debugging purposes
+ * for debugging only
  */
 @Override
 protected void toStringInfo(int tab, StringBuilder buffer, Object info, boolean showResolvedInfo) {

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/BinaryMethod.java

@@ -688,7 +688,7 @@ public JavaElement resolved(Binding binding) {
 	SourceRefElement resolvedHandle = new ResolvedBinaryMethod(this.getParent(), this.name, this.parameterTypes, DeduplicationUtil.toString(binding.computeUniqueKey()), this.getOccurrenceCount());
 	return resolvedHandle;
 }/*
- * @private Debugging purposes
+ * for debugging only
  */
 @Override
 protected void toStringInfo(int tab, StringBuilder buffer, Object info, boolean showResolvedInfo) {

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/BinaryType.java

@@ -1019,7 +1019,7 @@ public String sourceFileName(IBinaryType info) {
 	}
 }
 /*
- * @private Debugging purposes
+ * for debugging only
  */
 @Override
 protected void toStringInfo(int tab, StringBuilder buffer, Object info, boolean showResolvedInfo) {

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/Buffer.java

@@ -302,7 +302,7 @@ public synchronized void removeBufferChangedListener(IBufferChangedListener list
 	}
 }
 /**
- * Replaces <code>length</code> characters starting from <code>position</code> with <code>text<code>.
+ * Replaces <code>length</code> characters starting from <code>position</code> with <code>text</code>.
  * After that operation, the gap is placed at the end of the
  * inserted <code>text</code>.
  */
@@ -339,7 +339,7 @@ public void replace(int position, int length, char[] text) {
 	}
 }
 /**
- * Replaces <code>length</code> characters starting from <code>position</code> with <code>text<code>.
+ * Replaces <code>length</code> characters starting from <code>position</code> with <code>text</code>.
  * After that operation, the gap is placed at the end of the
  * inserted <code>text</code>.
  */

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/ClasspathEntry.java

@@ -150,13 +150,13 @@ public AssertionFailedException(String message) {
 	 *		path to the corresponding project resource.</li>
 	 *  <li>A variable entry (<code>CPE_VARIABLE</code>) - the first segment of the path
 	 *      is the name of a classpath variable. If this classpath variable
-	 *		is bound to the path <it>P</it>, the path of the corresponding classpath entry
-	 *		is computed by appending to <it>P</it> the segments of the returned
+	 *		is bound to the path <code>P</code>, the path of the corresponding classpath entry
+	 *		is computed by appending to <code>P</code> the segments of the returned
 	 *		path without the variable.</li>
 	 *  <li> A container entry (<code>CPE_CONTAINER</code>) - the first segment of the path is denoting
 	 *     the unique container identifier (for which a <code>ClasspathContainerInitializer</code> could be
 	 * 	registered), and the remaining segments are used as additional hints for resolving the container entry to
-	 * 	an actual <code>IClasspathContainer</code>.</li>
+	 * 	an actual <code>IClasspathContainer</code>.</li></ul>
 	 */
 	public final IPath path;
 
@@ -1839,7 +1839,7 @@ public boolean ignoreOptionalProblems() {
 	 *  <p>
 	 *  This validation is intended to anticipate classpath issues prior to assigning it to a project. In particular, it will automatically
 	 *  be performed during the classpath setting operation (if validation fails, the classpath setting will not complete).
-	 *  <p>
+	 *
 	 * @param javaProject the given java project
 	 * @param rawClasspath a given classpath
 	 * @param projectOutputLocation a given output location

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/CreateImportOperation.java

@@ -134,6 +134,7 @@ public String getMainTaskName(){
  * <li> if no imports, before the first type
  * <li> if no type, after the package statement
  * <li> and if no package statement - first thing in the CU
+ * </ul>
  */
 @Override
 protected void initializeDefaultPosition() {

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/CreatePackageDeclarationOperation.java

@@ -96,6 +96,7 @@ public String getMainTaskName(){
  * <li> if no imports, before the first type
  * <li> if no type - first thing in the CU
  * <li>
+ * </ul>
  */
 @Override
 protected void initializeDefaultPosition() {

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/ImportContainer.java

@@ -98,7 +98,7 @@ public String readableName() {
 	return null;
 }
 /**
- * @private Debugging purposes
+ * for debugging only
  */
 @Override
 protected void toString(int tab, StringBuilder buffer) {
@@ -111,7 +111,7 @@ protected void toString(int tab, StringBuilder buffer) {
 	}
 }
 /**
- *  Debugging purposes
+ * for debugging only
  */
 @Override
 protected void toStringInfo(int tab, StringBuilder buffer, Object info, boolean showResolvedInfo) {

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/ImportDeclaration.java

@@ -111,7 +111,7 @@ public String readableName() {
 	return null;
 }
 /**
- * @private Debugging purposes
+ * for debugging only
  */
 @Override
 protected void toStringInfo(int tab, StringBuilder buffer, Object info, boolean showResolvedInfo) {

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/Initializer.java

@@ -90,7 +90,7 @@ public JavaElement getPrimaryElement(boolean checkOwner) {
 	return (JavaElement) ((IType) primaryParent).getInitializer(this.getOccurrenceCount());
 }
 /**
- * @private Debugging purposes
+ * for debugging only
  */
 @Override
 protected void toStringInfo(int tab, StringBuilder buffer, Object info, boolean showResolvedInfo) {

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/JarPackageFragmentRoot.java

@@ -74,7 +74,7 @@ public class JarPackageFragmentRoot extends PackageFragmentRoot {
 
 	/**
 	 * Reflects the extra attributes of the classpath entry declaring this root.
-	 * Caution, this field is used in hashCode() & equals() to avoid overzealous sharing.
+	 * Caution, this field is used in {@link #hashCode()} and {@link #equals(Object)} to avoid overzealous sharing.
 	 * Can be null, if lookup via the corresponding classpath entry failed.
 	 */
 	final protected IClasspathAttribute[] extraAttributes;

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/JavaElement.java

@@ -103,7 +103,7 @@ public abstract class JavaElement extends PlatformObject implements IJavaElement
 	public static final char JEM_MODULE = '`';
 
 	/**
-	 * Before ')', '&' and '"' became the newest additions as delimiters, the former two
+	 * Before ')', {@code '&'} and '"' became the newest additions as delimiters, the former two
 	 * were allowed as part of element attributes and possibly stored. Trying to recreate
 	 * elements from such memento would cause undesirable results. Consider the following
 	 * valid project name: (abc)

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/JavaModel.java

@@ -308,7 +308,7 @@ protected void runOperation(MultiOperation op, IJavaElement[] elements, IJavaEle
 	op.runOperation(monitor);
 }
 /**
- * @private Debugging purposes
+ * for debugging only
  */
 @Override
 protected void toStringInfo(int tab, StringBuilder buffer, Object info, boolean showResolvedInfo) {

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/JavaModelManager.java

@@ -5003,7 +5003,7 @@ private static void dumpSecondaryTypes(Map<String, Map<String, IType>> secondary
 	 * 		</ul>
 	 * </ul>
 	 * Hashtable was used to protect callers from possible concurrent access.
-	 * </p>
+	 * <p>
 	 * Note, if indexing is not finished and caller does
 	 * not wait for the end of indexing, returned map is the current secondary
 	 * types cache content which may be invalid...

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/OverflowingLRUCache.java

@@ -46,7 +46,7 @@
  *	<p>Use the <code>#peek(Object)</code> and <code>#disableTimestamps()</code> method to
  *	circumvent the timestamp feature of the cache.  This feature is intended to be used
  *	only when the <code>#close(LRUCacheEntry)</code> method causes changes to the cache.
- *	For example, if a parent closes its children when </code>#close(LRUCacheEntry)</code> is called,
+ *	For example, if a parent closes its children when <code>#close(LRUCacheEntry)</code> is called,
  *	it should be careful not to change the LRU linked list.  It can be sure it is not causing
  *	problems by calling <code>#peek(Object)</code> instead of <code>#get(Object)</code> method.
  *

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/PackageDeclaration.java

@@ -66,7 +66,7 @@ public JavaElement getPrimaryElement(boolean checkOwner) {
 	return cu.getPackageDeclaration(this.name);
 }
 /**
- * @private Debugging purposes
+ * for debugging only
  */
 @Override
 protected void toStringInfo(int tab, StringBuilder buffer, Object info, boolean showResolvedInfo) {

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/PackageFragmentRoot.java

@@ -833,7 +833,7 @@ public void move(
 }
 
 /**
- * @private Debugging purposes
+ * for debugging only
  */
 @Override
 protected void toStringInfo(int tab, StringBuilder buffer, Object info, boolean showResolvedInfo) {

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/ReconcileWorkingCopyOperation.java

@@ -37,9 +37,9 @@
  * <li>populates the model with the new working copy contents</li>
  * <li>fires a fine grained delta (flag F_FINE_GRAINED) describing the difference between the previous content
  *      and the new content (which method was added/removed, which field was changed, etc.)</li>
- * <li>computes problems and reports them to the IProblemRequestor (begingReporting(), n x acceptProblem(...), endReporting()) iff
+ * <li>computes problems and reports them to the IProblemRequestor {@code (begingReporting(), n x acceptProblem(...), endReporting()) iff
  *     	(working copy is not consistent with its buffer || forceProblemDetection is set)
- * 		&& problem requestor is active
+ * 		&& problem} requestor is active
  * </li>
  * <li>produces a DOM AST (either JLS_2, JLS_3 or NO_AST) that is resolved if flag is set</li>
  * <li>notifies compilation participants of the reconcile allowing them to participate in this operation and report problems</li>

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/ResolvedBinaryField.java

@@ -51,7 +51,7 @@ public boolean isResolved() {
 	}
 
 	/**
-	 * @private Debugging purposes
+	 * for debugging only
 	 */
 	@Override
 	protected void toStringInfo(int tab, StringBuilder buffer, Object info, boolean showResolvedInfo) {

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/ResolvedBinaryMethod.java

@@ -52,7 +52,7 @@ public boolean isResolved() {
 	}
 
 	/**
-	 * @private Debugging purposes
+	 * for debugging only
 	 */
 	@Override
 	protected void toStringInfo(int tab, StringBuilder buffer, Object info, boolean showResolvedInfo) {

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/ResolvedBinaryType.java

@@ -56,7 +56,7 @@ public boolean isResolved() {
 	}
 
 	/**
-	 * @private Debugging purposes
+	 * for debugging only
 	 */
 	@Override
 	protected void toStringInfo(int tab, StringBuilder buffer, Object info, boolean showResolvedInfo) {

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/ResolvedLambdaExpression.java

@@ -47,7 +47,7 @@ public boolean isResolved() {
 	}
 
 	/**
-	 * @private Debugging purposes
+	 * for debugging only
 	 */
 	@Override
 	protected void toStringInfo(int tab, StringBuilder buffer, Object info, boolean showResolvedInfo) {

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/ResolvedSourceField.java

@@ -43,7 +43,7 @@ public boolean isResolved() {
 	}
 
 	/**
-	 * @private Debugging purposes
+	 * for debugging only
 	 */
 	@Override
 	protected void toStringInfo(int tab, StringBuilder buffer, Object info, boolean showResolvedInfo) {

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/ResolvedSourceMethod.java

@@ -45,7 +45,7 @@ public boolean isResolved() {
 	}
 
 	/**
-	 * @private Debugging purposes
+	 * for debugging only
 	 */
 	@Override
 	protected void toStringInfo(int tab, StringBuilder buffer, Object info, boolean showResolvedInfo) {

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/ResolvedSourceType.java

@@ -51,7 +51,7 @@ public boolean isResolved() {
 	}
 
 	/**
-	 * @private Debugging purposes
+	 * for debugging only
 	 */
 	@Override
 	protected void toStringInfo(int tab, StringBuilder buffer, Object info, boolean showResolvedInfo) {

org.eclipse.jdt.core/model/org/eclipse/jdt/internal/core/SortElementsOperation.java

@@ -343,8 +343,8 @@ public boolean visit(EnumDeclaration enumDeclaration) {
 	/**
 	 * Possible failures:
 	 * <ul>
-	 *  <li>NO_ELEMENTS_TO_PROCESS - the compilation unit supplied to the operation is <code>null</code></li>.
-	 *  <li>INVALID_ELEMENT_TYPES - the supplied elements are not an instance of IWorkingCopy</li>.
+	 *  <li>NO_ELEMENTS_TO_PROCESS - the compilation unit supplied to the operation is <code>null</code>.</li>
+	 *  <li>INVALID_ELEMENT_TYPES - the supplied elements are not an instance of IWorkingCopy.</li>
 	 * </ul>
 	 * @return IJavaModelStatus
 	 */