cleanup inspection descriptions (IDEADEV-35572)

This commit is contained in:
Dmitry Jemerov
2009-03-20 20:22:49 +03:00
parent c35258523c
commit e506f25a82
3 changed files with 5 additions and 21 deletions
@@ -1000,7 +1000,8 @@ public class InspectionGadgetsPlugin implements ApplicationComponent,
m_inspectionClasses.add(ThrowablePrintStackTraceInspection.class);
m_inspectionClasses.add(TodoCommentInspection.class);
m_inspectionClasses.add(ThreadDumpStackInspection.class);
m_inspectionClasses.add(ClassWithoutToStringInspection.class);
//m_inspectionClasses.add(ClassWithoutToStringInspection.class);
// - the same inspection is provided by "Generate toString()" plugin, and the other version has a quickfix
m_inspectionClasses.add(ObsoleteCollectionInspection.class);
}
@@ -3,17 +3,6 @@
<table height="170"> <tr height="150"> <td valign="top" height="150">
<font face="verdana" size="-1">
This inspection reports any classes with no toString() method.
<p>
This inspection will use the exclude settings from the plugin configuration to ignore classes having fields
not supposed to be dumped.
<br>An additional settings is to exclude certain classes by using a regular expression
matching the classname.
<br>Exception, deprecated, abstract or enum classes can also be excluded.
<p>
This inspection can use on-the-fly code inspection by enabling it to show errors as warnings. This will highlight
the classname on-the-fly in the java editor.
<p>
<font color="#000080"><b>Notice</b> 'on-the-fly' should be enabled from the settings to this plugin.</font>
</font>
</td> </tr> </table>
</body>
@@ -2,18 +2,12 @@
<body>
<table height="170"> <tr height="150"> <td valign="top" height="150">
<font face="verdana" size="-1">
This insepction is used to identify out of synchronization situations
where you have an existing toString() method that dumps the fields. However some fields have been added to the class
later and these new fields are not dumped in the toString() method.
This inspection reports any fields which are not used in the toString() method of the class. This can be useful to discover
fields that were added after the toString() method was created and for which the toString() method was not correctly adjusted.
It is possible to exclude fields from this check in the settings accessible via the Generate > toString() dialog.
<p>
This inspection will also check for problems with getter methods if 'enable getters in code generation' is enabled
in settings.
<p>
This inspection can use on-the-fly code inspection by enabling it to show errors as warnings. This will highlight
any unused fields on-the-fly in the java editor - also the right gutter will indicate the location of the error using
a yellow marker. This is the same feature as the build in inspection <font color="#000080">'Field XXX is never assigned'</font>.
<p>
<font color="#000080"><b>Notice</b> 'on-the-fly' should be enabled from the settings to this plugin.</font>
</font>
</td> </tr> </table>
</body>