Skip to content
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

Configuration property javadoc could not use Javadoc tags #932

Closed
snicoll opened this issue Oct 16, 2018 · 5 comments
Closed

Configuration property javadoc could not use Javadoc tags #932

snicoll opened this issue Oct 16, 2018 · 5 comments
Assignees
Labels
polish A general improvement (naming things, fixing minor issues, etc.)
Milestone

Comments

@snicoll
Copy link
Contributor

snicoll commented Oct 16, 2018

The field javadoc for configuration properties can't use javadoc tag as it's used as the source for the key's description.

There is an example here. It would be nice to review the others to see if that pattern isn't used anywhere else.

@jkschneider jkschneider added this to the 1.1.0-rc.2 milestone Oct 16, 2018
@jkschneider jkschneider added the polish A general improvement (naming things, fixing minor issues, etc.) label Oct 16, 2018
@snicoll
Copy link
Contributor Author

snicoll commented Oct 16, 2018

Can we reopen this please? This commit adds even more javadoc tags. None of the {@ thing is supported.

@izeye
Copy link
Contributor

izeye commented Oct 16, 2018

@snicoll If the commit you pointed is 3cd2dab, it's for AppOpticsConfig, not for AppOpticsProperties. AppOpticsProperties has been fixed in 289977b.

I'll reopen this to check there are more cases across codebase.

@izeye izeye reopened this Oct 16, 2018
@izeye
Copy link
Contributor

izeye commented Oct 16, 2018

And I'll also align Javadoc for configuration properties with Spring Boot 2.x's if possible.

@izeye izeye self-assigned this Oct 16, 2018
@snicoll
Copy link
Contributor Author

snicoll commented Oct 16, 2018

Thanks @izeye

@izeye
Copy link
Contributor

izeye commented Oct 16, 2018

@snicoll @jkschneider I didn't find any issue with Javadoc at least in configuration properties for meter registries. I created #938 to align configuration properties for meter registries with Spring Boot 2.x.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
polish A general improvement (naming things, fixing minor issues, etc.)
Projects
None yet
Development

No branches or pull requests

3 participants