Overview

• Introduction
• Javadocs
• Source Xref

Descriptors Reference

• POM
• Settings
• Toolchains

Reference

• Lifecycles
• Plugin Bindings to Default Lifecycle
• Artifact Handlers
• CLI options
• Super POM

Development

• Maven Developer Centre
• Maven Core ITs

Project Documentation

• Project Information
• Project Reports
  • Surefire
  • Checkstyle
  • CPD
  • PMD
  • Source Xref
  • Test Source Xref
  • Tag List
  • Javadoc

Checkstyle Results

The following document contains the results of Checkstyle 9.3 with config/maven_checks_nocodestyle.xml ruleset.

Summary

Files	Info	Warnings	Errors
27	14	179	4

Files

File	I	W	E
org/apache/maven/model/building/DefaultModelBuilder.java	0	53	1
org/apache/maven/model/building/DefaultModelBuilderFactory.java	0	20	0
org/apache/maven/model/building/DefaultModelBuildingRequest.java	0	19	0
org/apache/maven/model/building/DefaultModelBuildingResult.java	0	2	0
org/apache/maven/model/building/DefaultModelProblem.java	0	1	0
org/apache/maven/model/building/DefaultModelProblemCollector.java	0	3	0
org/apache/maven/model/building/ModelBuilder.java	0	18	0
org/apache/maven/model/building/ModelBuildingRequest.java	0	3	0
org/apache/maven/model/building/ModelProblem.java	8	0	0
org/apache/maven/model/building/ModelProblemCollectorRequest.java	0	3	0
org/apache/maven/model/building/ModelProcessor.java	1	0	0
org/apache/maven/model/building/ModelSource2.java	0	1	0
org/apache/maven/model/building/ModelSource3.java	0	2	0
org/apache/maven/model/building/Result.java	0	18	0
org/apache/maven/model/building/TransformerContext.java	0	4	0
org/apache/maven/model/composition/DependencyManagementImporter.java	0	1	0
org/apache/maven/model/inheritance/InheritanceAssembler.java	0	1	0
org/apache/maven/model/interpolation/MavenBuildTimestamp.java	3	2	0
org/apache/maven/model/interpolation/ModelInterpolator.java	0	5	0
org/apache/maven/model/interpolation/ObjectBasedValueSource.java	0	2	0
org/apache/maven/model/locator/ModelLocator.java	0	4	0
org/apache/maven/model/path/ProfileActivationFilePathInterpolator.java	0	2	0
org/apache/maven/model/profile/DefaultProfileActivationContext.java	0	9	0
org/apache/maven/model/profile/ProfileInjector.java	0	2	0
org/apache/maven/model/resolution/ModelResolver.java	0	1	0
org/apache/maven/model/root/RootLocator.java	1	0	0
org/apache/maven/model/validation/DefaultModelValidator.java	1	3	3

Rules

Category	Rule	Violations	Severity
coding	HiddenField ignoreConstructorParameter: "true" ignoreSetter: "true"	73	Warning
javadoc	JavadocMethod accessModifiers: "public, protected"	106	Warning
	JavadocVariable scope: "protected"	14	Info
sizes	FileLength	2	Error
	MethodLength	2	Error

Details

org/apache/maven/model/building/DefaultModelBuilder.java

Severity	Category	Rule	Message	Line
Error	sizes	FileLength	File length is 2,013 lines (max allowed is 2,000).	1
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	179
Warning	coding	HiddenField	'modelProcessor' hides a field.	180
Warning	javadoc	JavadocMethod	Expected @param tag for 'modelProcessor'.	180
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	208
Warning	coding	HiddenField	'modelValidator' hides a field.	209
Warning	javadoc	JavadocMethod	Expected @param tag for 'modelValidator'.	209
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	237
Warning	coding	HiddenField	'modelNormalizer' hides a field.	238
Warning	javadoc	JavadocMethod	Expected @param tag for 'modelNormalizer'.	238
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	266
Warning	coding	HiddenField	'modelInterpolator' hides a field.	267
Warning	javadoc	JavadocMethod	Expected @param tag for 'modelInterpolator'.	267
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	295
Warning	coding	HiddenField	'modelPathTranslator' hides a field.	296
Warning	javadoc	JavadocMethod	Expected @param tag for 'modelPathTranslator'.	296
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	324
Warning	coding	HiddenField	'modelUrlNormalizer' hides a field.	325
Warning	javadoc	JavadocMethod	Expected @param tag for 'modelUrlNormalizer'.	325
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	353
Warning	coding	HiddenField	'superPomProvider' hides a field.	354
Warning	javadoc	JavadocMethod	Expected @param tag for 'superPomProvider'.	354
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	382
Warning	coding	HiddenField	'inheritanceAssembler' hides a field.	383
Warning	javadoc	JavadocMethod	Expected @param tag for 'inheritanceAssembler'.	383
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	411
Warning	coding	HiddenField	'profileSelector' hides a field.	412
Warning	javadoc	JavadocMethod	Expected @param tag for 'profileSelector'.	412
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	440
Warning	coding	HiddenField	'profileInjector' hides a field.	441
Warning	javadoc	JavadocMethod	Expected @param tag for 'profileInjector'.	441
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	469
Warning	coding	HiddenField	'pluginManagementInjector' hides a field.	470
Warning	javadoc	JavadocMethod	Expected @param tag for 'pluginManagementInjector'.	470
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	498
Warning	coding	HiddenField	'dependencyManagementInjector' hides a field.	500
Warning	javadoc	JavadocMethod	Expected @param tag for 'dependencyManagementInjector'.	500
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	528
Warning	coding	HiddenField	'dependencyManagementImporter' hides a field.	530
Warning	javadoc	JavadocMethod	Expected @param tag for 'dependencyManagementImporter'.	530
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	558
Warning	coding	HiddenField	'lifecycleBindingsInjector' hides a field.	559
Warning	javadoc	JavadocMethod	Expected @param tag for 'lifecycleBindingsInjector'.	559
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	587
Warning	coding	HiddenField	'pluginConfigurationExpander' hides a field.	588
Warning	javadoc	JavadocMethod	Expected @param tag for 'pluginConfigurationExpander'.	588
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	616
Warning	coding	HiddenField	'reportConfigurationExpander' hides a field.	617
Warning	javadoc	JavadocMethod	Expected @param tag for 'reportConfigurationExpander'.	617
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	645
Warning	coding	HiddenField	'profileActivationFilePathInterpolator' hides a field.	647
Warning	javadoc	JavadocMethod	Expected @param tag for 'profileActivationFilePathInterpolator'.	647
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	675
Warning	javadoc	JavadocMethod	Expected @param tag for 'reportingConverter'.	676

org/apache/maven/model/building/DefaultModelBuilderFactory.java

Severity	Category	Rule	Message	Line
Warning	coding	HiddenField	'modelProcessor' hides a field.	112
Warning	coding	HiddenField	'modelValidator' hides a field.	117
Warning	coding	HiddenField	'modelNormalizer' hides a field.	122
Warning	coding	HiddenField	'modelInterpolator' hides a field.	127
Warning	coding	HiddenField	'modelPathTranslator' hides a field.	132
Warning	coding	HiddenField	'modelUrlNormalizer' hides a field.	137
Warning	coding	HiddenField	'superPomProvider' hides a field.	142
Warning	coding	HiddenField	'inheritanceAssembler' hides a field.	147
Warning	coding	HiddenField	'profileSelector' hides a field.	152
Warning	coding	HiddenField	'profileInjector' hides a field.	157
Warning	coding	HiddenField	'pluginManagementInjector' hides a field.	162
Warning	coding	HiddenField	'dependencyManagementInjector' hides a field.	168
Warning	coding	HiddenField	'dependencyManagementImporter' hides a field.	174
Warning	coding	HiddenField	'lifecycleBindingsInjector' hides a field.	180
Warning	coding	HiddenField	'pluginConfigurationExpander' hides a field.	186
Warning	coding	HiddenField	'reportConfigurationExpander' hides a field.	192
Warning	coding	HiddenField	'profileActivationFilePathInterpolator' hides a field.	203
Warning	coding	HiddenField	'versionProcessor' hides a field.	208
Warning	coding	HiddenField	'transformer' hides a field.	213
Warning	coding	HiddenField	'versionParser' hides a field.	218

org/apache/maven/model/building/DefaultModelBuildingRequest.java

Severity	Category	Rule	Message	Line
Warning	coding	HiddenField	'pomPath' hides a field.	126
Warning	coding	HiddenField	'modelSource' hides a field.	140
Warning	coding	HiddenField	'validationLevel' hides a field.	152
Warning	coding	HiddenField	'processPlugins' hides a field.	164
Warning	coding	HiddenField	'twoPhaseBuilding' hides a field.	176
Warning	coding	HiddenField	'locationTracking' hides a field.	188
Warning	coding	HiddenField	'profiles' hides a field.	204
Warning	coding	HiddenField	'activeProfileIds' hides a field.	224
Warning	coding	HiddenField	'inactiveProfileIds' hides a field.	244
Warning	coding	HiddenField	'systemProperties' hides a field.	264
Warning	coding	HiddenField	'userProperties' hides a field.	288
Warning	coding	HiddenField	'buildStartTime' hides a field.	305
Warning	coding	HiddenField	'modelResolver' hides a field.	317
Warning	coding	HiddenField	'modelBuildingListener' hides a field.	329
Warning	coding	HiddenField	'modelCache' hides a field.	341
Warning	coding	HiddenField	'fileModel' hides a field.	353
Warning	coding	HiddenField	'workspaceResolver' hides a field.	374
Warning	coding	HiddenField	'contextBuilder' hides a field.	385
Warning	coding	HiddenField	'rootDirectory' hides a field.	396

org/apache/maven/model/building/DefaultModelBuildingResult.java

Severity	Category	Rule	Message	Line
Warning	coding	HiddenField	'fileModel' hides a field.	76
Warning	coding	HiddenField	'problems' hides a field.	164

org/apache/maven/model/building/DefaultModelProblem.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	Expected @param tag for 'version'.	62

org/apache/maven/model/building/DefaultModelProblemCollector.java

Severity	Category	Rule	Message	Line
Warning	coding	HiddenField	'problems' hides a field.	115
Warning	coding	HiddenField	'source' hides a field.	127
Warning	coding	HiddenField	'result' hides a field.	164

org/apache/maven/model/building/ModelBuilder.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	59
Warning	javadoc	JavadocMethod	Expected @param tag for 'pomFile'.	60
Warning	javadoc	JavadocMethod	Expected @param tag for 'validationLevel'.	60
Warning	javadoc	JavadocMethod	Expected @param tag for 'locationTracking'.	60
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	67
Warning	javadoc	JavadocMethod	Expected @param tag for 'pomFile'.	67
Warning	javadoc	JavadocMethod	Expected @param tag for 'validationLevel'.	67
Warning	javadoc	JavadocMethod	Expected @param tag for 'locationTracking'.	67
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	72
Warning	javadoc	JavadocMethod	Expected @param tag for 'pomFile'.	74
Warning	javadoc	JavadocMethod	Expected @param tag for 'validationLevel'.	74
Warning	javadoc	JavadocMethod	Expected @param tag for 'locationTracking'.	74
Warning	javadoc	JavadocMethod	Expected @param tag for 'context'.	74
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	79
Warning	javadoc	JavadocMethod	Expected @param tag for 'pomFile'.	80
Warning	javadoc	JavadocMethod	Expected @param tag for 'validationLevel'.	80
Warning	javadoc	JavadocMethod	Expected @param tag for 'locationTracking'.	80
Warning	javadoc	JavadocMethod	Expected @param tag for 'context'.	80

org/apache/maven/model/building/ModelBuildingRequest.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	91
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	97
Warning	javadoc	JavadocMethod	Expected @param tag for 'rawModel'.	98

org/apache/maven/model/building/ModelProblem.java

Severity	Category	Rule	Message	Line
Info	javadoc	JavadocVariable	Missing a Javadoc comment.	33
Info	javadoc	JavadocVariable	Missing a Javadoc comment.	34
Info	javadoc	JavadocVariable	Missing a Javadoc comment.	35
Info	javadoc	JavadocVariable	Missing a Javadoc comment.	43
Info	javadoc	JavadocVariable	Missing a Javadoc comment.	44
Info	javadoc	JavadocVariable	Missing a Javadoc comment.	45
Info	javadoc	JavadocVariable	Missing a Javadoc comment.	46
Info	javadoc	JavadocVariable	Missing a Javadoc comment.	47

org/apache/maven/model/building/ModelProblemCollectorRequest.java

Severity	Category	Rule	Message	Line
Warning	coding	HiddenField	'exception' hides a field.	61
Warning	coding	HiddenField	'message' hides a field.	70
Warning	coding	HiddenField	'location' hides a field.	79

org/apache/maven/model/building/ModelProcessor.java

Severity	Category	Rule	Message	Line
Info	javadoc	JavadocVariable	Missing a Javadoc comment.	30

org/apache/maven/model/building/ModelSource2.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	52

org/apache/maven/model/building/ModelSource3.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	52
Warning	javadoc	JavadocMethod	Expected @param tag for 'relPath'.	53

org/apache/maven/model/building/Result.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	49
Warning	javadoc	JavadocMethod	Expected @param tag for '<T>'.	49
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	59
Warning	javadoc	JavadocMethod	Expected @param tag for '<T>'.	59
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	70
Warning	javadoc	JavadocMethod	Expected @param tag for '<T>'.	70
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	87
Warning	javadoc	JavadocMethod	Expected @param tag for '<T>'.	87
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	117
Warning	javadoc	JavadocMethod	Expected @param tag for '<T>'.	117
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	127
Warning	javadoc	JavadocMethod	Expected @param tag for '<T>'.	127
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	138
Warning	javadoc	JavadocMethod	Expected @param tag for '<T>'.	138
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	148
Warning	javadoc	JavadocMethod	Expected @param tag for '<T>'.	148
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	175
Warning	javadoc	JavadocMethod	Expected @param tag for '<T>'.	175

org/apache/maven/model/building/TransformerContext.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	40
Warning	javadoc	JavadocMethod	Expected @param tag for 'key'.	40
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	65
Warning	javadoc	JavadocMethod	Expected @param tag for 'path'.	65

org/apache/maven/model/composition/DependencyManagementImporter.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	42

org/apache/maven/model/inheritance/InheritanceAssembler.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	42

org/apache/maven/model/interpolation/MavenBuildTimestamp.java

Severity	Category	Rule	Message	Line
Info	javadoc	JavadocVariable	Missing a Javadoc comment.	33
Info	javadoc	JavadocVariable	Missing a Javadoc comment.	35
Info	javadoc	JavadocVariable	Missing a Javadoc comment.	37
Warning	javadoc	JavadocMethod	Expected @param tag for 'time'.	59
Warning	javadoc	JavadocMethod	Expected @param tag for 'properties'.	59

org/apache/maven/model/interpolation/ModelInterpolator.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	76
Warning	javadoc	JavadocMethod	Expected @param tag for 'model'.	77
Warning	javadoc	JavadocMethod	Expected @param tag for 'projectDir'.	78
Warning	javadoc	JavadocMethod	Expected @param tag for 'request'.	79
Warning	javadoc	JavadocMethod	Expected @param tag for 'problems'.	80

org/apache/maven/model/interpolation/ObjectBasedValueSource.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	71
Warning	javadoc	JavadocMethod	Expected @param tag for 'expression'.	71

org/apache/maven/model/locator/ModelLocator.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	62
Warning	javadoc	JavadocMethod	Expected @param tag for 'project'.	63
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	73
Warning	javadoc	JavadocMethod	Expected @param tag for 'project'.	73

org/apache/maven/model/path/ProfileActivationFilePathInterpolator.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	Expected @param tag for 'path'.	59
Warning	javadoc	JavadocMethod	Expected @param tag for 'context'.	59

org/apache/maven/model/profile/DefaultProfileActivationContext.java

Severity	Category	Rule	Message	Line
Warning	coding	HiddenField	'activeProfileIds' hides a field.	59
Warning	coding	HiddenField	'inactiveProfileIds' hides a field.	75
Warning	coding	HiddenField	'systemProperties' hides a field.	93
Warning	coding	HiddenField	'systemProperties' hides a field.	104
Warning	coding	HiddenField	'userProperties' hides a field.	123
Warning	coding	HiddenField	'userProperties' hides a field.	135
Warning	coding	HiddenField	'projectDirectory' hides a field.	152
Warning	coding	HiddenField	'projectProperties' hides a field.	163
Warning	coding	HiddenField	'projectProperties' hides a field.	167

org/apache/maven/model/profile/ProfileInjector.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	54
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	73

org/apache/maven/model/resolution/ModelResolver.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	Expected @param tag for 'replace'.	108

org/apache/maven/model/root/RootLocator.java

Severity	Category	Rule	Message	Line
Info	javadoc	JavadocVariable	Missing a Javadoc comment.	41

org/apache/maven/model/validation/DefaultModelValidator.java

Severity	Category	Rule	Message	Line
Error	sizes	FileLength	File length is 2,016 lines (max allowed is 2,000).	1
Info	javadoc	JavadocVariable	Missing a Javadoc comment.	84
Error	sizes	MethodLength	Method validateFileModel length is 158 lines (max allowed is 150).	299
Error	sizes	MethodLength	Method validateEffectiveModel length is 165 lines (max allowed is 150).	625
Warning	javadoc	JavadocMethod	Expected @param tag for 'problems'.	1219
Warning	javadoc	JavadocMethod	Expected @param tag for 'd'.	1219
Warning	javadoc	JavadocMethod	Expected @param tag for 'prefix'.	1219