[maven-enforcer] 04/05: Change javadoc for RequireJavaVendor.setName to better explain how it works

[rf...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rfscholte pushed a commit to branch MENFORCER-338
in repository https://gitbox.apache.org/repos/asf/maven-enforcer.git

commit a25d721ab05465270300634e12ea0c25799c3869
Author: Tim <ti...@dpgmedia.nl>
AuthorDate: Fri Jul 31 11:51:18 2020 +0200

    Change javadoc for RequireJavaVendor.setName to better explain how it works
---
 .../java/org/apache/maven/plugins/enforcer/RequireJavaVendor.java   | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireJavaVendor.java b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireJavaVendor.java
index f3f297a..5d2444e 100644
--- a/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireJavaVendor.java
+++ b/enforcer-rules/src/main/java/org/apache/maven/plugins/enforcer/RequireJavaVendor.java
@@ -54,9 +54,11 @@ public class RequireJavaVendor extends AbstractNonCacheableEnforcerRule
 
     /**
      * Specify the required name. Some examples are:
+     * Name should be an exact match of the System Property java.vendor, which you can also see with mvn --version
+     *
      * <ul>
-     * <li><code>AdoptOpenJDK</code> enforces name AdoptOpenJDK </li>
-     * <li><code>Java.net</code> enforces name Amazon </li>
+     * <li><code>AdoptOpenJDK</code> enforces vendor name AdoptOpenJDK </li>
+     * <li><code>Amazon</code> enforces vendor name Amazon </li>
      * </ul>
      *
      * @param name the required name to set