[Japi-cvs] SF.net SVN: japi: [50] trunk/src/doc/tasks.xhtml

[<chr...@us...>]

Revision: 50
Author:   christianhujer
Date:     2006-04-11 16:08:22 -0700 (Tue, 11 Apr 2006)
ViewCVS:  http://svn.sourceforge.net/japi/?rev=50&view=rev

Log Message:
-----------
Added task to unify workaround SuppressWarnings.

Modified Paths:
--------------
    trunk/src/doc/tasks.xhtml
Modified: trunk/src/doc/tasks.xhtml
===================================================================
--- trunk/src/doc/tasks.xhtml	2006-04-11 23:01:40 UTC (rev 49)
+++ trunk/src/doc/tasks.xhtml	2006-04-11 23:08:22 UTC (rev 50)
@@ -143,6 +143,21 @@
             <dd>
                 Some classes have two blank lines between copyright comment and package, some have only one. This should be unified.
             </dd>
+            <dt>Unify SuppressWarnings in case of working around bugs</dt>
+            <dd>
+                Several warning suppressions do not suppress valid warnings but bogus warnings that are bugs of IntelliJ IDEA.
+                These warning suppressions should be tagged as such with a special comment to find and remove them once the bugs in IntelliJ IDEA are
+                fixed.
+                <br />
+                Suggestion: <samp>// XXX workaround bug in IntelliJ IDEA (<var>explanatory text</var>)</samp>.
+                <br />
+                Example: <pre><![CDATA[        } catch (final InvocationTargetException ex) {
+            // XXX workaround bug in IntelliJ IDEA (ex is NOT ignored)
+            //noinspection ThrowInsideCatchBlockWhichIgnoresCaughtException
+            throw new RuntimeException(ex.getCause());
+        }]]></pre>
+                Also think whether IntelliJ IDEA or Inspection Gadgets is to blame.
+            </dd>
         </dl>
     </body>
 </html>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.