Back to Intellij Community

JavaDoc

java/java-impl/resources/inspectionDescriptions/JavaDoc.html

2025.3-rc-2684 B
Original Source

Reports the following Javadoc comment flaws:

  • No Javadoc where it is required
  • Required tag is missing
  • Invalid or incomplete tag
  • Javadoc description is missing or incomplete

Example:

class Main {
  }

After the quick-fix is applied:

/**
   *
   */
  class Main {
  }

Example:

String id(String value) {
    return value;
  }

After the quick-fix is applied:

/**
   * @param value
   * @return
   */
  String id(String value) {
    return value;
  }

Use the tabs and corresponding inspection options to define visibility scope in which Javadoc is required, as well as the required Javadoc tags for classes, methods, fields, and inner classes.