documentation version 1.4.2

2026-04-22 16:28:48 +02:00 · 2016-07-31 08:10:07 -04:00
parent 6193968089
commit 44917ad0d3
1319 changed files with 93942 additions and 60498 deletions
--- a/dependency-check-maven/apidocs/org/owasp/dependencycheck/maven/AggregateMojo.html
+++ b/dependency-check-maven/apidocs/org/owasp/dependencycheck/maven/AggregateMojo.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_92) on Thu Jun 16 06:48:24 EDT 2016 -->
+<!-- Generated by javadoc (1.8.0_92) on Sun Jul 31 07:45:59 EDT 2016 -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>AggregateMojo (Dependency-Check Maven Plugin 1.4.0 API)</title>
-<meta name="date" content="2016-06-16">
+<title>AggregateMojo (Dependency-Check Maven Plugin 1.4.2 API)</title>
+<meta name="date" content="2016-07-31">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
@@ -13,7 +13,7 @@
 <script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="AggregateMojo (Dependency-Check Maven Plugin 1.4.0 API)";
+            parent.document.title="AggregateMojo (Dependency-Check Maven Plugin 1.4.2 API)";
        }
    }
    catch(err) {
@@ -131,8 +131,8 @@ var activeTableTab = "activeTableTab";
      requiresOnline=true)
 public class <span class="typeNameLabel">AggregateMojo</span>
 extends <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html" title="class in org.owasp.dependencycheck.maven">BaseDependencyCheckMojo</a></pre>
-<div class="block">Maven Plugin that checks project dependencies and the dependencies of all child modules to see if they have any known published
- vulnerabilities.</div>
+<div class="block">Maven Plugin that checks project dependencies and the dependencies of all
+ child modules to see if they have any known published vulnerabilities.</div>
 <dl>
 <dt><span class="simpleTagLabel">Author:</span></dt>
 <dd>Jeremy Long</dd>
@@ -199,28 +199,32 @@ extends <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheck
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html#canGenerateReport--">canGenerateReport</a></span>()</code>&nbsp;</td>
 </tr>
 <tr id="i1" class="rowColor">
-<td class="colFirst"><code>protected <a href="../../../../org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven">Engine</a></code></td>
+<td class="colFirst"><code>protected <a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html#generateDataFile--">generateDataFile</a></span>()</code>
-<div class="block">Initilizes the engine, runs a scan, and writes the serialized dependencies to disk.</div>
+<div class="block">Initializes the engine, runs a scan, and writes the serialized
+ dependencies to disk.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
-<td class="colFirst"><code>protected <a href="../../../../org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven">Engine</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html#generateDataFile-org.owasp.dependencycheck.maven.Engine-org.apache.maven.project.MavenProject-">generateDataFile</a></span>(<a href="../../../../org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven">Engine</a>&nbsp;engine,
+<td class="colFirst"><code>protected <a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html#generateDataFile-org.owasp.dependencycheck.maven.MavenEngine-org.apache.maven.project.MavenProject-">generateDataFile</a></span>(<a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a>&nbsp;engine,
                org.apache.maven.project.MavenProject&nbsp;project)</code>
-<div class="block">Runs dependency-check's Engine and writes the serialized dependencies to disk.</div>
+<div class="block">Runs dependency-check's MavenEngine and writes the serialized
+ dependencies to disk.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;org.apache.maven.project.MavenProject&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html#getDescendants-org.apache.maven.project.MavenProject-">getDescendants</a></span>(org.apache.maven.project.MavenProject&nbsp;project)</code>
-<div class="block">Returns a set containing all the descendant projects of the given project.</div>
+<div class="block">Returns a set containing all the descendant projects of the given
+ project.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html#getDescription-java.util.Locale-">getDescription</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)</code>
-<div class="block">Gets the description of the Dependency-Check report to be displayed in the Maven Generated Reports page.</div>
+<div class="block">Gets the description of the Dependency-Check report to be displayed in
+ the Maven Generated Reports page.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
@@ -247,7 +251,7 @@ extends <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheck
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;org.owasp.dependencycheck.maven.<a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html" title="class in org.owasp.dependencycheck.maven">BaseDependencyCheckMojo</a></h3>
-<code><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#checkForFailure-java.util.List-">checkForFailure</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#excludeFromScan-org.apache.maven.artifact.Artifact-">excludeFromScan</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#execute--">execute</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#generate-org.codehaus.doxia.sink.Sink-java.util.Locale-">generate</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#generate-org.apache.maven.doxia.sink.Sink-java.util.Locale-">generate</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getCategoryName--">getCategoryName</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getConnectionString--">getConnectionString</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getCorrectOutputDirectory--">getCorrectOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getCorrectOutputDirectory-org.apache.maven.project.MavenProject-">getCorrectOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getDataFile-org.apache.maven.project.MavenProject-">getDataFile</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getDataFileContextKey--">getDataFileContextKey</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getFormat--">getFormat</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getOutputDirectory--">getOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getOutputDirectoryContextKey--">getOutputDirectoryContextKey</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getOutputName--">getOutputName</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getProject--">getProject</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getReactorProjects--">getReactorProjects</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getReportOutputDirectory--">getReportOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#initializeEngine--">initializeEngine</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#isExternalReport--">isExternalReport</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#isGeneratingSite--">isGeneratingSite</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#populateSettings--">populateSettings</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#readDataFile-org.apache.maven.project.MavenProject-">readDataFile</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#scanArtifacts-org.apache.maven.project.MavenProject-org.owasp.dependencycheck.maven.Engine-">scanArtifacts</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#setReportOutputDirectory-java.io.File-">setReportOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#showSummary-org.apache.maven.project.MavenProject-java.util.List-">showSummary</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#writeDataFile-org.apache.maven.project.MavenProject-java.io.File-java.util.List-">writeDataFile</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#writeReports-org.owasp.dependencycheck.maven.Engine-org.apache.maven.project.MavenProject-java.io.File-">writeReports</a></code></li>
+<code><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#checkForFailure-java.util.List-">checkForFailure</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#excludeFromScan-org.apache.maven.artifact.Artifact-">excludeFromScan</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#execute--">execute</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#generate-org.codehaus.doxia.sink.Sink-java.util.Locale-">generate</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#generate-org.apache.maven.doxia.sink.Sink-java.util.Locale-">generate</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getCategoryName--">getCategoryName</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getConnectionString--">getConnectionString</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getCorrectOutputDirectory--">getCorrectOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getCorrectOutputDirectory-org.apache.maven.project.MavenProject-">getCorrectOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getDataFile-org.apache.maven.project.MavenProject-">getDataFile</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getDataFileContextKey--">getDataFileContextKey</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getFormat--">getFormat</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getOutputDirectory--">getOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getOutputDirectoryContextKey--">getOutputDirectoryContextKey</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getOutputName--">getOutputName</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getProject--">getProject</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getReactorProjects--">getReactorProjects</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getReportOutputDirectory--">getReportOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#initializeEngine--">initializeEngine</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#isExternalReport--">isExternalReport</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#isFailOnError--">isFailOnError</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#isGeneratingSite--">isGeneratingSite</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#populateSettings--">populateSettings</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#readDataFile-org.apache.maven.project.MavenProject-">readDataFile</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#scanArtifacts-org.apache.maven.project.MavenProject-org.owasp.dependencycheck.maven.MavenEngine-">scanArtifacts</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#setReportOutputDirectory-java.io.File-">setReportOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#showSummary-org.apache.maven.project.MavenProject-java.util.List-">showSummary</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#writeDataFile-org.apache.maven.project.MavenProject-java.io.File-java.util.List-">writeDataFile</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#writeReports-org.owasp.dependencycheck.maven.MavenEngine-org.apache.maven.project.MavenProject-java.io.File-">writeReports</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.org.apache.maven.plugin.AbstractMojo">
@@ -303,13 +307,16 @@ extends <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheck
 <pre>public&nbsp;void&nbsp;runCheck()
              throws org.apache.maven.plugin.MojoExecutionException,
                     org.apache.maven.plugin.MojoFailureException</pre>
-<div class="block">Executes the aggregate dependency-check goal. This runs dependency-check and generates the subsequent reports.</div>
+<div class="block">Executes the aggregate dependency-check goal. This runs dependency-check
+ and generates the subsequent reports.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#runCheck--">runCheck</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html" title="class in org.owasp.dependencycheck.maven">BaseDependencyCheckMojo</a></code></dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - thrown if there is ane exception running the mojo</dd>
-<dd><code>org.apache.maven.plugin.MojoFailureException</code> - thrown if dependency-check is configured to fail the build</dd>
+<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - thrown if there is ane exception running
+ the mojo</dd>
+<dd><code>org.apache.maven.plugin.MojoFailureException</code> - thrown if dependency-check is configured to
+ fail the build</dd>
 </dl>
 </li>
 </ul>
@@ -320,7 +327,8 @@ extends <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheck
 <li class="blockList">
 <h4>getDescendants</h4>
 <pre>protected&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;org.apache.maven.project.MavenProject&gt;&nbsp;getDescendants(org.apache.maven.project.MavenProject&nbsp;project)</pre>
-<div class="block">Returns a set containing all the descendant projects of the given project.</div>
+<div class="block">Returns a set containing all the descendant projects of the given
+ project.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>project</code> - the project for which all descendants will be returned</dd>
@@ -341,7 +349,8 @@ extends <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheck
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>mavenProject</code> - Project to test</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
-<dd><code>true</code> if it has a pom packaging; otherwise <code>false</code></dd>
+<dd><code>true</code> if it has a pom packaging; otherwise
+ <code>false</code></dd>
 </dl>
 </li>
 </ul>
@@ -351,39 +360,45 @@ extends <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheck
 <ul class="blockList">
 <li class="blockList">
 <h4>generateDataFile</h4>
-<pre>protected&nbsp;<a href="../../../../org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven">Engine</a>&nbsp;generateDataFile()
-                           throws org.apache.maven.plugin.MojoExecutionException,
-                                  org.apache.maven.plugin.MojoFailureException</pre>
-<div class="block">Initilizes the engine, runs a scan, and writes the serialized dependencies to disk.</div>
+<pre>protected&nbsp;<a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a>&nbsp;generateDataFile()
+                                throws org.apache.maven.plugin.MojoExecutionException,
+                                       org.apache.maven.plugin.MojoFailureException</pre>
+<div class="block">Initializes the engine, runs a scan, and writes the serialized
+ dependencies to disk.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
-<dd>the Engine used to execute dependency-check</dd>
+<dd>the MavenEngine used to execute dependency-check</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - thrown if there is an exception running the mojo</dd>
-<dd><code>org.apache.maven.plugin.MojoFailureException</code> - thrown if dependency-check is configured to fail the build if severe CVEs are identified.</dd>
+<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - thrown if there is an exception running
+ the mojo</dd>
+<dd><code>org.apache.maven.plugin.MojoFailureException</code> - thrown if dependency-check is configured to
+ fail the build if severe CVEs are identified.</dd>
 </dl>
 </li>
 </ul>
-<a name="generateDataFile-org.owasp.dependencycheck.maven.Engine-org.apache.maven.project.MavenProject-">
+<a name="generateDataFile-org.owasp.dependencycheck.maven.MavenEngine-org.apache.maven.project.MavenProject-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>generateDataFile</h4>
-<pre>protected&nbsp;<a href="../../../../org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven">Engine</a>&nbsp;generateDataFile(<a href="../../../../org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven">Engine</a>&nbsp;engine,
-                                  org.apache.maven.project.MavenProject&nbsp;project)
-                           throws org.apache.maven.plugin.MojoExecutionException,
-                                  org.apache.maven.plugin.MojoFailureException</pre>
-<div class="block">Runs dependency-check's Engine and writes the serialized dependencies to disk.</div>
+<pre>protected&nbsp;<a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a>&nbsp;generateDataFile(<a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a>&nbsp;engine,
+                                       org.apache.maven.project.MavenProject&nbsp;project)
+                                throws org.apache.maven.plugin.MojoExecutionException,
+                                       org.apache.maven.plugin.MojoFailureException</pre>
+<div class="block">Runs dependency-check's MavenEngine and writes the serialized
+ dependencies to disk.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>engine</code> - the Engine to use when scanning.</dd>
+<dd><code>engine</code> - the MavenEngine to use when scanning.</dd>
 <dd><code>project</code> - the project to scan and generate the data file for</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
-<dd>the Engine used to execute dependency-check</dd>
+<dd>the MavenEngine used to execute dependency-check</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - thrown if there is an exception running the mojo</dd>
-<dd><code>org.apache.maven.plugin.MojoFailureException</code> - thrown if dependency-check is configured to fail the build if severe CVEs are identified.</dd>
+<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - thrown if there is an exception running
+ the mojo</dd>
+<dd><code>org.apache.maven.plugin.MojoFailureException</code> - thrown if dependency-check is configured to
+ fail the build if severe CVEs are identified.</dd>
 </dl>
 </li>
 </ul>
@@ -419,7 +434,8 @@ extends <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheck
 <li class="blockList">
 <h4>getDescription</h4>
 <pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDescription(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)</pre>
-<div class="block">Gets the description of the Dependency-Check report to be displayed in the Maven Generated Reports page.</div>
+<div class="block">Gets the description of the Dependency-Check report to be displayed in
+ the Maven Generated Reports page.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>locale</code> - The Locale to get the description for</dd>