From 9b643f388a4e6db4ba5199b6da6c2ab94dc99026 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yann=20C=C3=A9bron?= Date: Wed, 17 May 2017 17:55:55 +0200 Subject: [PATCH] [devkit] Cleanup/align/format inspection descriptions --- .../inspectionDescriptions/ComponentRegistrationProblems.html | 2 +- .../inspectionDescriptions/DontUsePairConstructor.html | 3 +-- .../resources/inspectionDescriptions/FileEqualsUsage.html | 4 ++-- .../inspectionDescriptions/GtkPreferredJComboBoxRenderer.html | 4 ++-- .../inspectionDescriptions/InspectionUsingGrayColors.html | 2 +- .../QuickFixGetFamilyNameViolation.html | 2 +- .../devkit/resources/inspectionDescriptions/StatefulEp.html | 4 ++-- .../inspectionDescriptions/UnsafeReturnStatementVisitor.html | 1 - .../resources/inspectionDescriptions/UnsafeVfsRecursion.html | 4 ++-- .../devkit/resources/inspectionDescriptions/UseCouple.html | 4 +--- .../resources/inspectionDescriptions/UseDPIAwareInsets.html | 3 +-- .../devkit/resources/inspectionDescriptions/UseJBColor.html | 4 ++-- .../resources/inspectionDescriptions/UsePrimitiveTypes.html | 2 +- .../inspectionDescriptions/UseVirtualFileEquals.html | 2 +- 14 files changed, 18 insertions(+), 23 deletions(-) diff --git a/plugins/devkit/resources/inspectionDescriptions/ComponentRegistrationProblems.html b/plugins/devkit/resources/inspectionDescriptions/ComponentRegistrationProblems.html index eeddcef6c4fd..751819bd3f00 100644 --- a/plugins/devkit/resources/inspectionDescriptions/ComponentRegistrationProblems.html +++ b/plugins/devkit/resources/inspectionDescriptions/ComponentRegistrationProblems.html @@ -9,7 +9,7 @@ This inspection finds various problems about incorrect registration of plugin co
  • Unresolved component/action implementation-classes (plugin.xml)
  • Unresolved component interface-classes (plugin.xml)
  • Component implementation-class is not assignable to its interface-class (plugin.xml)
    • -
  • Incorrect component registration, e.g. ProjectComponent is registered as Application Component +
  • Incorrect component registration, e.g. ProjectComponent is registered as Application Component or the class doesn't implement any component interface at all (plugin.xml / Java Code)
  • Incorrect class modifiers: Action classes must be public and must have a public diff --git a/plugins/devkit/resources/inspectionDescriptions/DontUsePairConstructor.html b/plugins/devkit/resources/inspectionDescriptions/DontUsePairConstructor.html index d1cb8f0582a4..d760b1a2bad7 100644 --- a/plugins/devkit/resources/inspectionDescriptions/DontUsePairConstructor.html +++ b/plugins/devkit/resources/inspectionDescriptions/DontUsePairConstructor.html @@ -1,6 +1,5 @@ -Using of Pair constructor produces unnecessary generic declarations. Use Pair.create(a, b) - +Using of Pair constructor produces unnecessary generic declarations. Use Pair.create(a, b) \ No newline at end of file diff --git a/plugins/devkit/resources/inspectionDescriptions/FileEqualsUsage.html b/plugins/devkit/resources/inspectionDescriptions/FileEqualsUsage.html index 11e81ca8f8cd..ab5e6b21e38d 100644 --- a/plugins/devkit/resources/inspectionDescriptions/FileEqualsUsage.html +++ b/plugins/devkit/resources/inspectionDescriptions/FileEqualsUsage.html @@ -1,6 +1,6 @@ -This inspection detects usages of File.equals/hashCode/compareTo methods - which do not honor case-insensitivity on Mac OS X. -Please use FileUtil.filesEquals/fileHashCode/compareFiles methods instead. +This inspection detects usages of File.equals/hashCode/compareTo methods - which do not honor case-insensitivity on Mac OS. +Please use FileUtil.filesEquals/fileHashCode/compareFiles methods instead. diff --git a/plugins/devkit/resources/inspectionDescriptions/GtkPreferredJComboBoxRenderer.html b/plugins/devkit/resources/inspectionDescriptions/GtkPreferredJComboBoxRenderer.html index d3b71cfba828..bb36899a61a9 100644 --- a/plugins/devkit/resources/inspectionDescriptions/GtkPreferredJComboBoxRenderer.html +++ b/plugins/devkit/resources/inspectionDescriptions/GtkPreferredJComboBoxRenderer.html @@ -1,6 +1,6 @@ -This inspection detects usages of DefaultListCellRenderer - which causes ugly UI under GTK+ L&F. -Please use ListCellRendererWrapper (or its inheritors) instead. +This inspection detects usages of DefaultListCellRenderer - which causes ugly UI under GTK+ L&F. +Please use ListCellRendererWrapper (or its inheritors) instead. diff --git a/plugins/devkit/resources/inspectionDescriptions/InspectionUsingGrayColors.html b/plugins/devkit/resources/inspectionDescriptions/InspectionUsingGrayColors.html index 7e59681963f1..926a0608f330 100644 --- a/plugins/devkit/resources/inspectionDescriptions/InspectionUsingGrayColors.html +++ b/plugins/devkit/resources/inspectionDescriptions/InspectionUsingGrayColors.html @@ -1,5 +1,5 @@ -Use cache (com.intellij.ui.Gray) for gray colors. +Use cache (com.intellij.ui.Gray) for gray colors. diff --git a/plugins/devkit/resources/inspectionDescriptions/QuickFixGetFamilyNameViolation.html b/plugins/devkit/resources/inspectionDescriptions/QuickFixGetFamilyNameViolation.html index 8c9c1911784c..021a9c036b68 100644 --- a/plugins/devkit/resources/inspectionDescriptions/QuickFixGetFamilyNameViolation.html +++ b/plugins/devkit/resources/inspectionDescriptions/QuickFixGetFamilyNameViolation.html @@ -1,6 +1,6 @@ -Inspection reports cases when QuickFix#getFamilyName() +Inspection reports cases when QuickFix#getFamilyName() implementation uses non-static fields, methods, containing method local variables variables etc. \ No newline at end of file diff --git a/plugins/devkit/resources/inspectionDescriptions/StatefulEp.html b/plugins/devkit/resources/inspectionDescriptions/StatefulEp.html index 254ac913fe47..88b849eee063 100644 --- a/plugins/devkit/resources/inspectionDescriptions/StatefulEp.html +++ b/plugins/devkit/resources/inspectionDescriptions/StatefulEp.html @@ -1,6 +1,6 @@ -Potential memory leak detected. Please don't hold heavy objects in extensions if you're not a 100% sure. -In the ideal world, extensions should be stateless. +Potential memory leak detected. Please don't hold heavy objects in extensions if you're not 100% sure. +Ideally, extensions should be stateless. \ No newline at end of file diff --git a/plugins/devkit/resources/inspectionDescriptions/UnsafeReturnStatementVisitor.html b/plugins/devkit/resources/inspectionDescriptions/UnsafeReturnStatementVisitor.html index 73f28f37032f..34b51bf0a107 100644 --- a/plugins/devkit/resources/inspectionDescriptions/UnsafeReturnStatementVisitor.html +++ b/plugins/devkit/resources/inspectionDescriptions/UnsafeReturnStatementVisitor.html @@ -1,6 +1,5 @@ This inspection detects recursive visitors which process return statements despite that they belong to another class/lambda expression. In most cases it's a bug. - \ No newline at end of file diff --git a/plugins/devkit/resources/inspectionDescriptions/UnsafeVfsRecursion.html b/plugins/devkit/resources/inspectionDescriptions/UnsafeVfsRecursion.html index 89816f2b5876..dd006f128a1f 100644 --- a/plugins/devkit/resources/inspectionDescriptions/UnsafeVfsRecursion.html +++ b/plugins/devkit/resources/inspectionDescriptions/UnsafeVfsRecursion.html @@ -1,7 +1,7 @@ -This inspection detects calls of VirtualFile.getChildren() inside recursive methods. +This inspection detects calls of VirtualFile.getChildren() inside recursive methods. Such code may cause dead loops when iterating over cyclic symlinks - -so please use VfsUtilCore.visitChildrenRecursively() instead. +so please use VfsUtilCore.visitChildrenRecursively() instead. diff --git a/plugins/devkit/resources/inspectionDescriptions/UseCouple.html b/plugins/devkit/resources/inspectionDescriptions/UseCouple.html index f87d46c79b12..1809de7ef844 100644 --- a/plugins/devkit/resources/inspectionDescriptions/UseCouple.html +++ b/plugins/devkit/resources/inspectionDescriptions/UseCouple.html @@ -1,7 +1,5 @@ -Use Couple<T> instead of Pair<T, T> - - +Use Couple<T> instead of Pair<T, T> \ No newline at end of file diff --git a/plugins/devkit/resources/inspectionDescriptions/UseDPIAwareInsets.html b/plugins/devkit/resources/inspectionDescriptions/UseDPIAwareInsets.html index bef0f7fffe65..01f93760cd73 100644 --- a/plugins/devkit/resources/inspectionDescriptions/UseDPIAwareInsets.html +++ b/plugins/devkit/resources/inspectionDescriptions/UseDPIAwareInsets.html @@ -1,6 +1,5 @@ -Use JBUI.insets for DPI-aware insets - +Use JBUI.insets for DPI-aware insets \ No newline at end of file diff --git a/plugins/devkit/resources/inspectionDescriptions/UseJBColor.html b/plugins/devkit/resources/inspectionDescriptions/UseJBColor.html index 880c9c71c75e..1240f54289e1 100644 --- a/plugins/devkit/resources/inspectionDescriptions/UseJBColor.html +++ b/plugins/devkit/resources/inspectionDescriptions/UseJBColor.html @@ -1,6 +1,6 @@ -Use dark theme aware JBColor instead of java.awt.Color. -Use the JBColor constructor to specify regular and dark theme colors, to avoid using bad looking colors under the Darcula UI Theme. +Use dark theme aware JBColor instead of java.awt.Color. +Use the JBColor constructor to specify regular and dark theme colors, to avoid using bad looking colors under the Darcula UI Theme. \ No newline at end of file diff --git a/plugins/devkit/resources/inspectionDescriptions/UsePrimitiveTypes.html b/plugins/devkit/resources/inspectionDescriptions/UsePrimitiveTypes.html index aadc3c90ab8c..5d9d7ed2f1b2 100644 --- a/plugins/devkit/resources/inspectionDescriptions/UsePrimitiveTypes.html +++ b/plugins/devkit/resources/inspectionDescriptions/UsePrimitiveTypes.html @@ -1,5 +1,5 @@ -Primitive types should be compared with .equals due to java 8 type annotations also applicable to primitive types +Primitive types should be compared with .equals due to java 8 type annotations also applicable to primitive types \ No newline at end of file diff --git a/plugins/devkit/resources/inspectionDescriptions/UseVirtualFileEquals.html b/plugins/devkit/resources/inspectionDescriptions/UseVirtualFileEquals.html index 83e99b3d0433..73ef0c5c7d45 100644 --- a/plugins/devkit/resources/inspectionDescriptions/UseVirtualFileEquals.html +++ b/plugins/devkit/resources/inspectionDescriptions/UseVirtualFileEquals.html @@ -1,5 +1,5 @@ -Use equals instead of == when comparing VirtualFile objects +Use equals instead of == when comparing VirtualFile objects \ No newline at end of file