Implement MissingJavadoc Error Prone check

Add a consolidated MissingJavadoc Error Prone check that flags missing Javadoc comments on public classes, interfaces, enums, annotations, and public/protected methods and fields.

Also includes a special case for nested Builder classes to suggest a tailored diagnostic and prefix SuggestedFix.

PiperOrigin-RevId: 940399041
3 files changed
tree: f0fe9a9323c14fd3d688220051fce7e54fdf0c94
  1. .github/
  2. .idea/
  3. annotation/
  4. annotations/
  5. check_api/
  6. core/
  7. docgen/
  8. docgen_processor/
  9. docs/
  10. examples/
  11. refaster/
  12. test_helpers/
  13. type_annotations/
  14. util/
  15. .gitattributes
  16. .gitignore
  17. appveyor.yml
  18. AUTHORS
  19. bnd.bnd
  20. CONTRIBUTING.md
  21. COPYING
  22. KEYS.txt
  23. pom.xml
  24. README.md
README.md

Error Prone

Error Prone is a static analysis tool for Java that catches common programming mistakes at compile-time.

public class ShortSet {
  public static void main (String[] args) {
    Set<Short> s = new HashSet<>();
    for (short i = 0; i < 100; i++) {
      s.add(i);
      s.remove(i - 1);
    }
    System.out.println(s.size());
  }
}
error: [CollectionIncompatibleType] Argument 'i - 1' should not be passed to this method;
its type int is not compatible with its collection's type argument Short
      s.remove(i - 1);
              ^
    (see https://errorprone.info/bugpattern/CollectionIncompatibleType)
1 error

Getting Started

Our documentation is at errorprone.info.

Error Prone works with Bazel, Maven, Ant, and Gradle. See our installation instructions for details.

Developing Error Prone

Developing and building Error Prone is documented on the wiki.

Links