Bug 375366 - ECJ ignores unusedParameterIncludeDocCommentReferencev20120926-212826I20121002-0800

unless enableJavadoc option is set
- doc updates

1 files changed, 13 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 b89e24b11..d46bce512 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
@@ -825,7 +825,8 @@ unusedLocal and deprecation warnings will be converted to errors. All other warn
 <td colspan="3">Set warnings/errors option based on the properties file contents. This option can be used with -nowarn, -err:.. or -warn:.. options, but the last one on the command line sets the
 options to be used.<br />
 <p>The properties file contents can be generated by setting project specific settings on an existing java project and using the file in <code>.settings/org.eclipse.jdt.core.prefs</code> file as a
-properties file, or a simple text file that is defined entry/value pairs using the constants defined in the <code>org.eclipse.jdt.core.JavaCore</code> class.</p>
+properties file, or a simple text file that is defined entry/value pairs using the constants defined in the <code>org.eclipse.jdt.core.JavaCore</code> class.
+Of those constants declared in this class, all options starting with <code>"org.eclipse.jdt.core.compiler."</code> are interpreted by the batch compiler.</p>
 
 <pre>
 ...
@@ -833,7 +834,16 @@ org.eclipse.jdt.core.compiler.problem.annotationSuperInterface=warning
 org.eclipse.jdt.core.compiler.problem.assertIdentifier=warning
 org.eclipse.jdt.core.compiler.problem.autoboxing=ignore
 ...
-</pre></td>
+</pre>
+<p>To ensure that a property file has the same effect when used in the IDE and for the batch compiler, use of the <code>-properties</code> option will change the defaults
+for a few options:</p>
+<table>
+<tr><td><b>-g</b></td><td>default changed to <em>all enabled</em></td></tr>
+<tr><td><b>-preserveAllLocals</b></td><td>default changed to <em>enabled</em></td></tr>
+<tr><td><b>-enableJavadoc</b></td><td>default changed to <em>enabled</em></td></tr>
+<tr><td>error/warning <b>forbidden</b></td><td>default changed to <em>error</em></td></tr>
+</table>
+</td>
 </tr>
 <tr>
 <th colspan="4">Debug options</th>
@@ -857,6 +867,7 @@ org.eclipse.jdt.core.compiler.problem.autoboxing=ignore
 </tr>
 
 </table>
+Not specifying this option is equivalent to setting <span class="c3">-g:lines,source</span>.
 </td>
 </tr>
 <tr>