Skip to content

Commit c878404

Browse files
jeremylongjeremylong
authored
docs: correct gradle documentation (#7511)
1 parent 7b14928 commit c878404

File tree

2 files changed

+35
-35
lines changed

2 files changed

+35
-35
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ analyzers | archiveEnabled | Sets whether the Archive Analyzer will be
130130
analyzers | zipExtensions | A comma-separated list of additional file extensions to be treated like a ZIP file, the contents will be extracted and analyzed. |  
131131
analyzers | jarEnabled | Sets whether Jar Analyzer will be used. | true
132132
analyzers | dartEnabled | Sets whether the [experimental](../analyzers/index.html) Dart Analyzer will be used. | true
133-
analyzers | centralEnabled | Sets whether Central Analyzer will be used; by default in the Gradle plugin this analyzer is disabled as all information gained from Central is already available in the build. Enable this analyzer when you hit false positives for (embedded) Maven dependencies that do not have an associated maven package-URL in the report. | false
133+
analyzers | centralEnabled | Sets whether Central Analyzer will be used. | true
134134
analyzers | nexusEnabled | Sets whether Nexus Analyzer will be used (requires Nexus Pro). This analyzer is superceded by the Central Analyzer; however, you can configure this to run against a Nexus Pro installation. | false
135135
analyzers | nexusUrl | Defines the Nexus Server's web service end point (example http://domain.enterprise/service/local/). If not set the Nexus Analyzer will be disabled. |  
136136
analyzers | nexusUsesProxy | Whether or not the defined proxy should be used when connecting to Nexus. | true

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

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -110,41 +110,41 @@ analyzers by configuring the `analyzers` section. Note, specific file type analy
110110
disable themselves if no file types that they support are detected - so specifically disabling the
111111
analyzers is likely not needed.
112112

113-
Config Group | Property | Description | Default Value
114-
-------------|-----------------------|-------------------------------------------------------------------------------------------------------------------|------------------
115-
analyzers | experimentalEnabled | Sets whether the [experimental analyzers](../analyzers/index.html) will be used. If not set to true the analyzers marked as experimental (see below) will not be used | false
116-
analyzers | archiveEnabled | Sets whether the Archive Analyzer will be used. | true
117-
analyzers | zipExtensions | A comma-separated list of additional file extensions to be treated like a ZIP file, the contents will be extracted and analyzed. |  
118-
analyzers | jarEnabled | Sets whether Jar Analyzer will be used. | true
119-
analyzers | dartEnabled | Sets whether the [experimental](../analyzers/index.html) Dart Analyzer will be used. | true
120-
analyzers | centralEnabled | Sets whether Central Analyzer will be used; by default in the Gradle plugin this analyzer is disabled as all information gained from Central is already available in the build. Enable this analyzer when you hit false positives for (embedded) Maven dependencies that do not have an associated maven package-URL in the report. | false
113+
Config Group | Property | Description | Default Value
114+
-------------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------
115+
analyzers | experimentalEnabled | Sets whether the [experimental analyzers](../analyzers/index.html) will be used. If not set to true the analyzers marked as experimental (see below) will not be used | false
116+
analyzers | archiveEnabled | Sets whether the Archive Analyzer will be used. | true
117+
analyzers | zipExtensions | A comma-separated list of additional file extensions to be treated like a ZIP file, the contents will be extracted and analyzed. |  
118+
analyzers | jarEnabled | Sets whether Jar Analyzer will be used. | true
119+
analyzers | dartEnabled | Sets whether the [experimental](../analyzers/index.html) Dart Analyzer will be used. | true
120+
analyzers | centralEnabled | Sets whether Central Analyzer will be used. | true
121121
analyzers | nexusEnabled | Sets whether Nexus Analyzer will be used (requires Nexus Pro). This analyzer is superceded by the Central Analyzer; however, you can configure this to run against a Nexus Pro installation. | false
122-
analyzers | nexusUrl | Defines the Nexus Server's web service end point (example http://domain.enterprise/service/local/). If not set the Nexus Analyzer will be disabled. |  
123-
analyzers | nexusUsesProxy | Whether or not the defined proxy should be used when connecting to Nexus. | true
124-
analyzers | pyDistributionEnabled | Sets whether the [experimental](../analyzers/index.html) Python Distribution Analyzer will be used. `experimentalEnabled` must be set to true. | true
125-
analyzers | pyPackageEnabled | Sets whether the [experimental](../analyzers/index.html) Python Package Analyzer will be used. `experimentalEnabled` must be set to true. | true
126-
analyzers | rubygemsEnabled | Sets whether the [experimental](../analyzers/index.html) Ruby Gemspec Analyzer will be used. `experimentalEnabled` must be set to true. | true
127-
analyzers | opensslEnabled | Sets whether the openssl Analyzer should be used. | true
128-
analyzers | nuspecEnabled | Sets whether the .NET Nuget Nuspec Analyzer will be used. | true
129-
analyzers | nugetconfEnabled | Sets whether the [experimental](../analyzers/index.html) .NET Nuget packages.config Analyzer will be used. `experimentalEnabled` must be set to true. | true
130-
analyzers | assemblyEnabled | Sets whether the .NET Assembly Analyzer should be used. | true
131-
analyzers | msbuildEnabled | Sets whether the MS Build Analyzer should be used. | true
132-
analyzers | pathToDotnet | The path to dotnet core - needed on some systems to analyze .net assemblies. |  
133-
analyzers | cmakeEnabled | Sets whether the [experimental](../analyzers/index.html) CMake Analyzer should be used. `experimentalEnabled` must be set to true. | true
134-
analyzers | autoconfEnabled | Sets whether the [experimental](../analyzers/index.html) autoconf Analyzer should be used. `experimentalEnabled` must be set to true. | true
135-
analyzers | composerEnabled | Sets whether the [experimental](../analyzers/index.html) PHP Composer Lock File Analyzer should be used. `experimentalEnabled` must be set to true. | true
136-
analyzers | composerSkipDev | Sets whether the [experimental](../analyzers/index.html) PHP Composer Lock File Analyzer should skip "packages-dev". | false
137-
analyzers | cpanEnabled | Sets whether the [experimental](../analyzers/index.html) Perl CPAN File Analyzer should be used. `experimentalEnabled` must be set to true. | true
138-
analyzers | cocoapodsEnabled | Sets whether the [experimental](../analyzers/index.html) Cocoapods Analyzer should be used. `experimentalEnabled` must be set to true. | true
139-
analyzers | carthageEnabled | Sets whether the [experimental](../analyzers/index.html) Carthage Analyzer should be used. `experimentalEnabled` must be set to true. | true
140-
analyzers | swiftEnabled | Sets whether the [experimental](../analyzers/index.html) Swift Package Manager Analyzer should be used. `experimentalEnabled` must be set to true. | true
141-
analyzers | swiftPackageResolvedEnabled | Sets whether the [experimental](../analyzers/index.html) Swift Package Resolved Analyzer should be used. `experimentalEnabled` must be set to true. | true
142-
analyzers | bundleAuditEnabled | Sets whether the [experimental](../analyzers/index.html) Ruby Bundle Audit Analyzer should be used. `experimentalEnabled` must be set to true. | true
143-
analyzers | pathToBundleAudit | The path to bundle audit. |  
144-
analyzers | retiredEnabled | Sets whether the [retired analyzers](../analyzers/index.html) will be used. If not set to true the analyzers marked as experimental (see below) will not be used | false
145-
analyzers | golangDepEnabled | Sets whether the [experimental](../analyzers/index.html) Golang Dependency Analyzer should be used. `experimentalEnabled` must be set to true. | true
146-
analyzers | golangModEnabled | Sets whether the [experimental](../analyzers/index.html) Goland Module Analyzer should be used; requires `go` to be installed. `experimentalEnabled` must be set to true. | true
147-
analyzers | pathToGo | The path to `go`. |  
122+
analyzers | nexusUrl | Defines the Nexus Server's web service end point (example http://domain.enterprise/service/local/). If not set the Nexus Analyzer will be disabled. |  
123+
analyzers | nexusUsesProxy | Whether or not the defined proxy should be used when connecting to Nexus. | true
124+
analyzers | pyDistributionEnabled | Sets whether the [experimental](../analyzers/index.html) Python Distribution Analyzer will be used. `experimentalEnabled` must be set to true. | true
125+
analyzers | pyPackageEnabled | Sets whether the [experimental](../analyzers/index.html) Python Package Analyzer will be used. `experimentalEnabled` must be set to true. | true
126+
analyzers | rubygemsEnabled | Sets whether the [experimental](../analyzers/index.html) Ruby Gemspec Analyzer will be used. `experimentalEnabled` must be set to true. | true
127+
analyzers | opensslEnabled | Sets whether the openssl Analyzer should be used. | true
128+
analyzers | nuspecEnabled | Sets whether the .NET Nuget Nuspec Analyzer will be used. | true
129+
analyzers | nugetconfEnabled | Sets whether the [experimental](../analyzers/index.html) .NET Nuget packages.config Analyzer will be used. `experimentalEnabled` must be set to true. | true
130+
analyzers | assemblyEnabled | Sets whether the .NET Assembly Analyzer should be used. | true
131+
analyzers | msbuildEnabled | Sets whether the MS Build Analyzer should be used. | true
132+
analyzers | pathToDotnet | The path to dotnet core - needed on some systems to analyze .net assemblies. |  
133+
analyzers | cmakeEnabled | Sets whether the [experimental](../analyzers/index.html) CMake Analyzer should be used. `experimentalEnabled` must be set to true. | true
134+
analyzers | autoconfEnabled | Sets whether the [experimental](../analyzers/index.html) autoconf Analyzer should be used. `experimentalEnabled` must be set to true. | true
135+
analyzers | composerEnabled | Sets whether the [experimental](../analyzers/index.html) PHP Composer Lock File Analyzer should be used. `experimentalEnabled` must be set to true. | true
136+
analyzers | composerSkipDev | Sets whether the [experimental](../analyzers/index.html) PHP Composer Lock File Analyzer should skip "packages-dev". | false
137+
analyzers | cpanEnabled | Sets whether the [experimental](../analyzers/index.html) Perl CPAN File Analyzer should be used. `experimentalEnabled` must be set to true. | true
138+
analyzers | cocoapodsEnabled | Sets whether the [experimental](../analyzers/index.html) Cocoapods Analyzer should be used. `experimentalEnabled` must be set to true. | true
139+
analyzers | carthageEnabled | Sets whether the [experimental](../analyzers/index.html) Carthage Analyzer should be used. `experimentalEnabled` must be set to true. | true
140+
analyzers | swiftEnabled | Sets whether the [experimental](../analyzers/index.html) Swift Package Manager Analyzer should be used. `experimentalEnabled` must be set to true. | true
141+
analyzers | swiftPackageResolvedEnabled | Sets whether the [experimental](../analyzers/index.html) Swift Package Resolved Analyzer should be used. `experimentalEnabled` must be set to true. | true
142+
analyzers | bundleAuditEnabled | Sets whether the [experimental](../analyzers/index.html) Ruby Bundle Audit Analyzer should be used. `experimentalEnabled` must be set to true. | true
143+
analyzers | pathToBundleAudit | The path to bundle audit. |  
144+
analyzers | retiredEnabled | Sets whether the [retired analyzers](../analyzers/index.html) will be used. If not set to true the analyzers marked as experimental (see below) will not be used | false
145+
analyzers | golangDepEnabled | Sets whether the [experimental](../analyzers/index.html) Golang Dependency Analyzer should be used. `experimentalEnabled` must be set to true. | true
146+
analyzers | golangModEnabled | Sets whether the [experimental](../analyzers/index.html) Goland Module Analyzer should be used; requires `go` to be installed. `experimentalEnabled` must be set to true. | true
147+
analyzers | pathToGo | The path to `go`. |  
148148

149149
#### Additional Configuration
150150

0 commit comments

Comments
 (0)