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 75d0dabdcd73ada3c46faff8844789e1d4b48cb0..a94be1e6332560634cf0dc6c30edf49da86daba0 100644 (file)
--- 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"
      */