[devkit] Cleanup/align/format inspection descriptions

2026-09-27 10:03:11 +07:00 · 2017-05-17 17:55:55 +02:00
parent 96ef3e613a
commit 9b643f388a
14 changed files with 18 additions and 23 deletions
@@ -9,7 +9,7 @@ This inspection finds various problems about incorrect registration of plugin co
        <li>Unresolved component/action implementation-classes (plugin.xml)</li>
        <li>Unresolved component interface-classes (plugin.xml)</li>
        <li>Component implementation-class is not assignable to its interface-class (plugin.xml)</li>
-        <li>Incorrect component registration, e.g. ProjectComponent is registered as Application Component
+        <li>Incorrect component registration, e.g. <code>ProjectComponent</code> is registered as Application Component
            or the class doesn't implement any component interface at all (plugin.xml / Java Code)
        </li>
        <li>Incorrect class modifiers: Action classes must be public and must have a public
@@ -1,6 +1,5 @@
 <html>
 <body>
-Using of Pair constructor produces unnecessary generic declarations. Use Pair.create(a, b)
-<!-- tooltip end -->
+Using of <code>Pair</code> constructor produces unnecessary generic declarations. Use <code>Pair.create(a, b)</code>
 </body>
 </html>
@@ -1,6 +1,6 @@
 <html>
 <body>
-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 <code>File.equals/hashCode/compareTo</code> methods - which do not honor case-insensitivity on Mac OS.
+Please use <code>FileUtil.filesEquals/fileHashCode/compareFiles</code> methods instead.
 </body>
 </html>
@@ -1,6 +1,6 @@
 <html>
 <body>
-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 <code>DefaultListCellRenderer</code> - which causes ugly UI under GTK+ L&F.
+Please use <code>ListCellRendererWrapper</code> (or its inheritors) instead.
 </body>
 </html>
@@ -1,5 +1,5 @@
 <html>
 <body>
-Use cache (com.intellij.ui.Gray) for gray colors.
+Use cache (<code>com.intellij.ui.Gray</code>) for gray colors.
 </body>
 </html>
@@ -1,6 +1,6 @@
 <html>
 <body>
-Inspection reports cases when <strong>QuickFix#getFamilyName()</strong>
+Inspection reports cases when <code>QuickFix#getFamilyName()</code>
 implementation uses non-static fields, methods, containing method local variables variables etc.
 </body>
 </html>
@@ -1,6 +1,6 @@
 <html>
 <body>
-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.
 </body>
 </html>
@@ -1,6 +1,5 @@
 <html>
 <body>
 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.
-<!-- tooltip end -->
 </body>
 </html>
@@ -1,7 +1,7 @@
 <html>
 <body>
-This inspection detects calls of VirtualFile.getChildren() inside recursive methods.
+This inspection detects calls of <code>VirtualFile.getChildren()</code> inside recursive methods.
 Such code may cause dead loops when iterating over cyclic symlinks -
-so please use VfsUtilCore.visitChildrenRecursively() instead.
+so please use <code>VfsUtilCore.visitChildrenRecursively()</code> instead.
 </body>
 </html>
@@ -1,7 +1,5 @@
 <html>
 <body>
-Use Couple&lt;T&gt; instead of Pair&lt;T, T&gt;
-<!-- tooltip end -->
-
+Use <code>Couple&lt;T&gt;</code> instead of <code>Pair&lt;T, T&gt;</code>
 </body>
 </html>
@@ -1,6 +1,5 @@
 <html>
 <body>
-Use JBUI.insets for DPI-aware insets
-<!-- tooltip end -->
+Use <code>JBUI.insets</code> for DPI-aware insets
 </body>
 </html>
@@ -1,6 +1,6 @@
 <html>
 <body>
-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 <code>JBColor</code> instead of <code>java.awt.Color</code>.
+Use the <code>JBColor</code> constructor to specify regular and dark theme colors, to avoid using bad looking colors under the Darcula UI Theme.
 </body>
 </html>
@@ -1,5 +1,5 @@
 <html>
 <body>
-Primitive types should be compared with .equals due to java 8 type annotations also applicable to primitive types 
+Primitive types should be compared with <code>.equals</code> due to java 8 type annotations also applicable to primitive types
 </body>
 </html>
@@ -1,5 +1,5 @@
 <html>
 <body>
-Use equals instead of == when comparing VirtualFile objects
+Use <code>equals</code> instead of <code>==</code> when comparing <code>VirtualFile</code> objects
 </body>
 </html>