Check for Backpressure: in javadoc without annotation

Author: akarnokd

src/main/java/io/reactivex/Maybe.java

@@ -631,8 +631,6 @@ public static <T> Maybe<T> fromFuture(Future<? extends T> future) {
      * <p>
      * <em>Important note:</em> This Maybe is blocking on the thread it gets subscribed on; you cannot unsubscribe from it.
      * <dl>
-     *  <dt><b>Backpressure:</b></dt>
-     *  <dd>The operator honors backpressure from downstream.</dd>
      *  <dt><b>Scheduler:</b></dt>
      *  <dd>{@code fromFuture} does not operate by default on a particular {@link Scheduler}.</dd>
      * </dl>

src/test/java/io/reactivex/JavadocWording.java

@@ -179,6 +179,7 @@ public void maybeDocRefersToMaybeTypes() throws Exception {
                 }
                 aOrAn(e, m, "Maybe");
                 missingClosingDD(e, m, "Maybe");
+                backpressureMentionedWithoutAnnotation(e, m, "Maybe");
             }
         }
 
@@ -261,6 +262,7 @@ public void flowableDocRefersToFlowableTypes() throws Exception {
                 }
                 aOrAn(e, m, "Flowable");
                 missingClosingDD(e, m, "Flowable");
+                backpressureMentionedWithoutAnnotation(e, m, "Flowable");
             }
         }
 
@@ -345,6 +347,7 @@ public void observableDocRefersToObservableTypes() throws Exception {
                 }
                 aOrAn(e, m, "Observable");
                 missingClosingDD(e, m, "Observable");
+                backpressureMentionedWithoutAnnotation(e, m, "Observable");
             }
         }
 
@@ -500,6 +503,7 @@ public void singleDocRefersToSingleTypes() throws Exception {
 
                 aOrAn(e, m, "Single");
                 missingClosingDD(e, m, "Single");
+                backpressureMentionedWithoutAnnotation(e, m, "Single");
             }
         }
 
@@ -510,62 +514,6 @@ public void singleDocRefersToSingleTypes() throws Exception {
         }
     }
 
-    static void aOrAn(StringBuilder e, RxMethod m, String baseTypeName) {
-        aOrAn(e, m, "an", "Single", baseTypeName);
-        aOrAn(e, m, "an", "Maybe", baseTypeName);
-        aOrAn(e, m, "a", "Observer", baseTypeName);
-        aOrAn(e, m, "a", "Observable", baseTypeName);
-        aOrAn(e, m, "an", "Publisher", baseTypeName);
-        aOrAn(e, m, "an", "Subscriber", baseTypeName);
-        aOrAn(e, m, "an", "Flowable", baseTypeName);
-    }
-
-    static void aOrAn(StringBuilder e, RxMethod m, String wrongPre, String word, String baseTypeName) {
-        int jdx = 0;
-        for (;;) {
-            int idx = m.javadoc.indexOf(wrongPre + " " + word, jdx);
-            if (idx >= 0) {
-                e.append("java.lang.RuntimeException: a/an typo ")
-                .append(word)
-                .append("\r\n at io.reactivex.")
-                .append(baseTypeName)
-                .append(" (")
-                .append(baseTypeName)
-                .append(".java:").append(m.javadocLine + lineNumber(m.javadoc, idx) - 1).append(")\r\n\r\n");
-                jdx = idx + 6;
-            } else {
-                break;
-            }
-        }
-
-    }
-
-    static void missingClosingDD(StringBuilder e, RxMethod m, String baseTypeName) {
-        int jdx = 0;
-        for (;;) {
-            int idx1 = m.javadoc.indexOf("<dd>", jdx);
-            int idx2 = m.javadoc.indexOf("</dd>", jdx);
-
-            if (idx1 < 0 && idx2 < 0) {
-                break;
-            }
-
-            int idx3 = m.javadoc.indexOf("<dd>", idx1 + 4);
-
-            if (idx1 > 0 && idx2 > 0 && (idx3 < 0 || (idx2 < idx3 && idx3 > 0))) {
-                jdx = idx2 + 5;
-            } else {
-                e.append("java.lang.RuntimeException: unbalanced <dd></dd> ")
-                .append("\r\n at io.reactivex.")
-                .append(baseTypeName)
-                .append(" (")
-                .append(baseTypeName)
-                .append(".java:").append(m.javadocLine + lineNumber(m.javadoc, idx1) - 1).append(")\r\n\r\n");
-                break;
-            }
-        }
-    }
-
     @Test
     public void completableDocRefersToCompletableTypes() throws Exception {
         List<RxMethod> list = BaseTypeParser.parse(MaybeNo2Dot0Since.findSource("Completable"), "Completable");
@@ -710,6 +658,7 @@ public void completableDocRefersToCompletableTypes() throws Exception {
                 }
                 aOrAn(e, m, "Completable");
                 missingClosingDD(e, m, "Completable");
+                backpressureMentionedWithoutAnnotation(e, m, "Completable");
             }
         }
 
@@ -719,4 +668,71 @@ public void completableDocRefersToCompletableTypes() throws Exception {
             fail(e.toString());
         }
     }
+
+    static void aOrAn(StringBuilder e, RxMethod m, String baseTypeName) {
+        aOrAn(e, m, "an", "Single", baseTypeName);
+        aOrAn(e, m, "an", "Maybe", baseTypeName);
+        aOrAn(e, m, "a", "Observer", baseTypeName);
+        aOrAn(e, m, "a", "Observable", baseTypeName);
+        aOrAn(e, m, "an", "Publisher", baseTypeName);
+        aOrAn(e, m, "an", "Subscriber", baseTypeName);
+        aOrAn(e, m, "an", "Flowable", baseTypeName);
+    }
+
+    static void aOrAn(StringBuilder e, RxMethod m, String wrongPre, String word, String baseTypeName) {
+        int jdx = 0;
+        for (;;) {
+            int idx = m.javadoc.indexOf(wrongPre + " " + word, jdx);
+            if (idx >= 0) {
+                e.append("java.lang.RuntimeException: a/an typo ")
+                .append(word)
+                .append("\r\n at io.reactivex.")
+                .append(baseTypeName)
+                .append(" (")
+                .append(baseTypeName)
+                .append(".java:").append(m.javadocLine + lineNumber(m.javadoc, idx) - 1).append(")\r\n\r\n");
+                jdx = idx + 6;
+            } else {
+                break;
+            }
+        }
+
+    }
+
+    static void missingClosingDD(StringBuilder e, RxMethod m, String baseTypeName) {
+        int jdx = 0;
+        for (;;) {
+            int idx1 = m.javadoc.indexOf("<dd>", jdx);
+            int idx2 = m.javadoc.indexOf("</dd>", jdx);
+
+            if (idx1 < 0 && idx2 < 0) {
+                break;
+            }
+
+            int idx3 = m.javadoc.indexOf("<dd>", idx1 + 4);
+
+            if (idx1 > 0 && idx2 > 0 && (idx3 < 0 || (idx2 < idx3 && idx3 > 0))) {
+                jdx = idx2 + 5;
+            } else {
+                e.append("java.lang.RuntimeException: unbalanced <dd></dd> ")
+                .append("\r\n at io.reactivex.")
+                .append(baseTypeName)
+                .append(" (")
+                .append(baseTypeName)
+                .append(".java:").append(m.javadocLine + lineNumber(m.javadoc, idx1) - 1).append(")\r\n\r\n");
+                break;
+            }
+        }
+    }
+
+    static void backpressureMentionedWithoutAnnotation(StringBuilder e, RxMethod m, String baseTypeName) {
+        if (m.backpressureDocLine > 0 && m.backpressureKind == null) {
+            e.append("java.lang.RuntimeException: backpressure documented but not annotated ")
+            .append("\r\n at io.reactivex.")
+            .append(baseTypeName)
+            .append(" (")
+            .append(baseTypeName)
+            .append(".java:").append(m.backpressureDocLine).append(")\r\n\r\n");
+        }
+    }
 }