Confusing javadoc in YamlProcessor.setDocumentMatchers [SPR-16849]

[spring-projects-issues]

Georgios Andrianakis opened SPR-16849 and commented

Currently the Javadoc of YamlProcessor.setDocumentMatchers states, that it can be used with something like:

 

YamlProcessor.mapMatcher({"environment": "prod"})

 

 which is somewhat confusing since mapMatcher is not a method of YamlProcessor. 

I propose that the javadoc shows a use case like the one that is used in the tests (see here) 

I can of course create a PR for this if it's something that you deem is worth changing

 

Thanks

---

Affects: 4.3.17, 5.0.6

Reference URL:

spring-framework/spring-beans/src/main/java/org/springframework/beans/factory/config/YamlProcessor.java

Line 83 in f5e8f49

* <code>documentMatchers = YamlProcessor.mapMatcher({"environment": "prod"})</code>

Referenced from: commits 455d8ac, 357ca21, 7ece0e2

Backported to: 4.3.18