Skip to content

Commit

Permalink
update documentation per #2120
Browse files Browse the repository at this point in the history
  • Loading branch information
@jeremylong
jeremylong committed Aug 4, 2019
1 parent b95441d commit 12a9762
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 10 deletions.
6 changes: 3 additions & 3 deletions ant/src/site/markdown/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,12 +102,12 @@ composerAnalyzerEnabled | Sets whether the [experimental](../analyze
nodeAnalyzerEnabled | Sets whether the [retired](../analyzers/index.html) Node.js Analyzer should be used. | true
nodeAuditAnalyzerEnabled | Sets whether the Node Audit Analyzer should be used. | true
nodeAuditAnalyzerUseCache | Sets whether the Node Audit Analyzer will cache results. Cached results expire after 24 hours. | true
retireJsAnalyzerEnabled | Sets whether the [experimental](../analyzers/index.html) RetireJS Analyzer should be used. | true
retireJsAnalyzerEnabled | Sets whether the RetireJS Analyzer should be used. | true
retirejsFilterNonVulnerable | Configures the RetireJS Analyzer to remove non-vulnerable JS dependencies from the report. | false
retirejsFilter | A nested configuration that can be specified multple times; The regex defined is used to filter JS files based on content. |  
retireJsUrl | The URL to the Retire JS repository. | https://raw.githubusercontent.com/Retirejs/retire.js/master/repository/jsrepository.json
retireJsUrl | The URL to the Retire JS repository. **Note** the file name must be `jsrepository.json`. | https://raw.githubusercontent.com/Retirejs/retire.js/master/repository/jsrepository.json
nuspecAnalyzerEnabled | Sets whether the .NET Nuget Nuspec Analyzer will be used. | true
nugetconfAnalyzerEnabled | Sets whether the [experimental](../analyzers/index.html) .NET Nuget packages.config Analyzer will be used. | true
nugetconfAnalyzerEnabled | Sets whether the [experimental](../analyzers/index.html) .NET Nuget packages.config Analyzer will be used. | true
cocoapodsAnalyzerEnabled | Sets whether the [experimental](../analyzers/index.html) Cocoapods Analyzer should be used. | true
bundleAuditAnalyzerEnabled | Sets whether the [experimental](../analyzers/index.html) Bundle Audit Analyzer should be used. | true
bundleAuditPath | Sets the path to the bundle audit executable; only used if bundle audit analyzer is enabled and experimental analyzers are enabled. |  
Expand Down
4 changes: 2 additions & 2 deletions cli/src/site/markdown/arguments.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ Advanced Options
| | \-\-disableNodeJS | | Sets whether the Node.js Package Analyzer will be used. |   |
| | \-\-disableNodeAudit | | Sets whether the Node Audit Analyzer will be used. |   |
| | \-\-disableNodeAuditCache | | When the argument is present the Node Audit Analyzer will not cache results. By default the results are cached for 24 hours. |   |
| | \-\-disableRetireJS | | Sets whether the [experimental](../analyzers/index.html) RetireJS Analyzer will be used. |   |
| | \-\-retireJsUrl | \<url\> | The URL to the Retire JS repository. | https://raw.githubusercontent.com/Retirejs/retire.js/master/repository/jsrepository.json |
| | \-\-disableRetireJS | | Sets whether the RetireJS Analyzer will be used. | &nbsp; |
| | \-\-retireJsUrl | \<url\> | The URL to the Retire JS repository. **Note** the file name must be `jsrepository.json`. | https://raw.githubusercontent.com/Retirejs/retire.js/master/repository/jsrepository.json |
| | \-\-retirejsFilter | \<pattern\> | The RetireJS Analyzers content filter used to exclude JS files when the content contains the given regular expression; this option can be specified multiple times. | &nbsp; |
| | \-\-retirejsFilterNonVulnerable | | Specifies that the Retire JS Analyzer should filter out non-vulnerable JS files from the report. | &nbsp; |
| | \-\-disableRubygems | | Sets whether the [experimental](../analyzers/index.html) Ruby Gemspec Analyzer will be used. | &nbsp; |
Expand Down
4 changes: 2 additions & 2 deletions maven/src/site/markdown/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ composerAnalyzerEnabled | Sets whether the [experimental](../analyzers/ind
nodeAnalyzerEnabled | Sets whether the [retired](../analyzers/index.html) Node.js Analyzer should be used. | true
nodeAuditAnalyzerEnabled | Sets whether the Node Audit Analyzer should be used. | true
nodeAuditAnalyzerUseCache | Sets whether the Node Audit Analyzer will cache results. Cached results expire after 24 hours. | true
retireJsAnalyzerEnabled | Sets whether the [experimental](../analyzers/index.html) RetireJS Analyzer should be used. | true
retireJsUrl | The URL to the Retire JS repository. | https://raw.githubusercontent.com/Retirejs/retire.js/master/repository/jsrepository.json
retireJsAnalyzerEnabled | Sets whether the RetireJS Analyzer should be used. | true
retireJsUrl | The URL to the Retire JS repository. **Note** the file name must be `jsrepository.json`. | https://raw.githubusercontent.com/Retirejs/retire.js/master/repository/jsrepository.json
nuspecAnalyzerEnabled | Sets whether the .NET Nuget Nuspec Analyzer will be used. | true
nugetconfAnalyzerEnabled | Sets whether the [experimental](../analyzers/index.html) .NET Nuget packages.config Analyzer will be used. | true
cocoapodsAnalyzerEnabled | Sets whether the [experimental](../analyzers/index.html) Cocoapods Analyzer should be used. | true
Expand Down
4 changes: 2 additions & 2 deletions src/site/markdown/dependency-check-gradle/configuration-aggregate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -151,8 +151,8 @@ artifactory | parallelAnalysis | Whether the Artifactory analyzer should b
artifactory | username | The user name (only used with API token) to connect to Artifactory instance. | &nbsp;
artifactory | apiToken | The API token to connect to Artifactory instance, only used if the username or the API key are not defined by artifactoryAnalyzerServerId,artifactoryAnalyzerUsername or artifactoryAnalyzerApiToken | &nbsp;
artifactory | bearerToken | The bearer token to connect to Artifactory instance. | &nbsp;
retirejs | enabled | Sets whether the [experimental](../analyzers/index.html) RetireJS Analyzer should be used. | true
retirejs | retireJsUrl | The URL to the Retire JS repository. | https://raw.githubusercontent.com/Retirejs/retire.js/master/repository/jsrepository.json
retirejs | enabled | Sets whether the RetireJS Analyzer should be used. | true
retirejs | retireJsUrl | The URL to the Retire JS repository. **Note** the file name must be `jsrepository.json`. | https://raw.githubusercontent.com/Retirejs/retire.js/master/repository/jsrepository.json
retirejs | filterNonVulnerable | Configures the RetireJS Analyzer to remove non-vulnerable JS dependencies from the report. | false
retirejs | filters | Configures the list of regular expessions used to filter JS files based on content. | &nbsp;
ossIndex | enabled | Sets whether OSS Index analyzer will be used. | true
Expand Down
3 changes: 2 additions & 1 deletion src/site/markdown/dependency-check-gradle/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,8 @@ artifactory | parallelAnalysis | Whether the Artifactory analyzer should b
artifactory | username | The user name (only used with API token) to connect to Artifactory instance. | &nbsp;
artifactory | apiToken | The API token to connect to Artifactory instance, only used if the username or the API key are not defined by artifactoryAnalyzerServerId,artifactoryAnalyzerUsername or artifactoryAnalyzerApiToken | &nbsp;
artifactory | bearerToken | The bearer token to connect to Artifactory instance | &nbsp;
retirejs | enabled | Sets whether the [experimental](../analyzers/index.html) RetireJS Analyzer should be used. | true
retirejs | enabled | Sets whether the RetireJS Analyzer should be used. | true
retirejs | retireJsUrl | The URL to the Retire JS repository. **Note** the file name must be `jsrepository.json`. | https://raw.githubusercontent.com/Retirejs/retire.js/master/repository/jsrepository.json
retirejs | filterNonVulnerable | Configures the RetireJS Analyzer to remove non-vulnerable JS dependencies from the report. | false
retirejs | filters | Configures the list of regular expessions used to filter JS files based on content. | &nbsp;
ossIndex | enabled | Sets whether Sonatype's OSS Index will be used. | true
Expand Down

0 comments on commit 12a9762

Please sign in to comment.