updated documentation per issue #782

src/site/markdown/dependency-check-gradle/configuration-purge.md

@@ -3,13 +3,28 @@ Tasks
 
 Task                                                | Description
 ----------------------------------------------------|-----------------------
-[dependencyCheck](configuration.html)               | Runs dependency-check against the project and generates a report.
+[dependencyCheckAnalyze](configuration.html)        | Runs dependency-check against the project and generates a report.
 [dependencyCheckUpdate](configuration-update.html)  | Updates the local cache of the NVD data from NIST.
 dependencyCheckPurge                                | Deletes the local copy of the NVD. This is used to force a refresh of the data.
 
-Configuration: dependencyCheckPurge
+Configuration
 ====================
-The following properties can be configured for the dependencyCheckPurge task:
+
+```groovy
+buildscript {
+    repositories {
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'org.owasp:dependency-check-gradle:${project.version}'
+    }
+}
+apply plugin: 'org.owasp.dependencycheck'
+```
+
+```bash
+$ gradle dependencyCheckPurge
+```
 
 Property             | Description                        | Default Value
 ---------------------|------------------------------------|------------------
@@ -17,7 +32,8 @@ failOnError          | Fails the build if an error occurs during the dependency-
 
 #### Example
 ```groovy
-dependencyCheckPurge {
+dependencyCheck {
+    failOnError=true
 }
 ```
 
@@ -31,7 +47,7 @@ data         | directory         | Sets the data directory to hold SQL CVEs cont
 
 #### Example
 ```groovy
-dependencyCheckPurge {
+dependencyCheck {
     data {
         directory='d:/nvd'
     }

src/site/markdown/dependency-check-gradle/configuration-update.md

@@ -3,13 +3,26 @@ Tasks
 
 Task                                             | Description
 -------------------------------------------------|-----------------------
-[dependencyCheck](configuration.html)            | Runs dependency-check against the project and generates a report.
+[dependencyCheckAnalyze](configuration.html)     | Runs dependency-check against the project and generates a report.
 dependencyCheckUpdate                            | Updates the local cache of the NVD data from NIST.
 [dependencyCheckPurge](configuration-purge.html) | Deletes the local copy of the NVD. This is used to force a refresh of the data.
 
-Configuration: dependencyCheckUpdate
+Configuration
 ====================
-The following properties can be configured for the dependencyCheckUpdate task:
+
+```groovy
+buildscript {
+    repositories {
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'org.owasp:dependency-check-gradle:${project.version}'
+    }
+}
+apply plugin: 'org.owasp.dependencycheck'
+
+check.dependsOn dependencyCheckUpdate
+```
 
 Property             | Description                        | Default Value
 ---------------------|------------------------------------|------------------
@@ -18,7 +31,7 @@ failOnError          | Fails the build if an error occurs during the dependency-
 
 #### Example
 ```groovy
-dependencyCheckUpdate {
+dependencyCheck {
     cveValidForHours=1
 }
 ```
@@ -35,7 +48,7 @@ connectionTimeout | The URL Connection Timeout.        |  
 
 #### Example
 ```groovy
-dependencyCheckUpdate {
+dependencyCheck {
     proxy {
         server=some.proxy.server
         port=8989
@@ -64,7 +77,7 @@ data         | password          | The password used when connecting to the data
 
 #### Example
 ```groovy
-dependencyCheckUpdate {
+dependencyCheck {
     data {
         directory='d:/nvd'
     }

src/site/markdown/dependency-check-gradle/configuration.md

@@ -3,13 +3,26 @@ Tasks
 
 Task                                               | Description
 ---------------------------------------------------|-----------------------
-dependencyCheck                                    | Runs dependency-check against the project and generates a report.
+dependencyCheckAnalyze                             | Runs dependency-check against the project and generates a report.
 [dependencyCheckUpdate](configuration-update.html) | Updates the local cache of the NVD data from NIST.
 [dependencyCheckPurge](configuration-purge.html)   | Deletes the local copy of the NVD. This is used to force a refresh of the data.
 
-Configuration: dependencyCheck
+Configuration:
 ====================
-The following properties can be configured for the dependencyCheck task:
+
+```groovy
+buildscript {
+    repositories {
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'org.owasp:dependency-check-gradle:${project.version}'
+    }
+}
+apply plugin: 'org.owasp.dependencycheck'
+
+check.dependsOn dependencyCheckAnalyze
+```
 
 Property             | Description                        | Default Value
 ---------------------|------------------------------------|------------------

src/site/markdown/dependency-check-gradle/index.md.vm

@@ -30,20 +30,20 @@ buildscript {
 apply plugin: 'org.owasp.dependencycheck'
 ```
 
-$H$H$H Step 2, Run the dependencyCheck task
+$H$H$H Step 2, Run the dependencyCheckAnalyze task
 
 Once the dependency-check plugin is applied, if the [Java plugin](https://docs.gradle.org/current/userguide/java_plugin.html)
 is being used dependency-check will automatically be added to the `check` task.
 Alternatively, you can run dependency-check directly:
 
 ```bash
-gradle dependencyCheck --info
+gradle dependencyCheckAnalyze --info
 ```
 
 The reports will be generated automatically under `build/reports` folder.
 
 $H$H Task Configuration
-The OWASP dependency-check-gradle plugin contains three tasks: [dependencyCheck](configuration.html),
+The OWASP dependency-check-gradle plugin contains three tasks: [dependencyCheckAnalyze](configuration.html),
 [dependencyCheckUpdate](configuration-update.html), and [dependencyCheckPurge](configuration-purge.html).
 Please see each tasks configuration page for more information.
 

src/site/site.xml

@@ -161,7 +161,7 @@ Copyright (c) 2013 Jeremy Long. All Rights Reserved.
                 </item>
                 <item collapse="true" name="Gradle Plugin" href="./dependency-check-gradle/index.html">
                     <description>Gradle plugin for OWASP dependency-check.</description>
-                    <item name="Check Task" href="./dependency-check-gradle/configuration.html" />
+                    <item name="Analyze Task" href="./dependency-check-gradle/configuration.html" />
                     <item name="Update Task" href="./dependency-check-gradle/configuration-update.html" />
                     <item name="Purge Task" href="./dependency-check-gradle/configuration-purge.html" />
                 </item>