From e506f25a82e5d45ec8e0ed88438f5b96ea06d3cc Mon Sep 17 00:00:00 2001 From: Dmitry Jemerov Date: Fri, 20 Mar 2009 20:22:49 +0300 Subject: [PATCH] cleanup inspection descriptions (IDEADEV-35572) --- .../src/com/siyeh/ig/InspectionGadgetsPlugin.java | 3 ++- .../ClassHasNoToStringMethod.html | 11 ----------- .../FieldNotUsedInToString.html | 12 +++--------- 3 files changed, 5 insertions(+), 21 deletions(-) diff --git a/plugins/InspectionGadgets/src/com/siyeh/ig/InspectionGadgetsPlugin.java b/plugins/InspectionGadgets/src/com/siyeh/ig/InspectionGadgetsPlugin.java index b1c39b09c6ad..544b94e89c53 100644 --- a/plugins/InspectionGadgets/src/com/siyeh/ig/InspectionGadgetsPlugin.java +++ b/plugins/InspectionGadgets/src/com/siyeh/ig/InspectionGadgetsPlugin.java @@ -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); } diff --git a/plugins/generate-tostring/resources/inspectionDescriptions/ClassHasNoToStringMethod.html b/plugins/generate-tostring/resources/inspectionDescriptions/ClassHasNoToStringMethod.html index 822ee049a9d3..8db9b6584fa8 100644 --- a/plugins/generate-tostring/resources/inspectionDescriptions/ClassHasNoToStringMethod.html +++ b/plugins/generate-tostring/resources/inspectionDescriptions/ClassHasNoToStringMethod.html @@ -3,17 +3,6 @@
This inspection reports any classes with no toString() method. -

- This inspection will use the exclude settings from the plugin configuration to ignore classes having fields - not supposed to be dumped. -
An additional settings is to exclude certain classes by using a regular expression - matching the classname. -
Exception, deprecated, abstract or enum classes can also be excluded. -

- 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. -

- Notice 'on-the-fly' should be enabled from the settings to this plugin.

diff --git a/plugins/generate-tostring/resources/inspectionDescriptions/FieldNotUsedInToString.html b/plugins/generate-tostring/resources/inspectionDescriptions/FieldNotUsedInToString.html index fb260f4778b5..60467e41b5eb 100644 --- a/plugins/generate-tostring/resources/inspectionDescriptions/FieldNotUsedInToString.html +++ b/plugins/generate-tostring/resources/inspectionDescriptions/FieldNotUsedInToString.html @@ -2,18 +2,12 @@
- 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.

This inspection will also check for problems with getter methods if 'enable getters in code generation' is enabled in settings. -

- 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 'Field XXX is never assigned'. -

- Notice 'on-the-fly' should be enabled from the settings to this plugin.