hoplite icon indicating copy to clipboard operation
hoplite copied to clipboard

Add documentation to configuration paramters

Open U1F984 opened this issue 9 months ago • 1 comments

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 https://github.com/JetBrains/java-annotations/issues/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.

U1F984 avatar Apr 29 '24 10:04 U1F984

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

sksamuel avatar Jun 03 '24 04:06 sksamuel