java inspections - fix descriptions

GitOrigin-RevId: b628c4204c612954bcdd226d78d752525dabf523
2026-09-27 10:03:11 +07:00 · 2021-04-29 07:32:15 +00:00
parent d1923f9b36
commit e32a42a8a0
3 changed files with 14 additions and 25 deletions
@@ -8,35 +8,18 @@ Only calls that target fields of the current class are reported by this inspecti
 <p>Example:</p>
 <pre>
  class Queue {
-    // ...
-    private final Lock lock = new ReentrantLock();
-    private final Condition isEmpty = lock.newCondition();
-    private int size = 0;
+    private final Condition isEmpty = ...;

    void add(Object elem) {
-      lock.lock();
-      try {
-          // ...
-          size++;
-          // isEmpty.signal();
-          // ...
-      } finally {
-          lock.unlock();
-      }
+      // ...
+      // isEmpty.signal();
+      // ...
    }

    void remove(Object elem) throws InterruptedException {
-      lock.lock();
-      try {
-          // ...
-          while (size <= 0) {
-            isEmpty.await(); // 'await()' doesn't contain corresponding 'signal()'/'signalAll()' call
-          }
-          size--;
-          // ...
-      } finally {
-          lock.unlock();
-      }
+      // ...
+      isEmpty.await(); // 'await()' doesn't contain corresponding 'signal()'/'signalAll()' call
+      // ...
    }
  }
 </pre>
@@ -2,6 +2,12 @@
 <body>
 Reports the newline (<code>\n</code>) or return (<code>\r</code>) characters in a string or
 character literal. These characters are commonly used as line separators, and portability may suffer if they are hardcoded.
+<p>Example:</p>
+<pre>
+  void test() {
+    String str = "first\nsecond\rthird";
+  }
+</pre>
 <!-- tooltip end -->
 <p>
 </body>
@@ -1,6 +1,6 @@
 <html>
 <body>
-Reports any references to variables that are checked for nullity
+Reports any references to variables that are checked for nullability
 in the condition of an <code>if</code> statement or
 conditional expression but which are not used inside the
 <code>if</code> statement. Usually this either means that