spring-boot icon indicating copy to clipboard operation
spring-boot copied to clipboard

Review modules that are included in the aggregated javadoc

Open wilkinsona opened this issue 3 years ago • 0 comments

We have some modules that contain public classes that we really consider to be internal. Such modules include:

  • spring-boot-configuration-processor
  • spring-boot-autoconfigure-processor

There are others that we may also want to consider such as spring-boot-properties-migrator, spring-boot-configuration-metadata, spring-boot-loader-tools, spring-boot-buildpack-platform, and so on. While we may want some of these to remain public, I think we should consider publishing their javadoc separately – as we already do with the Gradle and Maven plugins – so that they're not cluttering the main API javadoc with classes that few users will care about.

wilkinsona avatar Aug 02 '22 09:08 wilkinsona

We talked about this today and felt that everything in spring-boot-tools doesn't need to be included in the aggregated javadoc. Rather than publishing javadoc for these tools separately, we're not convinced that it needs to be published to docs.spring.io at all. We also discussed spring-boot-properties-migrator moving into spring-boot-tools. It is currently in spring-boot-project due to a limitation of the Maven-based build that no longer applies.

wilkinsona avatar Aug 11 '22 15:08 wilkinsona