VersionNumber: Add API doc for string parsing

1 files changed, 7 insertions, 0 deletions

diff --git a/src/java/com/jogamp/common/util/VersionNumber.java b/src/java/com/jogamp/common/util/VersionNumber.java
index 1bf9dbf..a35c15e 100644
--- a/src/java/com/jogamp/common/util/VersionNumber.java
+++ b/src/java/com/jogamp/common/util/VersionNumber.java
@@ -43,6 +43,13 @@ public class VersionNumber implements Comparable<Object> {
     }
 
     /**
+     * Parser first tokenizes the input versionString w/ given delimiter.
+     * <p>
+     * Each token will represent major, minor and sub version number component.
+     * </p>
+     * <p>
+     * For each token it ignores any leading non-digit and uses only contiguous digits, i.e. ignores pending non-digits. 
+     * </p>
      * @param versionString should be given as [MAJOR[.MINOR[.SUB]]]
      * @param delim the delimiter, e.g. "."
      */