cxx:cppcheck

Full name:

org.codehaus.mojo:cxx-maven-plugin:0.0.6-SNAPSHOT:cppcheck

Description:

Goal which cppcheck sources.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: test.

Optional Parameters

Name Type Since Description
commandArgs String - Arguments for the cppcheck program. Shall be -v --enable=style --force --xml
Default value is: -v --enable=style --force --xml.
User property is: cppcheck.args.
environmentVariables Map 0.0.4 Environment variables to pass to cppcheck program.
excludes String 0.0.5 Excludes files/folder from analysis (comma separated list of filter)
User property is: cppcheck.excludes.
includeDirs List 0.0.4 Directory where included file shall be found
reportIdentifier String 0.0.4 The Report OutputFile name identifier.
User property is: cppcheck.reportIdentifier.
reportsfileDir File 0.0.4 The Report OutputFile Location.
Default value is: ${project.build.directory}/cppcheck-reports.
User property is: cppcheck.reportsfilePath.
skip boolean 0.0.5 Set this to "true" to bypass unit tests entirely. Its use is NOT RECOMMENDED, especially if you enable it using the "maven.test.skip" property, because maven.test.skip shall disables both running the tests and compiling the tests. Consider using the skipTests parameter instead.
Default value is: false.
User property is: maven.test.skip.
skipTests boolean 0.0.5 Set this to "true" to skip running tests, but still compile them. Its use is NOT RECOMMENDED, but quite convenient on occasion.
Default value is: false.
User property is: skipTests.
sourceDirs List 0.0.4 Directory where cppcheck should search for source files
workingDir File 0.0.4 The current working directory. Optional. If not specified, basedir will be used.
User property is: cppcheck.workingdir.

Parameter Details

commandArgs:

Arguments for the cppcheck program. Shall be -v --enable=style --force --xml
  • Type: java.lang.String
  • Required: No
  • User Property: cppcheck.args
  • Default: -v --enable=style --force --xml

environmentVariables:

Environment variables to pass to cppcheck program.
  • Type: java.util.Map
  • Since: 0.0.4
  • Required: No

excludes:

Excludes files/folder from analysis (comma separated list of filter)
  • Type: java.lang.String
  • Since: 0.0.5
  • Required: No
  • User Property: cppcheck.excludes

includeDirs:

Directory where included file shall be found
  • Type: java.util.List
  • Since: 0.0.4
  • Required: No

reportIdentifier:

The Report OutputFile name identifier.
  • Type: java.lang.String
  • Since: 0.0.4
  • Required: No
  • User Property: cppcheck.reportIdentifier

reportsfileDir:

The Report OutputFile Location.
  • Type: java.io.File
  • Since: 0.0.4
  • Required: No
  • User Property: cppcheck.reportsfilePath
  • Default: ${project.build.directory}/cppcheck-reports

skip:

Set this to "true" to bypass unit tests entirely. Its use is NOT RECOMMENDED, especially if you enable it using the "maven.test.skip" property, because maven.test.skip shall disables both running the tests and compiling the tests. Consider using the skipTests parameter instead.
  • Type: boolean
  • Since: 0.0.5
  • Required: No
  • User Property: maven.test.skip
  • Default: false

skipTests:

Set this to "true" to skip running tests, but still compile them. Its use is NOT RECOMMENDED, but quite convenient on occasion.
  • Type: boolean
  • Since: 0.0.5
  • Required: No
  • User Property: skipTests
  • Default: false

sourceDirs:

Directory where cppcheck should search for source files
  • Type: java.util.List
  • Since: 0.0.4
  • Required: No

workingDir:

The current working directory. Optional. If not specified, basedir will be used.
  • Type: java.io.File
  • Since: 0.0.4
  • Required: No
  • User Property: cppcheck.workingdir