[annotreach] document issues

Reviewed By: jvillard

Differential Revision: D22034683

fbshipit-source-id: b354d14b3

infer/documentation/issues/CHECKERS_ALLOCATES_MEMORY.md

@@ -0,0 +1,12 @@
+A method annotated with `@NoAllocation` transitively calls `new`.
+
+Example:
+
+```java
+class C implements I {
+  @NoAllocation
+  void directlyAllocatingMethod() {
+    new Object();
+  }
+}
+```

infer/documentation/issues/CHECKERS_ANNOTATION_REACHABILITY_ERROR.md

@@ -0,0 +1 @@
+A method annotated with an annotation `@A` transitively calls a method annotated `@B` where the combination of annotations is forbidden (for example, `@UiThread` calling `@WorkerThread`).

infer/documentation/issues/CHECKERS_CALLS_EXPENSIVE_METHOD.md

@@ -0,0 +1,15 @@
+A method annotated with `@PerformanceCritical` transitively calls a method annotated `@Expensive`.
+
+Example:
+
+```java
+class C {
+  @PerformanceCritical
+  void perfCritical() {
+    expensive();
+  }
+
+  @Expensive
+  void expensive() {}
+}
+```

infer/documentation/issues/CHECKERS_EXPENSIVE_OVERRIDES_UNANNOTATED.md

@@ -0,0 +1,14 @@
+A method annotated with `@Expensive` overrides an un-annotated method.
+
+Example:
+
+```java
+interface I {
+  void foo();
+}
+
+class A implements I {
+  @Expensive
+  public void foo() {}
+}
+```

infer/src/base/IssueType.ml

@@ -307,21 +307,27 @@ let captured_strong_self =
 let checkers_allocates_memory =
   register_from_string ~id:"CHECKERS_ALLOCATES_MEMORY" ~hum:"Allocates Memory" Error
     AnnotationReachability
+    ~user_documentation:[%blob "../../documentation/issues/CHECKERS_ALLOCATES_MEMORY.md"]
 
 
 let checkers_annotation_reachability_error =
   register_from_string ~id:"CHECKERS_ANNOTATION_REACHABILITY_ERROR"
     ~hum:"Annotation Reachability Error" Error AnnotationReachability
+    ~user_documentation:
+      [%blob "../../documentation/issues/CHECKERS_ANNOTATION_REACHABILITY_ERROR.md"]
 
 
 let checkers_calls_expensive_method =
   register_from_string ~id:"CHECKERS_CALLS_EXPENSIVE_METHOD" ~hum:"Expensive Method Called" Error
     AnnotationReachability
+    ~user_documentation:[%blob "../../documentation/issues/CHECKERS_CALLS_EXPENSIVE_METHOD.md"]
 
 
 let checkers_expensive_overrides_unexpensive =
   register_from_string ~id:"CHECKERS_EXPENSIVE_OVERRIDES_UNANNOTATED"
     ~hum:"Expensive Overrides Unannotated" Error AnnotationReachability
+    ~user_documentation:
+      [%blob "../../documentation/issues/CHECKERS_EXPENSIVE_OVERRIDES_UNANNOTATED.md"]
 
 
 let checkers_fragment_retain_view =