svn commit: r1410283 - /maven/indexer/trunk/indexer-core/src/main/java/org/apache/maven/index/Indexer.java

[cs...@apache.org]

Author: cstamas
Date: Fri Nov 16 10:18:36 2012
New Revision: 1410283

URL: http://svn.apache.org/viewvc?rev=1410283&view=rev
Log:
Javadoced the main difference between this and NexusIndexer component.

Modified:
    maven/indexer/trunk/indexer-core/src/main/java/org/apache/maven/index/Indexer.java

Modified: maven/indexer/trunk/indexer-core/src/main/java/org/apache/maven/index/Indexer.java
URL: http://svn.apache.org/viewvc/maven/indexer/trunk/indexer-core/src/main/java/org/apache/maven/index/Indexer.java?rev=1410283&r1=1410282&r2=1410283&view=diff
==============================================================================
--- maven/indexer/trunk/indexer-core/src/main/java/org/apache/maven/index/Indexer.java (original)
+++ maven/indexer/trunk/indexer-core/src/main/java/org/apache/maven/index/Indexer.java Fri Nov 16 10:18:36 2012
@@ -36,7 +36,9 @@ import org.apache.maven.index.expr.UserI
 /**
  * Indexer component. It is the main component of Maven Indexer, offering {@link IndexingContext} creation and close
  * methods, context maintenance (scan, add, remove) and search methods. Supersedes the {@link NexusIndexer} component,
- * making it less cludged, and focusing on main use cases.
+ * making it less cludged, and focusing on main use cases. This component does not hold any reference to contexts
+ * it creates or uses, and caller of every method (except the createIndexingContext naturally) is obliged to
+ * explicitly supply {@link IndexingContext} to work with (perform searches or such).
  * 
  * @author cstamas
  * @since 5.1.0