You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by rf...@apache.org on 2018/01/04 10:22:38 UTC
svn commit: r1023252 [15/49] - in
/websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST:
./ apidocs/ apidocs/org/apache/maven/plugin/
apidocs/org/apache/maven/plugins/
apidocs/org/apache/maven/plugins/checkstyle/ apidocs...
Modified: websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/apidocs/stylesheet.css
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/apidocs/stylesheet.css (original)
+++ websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/apidocs/stylesheet.css Thu Jan 4 10:22:34 2018
@@ -2,16 +2,19 @@
/*
Overall document style
*/
+
+@import url('resources/fonts/dejavu.css');
+
body {
background-color:#ffffff;
color:#353833;
- font-family:Arial, Helvetica, sans-serif;
- font-size:76%;
+ font-family:'DejaVu Sans', Arial, Helvetica, sans-serif;
+ font-size:14px;
margin:0;
}
a:link, a:visited {
text-decoration:none;
- color:#4c6b87;
+ color:#4A6782;
}
a:hover, a:focus {
text-decoration:none;
@@ -19,7 +22,7 @@ a:hover, a:focus {
}
a:active {
text-decoration:none;
- color:#4c6b87;
+ color:#4A6782;
}
a[name] {
color:#353833;
@@ -29,41 +32,51 @@ a[name]:hover {
color:#353833;
}
pre {
- font-size:1.3em;
+ font-family:'DejaVu Sans Mono', monospace;
+ font-size:14px;
}
h1 {
- font-size:1.8em;
+ font-size:20px;
}
h2 {
- font-size:1.5em;
+ font-size:18px;
}
h3 {
- font-size:1.4em;
+ font-size:16px;
+ font-style:italic;
}
h4 {
- font-size:1.3em;
+ font-size:13px;
}
h5 {
- font-size:1.2em;
+ font-size:12px;
}
h6 {
- font-size:1.1em;
+ font-size:11px;
}
ul {
list-style-type:disc;
}
code, tt {
- font-size:1.2em;
+ font-family:'DejaVu Sans Mono', monospace;
+ font-size:14px;
+ padding-top:4px;
+ margin-top:8px;
+ line-height:1.4em;
}
dt code {
- font-size:1.2em;
+ font-family:'DejaVu Sans Mono', monospace;
+ font-size:14px;
+ padding-top:4px;
}
table tr td dt code {
- font-size:1.2em;
+ font-family:'DejaVu Sans Mono', monospace;
+ font-size:14px;
vertical-align:top;
+ padding-top:4px;
}
sup {
- font-size:.6em;
+ font-size:8px;
}
/*
Document title and Copyright styles
@@ -76,9 +89,9 @@ Document title and Copyright styles
.aboutLanguage {
float:right;
padding:0px 21px;
- font-size:.8em;
+ font-size:11px;
z-index:200;
- margin-top:-7px;
+ margin-top:-9px;
}
.legalCopy {
margin-left:.5em;
@@ -92,9 +105,6 @@ Document title and Copyright styles
}
.tab {
background-color:#0066FF;
- background-image:url(resources/titlebar.gif);
- background-position:left top;
- background-repeat:no-repeat;
color:#ffffff;
padding:8px;
width:5em;
@@ -104,17 +114,15 @@ Document title and Copyright styles
Navigation bar styles
*/
.bar {
- background-image:url(resources/background.gif);
- background-repeat:repeat-x;
+ background-color:#4D7A97;
color:#FFFFFF;
padding:.8em .5em .4em .8em;
height:auto;/*height:1.8em;*/
- font-size:1em;
+ font-size:11px;
margin:0;
}
.topNav {
- background-image:url(resources/background.gif);
- background-repeat:repeat-x;
+ background-color:#4D7A97;
color:#FFFFFF;
float:left;
padding:0;
@@ -123,11 +131,11 @@ Navigation bar styles
height:2.8em;
padding-top:10px;
overflow:hidden;
+ font-size:12px;
}
.bottomNav {
margin-top:10px;
- background-image:url(resources/background.gif);
- background-repeat:repeat-x;
+ background-color:#4D7A97;
color:#FFFFFF;
float:left;
padding:0;
@@ -136,18 +144,20 @@ Navigation bar styles
height:2.8em;
padding-top:10px;
overflow:hidden;
+ font-size:12px;
}
.subNav {
background-color:#dee3e9;
- border-bottom:1px solid #9eadc0;
float:left;
width:100%;
overflow:hidden;
+ font-size:12px;
}
.subNav div {
clear:left;
float:left;
padding:0 0 5px 6px;
+ text-transform:uppercase;
}
ul.navList, ul.subNavList {
float:left;
@@ -157,27 +167,33 @@ ul.navList, ul.subNavList {
ul.navList li{
list-style:none;
float:left;
- padding:3px 6px;
+ padding: 5px 6px;
+ text-transform:uppercase;
}
ul.subNavList li{
list-style:none;
float:left;
- font-size:90%;
}
.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited {
color:#FFFFFF;
text-decoration:none;
+ text-transform:uppercase;
}
.topNav a:hover, .bottomNav a:hover {
text-decoration:none;
color:#bb7a2a;
+ text-transform:uppercase;
}
.navBarCell1Rev {
- background-image:url(resources/tab.gif);
- background-color:#a88834;
- color:#FFFFFF;
+ background-color:#F8981D;
+ color:#253441;
margin: auto 5px;
- border:1px solid #c9aa44;
+}
+.skipNav {
+ position:absolute;
+ top:auto;
+ left:-9999px;
+ overflow:hidden;
}
/*
Page header and footer styles
@@ -191,8 +207,11 @@ Page header and footer styles
margin:10px;
position:relative;
}
+.indexHeader span{
+ margin-right:15px;
+}
.indexHeader h1 {
- font-size:1.3em;
+ font-size:13px;
}
.title {
color:#2c4557;
@@ -202,7 +221,7 @@ Page header and footer styles
margin:5px 0 0 0;
}
.header ul {
- margin:0 0 25px 0;
+ margin:0 0 15px 0;
padding:0;
}
.footer ul {
@@ -210,24 +229,22 @@ Page header and footer styles
}
.header ul li, .footer ul li {
list-style:none;
- font-size:1.2em;
+ font-size:13px;
}
/*
Heading styles
*/
div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 {
background-color:#dee3e9;
- border-top:1px solid #9eadc0;
- border-bottom:1px solid #9eadc0;
+ border:1px solid #d0d9e0;
margin:0 0 6px -8px;
- padding:2px 5px;
+ padding:7px 5px;
}
ul.blockList ul.blockList ul.blockList li.blockList h3 {
background-color:#dee3e9;
- border-top:1px solid #9eadc0;
- border-bottom:1px solid #9eadc0;
+ border:1px solid #d0d9e0;
margin:0 0 6px -8px;
- padding:2px 5px;
+ padding:7px 5px;
}
ul.blockList ul.blockList li.blockList h3 {
padding:0;
@@ -247,10 +264,10 @@ Page layout container styles
.indexContainer {
margin:10px;
position:relative;
- font-size:1.0em;
+ font-size:12px;
}
.indexContainer h2 {
- font-size:1.1em;
+ font-size:13px;
padding:0 0 3px 0;
}
.indexContainer ul {
@@ -259,15 +276,18 @@ Page layout container styles
}
.indexContainer ul li {
list-style:none;
+ padding-top:2px;
}
.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt {
- font-size:1.1em;
+ font-size:12px;
font-weight:bold;
margin:10px 0 0 0;
color:#4E4E4E;
}
.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd {
- margin:10px 0 10px 20px;
+ margin:5px 0 10px 0px;
+ font-size:14px;
+ font-family:'DejaVu Sans Mono',monospace;
}
.serializedFormContainer dl.nameValue dt {
margin-left:1px;
@@ -306,25 +326,24 @@ ul.blockList, ul.blockListLast {
}
ul.blockList li.blockList, ul.blockListLast li.blockList {
list-style:none;
- margin-bottom:25px;
+ margin-bottom:15px;
+ line-height:1.4;
}
ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList {
padding:0px 20px 5px 10px;
- border:1px solid #9eadc0;
- background-color:#f9f9f9;
+ border:1px solid #ededed;
+ background-color:#f8f8f8;
}
ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList {
padding:0 0 5px 8px;
background-color:#ffffff;
- border:1px solid #9eadc0;
- border-top:none;
+ border:none;
}
ul.blockList ul.blockList ul.blockList ul.blockList li.blockList {
margin-left:0;
padding-left:0;
padding-bottom:15px;
border:none;
- border-bottom:1px solid #9eadc0;
}
ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast {
list-style:none;
@@ -338,107 +357,155 @@ table tr td dl, table tr td dl dt, table
/*
Table styles
*/
-.contentContainer table, .classUseContainer table, .constantValuesContainer table {
- border-bottom:1px solid #9eadc0;
- width:100%;
-}
-.contentContainer ul li table, .classUseContainer ul li table, .constantValuesContainer ul li table {
+.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary {
width:100%;
+ border-left:1px solid #EEE;
+ border-right:1px solid #EEE;
+ border-bottom:1px solid #EEE;
}
-.contentContainer .description table, .contentContainer .details table {
- border-bottom:none;
-}
-.contentContainer ul li table th.colOne, .contentContainer ul li table th.colFirst, .contentContainer ul li table th.colLast, .classUseContainer ul li table th, .constantValuesContainer ul li table th, .contentContainer ul li table td.colOne, .contentContainer ul li table td.colFirst, .contentContainer ul li table td.colLast, .classUseContainer ul li table td, .constantValuesContainer ul li table td{
- vertical-align:top;
- padding-right:20px;
-}
-.contentContainer ul li table th.colLast, .classUseContainer ul li table th.colLast,.constantValuesContainer ul li table th.colLast,
-.contentContainer ul li table td.colLast, .classUseContainer ul li table td.colLast,.constantValuesContainer ul li table td.colLast,
-.contentContainer ul li table th.colOne, .classUseContainer ul li table th.colOne,
-.contentContainer ul li table td.colOne, .classUseContainer ul li table td.colOne {
- padding-right:3px;
+.overviewSummary, .memberSummary {
+ padding:0px;
}
-.overviewSummary caption, .packageSummary caption, .contentContainer ul.blockList li.blockList caption, .summary caption, .classUseContainer caption, .constantValuesContainer caption {
+.overviewSummary caption, .memberSummary caption, .typeSummary caption,
+.useSummary caption, .constantsSummary caption, .deprecatedSummary caption {
position:relative;
text-align:left;
background-repeat:no-repeat;
- color:#FFFFFF;
+ color:#253441;
font-weight:bold;
clear:none;
overflow:hidden;
padding:0px;
+ padding-top:10px;
+ padding-left:1px;
margin:0px;
+ white-space:pre;
}
-caption a:link, caption a:hover, caption a:active, caption a:visited {
+.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link,
+.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link,
+.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover,
+.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover,
+.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active,
+.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active,
+.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited,
+.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited {
color:#FFFFFF;
}
-.overviewSummary caption span, .packageSummary caption span, .contentContainer ul.blockList li.blockList caption span, .summary caption span, .classUseContainer caption span, .constantValuesContainer caption span {
+.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span,
+.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span {
white-space:nowrap;
- padding-top:8px;
- padding-left:8px;
- display:block;
+ padding-top:5px;
+ padding-left:12px;
+ padding-right:12px;
+ padding-bottom:7px;
+ display:inline-block;
float:left;
- background-image:url(resources/titlebar.gif);
- height:18px;
+ background-color:#F8981D;
+ border: none;
+ height:16px;
}
-.overviewSummary .tabEnd, .packageSummary .tabEnd, .contentContainer ul.blockList li.blockList .tabEnd, .summary .tabEnd, .classUseContainer .tabEnd, .constantValuesContainer .tabEnd {
- width:10px;
- background-image:url(resources/titlebar_end.gif);
- background-repeat:no-repeat;
- background-position:top right;
- position:relative;
+.memberSummary caption span.activeTableTab span {
+ white-space:nowrap;
+ padding-top:5px;
+ padding-left:12px;
+ padding-right:12px;
+ margin-right:3px;
+ display:inline-block;
float:left;
+ background-color:#F8981D;
+ height:16px;
}
-ul.blockList ul.blockList li.blockList table {
- margin:0 0 12px 0px;
- width:100%;
+.memberSummary caption span.tableTab span {
+ white-space:nowrap;
+ padding-top:5px;
+ padding-left:12px;
+ padding-right:12px;
+ margin-right:3px;
+ display:inline-block;
+ float:left;
+ background-color:#4D7A97;
+ height:16px;
}
-.tableSubHeadingColor {
- background-color: #EEEEFF;
+.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab {
+ padding-top:0px;
+ padding-left:0px;
+ padding-right:0px;
+ background-image:none;
+ float:none;
+ display:inline;
}
-.altColor {
- background-color:#eeeeef;
+.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd,
+.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd {
+ display:none;
+ width:5px;
+ position:relative;
+ float:left;
+ background-color:#F8981D;
}
-.rowColor {
- background-color:#ffffff;
+.memberSummary .activeTableTab .tabEnd {
+ display:none;
+ width:5px;
+ margin-right:3px;
+ position:relative;
+ float:left;
+ background-color:#F8981D;
}
-.overviewSummary td, .packageSummary td, .contentContainer ul.blockList li.blockList td, .summary td, .classUseContainer td, .constantValuesContainer td {
+.memberSummary .tableTab .tabEnd {
+ display:none;
+ width:5px;
+ margin-right:3px;
+ position:relative;
+ background-color:#4D7A97;
+ float:left;
+
+}
+.overviewSummary td, .memberSummary td, .typeSummary td,
+.useSummary td, .constantsSummary td, .deprecatedSummary td {
text-align:left;
- padding:3px 3px 3px 7px;
+ padding:0px 0px 12px 10px;
}
-th.colFirst, th.colLast, th.colOne, .constantValuesContainer th {
+th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th,
+td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{
+ vertical-align:top;
+ padding-right:0px;
+ padding-top:8px;
+ padding-bottom:3px;
+}
+th.colFirst, th.colLast, th.colOne, .constantsSummary th {
background:#dee3e9;
- border-top:1px solid #9eadc0;
- border-bottom:1px solid #9eadc0;
text-align:left;
- padding:3px 3px 3px 7px;
-}
-td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover {
- font-weight:bold;
+ padding:8px 3px 3px 7px;
}
td.colFirst, th.colFirst {
- border-left:1px solid #9eadc0;
white-space:nowrap;
+ font-size:13px;
}
td.colLast, th.colLast {
- border-right:1px solid #9eadc0;
+ font-size:13px;
}
td.colOne, th.colOne {
- border-right:1px solid #9eadc0;
- border-left:1px solid #9eadc0;
-}
-table.overviewSummary {
- padding:0px;
- margin-left:0px;
+ font-size:13px;
}
-table.overviewSummary td.colFirst, table.overviewSummary th.colFirst,
-table.overviewSummary td.colOne, table.overviewSummary th.colOne {
+.overviewSummary td.colFirst, .overviewSummary th.colFirst,
+.useSummary td.colFirst, .useSummary th.colFirst,
+.overviewSummary td.colOne, .overviewSummary th.colOne,
+.memberSummary td.colFirst, .memberSummary th.colFirst,
+.memberSummary td.colOne, .memberSummary th.colOne,
+.typeSummary td.colFirst{
width:25%;
- vertical-align:middle;
+ vertical-align:top;
}
-table.packageSummary td.colFirst, table.overviewSummary th.colFirst {
- width:25%;
- vertical-align:middle;
+td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover {
+ font-weight:bold;
+}
+.tableSubHeadingColor {
+ background-color:#EEEEFF;
+}
+.altColor {
+ background-color:#FFFFFF;
+}
+.rowColor {
+ background-color:#EEEEEF;
}
/*
Content styles
@@ -453,6 +520,24 @@ Content styles
.docSummary {
padding:0;
}
+
+ul.blockList ul.blockList ul.blockList li.blockList h3 {
+ font-style:normal;
+}
+
+div.block {
+ font-size:14px;
+ font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
+}
+
+td.colLast div {
+ padding-top:0px;
+}
+
+
+td.colLast a {
+ padding-bottom:3px;
+}
/*
Formatting effect styles
*/
@@ -463,12 +548,27 @@ Formatting effect styles
h1.hidden {
visibility:hidden;
overflow:hidden;
- font-size:.9em;
+ font-size:10px;
}
.block {
display:block;
- margin:3px 0 0 0;
+ margin:3px 10px 2px 0px;
+ color:#474747;
}
-.strong {
+.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink,
+.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel,
+.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink {
font-weight:bold;
+}
+.deprecationComment, .emphasizedPhrase, .interfaceName {
+ font-style:italic;
+}
+
+div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase,
+div.block div.block span.interfaceName {
+ font-style:normal;
+}
+
+div.contentContainer ul.blockList li.blockList h2{
+ padding-bottom:0px;
}
\ No newline at end of file
Modified: websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/check-mojo.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/check-mojo.html (original)
+++ websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/check-mojo.html Thu Jan 4 10:22:34 2018
@@ -1,31 +1,37 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia 1.4 at 2015-10-15
- | Rendered using Apache Maven Fluido Skin 1.4
+ | Generated by Apache Maven Doxia Site Renderer 1.7.1 at 2018-01-04
+ | Rendered using Apache Maven Fluido Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20151015" />
+ <meta name="Date-Revision-yyyymmdd" content="20180104" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Maven Checkstyle Plugin – checkstyle:check</title>
- <link rel="stylesheet" href="./css/apache-maven-fluido-1.4.min.css" />
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
- <script type="text/javascript" src="./js/apache-maven-fluido-1.4.min.js"></script>
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.5.min.js"></script>
-
-
-<script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>
-
-
-<script type="text/javascript">_uacct = "UA-140879-1";
- urchinTracker();</script>
-
- </head>
+ <!-- Google Analytics -->
+ <script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-140879-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+ </head>
<body class="topBarDisabled">
@@ -34,8 +40,8 @@
<div class="container-fluid">
<div id="banner">
<div class="pull-left">
- <a href="http://www.apache.org/" id="bannerLeft">
- <img src="../../images/apache-maven-project.png" alt="Apache Maven"/>
+ <a href="https://www.apache.org/" id="bannerLeft">
+ <img src="../../images/apache-maven-project.png" alt="Apache Maven Checkstyle Plugin"/>
</a>
</div>
<div class="pull-right"> <a href="../../" id="bannerRight">
@@ -47,10 +53,9 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
-
-
+
<li class="">
- <a href="http://www.apache.org/" class="externalLink" title="Apache">
+ <a href="https://www.apache.org/" class="externalLink" title="Apache">
Apache</a>
<span class="divider">/</span>
</li>
@@ -64,18 +69,17 @@
Plugins</a>
<span class="divider">/</span>
</li>
- <li class="">
- <a href="./" title="Apache Maven Checkstyle Plugin">
+ <li class="">
+ <a href="index.html" title="Apache Maven Checkstyle Plugin">
Apache Maven Checkstyle Plugin</a>
<span class="divider">/</span>
</li>
<li class="active ">checkstyle:check</li>
-
-
- <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2015-10-15</li>
+
+ <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2018-01-04</li>
<li id="projectVersion" class="pull-right">
- Version: 2.17
+ Version: 3.0.0
</li>
</ul>
@@ -85,8 +89,7 @@
<div class="row-fluid">
<div id="leftColumn" class="span2">
<div class="well sidebar-nav">
-
-
+
<ul class="nav nav-list">
<li class="nav-header">Overview</li>
@@ -207,13 +210,6 @@
<li>
- <a href="../../ant-tasks/index.html" title="Ant Tasks">
- <span class="none"></span>
- Ant Tasks</a>
- </li>
-
- <li>
-
<a href="../../archetype/index.html" title="Archetype">
<span class="none"></span>
Archetype</a>
@@ -313,40 +309,39 @@
<li>
- <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works">
+ <a href="https://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works">
<span class="none"></span>
How Apache Works</a>
</li>
<li>
- <a href="http://www.apache.org/foundation/" class="externalLink" title="Foundation">
+ <a href="https://www.apache.org/foundation/" class="externalLink" title="Foundation">
<span class="none"></span>
Foundation</a>
</li>
<li>
- <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache">
+ <a href="https://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache">
<span class="none"></span>
Sponsoring Apache</a>
</li>
<li>
- <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
+ <a href="https://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
<span class="none"></span>
Thanks</a>
</li>
</ul>
-
-
+
<form id="search-form" action="https://www.google.com/search" method="get" >
<input value="$sitesearchValue" name="sitesearch" type="hidden"/>
<input class="search-query" name="q" id="query" type="text" />
</form>
-<script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=search-form"></script>
+<script type="text/javascript" src="https://cse.google.com/brand?form=search-form"></script>
<hr />
@@ -355,7 +350,7 @@
<script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
- <div class="g-plusone" data-href="http://maven.apache.org/plugins/maven-checkstyle-plugin/" data-size="tall" ></div>
+ <div class="g-plusone" data-href="https://maven.apache.org/plugins/maven-checkstyle-plugin/" data-size="tall" ></div>
<div class="clear"></div>
<div class="clear"></div>
@@ -378,7 +373,7 @@
<p><b>Full name</b>:</p>
-<p>org.apache.maven.plugins:maven-checkstyle-plugin:2.17:check</p>
+<p>org.apache.maven.plugins:maven-checkstyle-plugin:3.0.0:check</p>
<p><b>Description</b>:</p>
@@ -500,7 +495,7 @@ runs.<br /><b>Default value is</b>: <tt>
<td><tt>2.12</tt></td>
<td>By using this property, you can specify the whole Checkstyle rules
-inline directly inside this pom. This feature requires Maven 3+.
+inline directly inside this pom.
<div>
<pre>
@@ -634,14 +629,18 @@ want to use <tt>logViolationsToConsole</
file) that can be used by Checkstyle to verify that source code has
the correct license header.</p>
-<p>You need to use ${checkstyle.header.file} in your Checkstyle xml
-configuration to reference the name of this header file.</p>
+<p>You need to use <tt>${checkstyle.header.file}</tt> in your
+Checkstyle xml configuration to reference the name of this header
+file.</p>
<p>For instance:</p>
-<p><tt><module name="RegexpHeader"> <property
-name="headerFile" value="${checkstyle.header.file}"/>
-</module></tt></p><br /><b>Default value is</b>: <tt>LICENSE.txt</tt>.<br /><b>User property is</b>: <tt>checkstyle.header.file</tt>.</td>
+<div>
+<pre>
+<module name="RegexpHeader">
+ <property name="headerFile" value="${checkstyle.header.file}"/>
+</module>
+</pre></div><br /><b>Default value is</b>: <tt>LICENSE.txt</tt>.<br /><b>User property is</b>: <tt>checkstyle.header.file</tt>.</td>
</tr>
<tr class="a">
@@ -680,6 +679,18 @@ if the number of violations is above thi
<tr class="b">
+<td><b><a href="#omitIgnoredModules">omitIgnoredModules</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>3.0.0</tt></td>
+
+<td>Specifies whether modules with a configured severity of
+<tt>ignore</tt> should be omitted during Checkstyle invocation.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td>
+ </tr>
+
+<tr class="a">
+
<td><b><a href="#outputFile">outputFile</a></b></td>
<td><tt>File</tt></td>
@@ -691,7 +702,7 @@ format of the output file is determined
<tt>outputFileFormat</tt> parameter.<br /><b>Default value is</b>: <tt>${project.build.directory}/checkstyle-result.xml</tt>.<br /><b>User property is</b>: <tt>checkstyle.output.file</tt>.</td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#outputFileFormat">outputFileFormat</a></b></td>
@@ -704,7 +715,7 @@ output file. Valid values are "<tt>
"<tt>xml</tt>".<br /><b>Default value is</b>: <tt>xml</tt>.<br /><b>User property is</b>: <tt>checkstyle.output.format</tt>.</td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#propertiesLocation">propertiesLocation</a></b></td>
@@ -727,7 +738,7 @@ the xml configuration (specified in the
parameter).</p><br /><b>User property is</b>: <tt>checkstyle.properties.location</tt>.</td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#propertyExpansion">propertyExpansion</a></b></td>
@@ -738,7 +749,7 @@ parameter).</p><br /><b>User property is
<td>Allows for specifying raw property expansion information.<br /></td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#resourceExcludes">resourceExcludes</a></b></td>
@@ -750,7 +761,7 @@ parameter).</p><br /><b>User property is
Checkstyle when checking resources.<br /><b>User property is</b>: <tt>checkstyle.resourceExcludes</tt>.</td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#rulesFiles">rulesFiles</a></b></td>
@@ -758,10 +769,10 @@ Checkstyle when checking resources.<br /
<td><tt>-</tt></td>
-<td>dump file for inlined Checkstyle rules<br /><b>Default value is</b>: <tt>${project.build.directory}/checkstyle-rules.xml</tt>.<br /><b>User property is</b>: <tt>checkstyle.output.rules.file</tt>.</td>
+<td>Dump file for inlined Checkstyle rules.<br /><b>Default value is</b>: <tt>${project.build.directory}/checkstyle-rules.xml</tt>.<br /><b>User property is</b>: <tt>checkstyle.output.rules.file</tt>.</td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#skip">skip</a></b></td>
@@ -772,7 +783,7 @@ Checkstyle when checking resources.<br /
<td>Skip entire check.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>checkstyle.skip</tt>.</td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#skipExec">skipExec</a></b></td>
@@ -783,7 +794,7 @@ Checkstyle when checking resources.<br /
<td>Skip Checkstyle execution will only scan the outputFile.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>checkstyle.skipExec</tt>.</td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#sourceDirectories">sourceDirectories</a></b></td>
@@ -792,10 +803,11 @@ Checkstyle when checking resources.<br /
<td><tt>2.13</tt></td>
<td>Specifies the location of the source directories to be used for
-Checkstyle.<br /><b>Default value is</b>: <tt>${project.compileSourceRoots}</tt>.<br /></td>
+Checkstyle. Default value is
+<tt>${project.compileSourceRoots}</tt>.<br /></td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#sourceDirectory">sourceDirectory</a></b></td>
@@ -803,10 +815,11 @@ Checkstyle.<br /><b>Default value is</b>
<td><tt>-</tt></td>
-<td><b>Deprecated.</b> instead use <tt>sourceDirectories</tt><br /></td>
+<td><b>Deprecated.</b> instead use <tt>sourceDirectories</tt>. For version 3.0.0, this
+parameter is only defined to break the build if you use it!<br /></td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#suppressionsFileExpression">suppressionsFileExpression</a></b></td>
@@ -817,7 +830,7 @@ Checkstyle.<br /><b>Default value is</b>
<td>The key to be used in the properties for the suppressions file.<br /><b>Default value is</b>: <tt>checkstyle.suppressions.file</tt>.<br /><b>User property is</b>: <tt>checkstyle.suppression.expression</tt>.</td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#suppressionsLocation">suppressionsLocation</a></b></td>
@@ -838,7 +851,7 @@ file before being passed to Checkstyle f
that will be made available to your Checkstyle configuration.</p><br /><b>User property is</b>: <tt>checkstyle.suppressions.location</tt>.</td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#testSourceDirectories">testSourceDirectories</a></b></td>
@@ -847,10 +860,11 @@ that will be made available to your Chec
<td><tt>2.13</tt></td>
<td>Specifies the location of the test source directories to be used
-for Checkstyle.<br /><b>Default value is</b>: <tt>${project.testCompileSourceRoots}</tt>.<br /></td>
+for Checkstyle. Default value is
+<tt>${project.testCompileSourceRoots}</tt>.<br /></td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#testSourceDirectory">testSourceDirectory</a></b></td>
@@ -858,10 +872,11 @@ for Checkstyle.<br /><b>Default value is
<td><tt>2.2</tt></td>
-<td><b>Deprecated.</b> instead use <tt>testSourceDirectories</tt><br /></td>
+<td><b>Deprecated.</b> instead use <tt>testSourceDirectories</tt>. For version 3.0.0,
+this parameter is only defined to break the build if you use it!<br /></td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#useFile">useFile</a></b></td>
@@ -874,7 +889,7 @@ on stdout. Otherwise, a text file will b
violations.<br /></td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#violationIgnore">violationIgnore</a></b></td>
@@ -887,7 +902,7 @@ being either a rule name, a rule categor
rule class.<br /><b>User property is</b>: <tt>checkstyle.violation.ignore</tt>.</td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#violationSeverity">violationSeverity</a></b></td>
@@ -921,7 +936,7 @@ runs.</div>
<p><b><a name="checkstyleRules">checkstyleRules</a>:</b></p>
<div>By using this property, you can specify the whole Checkstyle rules
-inline directly inside this pom. This feature requires Maven 3+.
+inline directly inside this pom.
<div>
<pre>
@@ -1074,14 +1089,18 @@ want to use <tt>logViolationsToConsole</
file) that can be used by Checkstyle to verify that source code has
the correct license header.</p>
-<p>You need to use ${checkstyle.header.file} in your Checkstyle xml
-configuration to reference the name of this header file.</p>
+<p>You need to use <tt>${checkstyle.header.file}</tt> in your
+Checkstyle xml configuration to reference the name of this header
+file.</p>
<p>For instance:</p>
-<p><tt><module name="RegexpHeader"> <property
-name="headerFile" value="${checkstyle.header.file}"/>
-</module></tt></p></div>
+<div>
+<pre>
+<module name="RegexpHeader">
+ <property name="headerFile" value="${checkstyle.header.file}"/>
+</module>
+</pre></div></div>
<ul>
@@ -1189,6 +1208,21 @@ if the number of violations is above thi
<li><b>Default</b>: <tt>0</tt></li>
</ul><hr />
+<p><b><a name="omitIgnoredModules">omitIgnoredModules</a>:</b></p>
+
+<div>Specifies whether modules with a configured severity of
+<tt>ignore</tt> should be omitted during Checkstyle invocation.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>3.0.0</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr />
<p><b><a name="outputFile">outputFile</a>:</b></p>
<div>Specifies the path and filename to save the Checkstyle output. The
@@ -1291,7 +1325,7 @@ when checking resources.</div>
</ul><hr />
<p><b><a name="rulesFiles">rulesFiles</a>:</b></p>
-<div>dump file for inlined Checkstyle rules</div>
+<div>Dump file for inlined Checkstyle rules.</div>
<ul>
@@ -1338,7 +1372,8 @@ when checking resources.</div>
<p><b><a name="sourceDirectories">sourceDirectories</a>:</b></p>
<div>Specifies the location of the source directories to be used for
-Checkstyle.</div>
+Checkstyle. Default value is
+<tt>${project.compileSourceRoots}</tt>.</div>
<ul>
@@ -1347,12 +1382,11 @@ Checkstyle.</div>
<li><b>Since</b>: <tt>2.13</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.compileSourceRoots}</tt></li>
</ul><hr />
<p><b><a name="sourceDirectory">sourceDirectory</a>:</b></p>
-<div><b>Deprecated.</b> instead use <tt>sourceDirectories</tt></div>
+<div><b>Deprecated.</b> instead use <tt>sourceDirectories</tt>. For version 3.0.0, this
+parameter is only defined to break the build if you use it!</div>
<div>Specifies the location of the source directory to be used for
Checkstyle.</div>
@@ -1406,7 +1440,8 @@ that will be made available to your Chec
<p><b><a name="testSourceDirectories">testSourceDirectories</a>:</b></p>
<div>Specifies the location of the test source directories to be used
-for Checkstyle.</div>
+for Checkstyle. Default value is
+<tt>${project.testCompileSourceRoots}</tt>.</div>
<ul>
@@ -1415,12 +1450,11 @@ for Checkstyle.</div>
<li><b>Since</b>: <tt>2.13</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.testCompileSourceRoots}</tt></li>
</ul><hr />
<p><b><a name="testSourceDirectory">testSourceDirectory</a>:</b></p>
-<div><b>Deprecated.</b> instead use <tt>testSourceDirectories</tt></div>
+<div><b>Deprecated.</b> instead use <tt>testSourceDirectories</tt>. For version 3.0.0,
+this parameter is only defined to break the build if you use it!</div>
<div>Specifies the location of the test source directory to be used for
Checkstyle.</div>
@@ -1492,10 +1526,9 @@ values are "<tt>error</tt>", &
<footer>
<div class="container-fluid">
<div class="row-fluid">
- <p >Copyright © 2005–2015
- <a href="http://www.apache.org/">The Apache Software Foundation</a>.
- All rights reserved.
-
+ <p >Copyright © 2005–2018
+ <a href="https://www.apache.org/">The Apache Software Foundation</a>.
+ All rights reserved.
</p>
</div>
Modified: websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/checkstyle-aggregate-mojo.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/checkstyle-aggregate-mojo.html (original)
+++ websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/checkstyle-aggregate-mojo.html Thu Jan 4 10:22:34 2018
@@ -1,31 +1,37 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia 1.4 at 2015-10-15
- | Rendered using Apache Maven Fluido Skin 1.4
+ | Generated by Apache Maven Doxia Site Renderer 1.7.1 at 2018-01-04
+ | Rendered using Apache Maven Fluido Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20151015" />
+ <meta name="Date-Revision-yyyymmdd" content="20180104" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Maven Checkstyle Plugin – checkstyle:checkstyle-aggregate</title>
- <link rel="stylesheet" href="./css/apache-maven-fluido-1.4.min.css" />
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
- <script type="text/javascript" src="./js/apache-maven-fluido-1.4.min.js"></script>
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.5.min.js"></script>
-
-
-<script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>
-
-
-<script type="text/javascript">_uacct = "UA-140879-1";
- urchinTracker();</script>
-
- </head>
+ <!-- Google Analytics -->
+ <script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-140879-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+ </head>
<body class="topBarDisabled">
@@ -34,8 +40,8 @@
<div class="container-fluid">
<div id="banner">
<div class="pull-left">
- <a href="http://www.apache.org/" id="bannerLeft">
- <img src="../../images/apache-maven-project.png" alt="Apache Maven"/>
+ <a href="https://www.apache.org/" id="bannerLeft">
+ <img src="../../images/apache-maven-project.png" alt="Apache Maven Checkstyle Plugin"/>
</a>
</div>
<div class="pull-right"> <a href="../../" id="bannerRight">
@@ -47,10 +53,9 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
-
-
+
<li class="">
- <a href="http://www.apache.org/" class="externalLink" title="Apache">
+ <a href="https://www.apache.org/" class="externalLink" title="Apache">
Apache</a>
<span class="divider">/</span>
</li>
@@ -64,18 +69,17 @@
Plugins</a>
<span class="divider">/</span>
</li>
- <li class="">
- <a href="./" title="Apache Maven Checkstyle Plugin">
+ <li class="">
+ <a href="index.html" title="Apache Maven Checkstyle Plugin">
Apache Maven Checkstyle Plugin</a>
<span class="divider">/</span>
</li>
<li class="active ">checkstyle:checkstyle-aggregate</li>
-
-
- <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2015-10-15</li>
+
+ <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2018-01-04</li>
<li id="projectVersion" class="pull-right">
- Version: 2.17
+ Version: 3.0.0
</li>
</ul>
@@ -85,8 +89,7 @@
<div class="row-fluid">
<div id="leftColumn" class="span2">
<div class="well sidebar-nav">
-
-
+
<ul class="nav nav-list">
<li class="nav-header">Overview</li>
@@ -207,13 +210,6 @@
<li>
- <a href="../../ant-tasks/index.html" title="Ant Tasks">
- <span class="none"></span>
- Ant Tasks</a>
- </li>
-
- <li>
-
<a href="../../archetype/index.html" title="Archetype">
<span class="none"></span>
Archetype</a>
@@ -313,40 +309,39 @@
<li>
- <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works">
+ <a href="https://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works">
<span class="none"></span>
How Apache Works</a>
</li>
<li>
- <a href="http://www.apache.org/foundation/" class="externalLink" title="Foundation">
+ <a href="https://www.apache.org/foundation/" class="externalLink" title="Foundation">
<span class="none"></span>
Foundation</a>
</li>
<li>
- <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache">
+ <a href="https://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache">
<span class="none"></span>
Sponsoring Apache</a>
</li>
<li>
- <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
+ <a href="https://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
<span class="none"></span>
Thanks</a>
</li>
</ul>
-
-
+
<form id="search-form" action="https://www.google.com/search" method="get" >
<input value="$sitesearchValue" name="sitesearch" type="hidden"/>
<input class="search-query" name="q" id="query" type="text" />
</form>
-<script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=search-form"></script>
+<script type="text/javascript" src="https://cse.google.com/brand?form=search-form"></script>
<hr />
@@ -355,7 +350,7 @@
<script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
- <div class="g-plusone" data-href="http://maven.apache.org/plugins/maven-checkstyle-plugin/" data-size="tall" ></div>
+ <div class="g-plusone" data-href="https://maven.apache.org/plugins/maven-checkstyle-plugin/" data-size="tall" ></div>
<div class="clear"></div>
<div class="clear"></div>
@@ -380,7 +375,7 @@
<p><b>Full name</b>:</p>
-<p>org.apache.maven.plugins:maven-checkstyle-plugin:2.17:checkstyle-aggregate</p>
+<p>org.apache.maven.plugins:maven-checkstyle-plugin:3.0.0:checkstyle-aggregate</p>
<p><b>Description</b>:</p>
@@ -633,14 +628,18 @@ Checkstyle.<br /><b>User property is</b>
file) that can be used by Checkstyle to verify that source code has
the correct license header.</p>
-<p>You need to use ${checkstyle.header.file} in your Checkstyle xml
-configuration to reference the name of this header file.</p>
+<p>You need to use <tt>${checkstyle.header.file}</tt> in your
+Checkstyle xml configuration to reference the name of this header
+file.</p>
<p>For instance:</p>
-<p><tt><module name="RegexpHeader"> <property
-name="headerFile" value="${checkstyle.header.file}"/>
-</module></tt></p><br /><b>Default value is</b>: <tt>LICENSE.txt</tt>.<br /><b>User property is</b>: <tt>checkstyle.header.file</tt>.</td>
+<div>
+<pre>
+<module name="RegexpHeader">
+ <property name="headerFile" value="${checkstyle.header.file}"/>
+</module>
+</pre></div><br /><b>Default value is</b>: <tt>LICENSE.txt</tt>.<br /><b>User property is</b>: <tt>checkstyle.header.file</tt>.</td>
</tr>
<tr class="a">
@@ -669,6 +668,18 @@ automatically if Maven JXR plugin is bei
<tr class="a">
+<td><b><a href="#omitIgnoredModules">omitIgnoredModules</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>3.0.0</tt></td>
+
+<td>Specifies whether modules with a configured severity of
+<tt>ignore</tt> should be omitted during Checkstyle invocation.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td>
+ </tr>
+
+<tr class="b">
+
<td><b><a href="#outputFile">outputFile</a></b></td>
<td><tt>File</tt></td>
@@ -680,7 +691,7 @@ format of the output file is determined
<tt>outputFileFormat</tt> parameter.<br /><b>Default value is</b>: <tt>${project.build.directory}/checkstyle-result.xml</tt>.<br /><b>User property is</b>: <tt>checkstyle.output.file</tt>.</td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#outputFileFormat">outputFileFormat</a></b></td>
@@ -693,7 +704,7 @@ output file. Valid values are "<tt>
"<tt>xml</tt>".<br /><b>Default value is</b>: <tt>xml</tt>.<br /><b>User property is</b>: <tt>checkstyle.output.format</tt>.</td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#propertiesLocation">propertiesLocation</a></b></td>
@@ -716,7 +727,7 @@ the xml configuration (specified in the
parameter).</p><br /><b>User property is</b>: <tt>checkstyle.properties.location</tt>.</td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#propertyExpansion">propertyExpansion</a></b></td>
@@ -727,7 +738,7 @@ parameter).</p><br /><b>User property is
<td>Allows for specifying raw property expansion information.<br /></td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#resourceExcludes">resourceExcludes</a></b></td>
@@ -739,7 +750,7 @@ parameter).</p><br /><b>User property is
Checkstyle.<br /><b>User property is</b>: <tt>checkstyle.resourceExcludes</tt>.</td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#skip">skip</a></b></td>
@@ -750,7 +761,7 @@ Checkstyle.<br /><b>User property is</b>
<td>Skip entire check.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>checkstyle.skip</tt>.</td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#sourceDirectories">sourceDirectories</a></b></td>
@@ -759,10 +770,11 @@ Checkstyle.<br /><b>User property is</b>
<td><tt>2.13</tt></td>
<td>Specifies the location of the source directories to be used for
-Checkstyle.<br /><b>Default value is</b>: <tt>${project.compileSourceRoots}</tt>.<br /></td>
+Checkstyle. Default value is
+<tt>${project.compileSourceRoots}</tt>.<br /></td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#sourceDirectory">sourceDirectory</a></b></td>
@@ -770,10 +782,11 @@ Checkstyle.<br /><b>Default value is</b>
<td><tt>-</tt></td>
-<td><b>Deprecated.</b> instead use <tt>sourceDirectories</tt><br /></td>
+<td><b>Deprecated.</b> instead use <tt>sourceDirectories</tt>. For version 3.0.0, this
+parameter is only defined to break the build if you use it!<br /></td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#suppressionsFileExpression">suppressionsFileExpression</a></b></td>
@@ -784,7 +797,7 @@ Checkstyle.<br /><b>Default value is</b>
<td>The key to be used in the properties for the suppressions file.<br /><b>Default value is</b>: <tt>checkstyle.suppressions.file</tt>.<br /><b>User property is</b>: <tt>checkstyle.suppression.expression</tt>.</td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#suppressionsLocation">suppressionsLocation</a></b></td>
@@ -805,7 +818,7 @@ file before being passed to Checkstyle f
that will be made available to your Checkstyle configuration.</p><br /><b>User property is</b>: <tt>checkstyle.suppressions.location</tt>.</td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#testSourceDirectories">testSourceDirectories</a></b></td>
@@ -814,10 +827,11 @@ that will be made available to your Chec
<td><tt>2.13</tt></td>
<td>Specifies the location of the test source directories to be used
-for Checkstyle.<br /><b>Default value is</b>: <tt>${project.testCompileSourceRoots}</tt>.<br /></td>
+for Checkstyle. Default value is
+<tt>${project.testCompileSourceRoots}</tt>.<br /></td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#testSourceDirectory">testSourceDirectory</a></b></td>
@@ -825,10 +839,11 @@ for Checkstyle.<br /><b>Default value is
<td><tt>2.2</tt></td>
-<td><b>Deprecated.</b> instead use <tt>testSourceDirectories</tt><br /></td>
+<td><b>Deprecated.</b> instead use <tt>testSourceDirectories</tt>. For version 3.0.0,
+this parameter is only defined to break the build if you use it!<br /></td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#treeWalkerNames">treeWalkerNames</a></b></td>
@@ -840,7 +855,7 @@ for Checkstyle.<br /><b>Default value is
checks inside the treeWalker end up the the rule-summary.<br /></td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#useFile">useFile</a></b></td>
@@ -853,7 +868,7 @@ on stdout. Otherwise, a text file will b
violations.<br /></td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#xrefLocation">xrefLocation</a></b></td>
@@ -1040,14 +1055,18 @@ Checkstyle.</div>
file) that can be used by Checkstyle to verify that source code has
the correct license header.</p>
-<p>You need to use ${checkstyle.header.file} in your Checkstyle xml
-configuration to reference the name of this header file.</p>
+<p>You need to use <tt>${checkstyle.header.file}</tt> in your
+Checkstyle xml configuration to reference the name of this header
+file.</p>
<p>For instance:</p>
-<p><tt><module name="RegexpHeader"> <property
-name="headerFile" value="${checkstyle.header.file}"/>
-</module></tt></p></div>
+<div>
+<pre>
+<module name="RegexpHeader">
+ <property name="headerFile" value="${checkstyle.header.file}"/>
+</module>
+</pre></div></div>
<ul>
@@ -1141,6 +1160,21 @@ automatically if Maven JXR plugin is bei
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr />
+<p><b><a name="omitIgnoredModules">omitIgnoredModules</a>:</b></p>
+
+<div>Specifies whether modules with a configured severity of
+<tt>ignore</tt> should be omitted during Checkstyle invocation.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>3.0.0</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr />
<p><b><a name="outputFile">outputFile</a>:</b></p>
<div>Specifies the path and filename to save the Checkstyle output. The
@@ -1260,7 +1294,8 @@ Checkstyle.</div>
<p><b><a name="sourceDirectories">sourceDirectories</a>:</b></p>
<div>Specifies the location of the source directories to be used for
-Checkstyle.</div>
+Checkstyle. Default value is
+<tt>${project.compileSourceRoots}</tt>.</div>
<ul>
@@ -1269,12 +1304,11 @@ Checkstyle.</div>
<li><b>Since</b>: <tt>2.13</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.compileSourceRoots}</tt></li>
</ul><hr />
<p><b><a name="sourceDirectory">sourceDirectory</a>:</b></p>
-<div><b>Deprecated.</b> instead use <tt>sourceDirectories</tt></div>
+<div><b>Deprecated.</b> instead use <tt>sourceDirectories</tt>. For version 3.0.0, this
+parameter is only defined to break the build if you use it!</div>
<div>Specifies the location of the source directory to be used for
Checkstyle.</div>
@@ -1328,7 +1362,8 @@ that will be made available to your Chec
<p><b><a name="testSourceDirectories">testSourceDirectories</a>:</b></p>
<div>Specifies the location of the test source directories to be used
-for Checkstyle.</div>
+for Checkstyle. Default value is
+<tt>${project.testCompileSourceRoots}</tt>.</div>
<ul>
@@ -1337,12 +1372,11 @@ for Checkstyle.</div>
<li><b>Since</b>: <tt>2.13</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.testCompileSourceRoots}</tt></li>
</ul><hr />
<p><b><a name="testSourceDirectory">testSourceDirectory</a>:</b></p>
-<div><b>Deprecated.</b> instead use <tt>testSourceDirectories</tt></div>
+<div><b>Deprecated.</b> instead use <tt>testSourceDirectories</tt>. For version 3.0.0,
+this parameter is only defined to break the build if you use it!</div>
<div>Specifies the location of the test source directory to be used for
Checkstyle.</div>
@@ -1405,10 +1439,9 @@ violations.</div>
<footer>
<div class="container-fluid">
<div class="row-fluid">
- <p >Copyright © 2005–2015
- <a href="http://www.apache.org/">The Apache Software Foundation</a>.
- All rights reserved.
-
+ <p >Copyright © 2005–2018
+ <a href="https://www.apache.org/">The Apache Software Foundation</a>.
+ All rights reserved.
</p>
</div>
Modified: websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/checkstyle-mojo.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/checkstyle-mojo.html (original)
+++ websites/production/maven/components/plugins-archives/maven-checkstyle-plugin-LATEST/checkstyle-mojo.html Thu Jan 4 10:22:34 2018
@@ -1,31 +1,37 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia 1.4 at 2015-10-15
- | Rendered using Apache Maven Fluido Skin 1.4
+ | Generated by Apache Maven Doxia Site Renderer 1.7.1 at 2018-01-04
+ | Rendered using Apache Maven Fluido Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20151015" />
+ <meta name="Date-Revision-yyyymmdd" content="20180104" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Maven Checkstyle Plugin – checkstyle:checkstyle</title>
- <link rel="stylesheet" href="./css/apache-maven-fluido-1.4.min.css" />
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
- <script type="text/javascript" src="./js/apache-maven-fluido-1.4.min.js"></script>
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.5.min.js"></script>
-
-
-<script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>
-
-
-<script type="text/javascript">_uacct = "UA-140879-1";
- urchinTracker();</script>
-
- </head>
+ <!-- Google Analytics -->
+ <script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-140879-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+ </head>
<body class="topBarDisabled">
@@ -34,8 +40,8 @@
<div class="container-fluid">
<div id="banner">
<div class="pull-left">
- <a href="http://www.apache.org/" id="bannerLeft">
- <img src="../../images/apache-maven-project.png" alt="Apache Maven"/>
+ <a href="https://www.apache.org/" id="bannerLeft">
+ <img src="../../images/apache-maven-project.png" alt="Apache Maven Checkstyle Plugin"/>
</a>
</div>
<div class="pull-right"> <a href="../../" id="bannerRight">
@@ -47,10 +53,9 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
-
-
+
<li class="">
- <a href="http://www.apache.org/" class="externalLink" title="Apache">
+ <a href="https://www.apache.org/" class="externalLink" title="Apache">
Apache</a>
<span class="divider">/</span>
</li>
@@ -64,18 +69,17 @@
Plugins</a>
<span class="divider">/</span>
</li>
- <li class="">
- <a href="./" title="Apache Maven Checkstyle Plugin">
+ <li class="">
+ <a href="index.html" title="Apache Maven Checkstyle Plugin">
Apache Maven Checkstyle Plugin</a>
<span class="divider">/</span>
</li>
<li class="active ">checkstyle:checkstyle</li>
-
-
- <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2015-10-15</li>
+
+ <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2018-01-04</li>
<li id="projectVersion" class="pull-right">
- Version: 2.17
+ Version: 3.0.0
</li>
</ul>
@@ -85,8 +89,7 @@
<div class="row-fluid">
<div id="leftColumn" class="span2">
<div class="well sidebar-nav">
-
-
+
<ul class="nav nav-list">
<li class="nav-header">Overview</li>
@@ -207,13 +210,6 @@
<li>
- <a href="../../ant-tasks/index.html" title="Ant Tasks">
- <span class="none"></span>
- Ant Tasks</a>
- </li>
-
- <li>
-
<a href="../../archetype/index.html" title="Archetype">
<span class="none"></span>
Archetype</a>
@@ -313,40 +309,39 @@
<li>
- <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works">
+ <a href="https://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works">
<span class="none"></span>
How Apache Works</a>
</li>
<li>
- <a href="http://www.apache.org/foundation/" class="externalLink" title="Foundation">
+ <a href="https://www.apache.org/foundation/" class="externalLink" title="Foundation">
<span class="none"></span>
Foundation</a>
</li>
<li>
- <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache">
+ <a href="https://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache">
<span class="none"></span>
Sponsoring Apache</a>
</li>
<li>
- <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
+ <a href="https://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
<span class="none"></span>
Thanks</a>
</li>
</ul>
-
-
+
<form id="search-form" action="https://www.google.com/search" method="get" >
<input value="$sitesearchValue" name="sitesearch" type="hidden"/>
<input class="search-query" name="q" id="query" type="text" />
</form>
-<script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=search-form"></script>
+<script type="text/javascript" src="https://cse.google.com/brand?form=search-form"></script>
<hr />
@@ -355,7 +350,7 @@
<script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
- <div class="g-plusone" data-href="http://maven.apache.org/plugins/maven-checkstyle-plugin/" data-size="tall" ></div>
+ <div class="g-plusone" data-href="https://maven.apache.org/plugins/maven-checkstyle-plugin/" data-size="tall" ></div>
<div class="clear"></div>
<div class="clear"></div>
@@ -380,7 +375,7 @@
<p><b>Full name</b>:</p>
-<p>org.apache.maven.plugins:maven-checkstyle-plugin:2.17:checkstyle</p>
+<p>org.apache.maven.plugins:maven-checkstyle-plugin:3.0.0:checkstyle</p>
<p><b>Description</b>:</p>
@@ -619,28 +614,6 @@ Checkstyle.<br /><b>User property is</b>
<tr class="b">
-<td><b><a href="#format">format</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td><b>Deprecated.</b> Use configLocation instead.<br /><b>Default value is</b>: <tt>sun</tt>.<br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#headerFile">headerFile</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td><b>Deprecated.</b> Use headerLocation instead.<br /><b>Default value is</b>: <tt>${basedir}/LICENSE.txt</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
<td><b><a href="#headerLocation">headerLocation</a></b></td>
<td><tt>String</tt></td>
@@ -652,14 +625,18 @@ Checkstyle.<br /><b>User property is</b>
file) that can be used by Checkstyle to verify that source code has
the correct license header.</p>
-<p>You need to use ${checkstyle.header.file} in your Checkstyle xml
-configuration to reference the name of this header file.</p>
+<p>You need to use <tt>${checkstyle.header.file}</tt> in your
+Checkstyle xml configuration to reference the name of this header
+file.</p>
<p>For instance:</p>
-<p><tt><module name="RegexpHeader"> <property
-name="headerFile" value="${checkstyle.header.file}"/>
-</module></tt></p><br /><b>Default value is</b>: <tt>LICENSE.txt</tt>.<br /><b>User property is</b>: <tt>checkstyle.header.file</tt>.</td>
+<div>
+<pre>
+<module name="RegexpHeader">
+ <property name="headerFile" value="${checkstyle.header.file}"/>
+</module>
+</pre></div><br /><b>Default value is</b>: <tt>LICENSE.txt</tt>.<br /><b>User property is</b>: <tt>checkstyle.header.file</tt>.</td>
</tr>
<tr class="a">
@@ -688,6 +665,18 @@ automatically if Maven JXR plugin is bei
<tr class="a">
+<td><b><a href="#omitIgnoredModules">omitIgnoredModules</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>3.0.0</tt></td>
+
+<td>Specifies whether modules with a configured severity of
+<tt>ignore</tt> should be omitted during Checkstyle invocation.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td>
+ </tr>
+
+<tr class="b">
+
<td><b><a href="#outputFile">outputFile</a></b></td>
<td><tt>File</tt></td>
@@ -699,7 +688,7 @@ format of the output file is determined
<tt>outputFileFormat</tt> parameter.<br /><b>Default value is</b>: <tt>${project.build.directory}/checkstyle-result.xml</tt>.<br /><b>User property is</b>: <tt>checkstyle.output.file</tt>.</td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#outputFileFormat">outputFileFormat</a></b></td>
@@ -712,47 +701,6 @@ output file. Valid values are "<tt>
"<tt>xml</tt>".<br /><b>Default value is</b>: <tt>xml</tt>.<br /><b>User property is</b>: <tt>checkstyle.output.format</tt>.</td>
</tr>
-<tr class="a">
-
-<td><b><a href="#packageNamesFile">packageNamesFile</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td><b>Deprecated.</b> Use packageNamesLocation instead.<br /></td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#packageNamesLocation">packageNamesLocation</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>2.0-beta-2</tt></td>
-
-<td>
-<p>Specifies the location of the package names XML to be used to
-configure the Checkstyle <a class="externalLink" href="http://checkstyle.sourceforge.net/config.html#Packages">Packages</a>.</p>
-
-<p>This parameter is resolved as resource, URL, then file. If
-resolved to a resource, or a URL, the contents of the package names
-XML is copied into the
-<tt>${project.build.directory}/checkstyle-packagenames.xml</tt>
-file before being passed to Checkstyle for loading.</p><br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#propertiesFile">propertiesFile</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>-</tt></td>
-
-<td><b>Deprecated.</b> Use propertiesLocation instead.<br /></td>
- </tr>
-
<tr class="b">
<td><b><a href="#propertiesLocation">propertiesLocation</a></b></td>
@@ -778,17 +726,6 @@ parameter).</p><br /><b>User property is
<tr class="a">
-<td><b><a href="#propertiesURL">propertiesURL</a></b></td>
-
-<td><tt>URL</tt></td>
-
-<td><tt>-</tt></td>
-
-<td><b>Deprecated.</b> Use propertiesLocation instead.<br /></td>
- </tr>
-
-<tr class="b">
-
<td><b><a href="#propertyExpansion">propertyExpansion</a></b></td>
<td><tt>String</tt></td>
@@ -798,7 +735,7 @@ parameter).</p><br /><b>User property is
<td>Allows for specifying raw property expansion information.<br /></td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#resourceExcludes">resourceExcludes</a></b></td>
@@ -810,7 +747,7 @@ parameter).</p><br /><b>User property is
Checkstyle.<br /><b>User property is</b>: <tt>checkstyle.resourceExcludes</tt>.</td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#skip">skip</a></b></td>
@@ -821,7 +758,7 @@ Checkstyle.<br /><b>User property is</b>
<td>Skip entire check.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>checkstyle.skip</tt>.</td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#sourceDirectories">sourceDirectories</a></b></td>
@@ -830,10 +767,11 @@ Checkstyle.<br /><b>User property is</b>
<td><tt>2.13</tt></td>
<td>Specifies the location of the source directories to be used for
-Checkstyle.<br /><b>Default value is</b>: <tt>${project.compileSourceRoots}</tt>.<br /></td>
+Checkstyle. Default value is
+<tt>${project.compileSourceRoots}</tt>.<br /></td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#sourceDirectory">sourceDirectory</a></b></td>
@@ -841,18 +779,8 @@ Checkstyle.<br /><b>Default value is</b>
<td><tt>-</tt></td>
-<td><b>Deprecated.</b> instead use <tt>sourceDirectories</tt><br /></td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#suppressionsFile">suppressionsFile</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td><b>Deprecated.</b> Use suppressionsLocation instead.<br /></td>
+<td><b>Deprecated.</b> instead use <tt>sourceDirectories</tt>. For version 3.0.0, this
+parameter is only defined to break the build if you use it!<br /></td>
</tr>
<tr class="b">
@@ -896,7 +824,8 @@ that will be made available to your Chec
<td><tt>2.13</tt></td>
<td>Specifies the location of the test source directories to be used
-for Checkstyle.<br /><b>Default value is</b>: <tt>${project.testCompileSourceRoots}</tt>.<br /></td>
+for Checkstyle. Default value is
+<tt>${project.testCompileSourceRoots}</tt>.<br /></td>
</tr>
<tr class="a">
@@ -907,7 +836,8 @@ for Checkstyle.<br /><b>Default value is
<td><tt>2.2</tt></td>
-<td><b>Deprecated.</b> instead use <tt>testSourceDirectories</tt><br /></td>
+<td><b>Deprecated.</b> instead use <tt>testSourceDirectories</tt>. For version 3.0.0,
+this parameter is only defined to break the build if you use it!<br /></td>
</tr>
<tr class="b">
@@ -1115,37 +1045,6 @@ Checkstyle.</div>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr />
-<p><b><a name="format">format</a>:</b></p>
-
-<div><b>Deprecated.</b> Use configLocation instead.</div>
-
-<div>Specifies what predefined check set to use. Available sets are
-"sun" (for the Sun coding conventions), and "maven".</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>sun</tt></li>
- </ul><hr />
-<p><b><a name="headerFile">headerFile</a>:</b></p>
-
-<div><b>Deprecated.</b> Use headerLocation instead.</div>
-
-<div>Specifies the location of the License file (a.k.a. the header file)
-that is used by Checkstyle to verify that source code has the
-correct license header.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${basedir}/LICENSE.txt</tt></li>
- </ul><hr />
<p><b><a name="headerLocation">headerLocation</a>:</b></p>
<div>
@@ -1153,14 +1052,18 @@ correct license header.</div>
file) that can be used by Checkstyle to verify that source code has
the correct license header.</p>
-<p>You need to use ${checkstyle.header.file} in your Checkstyle xml
-configuration to reference the name of this header file.</p>
+<p>You need to use <tt>${checkstyle.header.file}</tt> in your
+Checkstyle xml configuration to reference the name of this header
+file.</p>
<p>For instance:</p>
-<p><tt><module name="RegexpHeader"> <property
-name="headerFile" value="${checkstyle.header.file}"/>
-</module></tt></p></div>
+<div>
+<pre>
+<module name="RegexpHeader">
+ <property name="headerFile" value="${checkstyle.header.file}"/>
+</module>
+</pre></div></div>
<ul>
@@ -1254,6 +1157,21 @@ automatically if Maven JXR plugin is bei
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr />
+<p><b><a name="omitIgnoredModules">omitIgnoredModules</a>:</b></p>
+
+<div>Specifies whether modules with a configured severity of
+<tt>ignore</tt> should be omitted during Checkstyle invocation.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>3.0.0</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr />
<p><b><a name="outputFile">outputFile</a>:</b></p>
<div>Specifies the path and filename to save the Checkstyle output. The
@@ -1286,52 +1204,6 @@ output file. Valid values are "<tt>
<li><b>Default</b>: <tt>xml</tt></li>
</ul><hr />
-<p><b><a name="packageNamesFile">packageNamesFile</a>:</b></p>
-
-<div><b>Deprecated.</b> Use packageNamesLocation instead.</div>
-
-<div>Specifies the location of the package names XML to be used to
-configure Checkstyle.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="packageNamesLocation">packageNamesLocation</a>:</b></p>
-
-<div>
-<p>Specifies the location of the package names XML to be used to
-configure the Checkstyle <a class="externalLink" href="http://checkstyle.sourceforge.net/config.html#Packages">Packages</a>.</p>
-
-<p>This parameter is resolved as resource, URL, then file. If
-resolved to a resource, or a URL, the contents of the package names
-XML is copied into the
-<tt>${project.build.directory}/checkstyle-packagenames.xml</tt>
-file before being passed to Checkstyle for loading.</p></div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Since</b>: <tt>2.0-beta-2</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
-<p><b><a name="propertiesFile">propertiesFile</a>:</b></p>
-
-<div><b>Deprecated.</b> Use propertiesLocation instead.</div>
-
-<div>Specifies the location of the Checkstyle properties file that will
-be used to check the source.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
<p><b><a name="propertiesLocation">propertiesLocation</a>:</b></p>
<div>
@@ -1358,19 +1230,6 @@ parameter).</p></div>
<li><b>User Property</b>: <tt>checkstyle.properties.location</tt></li>
</ul><hr />
-<p><b><a name="propertiesURL">propertiesURL</a>:</b></p>
-
-<div><b>Deprecated.</b> Use propertiesLocation instead.</div>
-
-<div>Specifies the URL of the Checkstyle properties that will be used to
-check the source.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.net.URL</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
<p><b><a name="propertyExpansion">propertyExpansion</a>:</b></p>
<div>Allows for specifying raw property expansion information.</div>
@@ -1432,7 +1291,8 @@ Checkstyle.</div>
<p><b><a name="sourceDirectories">sourceDirectories</a>:</b></p>
<div>Specifies the location of the source directories to be used for
-Checkstyle.</div>
+Checkstyle. Default value is
+<tt>${project.compileSourceRoots}</tt>.</div>
<ul>
@@ -1441,12 +1301,11 @@ Checkstyle.</div>
<li><b>Since</b>: <tt>2.13</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.compileSourceRoots}</tt></li>
</ul><hr />
<p><b><a name="sourceDirectory">sourceDirectory</a>:</b></p>
-<div><b>Deprecated.</b> instead use <tt>sourceDirectories</tt></div>
+<div><b>Deprecated.</b> instead use <tt>sourceDirectories</tt>. For version 3.0.0, this
+parameter is only defined to break the build if you use it!</div>
<div>Specifies the location of the source directory to be used for
Checkstyle.</div>
@@ -1457,23 +1316,6 @@ Checkstyle.</div>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
-<p><b><a name="suppressionsFile">suppressionsFile</a>:</b></p>
-
-<div><b>Deprecated.</b> Use suppressionsLocation instead.</div>
-
-<div>Specifies the location of the suppressions XML file to use. The
-plugin defines a Checkstyle property named
-<tt>checkstyle.suppressions.file</tt> with the value of this
-property. This allows using the Checkstyle property in your own
-custom Checkstyle configuration file when specifying a suppressions
-file.</div>
-
-<ul>
-
-<li><b>Type</b>: <tt>java.lang.String</tt></li>
-
-<li><b>Required</b>: <tt>No</tt></li>
- </ul><hr />
<p><b><a name="suppressionsFileExpression">suppressionsFileExpression</a>:</b></p>
<div>The key to be used in the properties for the suppressions file.</div>
@@ -1517,7 +1359,8 @@ that will be made available to your Chec
<p><b><a name="testSourceDirectories">testSourceDirectories</a>:</b></p>
<div>Specifies the location of the test source directories to be used
-for Checkstyle.</div>
+for Checkstyle. Default value is
+<tt>${project.testCompileSourceRoots}</tt>.</div>
<ul>
@@ -1526,12 +1369,11 @@ for Checkstyle.</div>
<li><b>Since</b>: <tt>2.13</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
-
-<li><b>Default</b>: <tt>${project.testCompileSourceRoots}</tt></li>
</ul><hr />
<p><b><a name="testSourceDirectory">testSourceDirectory</a>:</b></p>
-<div><b>Deprecated.</b> instead use <tt>testSourceDirectories</tt></div>
+<div><b>Deprecated.</b> instead use <tt>testSourceDirectories</tt>. For version 3.0.0,
+this parameter is only defined to break the build if you use it!</div>
<div>Specifies the location of the test source directory to be used for
Checkstyle.</div>
@@ -1594,10 +1436,9 @@ violations.</div>
<footer>
<div class="container-fluid">
<div class="row-fluid">
- <p >Copyright © 2005–2015
- <a href="http://www.apache.org/">The Apache Software Foundation</a>.
- All rights reserved.
-
+ <p >Copyright © 2005–2018
+ <a href="https://www.apache.org/">The Apache Software Foundation</a>.
+ All rights reserved.
</p>
</div>