adding doc

diff --git a/source/mir/generator/Generator.java b/source/mir/generator/Generator.java
index 805d0cc..ead7ba1 100755 (executable)
--- a/source/mir/generator/Generator.java
+++ b/source/mir/generator/Generator.java
@@ -38,11 +38,18 @@ import java.util.Map;
 import mir.log.LoggerWrapper;
 
 /**
- * Interface representing a "generator", typically a template engine/
+ * A "generator" is an abstraction for a template
+ * If you need a generator, use MirGeneratorLocalizer  
  */
 public interface Generator {
+  /** This is the method that actually runs the template engine on this template
+   * @param anOutputWriter a writer to the file we want to generate, use the 
+   * MirGeneratorLocalizer to create a writer.
+   * @param aValues the key/value pairs which the template engine will use as variables 
+   */
   public void generate(Object anOutputWriter, Map aValues, LoggerWrapper aLogger) throws GeneratorExc, GeneratorFailure;
 
+  
   public static interface Library {
     public Generator makeGenerator(String anIdentifier) throws GeneratorExc, GeneratorFailure;
   }