incubator-depot-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nickcha...@apache.org
Subject svn commit: rev 36496 - incubator/depot/trunk/version/src/java/org/apache/depot/version
Date Tue, 17 Aug 2004 06:34:39 GMT
Author: nickchalko
Date: Mon Aug 16 23:34:38 2004
New Revision: 36496

Modified:
   incubator/depot/trunk/version/src/java/org/apache/depot/version/Version.java
   incubator/depot/trunk/version/src/java/org/apache/depot/version/VersionRuntime.java
Log:
Javadocs.

Modified: incubator/depot/trunk/version/src/java/org/apache/depot/version/Version.java
==============================================================================
--- incubator/depot/trunk/version/src/java/org/apache/depot/version/Version.java	(original)
+++ incubator/depot/trunk/version/src/java/org/apache/depot/version/Version.java	Mon Aug 16
23:34:38 2004
@@ -40,27 +40,23 @@
 //
 
 /**
- * This  Main version interface.
+ * This  primary Version interface.
  * 
  * This class provides NO restrictions on what and how to 
  * order and format or display version.  How it is created incremented or 
  * displayed is completly independent.
  * 
  * Given Version objects a and b
- * a.equals(b) iff b.equals(a)
- * a.compare(b) == 0 iff a.equals(b)
- * a.equals(b) --> a.hashCode() == b.hashCode()
- * 
- * a.equals(b) --> a.isCompatible(b)
- * 
- * BUT what about 
- * a.compare(b) < 0  --> ! a.isCompatible(b) 
- *  
+ * <ul>
+ * <li>a.equals(b) iff b.equals(a)</li>
+ *  <li>a.compare(b) == 0 iff a.equals(b)</li>
+ *  <li>a.equals(b) --> a.hashCode() == b.hashCode()</li>
+ *  <li>a.equals(b) --> a.isCompatible(b)</li>
+ * </ul>
+ *  <br/>
  * NOTE:  Version should be implemented as a Immutable object.
  * 
- * @author Nick Chalko
- * @author $Author: chalko $
- * @version $Revision: 1.5 $
+ * @version $ $
  */
 public interface Version extends Comparable {
 
@@ -72,7 +68,7 @@
     /**
      * May this version be used in place of the specified version.
      * @param version the BaseVersion to check with
-     * @return boolean
+     * @return boolean true iff this Version may be used in place of the specified version.
      */
     boolean isCompatible(Version version);
 
@@ -88,7 +84,7 @@
     Version increment(String level) throws VersionException;
 
     /**
-     * Gets the default Comparator.
+     * Gets version Comparator.  Usefull for sorting.
      * The Comparator will throw a IllegalArgument of the two objects do not
      * have exactly the same id.
      * @return Comparator

Modified: incubator/depot/trunk/version/src/java/org/apache/depot/version/VersionRuntime.java
==============================================================================
--- incubator/depot/trunk/version/src/java/org/apache/depot/version/VersionRuntime.java	(original)
+++ incubator/depot/trunk/version/src/java/org/apache/depot/version/VersionRuntime.java	Mon
Aug 16 23:34:38 2004
@@ -41,6 +41,9 @@
 import org.apache.depot.version.context.VersionRegistry;
 
 /**
+ * TODO: What is the purpose of the VersionRuntime?
+ * TODO: njc I think we should delete it.
+ * 
  * @author arb_jack@users.sourceforge.net
  */
 public class VersionRuntime {

Mime
View raw message