diff options
| author | Tomasz Zarna | 2012-07-20 09:01:13 +0000 |
|---|---|---|
| committer | Jayaprakash Arthanareeswaran | 2012-08-10 06:57:25 +0000 |
| commit | 77c4fc99b77799252d5be9c7606ffbaa714b3d5d (patch) | |
| tree | e287206add63f6d40799137dcb98d5e670376042 | |
| parent | 587deaab79fbebc87b8089ceba0433e6e93b37c4 (diff) | |
| download | eclipse.jdt.core-77c4fc99b77799252d5be9c7606ffbaa714b3d5d.tar.gz eclipse.jdt.core-77c4fc99b77799252d5be9c7606ffbaa714b3d5d.tar.xz eclipse.jdt.core-77c4fc99b77799252d5be9c7606ffbaa714b3d5d.zip | |
Most Javadocs in JavaCore.java are missing </p>.
Bug: 326514
Change-Id: I4b8d7801939a4f6d12d3e2459ac23d586d339d66
| -rw-r--r-- | org.eclipse.jdt.core/model/org/eclipse/jdt/core/JavaCore.java | 482 |
1 files changed, 271 insertions, 211 deletions
diff --git a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/JavaCore.java b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/JavaCore.java index 1af551081e..813069944f 100644 --- a/org.eclipse.jdt.core/model/org/eclipse/jdt/core/JavaCore.java +++ b/org.eclipse.jdt.core/model/org/eclipse/jdt/core/JavaCore.java @@ -220,7 +220,7 @@ public final class JavaCore extends Plugin { * Compiler option ID: Generating Local Variable Debug Attribute. * <p>When generated, this attribute will enable local variable names * to be displayed in debugger, only in place where variables are - * definitely assigned (.class file is then bigger). + * definitely assigned (.class file is then bigger).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.debug.localVariable"</code></dd> * <dt>Possible values:</dt><dd><code>{ "generate", "do not generate" }</code></dd> @@ -232,7 +232,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Generating Line Number Debug Attribute. * <p>When generated, this attribute will enable source code highlighting in debugger - * (.class file is then bigger). + * (.class file is then bigger).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.debug.lineNumber"</code></dd> * <dt>Possible values:</dt><dd><code>{ "generate", "do not generate" }</code></dd> @@ -244,7 +244,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Generating Source Debug Attribute. * <p>When generated, this attribute will enable the debugger to present the - * corresponding source code. + * corresponding source code.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.debug.sourceFile"</code></dd> * <dt>Possible values:</dt><dd><code>{ "generate", "do not generate" }</code></dd> @@ -256,7 +256,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Preserving Unused Local Variables. * <p>Unless requested to preserve unused local variables (that is, never read), the - * compiler will optimize them out, potentially altering debugging. + * compiler will optimize them out, potentially altering debugging.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.codegen.unusedLocal"</code></dd> * <dt>Possible values:</dt><dd><code>{ "preserve", "optimize out" }</code></dd> @@ -267,11 +267,11 @@ public final class JavaCore extends Plugin { public static final String COMPILER_CODEGEN_UNUSED_LOCAL = PLUGIN_ID + ".compiler.codegen.unusedLocal"; //$NON-NLS-1$ /** * Compiler option ID: Defining Target Java Platform. - * <p>For binary compatibility reason, .class files can be tagged to with certain VM versions and later. + * <p>For binary compatibility reason, .class files can be tagged to with certain VM versions and later.</p> * <p>Note that <code>"1.4"</code> target requires to toggle compliance mode to <code>"1.4"</code>, <code>"1.5"</code> target requires * to toggle compliance mode to <code>"1.5"</code>, <code>"1.6"</code> target requires to toggle compliance mode to <code>"1.6"</code> and * <code>"1.7"</code> target requires to toggle compliance mode to <code>"1.7"</code>. - * <code>"cldc1.1"</code> requires the source version to be <code>"1.3"</code> and the compliance version to be <code>"1.4"</code> or lower. + * <code>"cldc1.1"</code> requires the source version to be <code>"1.3"</code> and the compliance version to be <code>"1.4"</code> or lower.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.codegen.targetPlatform"</code></dd> * <dt>Possible values:</dt><dd><code>{ "1.1", "1.2", "1.3", "1.4", "1.5", "1.6", "1.7", "cldc1.1" }</code></dd> @@ -284,10 +284,10 @@ public final class JavaCore extends Plugin { * Compiler option ID: Inline JSR Bytecode Instruction. * <p>When enabled, the compiler will no longer generate JSR instructions, but rather inline corresponding * subroutine code sequences (mostly corresponding to try finally blocks). The generated code will thus - * get bigger, but will load faster on virtual machines since the verification process is then much simpler. - * <p>This mode is anticipating support for the Java Specification Request 202. + * get bigger, but will load faster on virtual machines since the verification process is then much simpler.</p> + * <p>This mode is anticipating support for the Java Specification Request 202.</p> * <p>Note that JSR inlining is optional only for target platform lesser than 1.5. From 1.5 on, the JSR - * inlining is mandatory (also see related setting {@link #COMPILER_CODEGEN_TARGET_PLATFORM}). + * inlining is mandatory (also see related setting {@link #COMPILER_CODEGEN_TARGET_PLATFORM}).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -301,7 +301,7 @@ public final class JavaCore extends Plugin { * Compiler option ID: Javadoc Comment Support. * <p>When this support is disabled, the compiler will ignore all javadoc problems options settings * and will not report any javadoc problem. It will also not find any reference in javadoc comment and - * DOM AST Javadoc node will be only a flat text instead of having structured tag elements. + * DOM AST Javadoc node will be only a flat text instead of having structured tag elements.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.doc.comment.support"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -329,7 +329,7 @@ public final class JavaCore extends Plugin { * Attempting to override a package visible method from another package * introduces a new method that is unrelated to the original one. When * enabling this option, the compiler will signal such situations as an - * error or a warning. + * error or a warning.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.overridingPackageDefaultMethod"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -342,7 +342,7 @@ public final class JavaCore extends Plugin { * Compiler option ID: Reporting Method With Constructor Name. * <p>Naming a method with a constructor name is generally considered poor * style programming. When enabling this option, the compiler will signal such - * scenarii either as an error or a warning. + * scenario either as an error or a warning.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.methodWithConstructorName"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -354,7 +354,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Deprecation. * <p>When enabled, the compiler will signal use of deprecated API either as an - * error or a warning. + * error or a warning.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.deprecation"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -365,8 +365,8 @@ public final class JavaCore extends Plugin { public static final String COMPILER_PB_DEPRECATION = PLUGIN_ID + ".compiler.problem.deprecation"; //$NON-NLS-1$ /** * Compiler option ID: Reporting Deprecation Inside Deprecated Code. - * <p>When enabled, the compiler will signal use of deprecated API inside deprecated code. - * <p>The severity of the problem is controlled with option {@link #COMPILER_PB_DEPRECATION}. + * <p>When enabled, the compiler will signal use of deprecated API inside deprecated code.</p> + * <p>The severity of the problem is controlled with option {@link #COMPILER_PB_DEPRECATION}.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.deprecationInDeprecatedCode"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -378,8 +378,8 @@ public final class JavaCore extends Plugin { public static final String COMPILER_PB_DEPRECATION_IN_DEPRECATED_CODE = PLUGIN_ID + ".compiler.problem.deprecationInDeprecatedCode"; //$NON-NLS-1$ /** * Compiler option ID: Reporting Deprecation When Overriding Deprecated Method. - * <p>When enabled, the compiler will signal the declaration of a method overriding a deprecated one. - * <p>The severity of the problem is controlled with option {@link #COMPILER_PB_DEPRECATION}. + * <p>When enabled, the compiler will signal the declaration of a method overriding a deprecated one.</p> + * <p>The severity of the problem is controlled with option {@link #COMPILER_PB_DEPRECATION}.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.deprecationWhenOverridingDeprecatedMethod"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -391,14 +391,14 @@ public final class JavaCore extends Plugin { public static final String COMPILER_PB_DEPRECATION_WHEN_OVERRIDING_DEPRECATED_METHOD = "org.eclipse.jdt.core.compiler.problem.deprecationWhenOverridingDeprecatedMethod"; //$NON-NLS-1$ /** * Compiler option ID: Reporting Hidden Catch Block. - * <p>Locally to a try statement, some catch blocks may hide others. For example, + * <p>Locally to a try statement, some catch blocks may hide others. For example,</p> * <pre> * try { throw new java.io.CharConversionException(); * } catch (java.io.CharConversionException e) { * } catch (java.io.IOException e) {}. * </pre> - * When enabling this option, the compiler will issue an error or a warning for hidden - * catch blocks corresponding to checked exceptions. + * <p>When enabling this option, the compiler will issue an error or a warning for hidden + * catch blocks corresponding to checked exceptions.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.hiddenCatchBlock"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -410,7 +410,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Unused Local. * <p>When enabled, the compiler will issue an error or a warning for unused local - * variables (that is, variables never read from). + * variables (that is, variables never read from).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.unusedLocal"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -422,7 +422,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Unused Parameter. * <p>When enabled, the compiler will issue an error or a warning for unused method - * parameters (that is, parameters never read from). + * parameters (that is, parameters never read from).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.unusedParameter"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -433,8 +433,8 @@ public final class JavaCore extends Plugin { public static final String COMPILER_PB_UNUSED_PARAMETER = PLUGIN_ID + ".compiler.problem.unusedParameter"; //$NON-NLS-1$ /** * Compiler option ID: Reporting Unused Parameter if Implementing Abstract Method. - * <p>When enabled, the compiler will signal unused parameters in abstract method implementations. - * <p>The severity of the problem is controlled with option {@link #COMPILER_PB_UNUSED_PARAMETER}. + * <p>When enabled, the compiler will signal unused parameters in abstract method implementations.</p> + * <p>The severity of the problem is controlled with option {@link #COMPILER_PB_UNUSED_PARAMETER}.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.unusedParameterWhenImplementingAbstract"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -446,8 +446,8 @@ public final class JavaCore extends Plugin { public static final String COMPILER_PB_UNUSED_PARAMETER_WHEN_IMPLEMENTING_ABSTRACT = PLUGIN_ID + ".compiler.problem.unusedParameterWhenImplementingAbstract"; //$NON-NLS-1$ /** * Compiler option ID: Reporting Unused Parameter if Overriding Concrete Method. - * <p>When enabled, the compiler will signal unused parameters in methods overriding concrete ones. - * <p>The severity of the problem is controlled with option {@link #COMPILER_PB_UNUSED_PARAMETER}. + * <p>When enabled, the compiler will signal unused parameters in methods overriding concrete ones.</p> + * <p>The severity of the problem is controlled with option {@link #COMPILER_PB_UNUSED_PARAMETER}.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.unusedParameterWhenOverridingConcrete"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -460,10 +460,10 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Consider Reference in Doc Comment for Unused Parameter Check. * <p>When enabled, the compiler will consider doc comment references to parameters (i.e. <code>@param</code> clauses) for the unused - * parameter check. Thus, documented parameters will be considered as mandated as per doc contract. - * <p>The severity of the unused parameter problem is controlled with option {@link #COMPILER_PB_UNUSED_PARAMETER}. + * parameter check. Thus, documented parameters will be considered as mandated as per doc contract.</p> + * <p>The severity of the unused parameter problem is controlled with option {@link #COMPILER_PB_UNUSED_PARAMETER}.</p> * <p>Note: this option has no effect until the doc comment support is enabled according to the - * option {@link #COMPILER_DOC_COMMENT_SUPPORT}. + * option {@link #COMPILER_DOC_COMMENT_SUPPORT}.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.unusedParameterIncludeDocCommentReference"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -476,7 +476,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Unused Import. * <p>When enabled, the compiler will issue an error or a warning for unused import - * reference. + * reference.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.unusedImport"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -490,7 +490,7 @@ public final class JavaCore extends Plugin { * Compiler option ID: Reporting Presence of Type Arguments for a Non-Generic Method Invocation. * <p>When enabled, the compiler will issue an error or a warning whenever type arguments are encountered for a * non-generic method invocation. Note that prior to compliance level is <code>"1.7"</code>, this situation would automatically result - * in an error. From Java7 on, unused type arguments are being tolerated, and optionally warned against. + * in an error. From Java7 on, unused type arguments are being tolerated, and optionally warned against.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.unusedTypeArgumentsForMethodInvocation"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -504,7 +504,7 @@ public final class JavaCore extends Plugin { * Compiler option ID: Reporting Synthetic Access Emulation. * <p>When enabled, the compiler will issue an error or a warning whenever it emulates * access to a non-accessible member of an enclosing type. Such access can have - * performance implications. + * performance implications.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.syntheticAccessEmulation"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -516,7 +516,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Non-Externalized String Literal. * <p>When enabled, the compiler will issue an error or a warning for non externalized - * String literal (that is, not tagged with <code>//$NON-NLS-<n>$</code>). + * String literal (that is, not tagged with <code>//$NON-NLS-<n>$</code>).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.nonExternalizedStringLiteral"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -529,7 +529,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Usage of <code>'assert'</code> Identifier. * <p>When enabled, the compiler will issue an error or a warning whenever <code>'assert'</code> is - * used as an identifier (reserved keyword in 1.4). + * used as an identifier (reserved keyword in 1.4).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.assertIdentifier"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -542,7 +542,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Usage of <code>'enum'</code> Identifier. * <p>When enabled, the compiler will issue an error or a warning whenever <code>'enum'</code> is - * used as an identifier (reserved keyword in 1.5). + * used as an identifier (reserved keyword in 1.5).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.enumIdentifier"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -556,7 +556,7 @@ public final class JavaCore extends Plugin { * Compiler option ID: Reporting Non-Static Reference to a Static Member. * <p>When enabled, the compiler will issue an error or a warning whenever a static field * or method is accessed with an expression receiver. A reference to a static member should - * be qualified with a type name. + * be qualified with a type name.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.staticAccessReceiver"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -570,7 +570,7 @@ public final class JavaCore extends Plugin { * Compiler option ID: Reporting Indirect Reference to a Static Member. * <p>When enabled, the compiler will issue an error or a warning whenever a static field * or method is accessed in an indirect way. A reference to a static member should - * preferably be qualified with its declaring type name. + * preferably be qualified with its declaring type name.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.indirectStaticAccess"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -583,7 +583,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Assignment with no Effect. * <p>When enabled, the compiler will issue an error or a warning whenever an assignment - * has no effect (e.g <code>'x = x'</code>). + * has no effect (e.g <code>'x = x'</code>).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.noEffectAssignment"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -597,7 +597,7 @@ public final class JavaCore extends Plugin { * Compiler option ID: Reporting Interface Method not Compatible with non-Inherited Methods. * <p>When enabled, the compiler will issue an error or a warning whenever an interface * defines a method incompatible with a non-inherited <code>Object</code> method. Until this conflict - * is resolved, such an interface cannot be implemented, For example, + * is resolved, such an interface cannot be implemented. For example,</p> * <pre> * interface I { * int clone(); @@ -615,7 +615,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Unused Private Members. * <p>When enabled, the compiler will issue an error or a warning whenever a private - * method or field is declared but never used within the same unit. + * method or field is declared but never used within the same unit.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.unusedPrivateMember"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -628,7 +628,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Local Variable Declaration Hiding another Variable. * <p>When enabled, the compiler will issue an error or a warning whenever a local variable - * declaration is hiding some field or local variable (either locally, inherited or defined in enclosing type). + * declaration is hiding some field or local variable (either locally, inherited or defined in enclosing type).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.localVariableHiding"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -641,8 +641,8 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Special Parameter Hiding another Field. * <p>When enabled, the compiler will signal cases where a constructor or setter method parameter declaration - * is hiding some field (either locally, inherited or defined in enclosing type). - * <p>The severity of the problem is controlled with option {@link #COMPILER_PB_LOCAL_VARIABLE_HIDING}. + * is hiding some field (either locally, inherited or defined in enclosing type).</p> + * <p>The severity of the problem is controlled with option {@link #COMPILER_PB_LOCAL_VARIABLE_HIDING}.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.specialParameterHidingField"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -655,7 +655,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Field Declaration Hiding another Variable. * <p>When enabled, the compiler will issue an error or a warning whenever a field - * declaration is hiding some field or local variable (either locally, inherited or defined in enclosing type). + * declaration is hiding some field or local variable (either locally, inherited or defined in enclosing type).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.fieldHiding"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -669,7 +669,7 @@ public final class JavaCore extends Plugin { * Compiler option ID: Reporting Type Declaration Hiding another Type. * <p>When enabled, the compiler will issue an error or a warning in situations where a type parameter * declaration is hiding some type, when a nested type is hiding some type parameter, or when - * a nested type is hiding another nested type defined in same unit. + * a nested type is hiding another nested type defined in same unit.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.typeParameterHiding"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -682,7 +682,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Possible Accidental Boolean Assignment. * <p>When enabled, the compiler will issue an error or a warning if a boolean assignment is acting as the condition - * of a control statement (where it probably was meant to be a boolean comparison). + * of a control statement (where it probably was meant to be a boolean comparison).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.possibleAccidentalBooleanAssignment"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -695,7 +695,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Switch Fall-Through Case. * <p>When enabled, the compiler will issue an error or a warning if a case may be - * entered by falling through previous case. Empty cases are allowed. + * entered by falling through previous case. Empty cases are allowed.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.fallthroughCase"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -708,7 +708,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Empty Statements and Unnecessary Semicolons. * <p>When enabled, the compiler will issue an error or a warning if an empty statement or a - * unnecessary semicolon is encountered. + * unnecessary semicolon is encountered.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.emptyStatement"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -733,7 +733,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Unnecessary Type Check. * <p>When enabled, the compiler will issue an error or a warning when a cast or an <code>instanceof</code> operation - * is unnecessary. + * is unnecessary.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.unnecessaryTypeCheck"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -746,7 +746,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Unnecessary Else. * <p>When enabled, the compiler will issue an error or a warning when a statement is unnecessarily - * nested within an <code>else</code> clause (in situation where then clause is not completing normally). + * nested within an <code>else</code> clause (in situation where then clause is not completing normally).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.unnecessaryElse"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -759,7 +759,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Undocumented Empty Block. * <p>When enabled, the compiler will issue an error or a warning when an empty block is detected and it is not - * documented with any comment. + * documented with any comment.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.undocumentedEmptyBlock"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -771,7 +771,7 @@ public final class JavaCore extends Plugin { public static final String COMPILER_PB_UNDOCUMENTED_EMPTY_BLOCK = PLUGIN_ID + ".compiler.problem.undocumentedEmptyBlock"; //$NON-NLS-1$ /** * Compiler option ID: Reporting Finally Blocks Not Completing Normally. - * <p>When enabled, the compiler will issue an error or a warning when a finally block does not complete normally. + * <p>When enabled, the compiler will issue an error or a warning when a finally block does not complete normally.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.finallyBlockNotCompletingNormally"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -786,11 +786,11 @@ public final class JavaCore extends Plugin { * <p>When enabled, the compiler will issue an error or a warning when a * method or a constructor is declaring a checked exception as thrown, * but its body actually raises neither that exception, nor any other - * exception extending it. + * exception extending it.</p> * <p>This diagnostic is further tuned by options * {@link #COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION_INCLUDE_DOC_COMMENT_REFERENCE}, * {@link #COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION_EXEMPT_EXCEPTION_AND_THROWABLE}, - * and {@link #COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION_WHEN_OVERRIDING}. + * and {@link #COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION_WHEN_OVERRIDING}.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownException"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -803,12 +803,12 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Unused Declared Thrown Exception in Overriding Method. * <p>When disabled, the compiler will report unused declared thrown - * exceptions neither on overriding methods nor on implementing methods. + * exceptions neither on overriding methods nor on implementing methods.</p> * <p>The severity of the unused declared thrown exception problem is - * controlled with option {@link #COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION}. + * controlled with option {@link #COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION}.</p> * <p>This diagnostic is further tuned by options * {@link #COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION_INCLUDE_DOC_COMMENT_REFERENCE} and - * {@link #COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION_EXEMPT_EXCEPTION_AND_THROWABLE}. + * {@link #COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION_EXEMPT_EXCEPTION_AND_THROWABLE}.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionWhenOverriding"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -823,13 +823,13 @@ public final class JavaCore extends Plugin { * <p>When enabled, the compiler will consider doc comment references to * exceptions (i.e. <code>@throws</code> clauses) for the unused * declared thrown exception check. Thus, documented exceptions will be - * considered as mandated as per doc contract. - * <p>The severity of the unused declared thrown exception problem is controlled with option {@link #COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION}. + * considered as mandated as per doc contract.</p> + * <p>The severity of the unused declared thrown exception problem is controlled with option {@link #COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION}.</p> * <p>Note: this option has no effect until the doc comment support is enabled according to the - * option {@link #COMPILER_DOC_COMMENT_SUPPORT}. + * option {@link #COMPILER_DOC_COMMENT_SUPPORT}.</p> * <p>This diagnostic is further tuned by options * {@link #COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION_EXEMPT_EXCEPTION_AND_THROWABLE} - * and {@link #COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION_WHEN_OVERRIDING}. + * and {@link #COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION_WHEN_OVERRIDING}.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionIncludeDocCommentReference"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -849,13 +849,13 @@ public final class JavaCore extends Plugin { * error or a warning when a method or a constructor is declaring a * checked exception (including {@link java.lang.Throwable} and * {@link java.lang.Exception}) as thrown, but its body actually raises - * neither that exception, nor any other exception extending it. + * neither that exception, nor any other exception extending it.</p> * <p>The severity of the unused declared thrown exception problem is * controlled with option - * {@link #COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION}. + * {@link #COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION}.</p> * <p>This diagnostic is further tuned by options * {@link #COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION_INCLUDE_DOC_COMMENT_REFERENCE} - * and {@link #COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION_WHEN_OVERRIDING}. + * and {@link #COMPILER_PB_UNUSED_DECLARED_THROWN_EXCEPTION_WHEN_OVERRIDING}.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionExemptExceptionAndThrowable"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -868,7 +868,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Unqualified Access to Field. * <p>When enabled, the compiler will issue an error or a warning when a field is access without any qualification. - * In order to improve code readability, it should be qualified, e.g. <code>'x'</code> should rather be written <code>'this.x'</code>. + * In order to improve code readability, it should be qualified, e.g. <code>'x'</code> should rather be written <code>'this.x'</code>.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.unqualifiedFieldAccess"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -887,7 +887,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Unchecked Type Operation. * <p>When enabled, the compiler will issue an error or a warning whenever an operation involves generic types, and potentially - * invalidates type safety since involving raw types (e.g. invoking <code>#foo(X<String>)</code> with arguments <code>(X)</code>). + * invalidates type safety since involving raw types (e.g. invoking <code>#foo(X<String>)</code> with arguments <code>(X)</code>).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.uncheckedTypeOperation"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -901,7 +901,7 @@ public final class JavaCore extends Plugin { * Compiler option ID: Reporting Raw Type Reference. * <p>When enabled, the compiler will issue an error or a warning when detecting references to raw types. Raw types are * discouraged, and are intended to help interfacing with legacy code. In the future, the language specification may - * reject raw references to generic types. + * reject raw references to generic types.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.rawTypeReference"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -916,7 +916,7 @@ public final class JavaCore extends Plugin { * <p> When enabled, the compiler will issue an error or warning even when it detects a generic type problem * that could not have been avoided by the programmer. As an example, a type may be forced to use raw types * in its method signatures and return types because the methods it overrides from a super type are declared to - * use raw types in the first place. + * use raw types in the first place.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.unavoidableGenericTypeProblems"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -930,7 +930,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting final Bound for Type Parameter. * <p>When enabled, the compiler will issue an error or a warning whenever a generic type parameter is associated with a - * bound corresponding to a final type; since final types cannot be further extended, the parameter is pretty useless. + * bound corresponding to a final type; since final types cannot be further extended, the parameter is pretty useless.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.finalParameterBound"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -943,7 +943,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Missing Declaration of serialVersionUID Field on Serializable Class. * <p>When enabled, the compiler will issue an error or a warning whenever a serializable class is missing a local declaration - * of a <code>serialVersionUID</code> field. This field must be declared as static final and be of type <code>long</code>. + * of a <code>serialVersionUID</code> field. This field must be declared as static final and be of type <code>long</code>.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.missingSerialVersion"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -957,7 +957,7 @@ public final class JavaCore extends Plugin { * Compiler option ID: Reporting Varargs Argument Needing a Cast in Method/Constructor Invocation. * <p>When enabled, the compiler will issue an error or a warning whenever a varargs arguments should be cast * when passed to a method/constructor invocation. (e.g. <code>Class.getMethod(String name, Class ... args )</code> - * invoked with arguments <code>("foo", null)</code>). + * invoked with arguments <code>("foo", null)</code>).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.varargsArgumentNeedCast"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -970,7 +970,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Boxing/Unboxing Conversion. * <p>When enabled, the compiler will issue an error or a warning whenever a boxing or an unboxing - * conversion is performed. + * conversion is performed.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.autoboxing"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -983,7 +983,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Use of Annotation Type as Super Interface. * <p>When enabled, the compiler will issue an error or a warning whenever an annotation type is used - * as a super-interface. Though legal, this is discouraged. + * as a super-interface. Though legal, this is discouraged.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.annotationSuperInterface"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -996,7 +996,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Missing <code>@Override</code> Annotation. * <p>When enabled, the compiler will issue an error or a warning whenever encountering a method - * declaration which overrides a superclass method but has no <code>@Override</code> annotation. + * declaration which overrides a superclass method but has no <code>@Override</code> annotation.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1024,7 +1024,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Missing <code>@Deprecated</code> Annotation. * <p>When enabled, the compiler will issue an error or a warning whenever encountering a declaration - * carrying a <code>@deprecated</code> doc tag but having no corresponding <code>@Deprecated</code> annotation. + * carrying a <code>@deprecated</code> doc tag but having no corresponding <code>@Deprecated</code> annotation.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1037,7 +1037,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Missing HashCode Method. * <p>When enabled, the compiler will issue an error or a warning if a type - * overrides Object.equals(Object) but does not override hashCode(). + * overrides Object.equals(Object) but does not override hashCode().</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.missingHashCodeMethod"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1051,7 +1051,7 @@ public final class JavaCore extends Plugin { * Compiler option ID: Reporting Dead Code. * <p>When enabled, the compiler will issue an error or a warning if some non fatal dead code is detected. For instance, <code>if (false) foo();</code> * is not reported as truly unreachable code by the Java Language Specification. If this diagnostic is enabled, then the invocation of <code>foo()</code> is - * going to be signaled as being dead code. + * going to be signaled as being dead code.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.deadCode"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1063,8 +1063,8 @@ public final class JavaCore extends Plugin { public static final String COMPILER_PB_DEAD_CODE = PLUGIN_ID + ".compiler.problem.deadCode"; //$NON-NLS-1$ /** * Compiler option ID: Reporting Dead Code Inside Trivial If Statement. - * <p>When enabled, the compiler will signal presence of dead code inside trivial IF statement, e.g. <code>if (DEBUG)...</code>.. - * <p>The severity of the problem is controlled with option {@link #COMPILER_PB_DEAD_CODE}. + * <p>When enabled, the compiler will signal presence of dead code inside trivial IF statement, e.g. <code>if (DEBUG)...</code>.</p> + * <p>The severity of the problem is controlled with option {@link #COMPILER_PB_DEAD_CODE}.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.deadCodeInTrivialIfStatement"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -1078,7 +1078,7 @@ public final class JavaCore extends Plugin { * Compiler option ID: Reporting Incomplete Enum Switch. * <p>When enabled, the compiler will issue an error or a warning * regarding each enum constant for which a corresponding case label is lacking. - * Reporting is further controlled by the option {@link #COMPILER_PB_MISSING_ENUM_CASE_DESPITE_DEFAULT}. + * Reporting is further controlled by the option {@link #COMPILER_PB_MISSING_ENUM_CASE_DESPITE_DEFAULT}.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1090,7 +1090,7 @@ public final class JavaCore extends Plugin { public static final String COMPILER_PB_INCOMPLETE_ENUM_SWITCH = PLUGIN_ID + ".compiler.problem.incompleteEnumSwitch"; //$NON-NLS-1$ /** * Compiler option ID: Reporting Missing Enum Case In Switch Despite An Existing Default Case. - * <p>This option further controls the option {@link #COMPILER_PB_INCOMPLETE_ENUM_SWITCH}: + * <p>This option further controls the option {@link #COMPILER_PB_INCOMPLETE_ENUM_SWITCH}:</p> * <ul> * <li>If enabled the compiler will report problems about missing enum constants even if a default case exists * in the same switch statement.</li> @@ -1109,7 +1109,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Missing Default Case In Switch. * <p>When enabled, the compiler will issue an error or a warning - * against each switch statement that lacks a default case. + * against each switch statement that lacks a default case.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.missingDefaultCase"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1129,7 +1129,7 @@ public final class JavaCore extends Plugin { * Compiler option ID: Reporting Unreferenced Label. * <p>When enabled, the compiler will issue an error or a warning when encountering a labeled statement which label * is never explicitly referenced. A label is considered to be referenced if its name explicitly appears behind a break - * or continue statement; for instance the following label would be considered unreferenced: + * or continue statement; for instance the following label would be considered unreferenced:</p> * <code>LABEL: { break; }</code> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.unusedLabel"</code></dd> @@ -1143,7 +1143,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Invalid Javadoc Comment. * <p>This is the generic control for the severity of Javadoc problems. - * When enabled, the compiler will issue an error or a warning for a problem in Javadoc. + * When enabled, the compiler will issue an error or a warning for a problem in Javadoc.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.invalidJavadoc"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1156,9 +1156,9 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Invalid Javadoc Tags. * <p>When enabled, the compiler will signal unbound or unexpected reference tags in Javadoc. - * A <code>@throws</code> tag referencing an undeclared exception would be considered as unexpected. + * A <code>@throws</code> tag referencing an undeclared exception would be considered as unexpected.</p> * <p>Note that this diagnosis can be enabled based on the visibility of the construct associated with the Javadoc; - * also see the setting {@link #COMPILER_PB_INVALID_JAVADOC_TAGS_VISIBILITY}. + * also see the setting {@link #COMPILER_PB_INVALID_JAVADOC_TAGS_VISIBILITY}.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.invalidJavadocTags"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -1170,9 +1170,9 @@ public final class JavaCore extends Plugin { public static final String COMPILER_PB_INVALID_JAVADOC_TAGS = PLUGIN_ID + ".compiler.problem.invalidJavadocTags"; //$NON-NLS-1$ /** * Compiler option ID: Reporting Invalid Javadoc Tags with Deprecated References. - * <p>Specify whether the compiler will report deprecated references used in Javadoc tags. + * <p>Specify whether the compiler will report deprecated references used in Javadoc tags.</p> * <p>Note that this diagnosis can be enabled based on the visibility of the construct associated with the Javadoc; - * also see the setting {@link #COMPILER_PB_INVALID_JAVADOC_TAGS_VISIBILITY}. + * also see the setting {@link #COMPILER_PB_INVALID_JAVADOC_TAGS_VISIBILITY}.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsDeprecatedRef"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -1184,9 +1184,9 @@ public final class JavaCore extends Plugin { public static final String COMPILER_PB_INVALID_JAVADOC_TAGS__DEPRECATED_REF = PLUGIN_ID + ".compiler.problem.invalidJavadocTagsDeprecatedRef"; //$NON-NLS-1$ /** * Compiler option ID: Reporting Invalid Javadoc Tags with Not Visible References. - * <p>Specify whether the compiler will report non-visible references used in Javadoc tags. + * <p>Specify whether the compiler will report non-visible references used in Javadoc tags.</p> * <p>Note that this diagnosis can be enabled based on the visibility of the construct associated with the Javadoc; - * also see the setting {@link #COMPILER_PB_INVALID_JAVADOC_TAGS_VISIBILITY}. + * also see the setting {@link #COMPILER_PB_INVALID_JAVADOC_TAGS_VISIBILITY}.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsNotVisibleRef"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -1198,7 +1198,7 @@ public final class JavaCore extends Plugin { public static final String COMPILER_PB_INVALID_JAVADOC_TAGS__NOT_VISIBLE_REF = PLUGIN_ID + ".compiler.problem.invalidJavadocTagsNotVisibleRef"; //$NON-NLS-1$ /** * Compiler option ID: Visibility Level For Invalid Javadoc Tags. - * <p>Set the minimum visibility level for Javadoc tag problems. Below this level problems will be ignored. + * <p>Set the minimum visibility level for Javadoc tag problems. Below this level problems will be ignored.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility"</code></dd> * <dt>Possible values:</dt><dd><code>{ "public", "protected", "default", "private" }</code></dd> @@ -1210,12 +1210,12 @@ public final class JavaCore extends Plugin { public static final String COMPILER_PB_INVALID_JAVADOC_TAGS_VISIBILITY = PLUGIN_ID + ".compiler.problem.invalidJavadocTagsVisibility"; //$NON-NLS-1$ /** * Compiler option ID: Reporting missing tag description. - * <p>When enabled, the compiler will report a warning or an error for any Javadoc tag missing a required description. - * <p>The severity of the problem is controlled with option {@link #COMPILER_PB_INVALID_JAVADOC}. - * <p>It does not depend on option {@link #COMPILER_PB_INVALID_JAVADOC_TAGS}. + * <p>When enabled, the compiler will report a warning or an error for any Javadoc tag missing a required description.</p> + * <p>The severity of the problem is controlled with option {@link #COMPILER_PB_INVALID_JAVADOC}.</p> + * <p>It does not depend on option {@link #COMPILER_PB_INVALID_JAVADOC_TAGS}.</p> * <p>When this option is valued to {@link #COMPILER_PB_MISSING_JAVADOC_TAG_DESCRIPTION_ALL_STANDARD_TAGS}, * a subset of the standard <a href="http://download.oracle.com/javase/6/docs/technotes/tools/windows/javadoc.html#javadoctags">Javadoc tags</a> - * that have a description, text or label are checked. While this set may grow in the future, note that user-defined tags are not and will not be checked. + * that have a description, text or label are checked. While this set may grow in the future, note that user-defined tags are not and will not be checked.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription"</code></dd> * <dt>Possible values:</dt><dd><code>{ "return_tag", "all_standard_tags", "no_tag" }</code></dd> @@ -1228,9 +1228,9 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Missing Javadoc Tags. * <p>This is the generic control for the severity of Javadoc missing tag problems. - * When enabled, the compiler will issue an error or a warning when tags are missing in Javadoc comments. + * When enabled, the compiler will issue an error or a warning when tags are missing in Javadoc comments.</p> * <p>Note that this diagnosis can be enabled based on the visibility of the construct associated with the Javadoc; - * also see the setting {@link #COMPILER_PB_MISSING_JAVADOC_TAGS_VISIBILITY}. + * also see the setting {@link #COMPILER_PB_MISSING_JAVADOC_TAGS_VISIBILITY}.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.missingJavadocTags"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1242,7 +1242,7 @@ public final class JavaCore extends Plugin { public static final String COMPILER_PB_MISSING_JAVADOC_TAGS = PLUGIN_ID + ".compiler.problem.missingJavadocTags"; //$NON-NLS-1$ /** * Compiler option ID: Visibility Level For Missing Javadoc Tags. - * <p>Set the minimum visibility level for Javadoc missing tag problems. Below this level problems will be ignored. + * <p>Set the minimum visibility level for Javadoc missing tag problems. Below this level problems will be ignored.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility"</code></dd> * <dt>Possible values:</dt><dd><code>{ "public", "protected", "default", "private" }</code></dd> @@ -1254,7 +1254,7 @@ public final class JavaCore extends Plugin { public static final String COMPILER_PB_MISSING_JAVADOC_TAGS_VISIBILITY = PLUGIN_ID + ".compiler.problem.missingJavadocTagsVisibility"; //$NON-NLS-1$ /** * Compiler option ID: Reporting Missing Javadoc Tags on Overriding Methods. - * <p>Specify whether the compiler will verify overriding methods in order to report Javadoc missing tag problems. + * <p>Specify whether the compiler will verify overriding methods in order to report Javadoc missing tag problems.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -1282,9 +1282,9 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Missing Javadoc Comments. * <p>This is the generic control for the severity of missing Javadoc comment problems. - * When enabled, the compiler will issue an error or a warning when Javadoc comments are missing. + * When enabled, the compiler will issue an error or a warning when Javadoc comments are missing.</p> * <p>Note that this diagnosis can be enabled based on the visibility of the construct associated with the expected Javadoc; - * also see the setting {@link #COMPILER_PB_MISSING_JAVADOC_COMMENTS_VISIBILITY}. + * also see the setting {@link #COMPILER_PB_MISSING_JAVADOC_COMMENTS_VISIBILITY}.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.missingJavadocComments"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1296,7 +1296,7 @@ public final class JavaCore extends Plugin { public static final String COMPILER_PB_MISSING_JAVADOC_COMMENTS = PLUGIN_ID + ".compiler.problem.missingJavadocComments"; //$NON-NLS-1$ /** * Compiler option ID: Visibility Level For Missing Javadoc Comments. - * <p>Set the minimum visibility level for missing Javadoc problems. Below this level problems will be ignored. + * <p>Set the minimum visibility level for missing Javadoc problems. Below this level problems will be ignored.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility"</code></dd> * <dt>Possible values:</dt><dd><code>{ "public", "protected", "default", "private" }</code></dd> @@ -1308,7 +1308,7 @@ public final class JavaCore extends Plugin { public static final String COMPILER_PB_MISSING_JAVADOC_COMMENTS_VISIBILITY = PLUGIN_ID + ".compiler.problem.missingJavadocCommentsVisibility"; //$NON-NLS-1$ /** * Compiler option ID: Reporting Missing Javadoc Comments on Overriding Methods. - * <p>Specify whether the compiler will verify overriding methods in order to report missing Javadoc comment problems. + * <p>Specify whether the compiler will verify overriding methods in order to report missing Javadoc comment problems.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -1321,7 +1321,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Usage of <code>char[]</code> Expressions in String Concatenations. * <p>When enabled, the compiler will issue an error or a warning whenever a <code>char[]</code> expression - * is used in String concatenations (for example, <code>"hello" + new char[]{'w','o','r','l','d'}</code>). + * is used in String concatenations (for example, <code>"hello" + new char[]{'w','o','r','l','d'}</code>).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.noImplicitStringConversion"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1333,7 +1333,7 @@ public final class JavaCore extends Plugin { public static final String COMPILER_PB_CHAR_ARRAY_IN_STRING_CONCATENATION = PLUGIN_ID + ".compiler.problem.noImplicitStringConversion"; //$NON-NLS-1$ /** * Compiler option ID: Maximum Number of Problems Reported per Compilation Unit. - * <p>Specify the maximum number of problems reported on each compilation unit. + * <p>Specify the maximum number of problems reported on each compilation unit.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.maxProblemPerUnit"</code></dd> * <dt>Possible values:</dt><dd><code>"<n>"</code> where <code><n></code> is zero or a positive integer (if zero then all problems are reported).</dd> @@ -1362,7 +1362,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Parameter Assignment. * <p>When enabled, the compiler will issue an error or a warning if a parameter is - * assigned to. + * assigned to.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.parameterAssignment"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1375,7 +1375,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting a method that qualifies as static, but not declared static. * <p>When enabled, the compiler will issue an error or a warning if a method has - * not been declared as <code>static</code>, even though it qualifies as one. + * not been declared as <code>static</code>, even though it qualifies as one.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.reportMethodCanBeStatic"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1389,7 +1389,7 @@ public final class JavaCore extends Plugin { * Compiler option ID: Reporting a method that may qualify as static, but not declared static. * <p>When enabled, the compiler will issue an error or a warning if a method has * not been declared as <code>static</code>, even though it may qualify as one, - * when another method doesn't override it. + * when another method doesn't override it.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.reportMethodCanBePotentiallyStatic"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1404,7 +1404,7 @@ public final class JavaCore extends Plugin { * <p>When enabled, the compiler will issue an error or a warning if * a local variable holds a value of type <code>java.lang.AutoCloseable</code> (compliance>=1.7) * or a value of type <code>java.io.Closeable</code> (compliance<=1.6) and if - * flow analysis shows that the method <code>close()</code> is not invoked locally on that value. + * flow analysis shows that the method <code>close()</code> is not invoked locally on that value.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.reportUnclosedCloseable"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1420,7 +1420,7 @@ public final class JavaCore extends Plugin { * a local variable holds a value of type <code>java.lang.AutoCloseable</code> (compliance>=1.7) * or a value of type <code>java.io.Closeable</code> (compliance<=1.6) and if * flow analysis shows that the method <code>close()</code> is - * not invoked locally on that value for all execution paths. + * not invoked locally on that value for all execution paths.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.reportPotentiallyUnclosedCloseable"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1435,7 +1435,7 @@ public final class JavaCore extends Plugin { * <p>When enabled, the compiler will issue an error or a warning if a local variable * holds a value of type <code>java.lang.AutoCloseable</code>, and if the method * <code>close()</code> is explicitly invoked on that resource, but the resource is - * not managed by a try-with-resources block. + * not managed by a try-with-resources block.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.reportPotentiallyUnclosedCloseable"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1559,7 +1559,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Violations of Null Specifications. * <p>Depending on this option, the compiler will issue either an error or a warning - * whenever one of the following situations is detected: + * whenever one of the following situations is detected:</p> * <ol> * <li>A method declared with a nonnull annotation returns a * <em>nullable</em> expression.</li> @@ -1579,7 +1579,6 @@ public final class JavaCore extends Plugin { * In the above an expression is considered as <em>nullable</em> if * either it is statically known to evaluate to the value <code>null</code>, or if it is * declared with a nullable annotation. - * </p> * <p>The compiler options {@link #COMPILER_NONNULL_ANNOTATION_NAME} and * {@link #COMPILER_NULLABLE_ANNOTATION_NAME} control which annotations the compiler * shall interpret as nonnull or nullable annotations, respectively. @@ -1597,7 +1596,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting conflicts between declared null annotation and inferred null value * <p>When enabled, the compiler will issue an error or a warning whenever one of the - * following situations is detected: + * following situations is detected:</p> * <ol> * <li>A method declared with a nonnull annotation returns an expression that is * statically known to evaluate to a null value on some flow.</li> @@ -1607,7 +1606,6 @@ public final class JavaCore extends Plugin { * <li>An expression that is statically known to evaluate to a null value on some flow * is assigned to a local variable that is declared with a nonnull annotation.</li> * </ol> - * </p> * <p>The compiler options {@link #COMPILER_NONNULL_ANNOTATION_NAME} and * {@link #COMPILER_NULLABLE_ANNOTATION_NAME} control which annotations the compiler * shall interpret as nonnull or nullable annotations, respectively. @@ -1625,7 +1623,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting unchecked conversion from a type with unknown nullness to a null annotated type * <p>When enabled, the compiler will issue an error or a warning whenever one of the - * following situations is detected: + * following situations is detected:</p> * <ol> * <li>A method declared with a nonnull annotation returns an expression for which * insufficient nullness information is available for statically proving that no @@ -1638,9 +1636,8 @@ public final class JavaCore extends Plugin { * statically proving that it will never evaluate to a null value at runtime * is assigned to a local variable that is declared with a nonnull annotation.</li> * </ol> - * Unchecked null conversion is usually a consequence of using other unannotated - * variables or methods. - * </p> + * <p>Unchecked null conversion is usually a consequence of using other unannotated + * variables or methods.</p> * <p>The compiler options {@link #COMPILER_NONNULL_ANNOTATION_NAME} and * {@link #COMPILER_NULLABLE_ANNOTATION_NAME} control which annotations the compiler * shall interpret as nonnull or nullable annotations, respectively. @@ -1677,14 +1674,14 @@ public final class JavaCore extends Plugin { * Compiler option ID: Setting Source Compatibility Mode. * <p>Specify whether which source level compatibility is used. From 1.4 on, <code>'assert'</code> is a keyword * reserved for assertion support. Also note, than when toggling to 1.4 mode, the target VM - * level should be set to <code>"1.4"</code> and the compliance mode should be <code>"1.4"</code>. + * level should be set to <code>"1.4"</code> and the compliance mode should be <code>"1.4"</code>.</p> * <p>Source level 1.5 is necessary to enable generics, autoboxing, covariance, annotations, enumerations * enhanced for loop, static imports and varargs. Once toggled, the target VM level should be set to <code>"1.5"</code> - * and the compliance mode should be <code>"1.5"</code>. + * and the compliance mode should be <code>"1.5"</code>.</p> * <p>Source level 1.6 is necessary to enable the computation of stack map tables. Once toggled, the target - * VM level should be set to <code>"1.6"</code> and the compliance mode should be <code>"1.6"</code>. + * VM level should be set to <code>"1.6"</code> and the compliance mode should be <code>"1.6"</code>.</p> * <p>Once the source level 1.7 is toggled, the target VM level should be set to <code>"1.7"</code> and the compliance mode - * should be <code>"1.7"</code>. + * should be <code>"1.7"</code>.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.source"</code></dd> * <dt>Possible values:</dt><dd><code>{ "1.3", "1.4", "1.5", "1.6", "1.7" }</code></dd> @@ -1697,7 +1694,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Setting Compliance Level. * <p>Select the compliance level for the compiler. In <code>"1.3"</code> mode, source and target settings - * should not go beyond <code>"1.3"</code> level. + * should not go beyond <code>"1.3"</code> level.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.compliance"</code></dd> * <dt>Possible values:</dt><dd><code>{ "1.3", "1.4", "1.5", "1.6", "1.7" }</code></dd> @@ -1727,7 +1724,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Defining the Automatic Task Tags. * <p>When the tag list is not empty, the compiler will issue a task marker whenever it encounters - * one of the corresponding tags inside any comment in Java source code. + * one of the corresponding tags inside any comment in Java source code.</p> * <p>Generated task messages will start with the tag, and range until the next line separator, * comment ending, or tag.</p> * <p>When a given line of code bears multiple tags, each tag will be reported separately. @@ -1752,7 +1749,7 @@ public final class JavaCore extends Plugin { public static final String COMPILER_TASK_TAGS = PLUGIN_ID + ".compiler.taskTags"; //$NON-NLS-1$ /** * Compiler option ID: Determining whether task tags are case-sensitive. - * <p>When enabled, task tags are considered in a case-sensitive way. + * <p>When enabled, task tags are considered in a case-sensitive way.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.taskCaseSensitive"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -1765,7 +1762,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Forbidden Reference to Type with Restricted Access. * <p>When enabled, the compiler will issue an error or a warning when referring to a type that is non accessible, as defined according - * to the access rule specifications. + * to the access rule specifications.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.forbiddenReference"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1778,7 +1775,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Discouraged Reference to Type with Restricted Access. * <p>When enabled, the compiler will issue an error or a warning when referring to a type with discouraged access, as defined according - * to the access rule specifications. + * to the access rule specifications.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.discouragedReference"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1790,8 +1787,8 @@ public final class JavaCore extends Plugin { public static final String COMPILER_PB_DISCOURAGED_REFERENCE = PLUGIN_ID + ".compiler.problem.discouragedReference"; //$NON-NLS-1$ /** * Compiler option ID: Determining Effect of <code>@SuppressWarnings</code>. - * <p>When enabled, the <code>@SuppressWarnings</code> annotation can be used to suppress some compiler warnings. - * <p>When disabled, all <code>@SupressWarnings</code> annotations are ignored; i.e., warnings are reported. + * <p>When enabled, the <code>@SuppressWarnings</code> annotation can be used to suppress some compiler warnings.</p> + * <p>When disabled, all <code>@SupressWarnings</code> annotations are ignored; i.e., warnings are reported.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.suppressWarnings"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -1820,8 +1817,8 @@ public final class JavaCore extends Plugin { * Compiler option ID: Further Determining the Effect of <code>@SuppressWarnings</code> if also * {@link #COMPILER_PB_SUPPRESS_WARNINGS} is enabled. * <p>When enabled, the <code>@SuppressWarnings</code> annotation can additionally be used to suppress - * optional compiler diagnostics that have been configured as {@link #ERROR}. - * <p>When disabled, all <code>@SuppressWarnings</code> annotations only affects warnings. + * optional compiler diagnostics that have been configured as {@link #ERROR}.</p> + * <p>When disabled, all <code>@SuppressWarnings</code> annotations only affects warnings.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.suppressOptionalErrors"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -1834,7 +1831,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Unhandled Warning Token for <code>@SuppressWarnings</code>. * <p>When enabled, the compiler will issue an error or a warning when encountering a token - * it cannot handle inside a <code>@SuppressWarnings</code> annotation. + * it cannot handle inside a <code>@SuppressWarnings</code> annotation.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.unhandledWarningToken"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1849,7 +1846,7 @@ public final class JavaCore extends Plugin { * <p>When enabled, the compiler will issue an error or a warning when encountering <code>@SuppressWarnings</code> annotation * for which no corresponding warning got detected in the code. This diagnostic is provided to help developers to get * rid of transient <code>@SuppressWarnings</code> no longer needed. Note that <code>@SuppressWarnings("all")</code> is still - * silencing the warning for unnecessary <code>@SuppressWarnings</code>, as it is the master switch to silence ALL warnings. + * silencing the warning for unnecessary <code>@SuppressWarnings</code>, as it is the master switch to silence ALL warnings.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.unusedWarningToken"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1911,7 +1908,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Overriding method that doesn't call the super method invocation. * <p>When enabled, the compiler will issue an error or a warning if a method is overriding a method without calling - * the super invocation. + * the super invocation.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.overridingMethodWithoutSuperInvocation"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1925,7 +1922,7 @@ public final class JavaCore extends Plugin { * Compiler option ID: Reporting Redundant Superinterface. * <p>When enabled, the compiler will issue an error or a warning if a type * explicitly implements an interface that is already implemented by any - * of its supertypes. + * of its supertypes.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.redundantSuperinterface"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1938,7 +1935,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Comparison of Identical Expressions. * <p>When enabled, the compiler will issue an error or a warning if a comparison - * is involving identical operands (e.g <code>'x == x'</code>). + * is involving identical operands (e.g <code>'x == x'</code>).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.comparingIdentical"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1951,7 +1948,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Missing Synchronized Modifier On Inherited Method. * <p>When enabled, the compiler will issue an error or a warning if a method - * overrides a synchronized method without having a synchronized modifier. + * overrides a synchronized method without having a synchronized modifier.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.missingSynchronizedOnInheritedMethod"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1964,7 +1961,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting Allocation of an Unused Object. * <p>When enabled, the compiler will issue an error or a warning if an object is allocated but never used, - * neither by holding a reference nor by invoking one of the object's methods. + * neither by holding a reference nor by invoking one of the object's methods.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.unusedObjectAllocation"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -1977,7 +1974,7 @@ public final class JavaCore extends Plugin { /** * Compiler option ID: Reporting redundant specification of type arguments in class instance creation expressions. * <p>When enabled, the compiler will issue an error or a warning if type arguments are used in a class instance creation, - * when the '<>' operator can be used instead. + * when the '<>' operator can be used instead.</p> * <p>This option only has an effect if the compiler compliance is 1.7 or greater.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.compiler.problem.redundantSpecificationOfTypeArguments"</code></dd> @@ -1992,7 +1989,7 @@ public final class JavaCore extends Plugin { * Core option ID: Computing Project Build Order. * <p>Indicate whether JavaCore should enforce the project build order to be based on * the classpath prerequisite chain. When requesting to compute, this takes over - * the platform default order (based on project references). + * the platform default order (based on project references).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.computeJavaBuildOrder"</code></dd> * <dt>Possible values:</dt><dd><code>{ "compute", "ignore" }</code></dd> @@ -2003,7 +2000,7 @@ public final class JavaCore extends Plugin { public static final String CORE_JAVA_BUILD_ORDER = PLUGIN_ID + ".computeJavaBuildOrder"; //$NON-NLS-1$ /** * Core option ID: Specifying Filters for Resource Copying Control. - * <p>Allow to specify some filters to control the resource copy process. + * <p>Allow to specify some filters to control the resource copy process.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.builder.resourceCopyExclusionFilter"</code></dd> * <dt>Possible values:</dt><dd><code>{ "<name>[,<name>]* }</code> where <code><name></code> is a file name pattern (* and ? wild-cards allowed) @@ -2017,7 +2014,7 @@ public final class JavaCore extends Plugin { /** * Core option ID: Reporting Duplicate Resources. * <p>Indicate the severity of the problem reported when more than one occurrence - * of a resource is to be copied into the output location. + * of a resource is to be copied into the output location.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.builder.duplicateResourceTask"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning" }</code></dd> @@ -2030,7 +2027,7 @@ public final class JavaCore extends Plugin { /** * Core option ID: Cleaning Output Folder(s). * <p>Indicate whether the JavaBuilder is allowed to clean the output folders - * when performing full build operations. + * when performing full build operations.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.builder.cleanOutputFolder"</code></dd> * <dt>Possible values:</dt><dd><code>{ "clean", "ignore" }</code></dd> @@ -2046,7 +2043,7 @@ public final class JavaCore extends Plugin { * in the output folders while performing incremental build operations. If changes * are detected to managed .class files, then a full build is performed, otherwise * the changes are left as is. Tools further altering generated .class files, like optimizers, - * should ensure this option remains set in its default state of ignore. + * should ensure this option remains set in its default state of ignore.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.builder.recreateModifiedClassFileInOutputFolder"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "ignore" }</code></dd> @@ -2059,7 +2056,7 @@ public final class JavaCore extends Plugin { /** * Core option ID: Reporting Incomplete Classpath. * <p>Indicate the severity of the problem reported when an entry on the classpath does not exist, - * is not legite or is not visible (for example, a referenced project is closed). + * is not legitimate or is not visible (for example, a referenced project is closed).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.incompleteClasspath"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning"}</code></dd> @@ -2071,7 +2068,7 @@ public final class JavaCore extends Plugin { public static final String CORE_INCOMPLETE_CLASSPATH = PLUGIN_ID + ".incompleteClasspath"; //$NON-NLS-1$ /** * Core option ID: Reporting Classpath Cycle. - * <p>Indicate the severity of the problem reported when a project is involved in a cycle. + * <p>Indicate the severity of the problem reported when a project is involved in a cycle.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.circularClasspath"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning" }</code></dd> @@ -2084,7 +2081,7 @@ public final class JavaCore extends Plugin { /** * Core option ID: Reporting Incompatible JDK Level for Required Binaries. * <p>Indicate the severity of the problem reported when a project prerequisites another project - * or library with an incompatible target JDK level (e.g. project targeting 1.1 vm, but compiled against 1.4 libraries). + * or library with an incompatible target JDK level (e.g. project targeting 1.1 vm, but compiled against 1.4 libraries).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.incompatibleJDKLevel"</code></dd> * <dt>Possible values:</dt><dd><code>{ "error", "warning", "ignore" }</code></dd> @@ -2096,7 +2093,7 @@ public final class JavaCore extends Plugin { public static final String CORE_INCOMPATIBLE_JDK_LEVEL = PLUGIN_ID + ".incompatibleJDKLevel"; //$NON-NLS-1$ /** * Core option ID: Abort if Invalid Classpath. - * <p>Allow to toggle the builder to abort if the classpath is invalid. + * <p>Allow to toggle the builder to abort if the classpath is invalid.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.builder.invalidClasspath"</code></dd> * <dt>Possible values:</dt><dd><code>{ "abort", "ignore" }</code></dd> @@ -2109,8 +2106,8 @@ public final class JavaCore extends Plugin { /** * Core option ID: Default Source Encoding Format. * <p>Get the default encoding format of source files. This value is - * immutable and preset to the result of <code>ResourcesPlugin.getEncoding()</code>. - * <p>It is offered as a convenience shortcut only. + * immutable and preset to the result of <code>ResourcesPlugin.getEncoding()</code>.</p> + * <p>It is offered as a convenience shortcut only.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.encoding"</code></dd> * <dt>value:</dt><dd><code><immutable, platform default value></code></dd> @@ -2122,7 +2119,7 @@ public final class JavaCore extends Plugin { /** * Core option ID: Enabling Usage of Classpath Exclusion Patterns. * <p>When disabled, no entry on a project classpath can be associated with - * an exclusion pattern. + * an exclusion pattern.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.classpath.exclusionPatterns"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -2135,7 +2132,7 @@ public final class JavaCore extends Plugin { /** * Core option ID: Enabling Usage of Classpath Multiple Output Locations. * <p>When disabled, no entry on a project classpath can be associated with - * a specific output location, preventing thus usage of multiple output locations. + * a specific output location, preventing thus usage of multiple output locations.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.classpath.multipleOutputLocations"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -2148,7 +2145,7 @@ public final class JavaCore extends Plugin { /** * Core option ID: Reporting an output location overlapping another source location. * <p> Indicate the severity of the problem reported when a source entry's output location overlaps another - * source entry. </p> + * source entry.</p> * * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.classpath.outputOverlappingAnotherSource"</code></dd> @@ -2160,8 +2157,8 @@ public final class JavaCore extends Plugin { public static final String CORE_OUTPUT_LOCATION_OVERLAPPING_ANOTHER_SOURCE = PLUGIN_ID + ".classpath.outputOverlappingAnotherSource"; //$NON-NLS-1$ /** * Core option ID: Set the timeout value for retrieving the method's parameter names from javadoc. - * <p>Timeout in milliseconds to retrieve the method's parameter names from javadoc. - * <p>If the value is <code>0</code>, the parameter names are not fetched and the raw names are returned. + * <p>Timeout in milliseconds to retrieve the method's parameter names from javadoc.</p> + * <p>If the value is <code>0</code>, the parameter names are not fetched and the raw names are returned.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.timeoutForParameterNameFromAttachedJavadoc"</code></dd> * <dt>Possible values:</dt><dd><code>"<n>"</code>, where <code>n</code> is an integer greater than or equal to <code>0</code></dd> @@ -2243,7 +2240,7 @@ public final class JavaCore extends Plugin { /** * Code assist option ID: Activate Visibility Sensitive Completion. * <p>When active, completion doesn't show that you can not see - * (for example, you can not see private methods of a super class). + * (for example, you can not see private methods of a super class).</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.codeComplete.visibilityCheck"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -2255,7 +2252,7 @@ public final class JavaCore extends Plugin { public static final String CODEASSIST_VISIBILITY_CHECK = PLUGIN_ID + ".codeComplete.visibilityCheck"; //$NON-NLS-1$ /** * Code assist option ID: Activate Deprecation Sensitive Completion. - * <p>When enabled, completion doesn't propose deprecated members and types. + * <p>When enabled, completion doesn't propose deprecated members and types.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.codeComplete.deprecationCheck"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -2268,7 +2265,7 @@ public final class JavaCore extends Plugin { /** * Code assist option ID: Activate Camel Case Sensitive Completion. * <p>When enabled, completion shows proposals whose name match the CamelCase - * pattern. + * pattern.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.codeComplete.camelCaseMatch"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -2281,7 +2278,7 @@ public final class JavaCore extends Plugin { /** * Code assist option ID: Automatic Qualification of Implicit Members. * <p>When active, completion automatically qualifies completion on implicit - * field references and message expressions. + * field references and message expressions.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.codeComplete.forceImplicitQualification"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -2294,7 +2291,7 @@ public final class JavaCore extends Plugin { /** * Code assist option ID: Define the Prefixes for Field Name. * <p>When the prefixes is non empty, completion for field name will begin with - * one of the proposed prefixes. + * one of the proposed prefixes.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.codeComplete.fieldPrefixes"</code></dd> * <dt>Possible values:</dt><dd><code>{ "<prefix>[,<prefix>]*" }</code> where <code><prefix></code> is a String without any wild-card</dd> @@ -2307,7 +2304,7 @@ public final class JavaCore extends Plugin { /** * Code assist option ID: Define the Prefixes for Static Field Name. * <p>When the prefixes is non empty, completion for static field name will begin with - * one of the proposed prefixes. + * one of the proposed prefixes.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.codeComplete.staticFieldPrefixes"</code></dd> * <dt>Possible values:</dt><dd><code>{ "<prefix>[,<prefix>]*" }</code> where <code><prefix></code> is a String without any wild-card</dd> @@ -2320,7 +2317,7 @@ public final class JavaCore extends Plugin { /** * Code assist option ID: Define the Prefixes for Static Final Field Name. * <p>When the prefixes is non empty, completion for static final field name will begin with - * one of the proposed prefixes. + * one of the proposed prefixes.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.codeComplete.staticFinalFieldPrefixes"</code></dd> * <dt>Possible values:</dt><dd><code>{ "<prefix>[,<prefix>]*" }</code> where <code><prefix></code> is a String without any wild-card</dd> @@ -2333,7 +2330,7 @@ public final class JavaCore extends Plugin { /** * Code assist option ID: Define the Prefixes for Local Variable Name. * <p>When the prefixes is non empty, completion for local variable name will begin with - * one of the proposed prefixes. + * one of the proposed prefixes.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.codeComplete.localPrefixes"</code></dd> * <dt>Possible values:</dt><dd><code>{ "<prefix>[,<prefix>]*" }</code> where <code><prefix></code> is a String without any wild-card</dd> @@ -2346,7 +2343,7 @@ public final class JavaCore extends Plugin { /** * Code assist option ID: Define the Prefixes for Argument Name. * <p>When the prefixes is non empty, completion for argument name will begin with - * one of the proposed prefixes. + * one of the proposed prefixes.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.codeComplete.argumentPrefixes"</code></dd> * <dt>Possible values:</dt><dd><code>{ "<prefix>[,<prefix>]*" }</code> where <code><prefix></code> is a String without any wild-card</dd> @@ -2359,7 +2356,7 @@ public final class JavaCore extends Plugin { /** * Code assist option ID: Define the Suffixes for Field Name. * <p>When the suffixes is non empty, completion for field name will end with - * one of the proposed suffixes. + * one of the proposed suffixes.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.codeComplete.fieldSuffixes"</code></dd> * <dt>Possible values:</dt><dd><code>{ "<suffix>[,<suffix>]*" }</code> where <code><suffix></code> is a String without any wild-card</dd> @@ -2372,7 +2369,7 @@ public final class JavaCore extends Plugin { /** * Code assist option ID: Define the Suffixes for Static Field Name. * <p>When the suffixes is non empty, completion for static field name will end with - * one of the proposed suffixes. + * one of the proposed suffixes.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.codeComplete.staticFieldSuffixes"</code></dd> * <dt>Possible values:</dt><dd><code>{ "<suffix>[,<suffix>]*" }</code>< where <code><suffix></code> is a String without any wild-card</dd> @@ -2385,7 +2382,7 @@ public final class JavaCore extends Plugin { /** * Code assist option ID: Define the Suffixes for Static Final Field Name. * <p>When the suffixes is non empty, completion for static final field name will end with - * one of the proposed suffixes. + * one of the proposed suffixes.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.codeComplete.staticFinalFieldSuffixes"</code></dd> * <dt>Possible values:</dt><dd><code>{ "<suffix>[,<suffix>]*" }</code>< where <code><suffix></code> is a String without any wild-card</dd> @@ -2398,7 +2395,7 @@ public final class JavaCore extends Plugin { /** * Code assist option ID: Define the Suffixes for Local Variable Name. * <p>When the suffixes is non empty, completion for local variable name will end with - * one of the proposed suffixes. + * one of the proposed suffixes.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.codeComplete.localSuffixes"</code></dd> * <dt>Possible values:</dt><dd><code>{ "<suffix>[,<suffix>]*" }</code> where <code><suffix></code> is a String without any wild-card</dd> @@ -2411,7 +2408,7 @@ public final class JavaCore extends Plugin { /** * Code assist option ID: Define the Suffixes for Argument Name. * <p>When the suffixes is non empty, completion for argument name will end with - * one of the proposed suffixes. + * one of the proposed suffixes.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.codeComplete.argumentSuffixes"</code></dd> * <dt>Possible values:</dt><dd><code>{ "<suffix>[,<suffix>]*" }</code> where <code><suffix></code> is a String without any wild-card</dd> @@ -2424,7 +2421,7 @@ public final class JavaCore extends Plugin { /** * Code assist option ID: Activate Forbidden Reference Sensitive Completion. * <p>When enabled, completion doesn't propose elements which match a - * forbidden reference rule. + * forbidden reference rule.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.codeComplete.forbiddenReferenceCheck"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -2437,7 +2434,7 @@ public final class JavaCore extends Plugin { /** * Code assist option ID: Activate Discouraged Reference Sensitive Completion. * <p>When enabled, completion doesn't propose elements which match a - * discouraged reference rule. + * discouraged reference rule.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.codeComplete.discouragedReferenceCheck"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -2450,7 +2447,7 @@ public final class JavaCore extends Plugin { /** * Code assist option ID: Activate Suggestion of Static Import. * <p>When enabled, completion proposals can contain static import - * pattern. + * pattern.</p> * <dl> * <dt>Option id:</dt><dd><code>"org.eclipse.jdt.core.codeComplete.suggestStaticImports"</code></dd> * <dt>Possible values:</dt><dd><code>{ "enabled", "disabled" }</code></dd> @@ -2739,11 +2736,14 @@ public final class JavaCore extends Plugin { /** * Adds the given listener for changes to Java elements. * Has no effect if an identical listener is already registered. - * + * <p> * This listener will only be notified during the POST_CHANGE resource change notification * and any reconcile operation (POST_RECONCILE). + * </p> + * <p> * For finer control of the notification, use <code>addElementChangedListener(IElementChangedListener,int)</code>, * which allows to specify a different eventMask. + * </p> * * @param listener the listener * @see ElementChangedEvent @@ -2854,6 +2854,7 @@ public final class JavaCore extends Plugin { * </p> * <p> * Supported event types are: + * </p> * <ul> * <li>{@link IResourceChangeEvent#PRE_BUILD}</li> * <li>{@link IResourceChangeEvent#POST_BUILD}</li> @@ -2862,7 +2863,6 @@ public final class JavaCore extends Plugin { * <li>{@link IResourceChangeEvent#PRE_CLOSE}</li> * </ul> * This list may increase in the future. - * </p> * * @param listener the listener * @param eventMask the bit-wise OR of all event types of interest to the @@ -2933,7 +2933,8 @@ public final class JavaCore extends Plugin { * <code>null</code> if unable to associate the given file * with a Java element. * - * <p>The file must be one of:<ul> + * <p>The file must be one of:</p> + * <ul> * <li>a file with one of the {@link JavaCore#getJavaLikeExtensions() * Java-like extensions} - the element returned is the corresponding <code>ICompilationUnit</code></li> * <li>a <code>.class</code> file - the element returned is the corresponding <code>IClassFile</code></li> @@ -2942,6 +2943,7 @@ public final class JavaCore extends Plugin { * <p> * Creating a Java element has the side effect of creating and opening all of the * element's parents if they are not yet open. + * </p> * * @param file the given file * @return the Java element corresponding to the given file, or @@ -2956,9 +2958,11 @@ public final class JavaCore extends Plugin { * <code>null</code> if unable to associate the given folder with a Java element. * <p> * Note that a package fragment root is returned rather than a default package. + * </p> * <p> * Creating a Java element has the side effect of creating and opening all of the * element's parents if they are not yet open. + * </p> * * @param folder the given folder * @return the package fragment or package fragment root corresponding to the given folder, or @@ -2972,8 +2976,10 @@ public final class JavaCore extends Plugin { * <p> * Creating a Java Project has the side effect of creating and opening all of the * project's parents if they are not yet open. + * </p> * <p> * Note that no check is done at this time on the existence or the java nature of this project. + * </p> * * @param project the given project * @return the Java project corresponding to the given project, null if the given project is null @@ -2990,7 +2996,9 @@ public final class JavaCore extends Plugin { * <code>null</code> if unable to associate the given resource * with a Java element. * <p> - * The resource must be one of:<ul> + * The resource must be one of: + * </p> + * <ul> * <li>a project - the element returned is the corresponding <code>IJavaProject</code></li> * <li>a file with one of the {@link JavaCore#getJavaLikeExtensions() * Java-like extensions} - the element returned is the corresponding <code>ICompilationUnit</code></li> @@ -3003,6 +3011,7 @@ public final class JavaCore extends Plugin { * <p> * Creating a Java element has the side effect of creating and opening all of the * element's parents if they are not yet open. + * </p> * * @param resource the given resource * @return the Java element corresponding to the given resource, or @@ -3016,8 +3025,10 @@ public final class JavaCore extends Plugin { * Returns the Java element corresponding to the given file, its project being the given * project. Returns <code>null</code> if unable to associate the given resource * with a Java element. - *<p> - * The resource must be one of:<ul> + * <p> + * The resource must be one of: + * </p> + * <ul> * <li>a project - the element returned is the corresponding <code>IJavaProject</code></li> * <li>a file with one of the {@link JavaCore#getJavaLikeExtensions() * Java-like extensions} - the element returned is the corresponding <code>ICompilationUnit</code></li> @@ -3030,6 +3041,7 @@ public final class JavaCore extends Plugin { * <p> * Creating a Java element has the side effect of creating and opening all of the * element's parents if they are not yet open. + * </p> * * @param resource the given resource * @return the Java element corresponding to the given file, or @@ -3100,16 +3112,19 @@ public final class JavaCore extends Plugin { * onto this project (using <code>setClasspathContainer</code>, then a * <code>ClasspathContainerInitializer</code> will be activated if any was registered for this container * ID onto the extension point "org.eclipse.jdt.core.classpathContainerInitializer". + * </p> * <p> * There is no assumption that the returned container must answer the exact same containerPath * when requested <code>IClasspathContainer#getPath</code>. * Indeed, the containerPath is just an indication for resolving it to an actual container object. + * </p> * <p> * Classpath container values are persisted locally to the workspace, but * are not preserved from a session to another. It is thus highly recommended to register a * <code>ClasspathContainerInitializer</code> for each referenced container * (through the extension point "org.eclipse.jdt.core.ClasspathContainerInitializer"). - * <p> + * </p> + * * @param containerPath the name of the container, which needs to be resolved * @param project a specific project in which the container is being resolved * @return the corresponding classpath container or <code>null</code> if unable to find one. @@ -3138,7 +3153,7 @@ public final class JavaCore extends Plugin { * the extension point "org.eclipse.jdt.core.classpathContainerInitializer". * <p> * A containerID is the first segment of any container path, used to identify the registered container initializer. - * <p> + * </p> * @param containerID - a containerID identifying a registered initializer * @return ClasspathContainerInitializer - the registered classpath container initializer or <code>null</code> if * none was found. @@ -3211,12 +3226,14 @@ public final class JavaCore extends Plugin { * <p> * Classpath variable values are persisted locally to the workspace, and * are preserved from session to session. + * </p> * <p> * Note that classpath variables can be contributed registered initializers for, * using the extension point "org.eclipse.jdt.core.classpathVariableInitializer". * If an initializer is registered for a variable, its persisted value will be ignored: * its initializer will thus get the opportunity to rebind the variable differently on * each session. + * </p> * * @param variableName the name of the classpath variable * @return the path, or <code>null</code> if none @@ -3351,7 +3368,7 @@ public final class JavaCore extends Plugin { * Helper method finding the classpath variable initializer registered for a given classpath variable name * or <code>null</code> if none was found while iterating over the contributions to extension point to * the extension point "org.eclipse.jdt.core.classpathVariableInitializer". - * <p> + * * @param variable the given variable * @return ClasspathVariableInitializer - the registered classpath variable initializer or <code>null</code> if * none was found. @@ -3421,7 +3438,7 @@ public final class JavaCore extends Plugin { * <p> * Classpath variable values are persisted locally to the workspace, and * are preserved from session to session. - * <p> + * </p> * * @return the list of classpath variable names * @see #setClasspathVariable(String, IPath) @@ -3440,8 +3457,10 @@ public final class JavaCore extends Plugin { * (categorized in Code assist option ID, Compiler option ID and Core option ID) * and some of their acceptable values (categorized in Option value). Some * options accept open value sets beyond the documented constant values. + * </p> * <p> * Note: each release may add new options. + * </p> * * @return a table of all known configurable options with their default values */ @@ -3676,8 +3695,10 @@ public final class JavaCore extends Plugin { * Returns the list of known Java-like extensions. * Java like extension are defined in the {@link org.eclipse.core.runtime.Platform#getContentTypeManager() * content type manager} for the {@link #JAVA_SOURCE_CONTENT_TYPE}. + * <p> * Note that a Java-like extension doesn't include the leading dot ('.'). * Also note that the "java" extension is always defined as a Java-like extension. + * </p> * * @return the list of known Java-like extensions. * @since 3.2 @@ -3694,8 +3715,10 @@ public final class JavaCore extends Plugin { * (categorized in Code assist option ID, Compiler option ID and Core option ID) * and some of their acceptable values (categorized in Option value). Some * options accept open value sets beyond the documented constant values. + * </p> * <p> * Note: each release may add new options. + * </p> * * @param optionName the name of an option * @return the String value of a given option @@ -3734,8 +3757,10 @@ public final class JavaCore extends Plugin { * (categorized in Code assist option ID, Compiler option ID and Core option ID) * and some of their acceptable values (categorized in Option value). Some * options accept open value sets beyond the documented constant values. + * </p> * <p> * Note: each release may add new options. + * </p> * <p>Returns a default set of options even if the platform is not running.</p> * * @return table of current settings of all options @@ -3769,10 +3794,11 @@ public final class JavaCore extends Plugin { * </ul> * <p> * Variable source attachment path and root path are also resolved and recorded in the resulting classpath entry. + * </p> * <p> * NOTE: This helper method does not handle classpath containers, for which should rather be used * <code>JavaCore#getClasspathContainer(IPath, IJavaProject)</code>. - * <p> + * </p> * * @param entry the given variable entry * @return the resolved library or project classpath entry, or <code>null</code> @@ -3850,7 +3876,7 @@ public final class JavaCore extends Plugin { * overhead on user actions, if it can be performed before at some * appropriate moment. * </p><p> - * This initialization runs accross all Java projects in the workspace. Thus the + * This initialization runs across all Java projects in the workspace. Thus the * workspace root scheduling rule is used during this operation. * </p><p> * This method may return before the initialization is complete. The @@ -3950,7 +3976,7 @@ public final class JavaCore extends Plugin { // initialize delta state if (monitor != null) monitor.subTask(Messages.javamodel_initializing_delta_state); - manager.deltaState.rootsAreStale = true; // in case it was already initialized before we cleaned up the source attachment proprties + manager.deltaState.rootsAreStale = true; // in case it was already initialized before we cleaned up the source attachment properties manager.deltaState.initializeRoots(true/*initAfteLoad*/); // dummy query for waiting until the indexes are ready @@ -4196,7 +4222,7 @@ public final class JavaCore extends Plugin { * for the given path. This method is fully equivalent to calling * {@link #newContainerEntry(IPath, IAccessRule[], IClasspathAttribute[], boolean) * newContainerEntry(containerPath, new IAccessRule[0], new IClasspathAttribute[0], false)}. - * <p> + * * @param containerPath the path identifying the container, it must be formed of two * segments * @return a new container classpath entry @@ -4245,11 +4271,15 @@ public final class JavaCore extends Plugin { * which can be interpreted differently for each Java project where it is used. * A classpath container entry can be resolved using <code>JavaCore.getResolvedClasspathContainer</code>, * and updated with <code>JavaCore.classpathContainerChanged</code> + * </p> * <p> * A container is exclusively resolved by a <code>ClasspathContainerInitializer</code> registered onto the * extension point "org.eclipse.jdt.core.classpathContainerInitializer". + * </p> * <p> - * A container path must be formed of at least one segment, where: <ul> + * A container path must be formed of at least one segment, where: + * </p> + * <ul> * <li> the first segment is a unique ID identifying the target container, there must be a container initializer registered * onto this ID through the extension point "org.eclipse.jdt.core.classpathContainerInitializer". </li> * <li> the remaining segments will be passed onto the initializer, and can be used as additional @@ -4257,6 +4287,7 @@ public final class JavaCore extends Plugin { * </ul> * <p> * Example of an ClasspathContainerInitializer for a classpath container denoting a default JDK container: + * </p> * <pre> * containerEntry = JavaCore.newContainerEntry(new Path("MyProvidedJDK/default")); * @@ -4348,7 +4379,7 @@ public final class JavaCore extends Plugin { * <p> * Note that if a working copy is empty, it will be as if the original compilation * unit had been deleted. - * <p> + * </p> * * @param monitor the given progress monitor * @param region the given region @@ -4407,9 +4438,11 @@ public final class JavaCore extends Plugin { * Creates and returns a new classpath entry of kind <code>CPE_LIBRARY</code> for the JAR or folder * identified by the given absolute path. This specifies that all package fragments within the root * will have children of type <code>IClassFile</code>. + * <p> * This method is fully equivalent to calling * {@link #newLibraryEntry(IPath, IPath, IPath, IAccessRule[], IClasspathAttribute[], boolean) * newLibraryEntry(path, sourceAttachmentPath, sourceAttachmentRootPath, new IAccessRule[0], new IClasspathAttribute[0], isExported)}. + * </p> * * @param path the path to the library * @param sourceAttachmentPath the absolute path of the corresponding source archive or folder, @@ -4449,13 +4482,16 @@ public final class JavaCore extends Plugin { * The target root folder can also be defined internally to the workspace (absolute path relative * to the workspace root), or - since 3.4 - externally to the workspace (absolute path in the file system). * Since 3.5, the path to the library can also be relative to the project using ".." as the first segment. + * </p> * <p> - * e.g. Here are some examples of binary path usage<ul> + * e.g. Here are some examples of binary path usage + * </p> + * <ul> * <li><code> "c:\jdk1.2.2\jre\lib\rt.jar" </code> - reference to an external JAR on Windows</li> * <li><code> "/Project/someLib.jar" </code> - reference to an internal JAR on Windows or Linux</li> * <li><code> "/Project/classes/" </code> - reference to an internal binary folder on Windows or Linux</li> * <li><code> "/home/usr/classes" </code> - reference to an external binary folder on Linux</li> - * <li><code> "../../lib/someLib.jar" </code> - reference to an external JAR that is a sibbling of the workspace on either platform</li> + * <li><code> "../../lib/someLib.jar" </code> - reference to an external JAR that is a sibling of the workspace on either platform</li> * </ul> * Note that on non-Windows platform, a path <code>"/some/lib.jar"</code> is ambiguous. * It can be a path to an external JAR (its file system path being <code>"/some/lib.jar"</code>) @@ -4485,7 +4521,7 @@ public final class JavaCore extends Plugin { * with the non accessible files patterns of the project. * </p> * <p> - * Since 3.5, if the libray is a ZIP archive, the "Class-Path" clause (if any) in the "META-INF/MANIFEST.MF" is read + * Since 3.5, if the library is a ZIP archive, the "Class-Path" clause (if any) in the "META-INF/MANIFEST.MF" is read * and referenced ZIP archives are added to the {@link IJavaProject#getResolvedClasspath(boolean) resolved classpath}. * </p> * @@ -4547,9 +4583,11 @@ public final class JavaCore extends Plugin { /** * Creates and returns a new non-exported classpath entry of kind <code>CPE_PROJECT</code> * for the project identified by the given absolute path. + * <p> * This method is fully equivalent to calling * {@link #newProjectEntry(IPath, IAccessRule[], boolean, IClasspathAttribute[], boolean) * newProjectEntry(path, new IAccessRule[0], true, new IClasspathAttribute[0], false)}. + * </p> * * @param path the absolute path of the binary archive * @return a new project classpath entry @@ -4561,9 +4599,11 @@ public final class JavaCore extends Plugin { /** * Creates and returns a new classpath entry of kind <code>CPE_PROJECT</code> * for the project identified by the given absolute path. + * <p> * This method is fully equivalent to calling * {@link #newProjectEntry(IPath, IAccessRule[], boolean, IClasspathAttribute[], boolean) * newProjectEntry(path, new IAccessRule[0], true, new IClasspathAttribute[0], isExported)}. + * </p> * * @param path the absolute path of the prerequisite project * @param isExported indicates whether this entry is contributed to dependent @@ -4675,10 +4715,10 @@ public final class JavaCore extends Plugin { * absolute workspace-relative path. * <p> * The convenience method is fully equivalent to: + * </p> * <pre> * newSourceEntry(path, new IPath[] {}, new IPath[] {}, null); * </pre> - * </p> * * @param path the absolute workspace-relative path of a source folder * @return a new source classpath entry @@ -4696,10 +4736,10 @@ public final class JavaCore extends Plugin { * matching any of the given patterns. * <p> * The convenience method is fully equivalent to: + * </p> * <pre> * newSourceEntry(path, new IPath[] {}, exclusionPatterns, null); * </pre> - * </p> * * @param path the absolute workspace-relative path of a source folder * @param exclusionPatterns the possibly empty list of exclusion patterns @@ -4721,15 +4761,15 @@ public final class JavaCore extends Plugin { * (that is, ".class" files are not going to the project default output location). * <p> * The convenience method is fully equivalent to: + * </p> * <pre> * newSourceEntry(path, new IPath[] {}, exclusionPatterns, specificOutputLocation); * </pre> - * </p> * * @param path the absolute workspace-relative path of a source folder * @param exclusionPatterns the possibly empty list of exclusion patterns * represented as relative paths - * @param specificOutputLocation the specific output location for this source entry (<code>null</code> if using project default ouput location) + * @param specificOutputLocation the specific output location for this source entry (<code>null</code> if using project default output location) * @return a new source classpath entry * @see #newSourceEntry(IPath, IPath[], IPath[], IPath) * @since 2.1 @@ -4747,17 +4787,17 @@ public final class JavaCore extends Plugin { * (that is, ".class" files are not going to the project default output location). * <p> * The convenience method is fully equivalent to: + * </p> * <pre> * newSourceEntry(path, new IPath[] {}, exclusionPatterns, specificOutputLocation, new IClasspathAttribute[] {}); * </pre> - * </p> * * @param path the absolute workspace-relative path of a source folder * @param inclusionPatterns the possibly empty list of inclusion patterns * represented as relative paths * @param exclusionPatterns the possibly empty list of exclusion patterns * represented as relative paths - * @param specificOutputLocation the specific output location for this source entry (<code>null</code> if using project default ouput location) + * @param specificOutputLocation the specific output location for this source entry (<code>null</code> if using project default output location) * @return a new source classpath entry * @see #newSourceEntry(IPath, IPath[], IPath[], IPath, IClasspathAttribute[]) * @since 3.0 @@ -4783,7 +4823,7 @@ public final class JavaCore extends Plugin { * The inclusion patterns determines the initial set of source files that * are to be included; the exclusion patterns are then used to reduce this * set. When no inclusion patterns are specified, the initial file set - * includes all relevent files in the resource tree rooted at the source + * includes all relevant files in the resource tree rooted at the source * entry's path. On the other hand, specifying one or more inclusion * patterns means that all <b>and only</b> files matching at least one of * the specified patterns are to be included. If exclusion patterns are @@ -4936,12 +4976,16 @@ public final class JavaCore extends Plugin { * <p> * A variable entry allows to express indirect references on a classpath to other projects or libraries, * depending on what the classpath variable is referring. + * </p> * <p> - * It is possible to register an automatic initializer (<code>ClasspathVariableInitializer</code>), + * It is possible to register an automatic initializer (<code>ClasspathVariableInitializer</code>), * which will be invoked through the extension point "org.eclipse.jdt.core.classpathVariableInitializer". * After resolution, a classpath variable entry may either correspond to a project or a library entry. + * </p> * <p> - * e.g. Here are some examples of variable path usage<ul> + * e.g. Here are some examples of variable path usage + * </p> + * <ul> * <li> "JDTCORE" where variable <code>JDTCORE</code> is * bound to "c:/jars/jdtcore.jar". The resolved classpath entry is denoting the library "c:\jars\jdtcore.jar"</li> * <li> "JDTCORE" where variable <code>JDTCORE</code> is @@ -5040,7 +5084,7 @@ public final class JavaCore extends Plugin { * * @param libraryEntry the library entry whose referenced entries are sought * @param project project where the persisted referenced entries to be retrieved from. If <code>null</code> - * persisted attributes are not attempted to be retrived. + * persisted attributes are not attempted to be retrieved. * @return an array of classpath entries that are referenced directly or indirectly by the given entry. * If not applicable, returns an empty array. * @since 3.6 @@ -5049,16 +5093,17 @@ public final class JavaCore extends Plugin { JavaModelManager manager = JavaModelManager.getJavaModelManager(); return manager.getReferencedClasspathEntries(libraryEntry, project); } - + /** * Removed the given classpath variable. Does nothing if no value was * set for this classpath variable. * <p> * This functionality cannot be used while the resource tree is locked. + * </p> * <p> * Classpath variable values are persisted locally to the workspace, and * are preserved from session to session. - * <p> + * </p> * * @param variableName the name of the classpath variable * @see #setClasspathVariable(String, IPath) @@ -5074,10 +5119,11 @@ public final class JavaCore extends Plugin { * set for this classpath variable. * <p> * This functionality cannot be used while the resource tree is locked. + * </p> * <p> * Classpath variable values are persisted locally to the workspace, and * are preserved from session to session. - * <p> + * </p> * * @param variableName the name of the classpath variable * @param monitor the progress monitor to report progress @@ -5119,6 +5165,7 @@ public final class JavaCore extends Plugin { * Removes the given pre-processing resource changed listener. * <p> * Has no effect if an identical listener is not registered. + * </p> * * @param listener the listener * @since 3.0 @@ -5215,6 +5262,7 @@ public final class JavaCore extends Plugin { * is formed by a first ID segment followed with extra segments, which can be used as additional hints * for the resolution. The container ID is used to identify a <code>ClasspathContainerInitializer</code> * registered on the extension point "org.eclipse.jdt.core.classpathContainerInitializer". + * </p> * <p> * There is no assumption that each individual container value passed in argument * (<code>respectiveContainers</code>) must answer the exact same path when requested @@ -5222,24 +5270,28 @@ public final class JavaCore extends Plugin { * Indeed, the containerPath is just an indication for resolving it to an actual container object. It can be * delegated to a <code>ClasspathContainerInitializer</code>, which can be activated through the extension * point "org.eclipse.jdt.core.ClasspathContainerInitializer"). + * </p> * <p> * In reaction to changing container values, the JavaModel will be updated to reflect the new * state of the updated container. A combined Java element delta will be notified to describe the corresponding * classpath changes resulting from the container update. This operation is batched, and automatically eliminates * unnecessary updates (new container is same as old one). This operation acquires a lock on the workspace's root. + * </p> * <p> * This functionality cannot be used while the workspace is locked, since * it may create/remove some resource markers. + * </p> * <p> * Classpath container values are persisted locally to the workspace, but * are not preserved from a session to another. It is thus highly recommended to register a * <code>ClasspathContainerInitializer</code> for each referenced container * (through the extension point "org.eclipse.jdt.core.ClasspathContainerInitializer"). + * </p> * <p> * Note: setting a container to <code>null</code> will cause it to be lazily resolved again whenever * its value is required. In particular, this will cause a registered initializer to be invoked * again. - * <p> + * </p> * @param containerPath - the name of the container reference, which is being updated * @param affectedProjects - the set of projects for which this container is being bound * @param respectiveContainers - the set of respective containers for the affected projects @@ -5274,10 +5326,11 @@ public final class JavaCore extends Plugin { * The path must have at least one segment. * <p> * This functionality cannot be used while the resource tree is locked. + * </p> * <p> * Classpath variable values are persisted locally to the workspace, and * are preserved from session to session. - * <p> + * </p> * * @param variableName the name of the classpath variable * @param path the path @@ -5298,11 +5351,14 @@ public final class JavaCore extends Plugin { * Since 3.5, the path to a library can also be relative to the project using ".." as the first segment. * <p> * This functionality cannot be used while the resource tree is locked. + * </p> * <p> * Classpath variable values are persisted locally to the workspace, and * are preserved from session to session. + * </p> * <p> * Updating a variable with the same value has no effect. + * </p> * * @param variableName the name of the classpath variable * @param path the path @@ -5329,14 +5385,18 @@ public final class JavaCore extends Plugin { * classpath changes resulting from the variables update. This operation is batched, * and automatically eliminates unnecessary updates (new variable is same as old one). * This operation acquires a lock on the workspace's root. + * </p> * <p> * This functionality cannot be used while the workspace is locked, since * it may create/remove some resource markers. + * </p> * <p> * Classpath variable values are persisted locally to the workspace, and * are preserved from session to session. + * </p> * <p> * Updating a variable with the same value has no effect. + * </p> * * @param variableNames an array of names for the updated classpath variables * @param paths an array of path updates for the modified classpath variables (null @@ -5362,7 +5422,7 @@ public final class JavaCore extends Plugin { * to the given compliance. * * <p>The given compliance must be one of those supported by the compiler, - * that is one of the acceptable values for option {@link #COMPILER_COMPLIANCE}. + * that is one of the acceptable values for option {@link #COMPILER_COMPLIANCE}.</p> * * <p>The list of modified options is currently:</p> * <ul> @@ -5431,7 +5491,7 @@ public final class JavaCore extends Plugin { * (categorized in Code assist option ID, Compiler option ID and Core option ID) * and some of their acceptable values (categorized in Option value). Some * options accept open value sets beyond the documented constant values. - * <p> + * </p> * Note: each release may add new options. * * @param newOptions @@ -5449,7 +5509,7 @@ public final class JavaCore extends Plugin { * Shutdown the JavaCore plug-in. * <p> * De-registers the JavaModelManager as a resource changed listener and save participant. - * <p> + * </p> * @see org.eclipse.core.runtime.Plugin#stop(BundleContext) */ public void stop(BundleContext context) throws Exception { @@ -5466,7 +5526,7 @@ public final class JavaCore extends Plugin { * <p> * Registers the JavaModelManager as a resource changed listener and save participant. * Starts the background indexing, and restore saved classpath variable values. - * <p> + * </p> * @throws Exception * @see org.eclipse.core.runtime.Plugin#start(BundleContext) */ |