Improve formatting of the code.

[gpl/argeo-slc.git] / org.argeo.slc / src / main / java / org / argeo / slc / core / build / VersionDistributionId.java

diff --git a/org.argeo.slc/src/main/java/org/argeo/slc/core/build/VersionDistributionId.java b/org.argeo.slc/src/main/java/org/argeo/slc/core/build/VersionDistributionId.java
index 44af89451030f37aaa6dbb109994ece72dd570b8..27ac020b3569f3cb9d68a2ee642617272ee5ed45 100644 (file)
--- a/org.argeo.slc/src/main/java/org/argeo/slc/core/build/VersionDistributionId.java
+++ b/org.argeo.slc/src/main/java/org/argeo/slc/core/build/VersionDistributionId.java
@@ -2,7 +2,19 @@ package org.argeo.slc.core.build;
 \r
 import java.util.StringTokenizer;\r
 \r
-\r
+/**\r
+ * <p>\r
+ * An implementation of the distribution id using the standard\r
+ * Major.Minor.Release notation. And additional arbitrary string can also be\r
+ * added.\r
+ * </p>\r
+ * \r
+ * <p>\r
+ * <b>Examples:</b><br>\r
+ * 0.2.6<br>\r
+ * 2.4.12.RC1\r
+ * </p>\r
+ */\r
 public class VersionDistributionId implements DistributionId {\r
 \r
        private Integer major;\r
@@ -10,6 +22,7 @@ public class VersionDistributionId implements DistributionId {
        private Integer release;\r
        private String additional;\r
 \r
+       /** Parse the provided string in order to set the various components. */\r
        public void setVersionString(String str) {\r
                StringTokenizer st = new StringTokenizer(str, ".");\r
                if (st.hasMoreTokens())\r