Fixed bug 375409 - Add missing Javadoc compile options to batch

compiler

1 files changed, 143 insertions, 2 deletions

diff --git a/bundles/org.eclipse.jdt.doc.user/tasks/task-using_batch_compiler.htm b/bundles/org.eclipse.jdt.doc.user/tasks/task-using_batch_compiler.htm
index 6fa81151b..1c792a651 100644
--- a/bundles/org.eclipse.jdt.doc.user/tasks/task-using_batch_compiler.htm
+++ b/bundles/org.eclipse.jdt.doc.user/tasks/task-using_batch_compiler.htm
@@ -416,6 +416,38 @@ will enable more warnings than the default, and specifying "-" disables some tha
 <td align="left" valign="top">intfRedundant</td>
 <td valign="top">find redundant superinterfaces</td>
 </tr>
+
+<tr>
+<td align="center" valign="top">-</td>
+<td align="left" valign="top">invalidJavadoc</td>
+<td valign="top">macro to toggle the 'malformed javadoc comments' option and all its sub-options listed below</td>
+</tr>
+
+<tr>
+<td align="center" valign="top">-</td>
+<td align="left" valign="top">invalidJavadocTag</td>
+<td valign="top">report invalid javadoc tags in javadoc comments.</td>
+</tr>
+
+<tr>
+<td align="center" valign="top">-</td>
+<td align="left" valign="top">invalidJavadocTagDep</td>
+<td valign="top">report invalid deprecated references in javadoc tag arguments</td>
+</tr>
+
+<tr>
+<td align="center" valign="top">-</td>
+<td align="left" valign="top">invalidJavadocTagNotVisible</td>
+<td valign="top">report invalid non-visible references in javadoc tag arguments</td>
+</tr>
+
+<tr>
+<td align="center" valign="top">-</td>
+<td align="left" valign="top">invalidJavadocVisibility(&lt;visibility&gt;)</td>
+<td valign="top">specify visibility modifier ("public", "protected" or "private") for malformed javadoc tag warnings. Usage
+example: invalidJavadocVisibility(public)</td>
+</tr>
+
 <tr>
 <td align="center" valign="top">-</td>
 <td align="left" valign="top">javadoc</td>
@@ -427,13 +459,58 @@ will enable more warnings than the default, and specifying "-" disables some tha
 <td align="left" valign="top">localHiding</td>
 <td valign="top">local variable hiding another variable</td>
 </tr>
+
 <tr>
 <td align="center" valign="top">+</td>
 <td align="left" valign="top">maskedCatchBlock</td>
 <td valign="top">hidden catch block</td>
 </tr>
+
 <tr>
+<td align="center" valign="top">-</td>
+<td align="left" valign="top">missingJavadocTags</td>
+<td valign="top">macro to toggle the 'missing Javadoc tags' option and all its sub-options listed below</td>
+</tr>
+
+<tr>
+<td align="center" valign="top">-</td>
+<td align="left" valign="top">missingJavadocTagsOverriding</td>
+<td valign="top">report missing javadoc tags in overriding methods</td>
+</tr>
+
+<tr>
+<td align="center" valign="top">-</td>
+<td align="left" valign="top">missingJavadocTagsMethod</td>
+<td valign="top">report missing javadoc tags for a method's type parameters</td>
+</tr>
+
+<tr>
+<td align="center" valign="top">-</td>
+<td align="left" valign="top">missingJavadocTagsVisibility(&lt;visibility&gt;)</td>
+<td valign="top">specify visibility modifier ("public", "protected" or "private") for missing javadoc tags warnings. Usage
+example: missingJavadocTagsVisibility(public)</td>
+</tr>
 
+<tr>
+<td align="center" valign="top">-</td>
+<td align="left" valign="top">missingJavadocComments</td>
+<td valign="top">macro to toggle the 'missing Javadoc comments' option and all its sub-options listed below</td>
+</tr>
+
+<tr>
+<td align="center" valign="top">-</td>
+<td align="left" valign="top">missingJavadocCommentsOverriding</td>
+<td valign="top">report missing javadoc comments in overriding methods</td>
+</tr>
+
+<tr>
+<td align="center" valign="top">-</td>
+<td align="left" valign="top">missingJavadocCommentsVisibility(&lt;visibility&gt;)</td>
+<td valign="top">specify visibility modifier ("public", "protected" or "private") for missing javadoc comments warnings. Usage
+example: missingJavadocCommentsVisibility(public)</td>
+</tr>
+
+<tr>
 <td align="center" valign="top">-</td>
 <td align="left" valign="top">nls</td>
 <td valign="top">non-nls string literals (lacking of tags //$NON-NLS-&lt;n&gt;)</td>
@@ -456,8 +533,32 @@ will enable more warnings than the default, and specifying "-" disables some tha
 If desired, the annotation types to be interpreted by the compiler can be specified
 by appending (nullable|nonnull|nonnullbydefault), 
 where each annotation type is specified using its fully qualified name.<br/>
-See also -nonNullByDefault below.</td>
+<i>Usage example: nullAnnot(p.Nullable|p.NonNull|p.NonNullByDefault)</i><br/>
+Enabling this option enables all null-annotation related sub-options. These can be individually 
+controlled using options listed below</td>
+</tr>
+
+<tr>
+<td align="center" valign="top">-</td>
+<td align="left" valign="top">nullAnnotConflict</td>
+<td valign="top">report conflicts between null annotation specified and nullness inferred. Is effective
+only with the nullAnnot option enabled.</td>
+</tr>
+
+<tr>
+<td align="center" valign="top">-</td>
+<td align="left" valign="top">nullAnnotRedundant</td>
+<td valign="top">report redundant specification of null annotation. Is effective
+only with the nullAnnot option enabled.</td>
 </tr>
+
+<tr>
+<td align="center" valign="top">-</td>
+<td align="left" valign="top">nullUncheckedConversion</td>
+<td valign="top">report unchecked conversion from unannotated type to @NonNull type. Is effective
+only with the nullAnnot option enabled.</td>
+</tr>
+
 <tr>
 <td align="center" valign="top">-</td>
 <td align="left" valign="top">nullDereference</td>
@@ -614,6 +715,31 @@ See also -nonNullByDefault below.</td>
 </tr>
 <tr>
 <td align="center" valign="top">+</td>
+<td align="left" valign="top">unusedParam</td>
+<td valign="top">unused parameter</td>
+</tr>
+<tr>
+<td align="center" valign="top">+</td>
+<td align="left" valign="top">unusedParamOverriding</td>
+<td valign="top">unused parameter for overriding method</td>
+</tr>
+<tr>
+<td align="center" valign="top">+</td>
+<td align="left" valign="top">unusedParamImplementing</td>
+<td valign="top">unused parameter for implementing method</td>
+</tr>
+<tr>
+<td align="center" valign="top">+</td>
+<td align="left" valign="top">unusedParamIncludeDoc</td>
+<td valign="top">unused parameter documented in a javadoc comment tag</td>
+</tr>
+<tr>
+<td align="center" valign="top">+</td>
+<td align="left" valign="top">unusedLocal</td>
+<td valign="top">unused local variable</td>
+</tr>
+<tr>
+<td align="center" valign="top">+</td>
 
 <td align="left" valign="top">unusedPrivate</td>
 <td valign="top">unused private member declaration</td>
@@ -624,6 +750,21 @@ See also -nonNullByDefault below.</td>
 <td valign="top">unused declared thrown exception</td>
 </tr>
 <tr>
+<td align="center" valign="top">-</td>
+<td align="left" valign="top">unusedThrownWhenOverriding</td>
+<td valign="top">unused declared thrown exception in overriding method</td>
+</tr>
+<tr>
+<td align="center" valign="top">-</td>
+<td align="left" valign="top">unusedThrownIncludeDocComment</td>
+<td valign="top">unused declared thrown exception documented in a javadoc comment tag</td>
+</tr>
+<tr>
+<td align="center" valign="top">-</td>
+<td align="left" valign="top">unusedThrownExemptExceptionThrowable</td>
+<td valign="top">report unused declared thrown exception but exempt Exception and Throwable</td>
+</tr>
+<tr>
 <td align="center" valign="top">+</td>
 <td align="left" valign="top">unusedTypeArgs</td>
 <td valign="top">unused type arguments for method and constructor</td>
@@ -848,7 +989,7 @@ generation and the produced .class files can be run without a problem.</td>
 </tr>
 <tr>
 <td valign="top">-enableJavadoc</td>
-<td colspan="3">Consider references inside javadoc.</td>
+<td colspan="3">Consider references inside javadoc. The javadoc options are effective only when this option is enabled.</td>
 </tr>
 <tr>
 <td valign="top">-missingNullDefault</td>