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

Add documentation to configuration paramters #417

Open
U1F984 opened this issue Apr 29, 2024 · 1 comment
Open

Add documentation to configuration paramters #417

U1F984 opened this issue Apr 29, 2024 · 1 comment

Comments

@U1F984
Copy link

U1F984 commented Apr 29, 2024

It would be great if there was a way to add documentation to configuration parameters. The documentation could be shown in the config report and in case any parameters are missing.

I've also created an issue in JetBrains/java-annotations#104, so if that is approved this standard annotation could be used to provide IDE support to such documentation.

If there is interest in this feature I'm willing to try to implement it.

@sksamuel
Copy link
Owner

sksamuel commented Jun 3, 2024

I think this sounds like a good idea. Would be happy to see a PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants