Skip to content

configuration-processor does not pick up description from javadoc on inherited properties in different Maven modules #27820

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
fjakop opened this issue Aug 26, 2021 · 1 comment
Labels
status: duplicate A duplicate of another issue

Comments

@fjakop
Copy link

fjakop commented Aug 26, 2021

Affected version: Spring Boot 2.5.3
Build system: Maven 3.6.9

Consider a class annotated with @ConfigurationProperties extending another class located in a different Maven module in the same reactor, the description (JavaDoc) of the parent class' properties is not picked up by the configuration-processor and therefore not written to spring-configuration-metadata.json.

This is rather unhandy because we generate our configuration documentation out of the spring-configuration-metadata.json.

A sample project can be found here https://github.com/fjakop/spring-boot-configuration-processor-description

Check for BProperties#output and CProperties#filenamePattern in spring-configuration-metadata.json, there's no description but should be.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Aug 26, 2021
@snicoll
Copy link
Member

snicoll commented Aug 26, 2021

This is working as expected I am afraid. If the source code of BProperties is not available, we can't extract the documentation and default value as the annotation processor doesn't have access to the source model. If you were expecting it to read that from the generated output of moduleA, this isn't supported, see #18366

@snicoll snicoll closed this as completed Aug 26, 2021
@snicoll snicoll added status: duplicate A duplicate of another issue and removed status: waiting-for-triage An issue we've not yet triaged labels Aug 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: duplicate A duplicate of another issue
Projects
None yet
Development

No branches or pull requests

3 participants