github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-03-18 07:14:09 +01:00
Code Issues Packages Projects Releases Wiki Activity

doclint fixes

Browse Source
This commit is contained in:
Jeremy Long
2016-03-05 13:18:32 -05:00
parent 0e31e59759
commit 36eefd0836
1 changed files with 9 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
dependency-check-core/src/main/java/org/owasp/dependencycheck/reporting/VelocityLoggerRedirect.java
View File

@@ -24,15 +24,14 @@ import org.slf4j.LoggerFactory;
/** /**
* <p> * <p>
* DependencyCheck uses {@link org.slf4j.Logger} as a logging framework, and Apache Velocity uses a custom * DependencyCheck uses {@link org.slf4j.Logger} as a logging framework, and Apache Velocity uses a custom logging implementation
* logging implementation that outputs to a file named velocity.log by default. This class is an implementation of a * that outputs to a file named velocity.log by default. This class is an implementation of a custom Velocity logger that
* custom Velocity logger that redirects all velocity logging to the Java Logger class. * redirects all velocity logging to the Java Logger class.
* </p><p> * </p><p>
* This class was written to address permission issues when using Dependency-Check in a server environment (such as the * This class was written to address permission issues when using Dependency-Check in a server environment (such as the Jenkins
* Jenkins plugin). In some circumstances, Velocity would attempt to create velocity.log in an un-writable * plugin). In some circumstances, Velocity would attempt to create velocity.log in an un-writable directory.</p>
* directory.</p>
* *
* @author Steve Springett <steve.springett@owasp.org> * @author Steve Springett
*/ */
public class VelocityLoggerRedirect implements LogChute { public class VelocityLoggerRedirect implements LogChute {
@@ -52,8 +51,7 @@ public class VelocityLoggerRedirect implements LogChute {
} }
/** /**
* Given a Velocity log level and message, this method will call the appropriate Logger level and log the specified * Given a Velocity log level and message, this method will call the appropriate Logger level and log the specified values.
* values.
* *
* @param level the logging level * @param level the logging level
* @param message the message to be logged * @param message the message to be logged
@@ -82,8 +80,8 @@ public class VelocityLoggerRedirect implements LogChute {
} }
/** /**
* Given a Velocity log level, message and Throwable, this method will call the appropriate Logger level and log the * Given a Velocity log level, message and Throwable, this method will call the appropriate Logger level and log the specified
* specified values. * values.
* *
* @param level the logging level * @param level the logging level
* @param message the message to be logged * @param message the message to be logged