Improve Javadoc of ComparableVersion#main()

This closes #108


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

Branch: refs/heads/mvn-3.5.1/MNG-6174
Commit: 6a93bbea23e362c9cea7d710a37556258c2dbd47
Parents: 08f3c76 10a18cf
Author: Lubomir Varga <lubomir.va...@nike.sk>
Authored: Tue Apr 11 16:00:42 2017 +0200
Committer: Michael Osipov <micha...@apache.org>
Committed: Tue Apr 11 16:02:21 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/6a93bbea/maven-artifact/src/main/java/org/apache/maven/artifact/versioning/ComparableVersion.java
----------------------------------------------------------------------
diff --cc 
maven-artifact/src/main/java/org/apache/maven/artifact/versioning/ComparableVersion.java
index 5222871,0ae4acb..e1fc5f0
--- 
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 +472,19 @@@ public class ComparableVersio
  
      /**
       * 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
++     * Checks how "1.2.7" compares to "1.2-SNAPSHOT", for example, you can 
issue
++     * <code>java -cp 
${maven.repo.local}/org/apache/maven/maven-artifact/${maven.version}/maven-artifact-${maven.version}.jar
 org.apache.maven.artifact.versioning.ComparableVersion "1.2.7" 
"1.2-SNAPSHOT"</code>
++     * command to command line. 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
++     *    1.2.7 &gt; 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