Attachment 209830 Details for Bug 369246 – proposed fix

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

[patch] proposed fix

Fixed-bug-369246-Update-doc-for-null-analysis.patch (text/plain), 4.84 KB, created by Ayushman Jain

on 2012-01-20 10:31:06 EST

(hide)

Description:

Filename:

MIME Type:

Creator: Ayushman Jain

Created: 2012-01-20 10:31:06 EST

Size: 4.84 KB

patch

obsolete

>diff --git a/bundles/org.eclipse.jdt.doc.isv/guide/jdt_api_options.htm b/bundles/org.eclipse.jdt.doc.isv/guide/jdt_api_options.htm
>index bcbab59..3b2eabf 100644
>--- a/bundles/org.eclipse.jdt.doc.isv/guide/jdt_api_options.htm
>+++ b/bundles/org.eclipse.jdt.doc.isv/guide/jdt_api_options.htm
>@@ -1461,8 +1461,6 @@
> current location. Such a default may be effective by enabling the option
> <a href="../reference/api/org/eclipse/jdt/core/JavaCore.html#COMPILER_NONNULL_IS_DEFAULT">COMPILER_NONNULL_IS_DEFAULT</a> or by using the annotation specified by the option
> <a href="../reference/api/org/eclipse/jdt/core/JavaCore.html#COMPILER_NONNULL_BY_DEFAULT_ANNOTATION_NAME">COMPILER_NONNULL_BY_DEFAULT_ANNOTATION_NAME</a>.
>-Insufficient nullness information is usually a consequence of using other unannotated
>-variables or methods.
> The compiler options <a href="../reference/api/org/eclipse/jdt/core/JavaCore.html#COMPILER_NONNULL_ANNOTATION_NAME">COMPILER_NONNULL_ANNOTATION_NAME</a> and
> <a href="../reference/api/org/eclipse/jdt/core/JavaCore.html#COMPILER_NULLABLE_ANNOTATION_NAME">COMPILER_NULLABLE_ANNOTATION_NAME</a> control which annotations the compiler
> shall interpret as nonnull or nullable annotations, respectively.
>diff --git a/bundles/org.eclipse.jdt.doc.user/reference/preferences/java/compiler/ref-preferences-errors-warnings.htm b/bundles/org.eclipse.jdt.doc.user/reference/preferences/java/compiler/ref-preferences-errors-warnings.htm
>index 238edfb..a15776f 100644
>--- a/bundles/org.eclipse.jdt.doc.user/reference/preferences/java/compiler/ref-preferences-errors-warnings.htm
>+++ b/bundles/org.eclipse.jdt.doc.user/reference/preferences/java/compiler/ref-preferences-errors-warnings.htm
>@@ -777,6 +777,7 @@
> 		</td>
> 		<td valign="top">
> 		When enabled, the compiler will issue an error or a warning when it encounters that a local variable which is certainly null is dereferenced. Note that the analysis can not find all null pointer accesses, see Potential null pointer access.
>+		This diagnostic can also be enabled for fields using the option Include fields in null analysis.
> 		</td>
> 		<td valign="top">
> 		Warning
>@@ -788,6 +789,9 @@
> 		</td>
> 		<td valign="top">
> 		When enabled, the compiler will issue an error or a warning when it encounters that a local variable which may be null is dereferenced. Note that the analysis is fairly conservative, it only considers cases where there is something suspicious.
>+		This diagnostic can also be enabled for fields using the option Include fields in null analysis.
>+		The quality of the analysis can be improved by using null-annotations, which can be enabled using the option 
>+		Enable annotation-based null analysis
> 		</td>
> 		<td valign="top">
> 		Ignore
>@@ -799,9 +803,23 @@
> 		</td>
> 		<td valign="top">
> 		When enabled, the compiler will issue an error or a warning whenever a local variable which can not be null is tested for null.
>+		This diagnostic can also be enabled for fields using the option Include fields in null analysis below.
> 		</td>
> 		<td valign="top">
> 		Ignore
>+		</td>
>+	</tr>
>+	<tr>
>+		<td valign="top">
>+		Include fields in null analysis
>+		</td>
>+		<td valign="top">
>+		When enabled, the compiler will raise null analysis based errors or warnings on fields.
>+		These diagnostics can be configured using the options Null pointer access, 
>+		Potential null pointer access and Redundant null check.
>+		</td>
>+		<td valign="top">
>+		Off
> 		</td>
> 	</tr>
> 	<tr>
>@@ -870,10 +888,11 @@
> 	</tr>
> 	<tr>
> 		<td valign="top" style="padding-left: 2em;">
>-		Use non-null as workspace-wide default
>+		Use non-null as workspace-wide (or project-wide) default
> 		</td>
> 		<td valign="top">
>-		When enabled, this option globally achieves the same effect as specifying 'NonNull' annotation does for individual elements.
>+		When enabled, this option globally (at a workspace level or project level depending on
>+		where the option is configured) achieves the same effect as specifying 'NonNull' annotation does for individual elements.
> 		</td>
> 		<td valign="top">
> 		Off
>@@ -937,7 +956,7 @@
> 		</td>
> 		<td valign="top">
> 		When enabled, the compiler will issue an error or a warning when a non-null annotation is applied although the same effect is already achieved by a default applicable at the current location. 
>-		Such a default may be set by enabling the option Use non-null as workspace-wide default or by using the annotation specified by the option 'NonNullByDefault' annotation.
>+		Such a default may be set by enabling the option Use non-null as workspace-wide (or project-wide) default or by using the annotation specified by the option 'NonNullByDefault' annotation.
> 		</td>
> 		<td valign="top">
> 		Warning

Actions: View | Diff

Attachments on bug 369246: 209830