summaryrefslogtreecommitdiff
path: root/src/main/java/bjc/esodata/AbbrevMap2.java
diff options
context:
space:
mode:
authorBen Culkin <scorpress@gmail.com>2020-04-06 22:06:07 -0400
committerBen Culkin <scorpress@gmail.com>2020-04-06 22:06:07 -0400
commitdd04fa3a64f7f9ea03691821eaa22a870e7a0529 (patch)
tree544d424f87c632c5ae0a64e61c9a87ee9d465934 /src/main/java/bjc/esodata/AbbrevMap2.java
parent4bb080869e6770f7d707cc53b72cabf7a6de8ea5 (diff)
Cleanup some warnings
Cleanup some warnings
Diffstat (limited to 'src/main/java/bjc/esodata/AbbrevMap2.java')
-rw-r--r--src/main/java/bjc/esodata/AbbrevMap2.java9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/main/java/bjc/esodata/AbbrevMap2.java b/src/main/java/bjc/esodata/AbbrevMap2.java
index f79a2d2..db41471 100644
--- a/src/main/java/bjc/esodata/AbbrevMap2.java
+++ b/src/main/java/bjc/esodata/AbbrevMap2.java
@@ -3,7 +3,14 @@ package bjc.esodata;
import java.util.*;
/**
- * A revised version of {@link AbbrevMap}
+ * A map that allows you to reference strings by unambiguous abbreviations to them.
+ *
+ * One example is that adding the string 'abc' would allow you to get it back with the following three keys
+ * <ul>
+ * <li>a</li>
+ * <li>ab</li>
+ * <li>abc</li>
+ * </ul>
*
* @author Ben Culkin
*/