svn commit: r1200517 - /maven/shared/trunk/maven-script-interpreter/src/main/java/org/apache/maven/shared/scriptinterpreter/ExecutionLogger.java

[rfscholte]

Author: rfscholte
Date: Thu Nov 10 20:11:06 2011
New Revision: 1200517

URL: http://svn.apache.org/viewvc?rev=1200517&view=rev
Log:
Add javadoc to ExecutionLogger

Modified:
    
maven/shared/trunk/maven-script-interpreter/src/main/java/org/apache/maven/shared/scriptinterpreter/ExecutionLogger.java

Modified: 
maven/shared/trunk/maven-script-interpreter/src/main/java/org/apache/maven/shared/scriptinterpreter/ExecutionLogger.java
URL: 
http://svn.apache.org/viewvc/maven/shared/trunk/maven-script-interpreter/src/main/java/org/apache/maven/shared/scriptinterpreter/ExecutionLogger.java?rev=1200517&r1=1200516&r2=1200517&view=diff
==============================================================================
--- 
maven/shared/trunk/maven-script-interpreter/src/main/java/org/apache/maven/shared/scriptinterpreter/ExecutionLogger.java
 (original)
+++ 
maven/shared/trunk/maven-script-interpreter/src/main/java/org/apache/maven/shared/scriptinterpreter/ExecutionLogger.java
 Thu Nov 10 20:11:06 2011
@@ -26,7 +26,17 @@ import java.io.PrintStream;
  */
 public interface ExecutionLogger
 {
+    /**
+     * The stream which will catch the output of the {@link ScriptRunner}.
+     * 
+     * @return the output stream
+     */
     PrintStream getPrintStream();
 
+    /**
+     * Consume logging from this component.
+     * 
+     * @param line the line to consume
+     */
     void consumeLine( String line );
 }