donaldp 01/04/20 19:53:22
Modified: src/java/org/apache/avalon/util Version.java
Log:
Updated the documentation.
Revision Changes Path
1.2 +10 -94 jakarta-avalon/src/java/org/apache/avalon/util/Version.java
Index: Version.java
===================================================================
RCS file: /home/cvs/jakarta-avalon/src/java/org/apache/avalon/util/Version.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Version.java 2001/02/24 03:59:37 1.1
+++ Version.java 2001/04/21 02:53:21 1.2
@@ -8,123 +8,39 @@
package org.apache.avalon.util;
/**
- * This document is NOT RIGHT.
+ * This class is used to hold version information pertaining to a Component or
interface.
* <p />
*
- * The version number of a <code>Block</code> is made up of three
+ * The version number of a <code>Component</code> is made up of three
* dot-separated fields:
* <p />
* "<b>major.minor.patchlevel</b>"
* <p />
- * and (optionally) by a fourth field (always <b>"-dev"</b>)
- * specifying that this version is under development.
- * <p />
* The <b>major</b>, <b>minor</b> and <b>patchlevel</b> fields are
* <i>integer</i> numbers represented in decimal notation and have the
* following meaning:
* <ul>
+ *
* <p /><li><b>major</b> - When the major version changes (in ex. from
* "1.5.12" to "2.0.0"), then backward compatibility
- * with previous releases is not granted (this usually happens this
- * <code>Block</code> is implementing a new major version of an interface
- * specified in <b>org.apache.avalon.blocks</b> package).
- * </li><p />
+ * with previous releases is not granted.</li><p />
+ *
* <p /><li><b>minor</b> - When the minor version changes (in ex. from
* "1.5.12" to "1.6.0"), then backward compatibility
* with previous releases is granted, but something changed in the
- * implementation (in ex. new features were added, the configuration
- * syntax may be different, or the <code>Block</code> is implementing a
- * new minor version of an interface specified in
- * <b>org.apache.avalon.blocks</b> package).
- * </li><p />
+ * implementation of the Component. (ie it methods could have been added)</li><p />
+ *
* <p /><li><b>patchlevel</b> - When the patchlevel version changes (in ex.
- * from "1.5.12" to "1.5.13"), then the only changed
- * things are fixes in the code implementation, but no new features or
- * changes were made to the behaviour of the code.
+ * from "1.5.12" to "1.5.13"), then the the changes are
+ * small forward compatible bug fixes or documentation modifications etc.
* </li>
* </ul>
- * <p />
- * The fourth field, optional and always "<b>-dev</b>" (in ex.
- * "1.5.12-dev") specifies that current <code>Block</code>
- * implementation is under development, and so may contain not-working
- * code or not all features were implemented.
- * <p />
- * <p />
- * <b>NOTE: The absence of the "-dev" tag does not endorse
- * any warranty of particular stability, safety or compliancy.
- * The only source for such informations is the (usually provided) license
- * file accompaining the block itself.</b>
- *
- * The class defining versioning pattern.
- * <p />
- * <p />
- * Any interface in <b>org.apache.avalon.blocks</b> package <b>MUST</b> provides
- * a Version instance containing versioning informations on this interface.<p />
- * Any BlockInfo returned by a Block implementation <b>MUST</b> provides a
- * Version instances containing versioning informations on this implementation.
- * <p /><p />
- * Version numbers are:<p />
- * "<b>major.minor.revision.dev</b>"
- * <p />
- * The <b>major</b> , <b>minor</b> and <b>revision</b>fields are <i>integer</i>
- * numbers represented in decimal notation and have the following meaning:
- * <ul><b> - Refering to an interface</b>
- * <ul>
- * <li><b>major</b> - When the major version changes (in ex. from
- * "1.5" to "2.0"), then backward compatibility with
- * previous releases is not granted.
- * </li><p />
- * <p /><li><b>minor</b> - When the minor version changes (in ex. from
- * "1.5" to "1.6"), then backward compatibility
- * with previous releases is granted, but something changed in the
- * interface (in ex. new methods were added).
- * </li><p />
- * <li><b>revision</b> - When refering to an interface may represent a change
- * in documentation or other minor changes. If some methods are modified a minor
- * version changes is needed.<p />
- * - When refering to a Block implementation this represent minor changes in
- * implementation like bugs fix.
- * </li><p />
- * <li><b>dev</b> - The boolean dev field specify if this Block or interface
- * is under development and not yet approved by the Java Apache
org.apache.avalon.interfaces;
- * developers group (mailing-list).
- * </li><p />
- * </ul>
- * </ul>
- * <ul><b> - Refering to a Block</b>
- * <ul>
- * <li><b>major</b> - When the major version changes (in ex. from
- * "1.5" to "2.0"), then backward compatibility with
- * previous releases is not granted.
- * </li><p />
- * <p /><li><b>minor</b> - When the minor version changes (in ex. from
- * "1.5" to "1.6"), then backward compatibility
- * with previous releases is granted, but something changed in the
- * interface (in ex. new methods were added).
- * </li><p />
- * <li><b>revision</b> - When refering to an interface may represent a change
- * in documentation or other minor changes. If some methods are modified a minor
- * version changes is needed.<p />
- * - When refering to a Block implementation this represent minor changes in
- * implementation like bugs fix.
- * </li><p />
- * <li><b>dev</b> - The boolean dev field specify if this Block or interface
- * is under development and not yet approved by the Java Apache
org.apache.avalon.interfaces;
- * developers group (mailing-list).
- * </li><p />
- * </ul>
- * </ul>
- * The third field, optional and always "<b>-dev</b>" (in ex.
- * "1.5-dev") specifies that the interface is currently under
- * development, or it was not yet approved by the Java Apache
org.apache.avalon.interfaces;
- * developers group (mailing-list) and so, not yet integrated with the
- * org.apache.avalon.interfaces; distributions.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Federico Barbieri</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Pierpaolo Fumagalli</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Stefano Mazzocchi</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Roberto Lo Giacco</a>
- * @author <a href="http://java.apache.org/">Java Apache Project</a>
+ * @author <a href="mailto:[EMAIL PROTECTED]">Peter Donald</a>
*/
public final class Version
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
