Skip to content

Update documentation of SuppressWarnings tokens #3790

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merks merged 1 commit into from
Apr 29, 2026
+58 −18
Merged

Update documentation of SuppressWarnings tokens #3790

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 58 additions & 18 deletions eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/task-suppress_warnings.htm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,21 @@ <h1>Excluding Warnings Using @SuppressWarnings</h1>
<p>to suppress warnings relative to deprecation</p>
</td>
<td>
<p>Deprecated API</p>
<p>Usage of deprecated API</p>
</td>
</tr>
<tr>
<td>
<p><span class="token">exports</span></p>
</td>
<td>
<p>to suppress warnings relative to module API leaks</p>
</td>
<td>
<p>Public API exposes a type that is not exported<br/>
Public API exposes a non-public type<br/>
Public API exposes a type from another module that is not transitively required
</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -145,6 +159,17 @@ <h1>Excluding Warnings Using @SuppressWarnings</h1>
<p>All options in <a href="../reference/preferences/java/compiler/ref-preferences-javadoc.htm">Java Compiler Javadoc Preferences</a></p>
</td>
</tr>
<tr>
<td>
<p><span class="token">module</span></p>
</td>
<td>
<p>to suppress warnings relative to modules</p>
</td>
<td>
<p>An automatic module has an unstable name</p>
</td>
</tr>
<tr>
<td>
<p><span class="token">nls</span></p>
Expand All @@ -167,6 +192,18 @@ <h1>Excluding Warnings Using @SuppressWarnings</h1>
<p>All options in <a href="../reference/preferences/java/compiler/ref-preferences-errors-warnings.htm#null_analysis">Java Compile Errors/Warnings Preferences for Null Analysis</a></p>
</td>
</tr>
<tr>
<td>
<p><span class="token">preview</span></p>
</td>
<td>
<p>to suppress warnings relative to preview features</p>
</td>
<td>
<p>Use of a preview language feature</p>
<p>Use of a preview API</p>
</td>
</tr>
<tr>
<td>
<p><span class="token">rawtypes</span></p>
Expand All @@ -180,35 +217,35 @@ <h1>Excluding Warnings Using @SuppressWarnings</h1>
</tr>
<tr>
<td>
<p><span class="token">resource</span></p>
<p><span class="token">removal</span></p>
</td>
<td>
<p>to suppress warnings relative to usage of resources of type Closeable</p>
<p>to suppress warnings relative to usage of terminally deprecated API</p>
</td>
<td>
<p>Resource leak<br/>
Potential resource leak<br/>
Resource not managed via try-with-resource</p>
<p>Usage of terminally deprecated API</p>
</td>
</tr>
<tr>
<td>
<p><span class="token">restriction</span></p>
<p><span class="token">resource</span></p>
</td>
<td>
<p>to suppress warnings relative to usage of discouraged or forbidden references</p>
<p>to suppress warnings relative to usage of resources of type Closeable</p>
</td>
<td>
<p>Forbidden reference (access rules)<br/>
Discouraged reference (access rules)</p>
<p>Resource leak<br/>
Potential resource leak<br/>
Resource not managed via try-with-resource<br/>
Specification using '@Owning'/'@NotOwning' is insufficient</p>
</td>
</tr>
<tr>
<td>
<p><span class="token">removal</span></p>
<p><span class="token">restriction</span></p>
</td>
<td>
<p>to suppress warnings relative to usage of terminally deprecated API</p>
<p>to suppress warnings relative to usage of discouraged or forbidden references</p>
</td>
<td>
<p>Forbidden reference (access rules)<br/>
Expand Down Expand Up @@ -294,21 +331,21 @@ <h1>Excluding Warnings Using @SuppressWarnings</h1>
</tr>
<tr>
<td>
<p><span class="token">unqualified-field-access</span></p>
<p><span class="token">unlikely-arg-type</span></p>
</td>
<td>
<p>to suppress warnings relative to field access unqualified</p>
<p>to suppress warnings relative to unlikely argument types</p>
</td>
<td>
<p>Unqualified access to instance field</p>
<p>Collection method with 'Object' parameter is called with an argument that may never match</p>
</td>
</tr>
<tr>
<td>
<p><span class="token">unlikely-arg-type</span></p>
<p><span class="token">unqualified-field-access</span></p>
</td>
<td>
<p>to suppress warnings relative to unlikely argument types</p>
<p>to suppress warnings relative to field access unqualified</p>
</td>
<td>
<p>Unqualified access to instance field</p>
Expand All @@ -330,7 +367,10 @@ <h1>Excluding Warnings Using @SuppressWarnings</h1>
Unused type parameter<br/>
Unused import<br/>
Unused private member<br/>
Unused 'break' or 'continue' label
Unused 'break' or 'continue' label<br/>
Redundant super interface specification<br/>
Unnecessary specification of type arguments<br/>
Method declares 'throws' but exception is not thrown<br/>
</p>
</td>
</tr>
Expand Down
Loading