← All recipes
Moderne licensed

Find public methods missing Javadoc

Recipe IDorg.openrewrite.staticanalysis.FindMissingJavadocOnPublicMethods
Artifactorg.openrewrite.recipe:rewrite-static-analysis

Locates public method declarations that are not documented with a Javadoc comment, marks them with a search result, and records them in a data table.

Single recipeMSAL

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.staticanalysis.FindMissingJavadocOnPublicMethods

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-static-analysis:2.40.0

Data tables

Structured output this recipe can produce.

  • Public methods missing JavadocPublic method declarations that are not documented with a Javadoc comment.org.openrewrite.staticanalysis.table.MissingJavadocOnPublicMethods
  • Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
  • Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
  • Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
  • Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats