svn commit: r1471714 - /commons/sandbox/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/Weaver.java

[mbenson]

Author: mbenson
Date: Wed Apr 24 21:59:21 2013
New Revision: 1471714

URL: http://svn.apache.org/r1471714
Log:
docs

Modified:
    
commons/sandbox/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/Weaver.java

Modified: 
commons/sandbox/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/Weaver.java
URL: 
http://svn.apache.org/viewvc/commons/sandbox/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/Weaver.java?rev=1471714&r1=1471713&r2=1471714&view=diff
==============================================================================
--- 
commons/sandbox/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/Weaver.java
 (original)
+++ 
commons/sandbox/weaver/trunk/processor/src/main/java/org/apache/commons/weaver/spi/Weaver.java
 Wed Apr 24 21:59:21 2013
@@ -26,30 +26,28 @@ import org.apache.commons.weaver.model.S
 import org.apache.commons.weaver.model.ScanResult;
 
 /**
- * An implementation of a 'Weaver' takes care about
- * certain weaving jobs and will perform the byte code
- * enhancement in the classes.
+ * A {@link Weaver} implementation performs the byte code enhancement in the 
classes.
  */
-public interface Weaver
-{
+public interface Weaver {
     /**
-     * This is for now a simple way to configure any weaver.
-     * Any configuration property of a weaver should start with its 'name'
-     * e.g. 'privilizer'
-     * @param classPath the classpath to look up cross-references in during 
weaving
+     * This is for now a simple way to configure a {@link Weaver}. By 
convention, any configuration property should
+     * start with its name, e.g. "privilizer".
+     * 
+     * @param classpath the classpath to look up cross-references in during 
weaving
      * @param target the File path where the classes to weave reside
      * @param config additional configuration for all plugins.
      */
-    void configure(List<String> classPath, File target, Properties config);
+    void configure(List<String> classpath, File target, Properties config);
 
     /**
-     * Get the scan request of this {@link Weaver}.
+     * Get the scan request.
      */
     ScanRequest getScanRequest();
 
     /**
      * Process the scanning results.
-     * @param scanResult
+     * 
+     * @param scanResult to process
      * @return whether any work was done.
      */
     boolean process(ScanResult scanResult);