Mentioned support for loading the rules file from the classpath in Ja…

…vaDoc. See mojohaus#193 for more.
obfischer · Aug 14, 2017 · f7dc2c8 · f7dc2c8
1 parent 72d2c9f
commit f7dc2c8
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/src/main/java/org/codehaus/mojo/versions/AbstractVersionsReport.java b/src/main/java/org/codehaus/mojo/versions/AbstractVersionsReport.java
@@ -160,7 +160,9 @@ public abstract class AbstractVersionsReport
     private String serverId;
 
     /**
-     * The Wagon URI of a ruleSet file containing the rules that control how to compare version numbers.
+     * URI of a ruleSet file containing the rules that control how to compare
+     * version numbers. The URI could be either a Wagon URI or a classpath URI
+     * (e.g. <code>classpath:///package/sub/package/rules.xml</code>).
      *
      * @since 1.0-alpha-3
      */

diff --git a/src/main/java/org/codehaus/mojo/versions/AbstractVersionsUpdaterMojo.java b/src/main/java/org/codehaus/mojo/versions/AbstractVersionsUpdaterMojo.java
@@ -148,7 +148,9 @@ public abstract class AbstractVersionsUpdaterMojo
     private String serverId;
 
     /**
-     * The Wagon URI of a ruleSet file containing the rules that control how to compare version numbers.
+     * URI of a ruleSet file containing the rules that control how to compare
+     * version numbers. The URI could be either a Wagon URI or a classpath URI
+     * (e.g. <code>classpath:///package/sub/package/rules.xml</code>).
      *
      * @since 1.0-alpha-3
      */