Mailing-List: contact commits-help@poi.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@poi.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1751574 - /poi/trunk/src/java/org/apache/poi/util/Removal.java
Date: Tue, 05 Jul 2016 23:33:31 -0000
To: commits@poi.apache.org
From: onealj@apache.org
Message-Id: <20160705233332.5255B3A023B@svn01-us-west.apache.org>
archived-at: Tue, 05 Jul 2016 23:33:36 -0000

Author: onealj
Date: Tue Jul  5 23:33:31 2016
New Revision: 1751574

URL: http://svn.apache.org/viewvc?rev=1751574&view=rev
Log:
bug 59804: javadoc update

Modified:
    poi/trunk/src/java/org/apache/poi/util/Removal.java

Modified: poi/trunk/src/java/org/apache/poi/util/Removal.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/util/Removal.java?rev=1751574&r1=1751573&r2=1751574&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/util/Removal.java (original)
+++ poi/trunk/src/java/org/apache/poi/util/Removal.java Tue Jul  5 23:33:31 2016
@@ -50,7 +50,10 @@ import java.lang.annotation.Documented;
 public @interface Removal {
     /**
      * The POI version when this feature may be removed.
-     *
+     * 
+     * To ensure that the version number can be compared to the current version
+     * and a unit test can generate a warning if a removal-eligible feature has
+     * not been removed yet, the version number should adhere to the following format:
      * Format: "(?<major>\d+)\.(?<minor>\d+)"
      * Example: "3.15"
      */


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org