svn commit: r1065207 - /commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/JavaVersion.java

[bayard]

Author: bayard
Date: Sun Jan 30 07:35:35 2011
New Revision: 1065207

URL: http://svn.apache.org/viewvc?rev=1065207&view=rev
Log:
Adding javadoc for public method

Modified:
    
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/JavaVersion.java

Modified: 
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/JavaVersion.java
URL: 
http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/JavaVersion.java?rev=1065207&r1=1065206&r2=1065207&view=diff
==============================================================================
--- 
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/JavaVersion.java
 (original)
+++ 
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/JavaVersion.java
 Sun Jan 30 07:35:35 2011
@@ -43,6 +43,17 @@ public enum JavaVersion {
         this.name = name;
     }
 
+    /**
+     * Whether this version of Java is at least the version 
+     * of Java passed in.
+     *
+     * For example:
+     *  myVersion.atLeast(JavaVersion.JAVA_1_4)
+     *
+     * @param requiredVersion to check this version is at least equivalent to
+     *
+     * @return Whether this version is at least the passed in version
+     */
     public boolean atLeast(JavaVersion requiredVersion) {
         return this.value >= requiredVersion.value;
     }