cleanup / abuse system fix / prepping for a release

[mir.git] / source / mir / bundle / Bundle.java

diff --git a/source/mir/bundle/Bundle.java b/source/mir/bundle/Bundle.java
index 3e46b85..0b92ff1 100755 (executable)
--- a/source/mir/bundle/Bundle.java
+++ b/source/mir/bundle/Bundle.java
@@ -32,9 +32,15 @@ package mir.bundle;
 import java.util.List;
 
 /**
- * bundles are key/value pairs in a text file, used for config 
- * and internationalization
+ * A Bundle represents a set  key/value pairs, for instane stored in a
+ * ".properties" text  file. Bundles are used for internationalization
+ * (language translations).
  */
 public interface Bundle {
+  /**
+   * Returns a bundle value. The argument list is used  for formating the
+   * returned value: braced expressions like {0}, {1} are replaced with
+   * appropriate parameter
+   */
   public String getValue(String aKey, List anArguments);
 }