spring-projects / spring-projects/spring-modulith

`SpringModulithProcessor` from apt rewrites `javadoc.json` if application modules in different gradle modules

Open
#1,133 6 comments 0 reactions 1 assignee View on GitHub

@odrotbohm is already working on this.

Since Apr 1, 2025.

in: documentation support meta: waiting for feedback
Dominant language
Java
Stars
1.2k
Forks
222
PR merge metrics
No merged PRs in 30d

Description

I have a multi-module Gradle project with application modules in different Gradle modules. I've added apt to gather Javadoc for documentation, and it runs separately for each module. However, each module overwrites the javadoc.json file content.

I'm uncertain about the best way to handle this. A solution that comes to mind is to generate a javadoc.json file in each module's build directory and then, when creating SpringModulithDocumentationSource, parse all build directories for javadoc.json files and consolidate them into one instance.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.