From: Javen O'Neal <onealj@apache.org>
Date: Tue, 5 Jul 2016 23:33:31 +0000 (+0000)
Subject: bug 59804: javadoc update
X-Git-Tag: REL_3_15_BETA3~180
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=c02052c5559b960a7a44e924446bb5a932d94b96;p=poi.git

bug 59804: javadoc update

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1751574 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/src/java/org/apache/poi/util/Removal.java b/src/java/org/apache/poi/util/Removal.java
index 75d0dabdcd..a94be1e633 100644
--- a/src/java/org/apache/poi/util/Removal.java
+++ b/src/java/org/apache/poi/util/Removal.java
@@ -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"
      */