Improve documentation of configuration properties with type Map<String, NotAConfigGroup>
#40332
Labels
Milestone
Map<String, NotAConfigGroup>
#40332
Description
Configuration properties of type
Map<String, SomeConfigGroup>
, whereSomeConfigGroup
is a type annotated with@ConfigGroup
are handled nicely, with documentation clearly stating that the map key is included in the configuration property key:The name of the map key in the documentation can even be customized with
@ConfigDocMapKey("someName")
.On the other hand, configuration properties of type
Map<String, NotAConfigGroup>
, whereNotAConfigGroup
is a type that is not annotated with@ConfigGroup
, are not handled nicely at all:Also, adding
@ConfigDocMapKey("someName")
on such properties has no effect.We should display Maps the same way in the documentation, regardless of whether the value type is a config group or not.
Implementation ideas
No response
The text was updated successfully, but these errors were encountered: