rebuilding head

[mir.git] / source / mir / producer / ProducerNode.java

diff --git a/source/mir/producer/ProducerNode.java b/source/mir/producer/ProducerNode.java
index 084e58e..2e0f7c8 100755 (executable)
--- a/source/mir/producer/ProducerNode.java
+++ b/source/mir/producer/ProducerNode.java
@@ -18,13 +18,13 @@
  * 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,
+ * 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.
  * If you do not wish to do so, delete this exception statement from your version.
  */
 package mir.producer;
@@ -33,6 +33,14 @@ import java.util.Map;
 
 import mir.log.LoggerWrapper;
 
+/**
+ * A <code>ProducerNode</code> is an atom of a noded producer factory.
+ *
+ */
 public interface ProducerNode {
+  /**
+   * Perform the operations of the producer node, based on a verb and a value set.
+   * The supplied logger object should be used for any logging.
+   */
   public void produce(Map aValueSet, String aVerb, LoggerWrapper aLogger) throws ProducerExc, ProducerFailure;
 }
\ No newline at end of file