Author: cbrisson
Date: Fri Mar 15 13:51:36 2019
New Revision: 1855594

URL: http://svn.apache.org/viewvc?rev=1855594&view=rev
Log:
[engine] Remove all instances of LogChute in the javadocs

Modified:
    
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/Velocity.java
    
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/VelocityEngine.java
    
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeInstance.java
    
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeServices.java
    
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeSingleton.java
    
velocity/engine/trunk/velocity-engine-core/src/test/java/org/apache/velocity/test/misc/TestLogger.java

Modified: 
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/Velocity.java
URL: 
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/Velocity.java?rev=1855594&r1=1855593&r2=1855594&view=diff
==============================================================================
--- 
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/Velocity.java
 (original)
+++ 
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/Velocity.java
 Fri Mar 15 13:51:36 2019
@@ -328,10 +328,9 @@ public class Velocity implements Runtime
     }
 
     /**
-     * Returns a convenient Log instance that wraps the current LogChute.
-     * Use this to log error messages. It has the usual methods.
+     * Returns the current logger.
      *
-     * @return A convenience Log instance that wraps the current LogChute.
+     * @return A convenience Logger instance.
      * @since 1.5
      */
     public static Logger getLog()

Modified: 
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/VelocityEngine.java
URL: 
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/VelocityEngine.java?rev=1855594&r1=1855593&r2=1855594&view=diff
==============================================================================
--- 
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/VelocityEngine.java
 (original)
+++ 
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/app/VelocityEngine.java
 Fri Mar 15 13:51:36 2019
@@ -356,9 +356,10 @@ public class VelocityEngine implements R
     }
 
     /**
-     * Returns a convenient Log instance that wraps the current LogChute.
-     * Use this to log error messages. It has the usual methods you'd expect.
-     * @return A log object.
+     * Returns the current slf4j logger. Its namespace defaults to 
<code>org.apache.velocity</code>
+     * if it hasn't been configured using the property 
<code>runtime.log.name</code> or the property
+     * <code>runtime.log.instance</code>.
+     * @return A Logger object.
      * @since 1.5
      */
     public Logger getLog()
@@ -372,7 +373,7 @@ public class VelocityEngine implements R
      *  accessible from any component of the system that gets a
      *  RuntimeServices. This allows communication between the application
      *  environment and custom pluggable components of the Velocity engine,
-     *  such as ResourceLoaders and LogChutes.
+     *  such as ResourceLoaders and Loggers.
      *  </p>
      *
      *  <p>
@@ -398,7 +399,7 @@ public class VelocityEngine implements R
       *  any component of the system that gets a RuntimeServices.
       *  This allows communication between the application
       *  environment and custom pluggable components of the
-      *  Velocity engine, such as ResourceLoaders and LogChutes.
+      *  Velocity engine, such as ResourceLoaders and Loggers.
       *  </p>
       *
       *  @param key object 'name' under which the object is stored

Modified: 
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeInstance.java
URL: 
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeInstance.java?rev=1855594&r1=1855593&r2=1855594&view=diff
==============================================================================
--- 
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeInstance.java
 (original)
+++ 
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeInstance.java
 Fri Mar 15 13:51:36 2019
@@ -1643,10 +1643,9 @@ public class RuntimeInstance implements
     }
 
     /**
-     * Returns a convenient Log instance that wraps the current LogChute.
-     * Use this to log error messages. It has the usual methods.
+     * Returns the configured logger.
      *
-     * @return A convenience Log instance that wraps the current LogChute.
+     * @return A Logger instance
      * @since 1.5
      */
     public Logger getLog()

Modified: 
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeServices.java
URL: 
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeServices.java?rev=1855594&r1=1855593&r2=1855594&view=diff
==============================================================================
--- 
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeServices.java
 (original)
+++ 
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeServices.java
 Fri Mar 15 13:51:36 2019
@@ -415,8 +415,8 @@ public interface RuntimeServices
     Uberspect getUberspect();
 
     /**
-     * Returns a convenient Log instance that wraps the current LogChute.
-     * @return A log object.
+     * Returns the configured logger.
+     * @return A Logger object.
      */
     Logger getLog();
 

Modified: 
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeSingleton.java
URL: 
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeSingleton.java?rev=1855594&r1=1855593&r2=1855594&view=diff
==============================================================================
--- 
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeSingleton.java
 (original)
+++ 
velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/RuntimeSingleton.java
 Fri Mar 15 13:51:36 2019
@@ -358,9 +358,9 @@ public class RuntimeSingleton implements
 
 
     /**
-     * Returns a convenient Log instance that wraps the current LogChute.
+     * Returns the configured logger.
      *
-     * @return A convenience Log instance that wraps the current LogChute.
+     * @return A Logger instance
      * @see RuntimeInstance#getLog()
      * @since 1.5
      */

Modified: 
velocity/engine/trunk/velocity-engine-core/src/test/java/org/apache/velocity/test/misc/TestLogger.java
URL: 
http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/test/java/org/apache/velocity/test/misc/TestLogger.java?rev=1855594&r1=1855593&r2=1855594&view=diff
==============================================================================
--- 
velocity/engine/trunk/velocity-engine-core/src/test/java/org/apache/velocity/test/misc/TestLogger.java
 (original)
+++ 
velocity/engine/trunk/velocity-engine-core/src/test/java/org/apache/velocity/test/misc/TestLogger.java
 Fri Mar 15 13:51:36 2019
@@ -30,7 +30,7 @@ import java.io.PrintStream;
 /**
  * Logger implementation that can easily capture output
  * or suppress it entirely.  By default, both capture and suppress
- * are on. To have this behave like a normal SystemLogChute,
+ * are on. To have this behave like a normal Logger,
  * you must turn it on() and stopCapture().
  *
  * @author <a href="mailto:[email protected]";>Will Glass-Husain</a>


Reply via email to