Added some javadoc

Added javadoc help for making easier to compare two versions in command line.

Project: http://git-wip-us.apache.org/repos/asf/maven/repo
Commit: http://git-wip-us.apache.org/repos/asf/maven/commit/3925163f
Tree: http://git-wip-us.apache.org/repos/asf/maven/tree/3925163f
Diff: http://git-wip-us.apache.org/repos/asf/maven/diff/3925163f

Branch: refs/heads/MNG-6169_2/not-updated-MJAR-MCOMPILER
Commit: 3925163f2314f9a6379a3ff6ddb72768ea183fe2
Parents: 4751114
Author: LuboVarga <lubomir.va...@nike.sk>
Authored: Mon Mar 13 13:23:04 2017 +0100
Committer: Michael Osipov <micha...@apache.org>
Committed: Thu May 11 19:54:09 2017 +0200

----------------------------------------------------------------------
 .../maven/artifact/versioning/ComparableVersion.java   | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/maven/blob/3925163f/maven-artifact/src/main/java/org/apache/maven/artifact/versioning/ComparableVersion.java
----------------------------------------------------------------------
diff --git 
a/maven-artifact/src/main/java/org/apache/maven/artifact/versioning/ComparableVersion.java
 
b/maven-artifact/src/main/java/org/apache/maven/artifact/versioning/ComparableVersion.java
index 5222871..0ae4acb 100644
--- 
a/maven-artifact/src/main/java/org/apache/maven/artifact/versioning/ComparableVersion.java
+++ 
b/maven-artifact/src/main/java/org/apache/maven/artifact/versioning/ComparableVersion.java
@@ -472,8 +472,19 @@ public class ComparableVersion
 
     /**
      * Main to test version parsing and comparison.
+     * <p>
+     * To check how "1.2.7" compares to "1.2-SNAPSHOT" for example, you can 
issue
+     * <code>java -cp 
~/.m2/repository/org/apache/maven/maven-artifact/3.3.9/maven-artifact-3.3.9.jar 
org.apache.maven.artifact.versioning.ComparableVersion "1.2.7" 
"1.2-SNAPSHOT"</code>
+     * command to commandline. Result of given command will be something like 
this:
+     * <pre
+     * Display parameters as parsed by Maven (in canonical form) and 
comparison result:
+     * 1. 1.2.7 == 1.2.7
+     *    1.2.7 > 1.2-SNAPSHOT
+     * 2. 1.2-SNAPSHOT == 1.2-snapshot
+     * </pre>
      *
-     * @param args the version strings to parse and compare
+     * @param args the version strings to parse and compare. You can pass 
arbitrary number of version strings and always
+     * two adjacent will be compared
      */
     public static void main( String... args )
     {

Reply via email to