merged 1.1 branch into head

[mir.git] / source / mir / generator / WriterEngine.java

diff --git a/source/mir/generator/WriterEngine.java b/source/mir/generator/WriterEngine.java
index 47ebf4d..a845794 100755 (executable)
--- a/source/mir/generator/WriterEngine.java
+++ b/source/mir/generator/WriterEngine.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2001, 2002 The Mir-coders group
+ * Copyright (C) 2005 The Mir-coders group
  *
  * This file is part of Mir.
  *
@@ -18,27 +18,25 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
  * In addition, as a special exception, The Mir-coders gives permission to link
- * the code of this program with  any library licensed under the Apache Software License, 
- * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library 
- * (or with modified versions of the above that use the same license as the above), 
- * and distribute linked combinations including the two.  You must obey the 
- * GNU General Public License in all respects for all of the code used other than 
- * the above mentioned libraries.  If you modify this file, you may extend this 
- * exception to your version of the file, but you are not obligated to do so.  
+ * the code of this program with  any library licensed under the Apache Software License.
+ * You must obey the GNU General Public License in all respects for all of the code used
+ * other than the above mentioned libraries.  If you modify this file, you may extend this
+ * exception to your version of the file, but you are not obligated to do so.
  * If you do not wish to do so, delete this exception statement from your version.
  */
-
 package mir.generator;
 
 /**
- * <p>Title: </p>
- * <p>Description: </p>
- * <p>Copyright: Copyright (c) 2002</p>
- * <p>Company: </p>
- * @author unascribed
- * @version 1.0
+ * <p>A WriterEngine creates  a java PrinterWriter object for writing
+ * formated output to a file.   The openWriter method creates a Writer
+ * given a  filename and an  encoding.  The closeWriter  method closes
+ * the writer.</p>
+ * 
+ * <p>      This      interface      allows     customization  via the
+ * MirGeneratorLocalizer.makeWriterEngine() method. The created writer is 
+ * used for 
+ * specifying where the output of a Generator should go.</p>
  */
-
 public interface WriterEngine {
   public Object openWriter(String anIdentifier, String aParameter) throws GeneratorExc, GeneratorFailure;
   public void closeWriter(Object aWriter) throws GeneratorExc, GeneratorFailure;