adding doc/comments

[mir.git] / source / mircoders / producer / UnIndexingProducerNode.java

diff --git a/source/mircoders/producer/UnIndexingProducerNode.java b/source/mircoders/producer/UnIndexingProducerNode.java
index 95ed7a5..5e24115 100755 (executable)
--- a/source/mircoders/producer/UnIndexingProducerNode.java
+++ b/source/mircoders/producer/UnIndexingProducerNode.java
@@ -42,6 +42,12 @@ import mir.util.ParameterExpander;
 import mircoders.entity.EntityContent;
 import mircoders.search.IndexUtil;
 
+/**
+ * UnIndexingProducerNode is one of the 2 producer nodes that works on
+ * the   search   index    db.    There's   IndexingProducerNode   and
+ * UnIndexingProducerNode.  The first one  adds/updates an  article to
+ * the search index the second one removes an article
+ */
 public class UnIndexingProducerNode implements ProducerNode {
   private String contentKey;
   private String indexPath;