From c864bf664cc625440771f94fab9ab440c73dd972 Mon Sep 17 00:00:00 2001 From: Brett Leslie Porter Date: Sun, 25 Sep 2005 22:47:08 +0000 Subject: [PATCH] PR: MNG-952 Submitted by: Allan Ramirez Reviewed by: Brett Porter documentation for the checkstyle plugin git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@291481 13f79535-47bb-0310-9956-ffa450edef68 --- .../src/site/apt/howto.apt | 33 ++++++++ .../src/site/resources/checkstyle.html | 80 +++++++++++++++++++ .../maven-checkstyle-plugin/src/site/site.xml | 21 +++++ 3 files changed, 134 insertions(+) create mode 100644 maven-plugins/maven-checkstyle-plugin/src/site/apt/howto.apt create mode 100644 maven-plugins/maven-checkstyle-plugin/src/site/resources/checkstyle.html create mode 100644 maven-plugins/maven-checkstyle-plugin/src/site/site.xml diff --git a/maven-plugins/maven-checkstyle-plugin/src/site/apt/howto.apt b/maven-plugins/maven-checkstyle-plugin/src/site/apt/howto.apt new file mode 100644 index 0000000000..0c09d6c6a9 --- /dev/null +++ b/maven-plugins/maven-checkstyle-plugin/src/site/apt/howto.apt @@ -0,0 +1,33 @@ + ------ + Maven 2 Checkstyle Plugin + ------ + +Maven 2 Checkstyle Plugin + + Checkstyle plugin generates report regarding the code style of the developer. + +*How to Generate Checkstyle Report + + In your project pom.xml, add the checkstyle plugin in section. + +------------------- + + ... + + + + org.apache.maven.plugins + maven-checkstyle-plugin + 2.0-alpha-3-SNAPSHOT + + + + ... + +------------------- + + Execute the site plugin to generate the report distribution. + +------------------- + m2 site:site +------------------- \ No newline at end of file diff --git a/maven-plugins/maven-checkstyle-plugin/src/site/resources/checkstyle.html b/maven-plugins/maven-checkstyle-plugin/src/site/resources/checkstyle.html new file mode 100644 index 0000000000..79cd3d66bc --- /dev/null +++ b/maven-plugins/maven-checkstyle-plugin/src/site/resources/checkstyle.html @@ -0,0 +1,80 @@ + + + + +Checkstyle Results + + + + + + + + +
+
+
+

Checkstyle Results

The following document contains the results of Checkstyle

Files

org/apache/maven/plugin/checkstyle/package.html

ViolationLine
Missing package documentation file.0

org/apache/maven/plugin/checkstyle/CheckstyleReport.java

ViolationLine
File does not end with a newline.0

org/apache/maven/plugin/checkstyle/CheckstyleReport.java

ViolationLine
'{' should be on the previous line.59
First sentence should end with a period.60
First sentence should end with a period.68
First sentence should end with a period.76
Line is longer than 80 characters.77
Line is longer than 80 characters.93
Line is longer than 80 characters.100
Line is longer than 80 characters.107
Line is longer than 80 characters.122
Line is longer than 80 characters.123
Line is longer than 80 characters.131
Line is longer than 80 characters.132
Line is longer than 80 characters.133
Line is longer than 80 characters.141
Line is longer than 80 characters.149
First sentence should end with a period.156
Line is longer than 80 characters.157
First sentence should end with a period.170
Line is longer than 80 characters.186
Method 'getName' is not designed for extension - needs to be abstract, final or empty.195
'(' is followed by whitespace.195
Parameter locale should be final.195
')' is preceded with whitespace.195
'{' should be on the previous line.196
'(' is followed by whitespace.197
')' is preceded with whitespace.197
'(' is followed by whitespace.197
')' is preceded with whitespace.197
Line is longer than 80 characters.201
Method 'getDescription' is not designed for extension - needs to be abstract, final or empty.203
'(' is followed by whitespace.203
Parameter locale should be final.203
')' is preceded with whitespace.203
'{' should be on the previous line.204
'(' is followed by whitespace.205
')' is preceded with whitespace.205
'(' is followed by whitespace.205
')' is preceded with whitespace.205
Method 'getOutputDirectory' is not designed for extension - needs to be abstract, final or empty.211
'{' should be on the previous line.212
Method 'getProject' is not designed for extension - needs to be abstract, final or empty.219
'{' should be on the previous line.220
Method 'getSiteRenderer' is not designed for extension - needs to be abstract, final or empty.227
'{' should be on the previous line.228
Line is longer than 80 characters.233
Method 'executeReport' is not designed for extension - needs to be abstract, final or empty.235
'(' is followed by whitespace.235
Parameter locale should be final.235
')' is preceded with whitespace.235
'{' should be on the previous line.237
'(' is followed by whitespace.238
')' is preceded with whitespace.238
'{' should be on the previous line.251
Line is longer than 80 characters.253
'(' is followed by whitespace.253
'(' is followed by whitespace.253
')' is preceded with whitespace.253
')' is preceded with whitespace.253
'if' construct must use '{}'s.257
'(' is followed by whitespace.257
')' is preceded with whitespace.257
'(' is followed by whitespace.258
')' is preceded with whitespace.258
'if' construct must use '{}'s.260
'(' is followed by whitespace.260
')' is preceded with whitespace.260
'(' is followed by whitespace.261
')' is preceded with whitespace.261
'(' is followed by whitespace.263
')' is preceded with whitespace.263
'}' should be on the same line.264
'(' is followed by whitespace.265
')' is preceded with whitespace.265
'{' should be on the previous line.266
Line is longer than 80 characters.267
'(' is followed by whitespace.267
')' is preceded with whitespace.267
'(' is followed by whitespace.272
')' is preceded with whitespace.272
'{' should be on the previous line.273
'(' is followed by whitespace.274
')' is preceded with whitespace.274
'(' is followed by whitespace.277
'(' is followed by whitespace.277
')' is preceded with whitespace.277
')' is preceded with whitespace.277
'{' should be on the previous line.278
'outputFile' hides a field.279
'(' is followed by whitespace.279
')' is preceded with whitespace.279
'(' is followed by whitespace.281
')' is preceded with whitespace.281
'(' is followed by whitespace.283
'(' is followed by whitespace.283
')' is preceded with whitespace.283
')' is preceded with whitespace.283
Line is longer than 80 characters.286
'(' is followed by whitespace.286
'(' is followed by whitespace.286
')' is preceded with whitespace.286
')' is preceded with whitespace.286
'(' is followed by whitespace.288
')' is preceded with whitespace.288
'(' is followed by whitespace.290
')' is preceded with whitespace.290
'(' is followed by whitespace.294
')' is preceded with whitespace.294
'{' should be on the previous line.295
Line is longer than 80 characters.296
'(' is followed by whitespace.296
')' is preceded with whitespace.296
Method 'getOutputName' is not designed for extension - needs to be abstract, final or empty.303
Missing a Javadoc comment.303
'{' should be on the previous line.304
Missing a Javadoc comment.308
'{' should be on the previous line.310
'(' is followed by whitespace.313
'(' is followed by whitespace.313
')' is preceded with whitespace.313
')' is preceded with whitespace.313
'{' should be on the previous line.314
'(' is followed by whitespace.315
')' is preceded with whitespace.315
'(' is followed by whitespace.317
')' is preceded with whitespace.317
'(' is followed by whitespace.319
'(' is followed by whitespace.319
')' is preceded with whitespace.319
')' is preceded with whitespace.319
'{' should be on the previous line.320
'(' is followed by whitespace.321
')' is preceded with whitespace.321
'}' should be on the same line.322
'(' is followed by whitespace.323
'(' is followed by whitespace.323
')' is preceded with whitespace.323
')' is preceded with whitespace.323
'{' should be on the previous line.324
'(' is followed by whitespace.325
')' is preceded with whitespace.325
'}' should be on the same line.326
'{' should be on the previous line.328
Line is longer than 80 characters.329
'(' is followed by whitespace.329
')' is preceded with whitespace.330
Missing a Javadoc comment.337
'(' is followed by whitespace.337
Parameter file should be final.337
')' is preceded with whitespace.337
'{' should be on the previous line.339
'{' should be on the previous line.343
'if' construct must use '{}'s.346
'(' is followed by whitespace.346
')' is preceded with whitespace.346
'(' is followed by whitespace.349
')' is preceded with whitespace.349
'}' should be on the same line.350
'(' is followed by whitespace.351
')' is preceded with whitespace.351
'{' should be on the previous line.352
Line is longer than 80 characters.353
'(' is followed by whitespace.353
')' is preceded with whitespace.353
Missing a Javadoc comment.357
'(' is followed by whitespace.357
Parameter includes should be final.357
'includes' hides a field.357
Parameter excludes should be final.357
'excludes' hides a field.357
')' is preceded with whitespace.357
'{' should be on the previous line.359
'(' is followed by whitespace.362
'(' is followed by whitespace.362
')' is preceded with whitespace.362
')' is preceded with whitespace.362
'{' should be on the previous line.363
'(' is followed by whitespace.364
')' is preceded with whitespace.364
'(' is followed by whitespace.367
')' is preceded with whitespace.367
'{' should be on the previous line.368
'(' is followed by whitespace.369
')' is preceded with whitespace.369
'{' should be on the previous line.370
'(' is followed by whitespace.371
')' is preceded with whitespace.371
'(' is followed by whitespace.374
')' is preceded with whitespace.374
'{' should be on the previous line.380
Line is longer than 80 characters.381
'(' is followed by whitespace.381
'(' is followed by whitespace.381
')' is preceded with whitespace.381
')' is preceded with whitespace.381
'}' should be on the same line.382
'(' is followed by whitespace.383
')' is preceded with whitespace.383
'{' should be on the previous line.384
'(' is followed by whitespace.385
')' is preceded with whitespace.385
'(' is followed by whitespace.388
'(' is followed by whitespace.388
')' is preceded with whitespace.388
')' is preceded with whitespace.388
Missing a Javadoc comment.391
'{' should be on the previous line.393
'{' should be on the previous line.397
'(' is followed by whitespace.398
')' is preceded with whitespace.398
'{' should be on the previous line.399
'(' is followed by whitespace.400
'(' is followed by whitespace.400
')' is preceded with whitespace.400
')' is preceded with whitespace.400
'}' should be on the same line.401
'(' is followed by whitespace.402
')' is preceded with whitespace.402
'{' should be on the previous line.403
'(' is followed by whitespace.404
')' is preceded with whitespace.404
'if' construct must use '{}'s.407
'(' is followed by whitespace.407
')' is preceded with whitespace.407
'(' is followed by whitespace.408
')' is preceded with whitespace.408
'if' construct must use '{}'s.410
'(' is followed by whitespace.410
')' is preceded with whitespace.410
'(' is followed by whitespace.411
')' is preceded with whitespace.411
'}' should be on the same line.412
'(' is followed by whitespace.413
')' is preceded with whitespace.413
'{' should be on the previous line.414
Line is longer than 80 characters.415
'(' is followed by whitespace.415
')' is preceded with whitespace.415
Missing a Javadoc comment.421
'{' should be on the previous line.423
Line is longer than 80 characters.426
'(' is followed by whitespace.426
'(' is followed by whitespace.426
')' is preceded with whitespace.426
'(' is followed by whitespace.426
'(' is followed by whitespace.426
')' is preceded with whitespace.426
')' is preceded with whitespace.426
')' is preceded with whitespace.426
'(' is followed by whitespace.429
')' is preceded with whitespace.429
'}' should be on the same line.430
'(' is followed by whitespace.431
'(' is followed by whitespace.431
')' is preceded with whitespace.431
')' is preceded with whitespace.431
'{' should be on the previous line.432
'(' is followed by whitespace.433
')' is preceded with whitespace.433
'}' should be on the same line.434
'(' is followed by whitespace.435
'(' is followed by whitespace.435
')' is preceded with whitespace.435
')' is preceded with whitespace.435
'{' should be on the previous line.436
'(' is followed by whitespace.437
')' is preceded with whitespace.437
'}' should be on the same line.438
'{' should be on the previous line.440
Line is longer than 80 characters.441
'(' is followed by whitespace.441
')' is preceded with whitespace.441
Missing a Javadoc comment.447
'{' should be on the previous line.449
'if' construct must use '{}'s.450
'(' is followed by whitespace.450
'(' is followed by whitespace.450
')' is preceded with whitespace.450
')' is preceded with whitespace.450
'{' should be on the previous line.454
'(' is followed by whitespace.455
')' is preceded with whitespace.455
'}' should be on the same line.456
'(' is followed by whitespace.457
')' is preceded with whitespace.457
'{' should be on the previous line.458
Line is longer than 80 characters.459
'(' is followed by whitespace.459
')' is preceded with whitespace.459
Missing a Javadoc comment.463
'{' should be on the previous line.465
'if' construct must use '{}'s.466
'(' is followed by whitespace.466
'(' is followed by whitespace.466
')' is preceded with whitespace.466
')' is preceded with whitespace.466
'{' should be on the previous line.470
'(' is followed by whitespace.471
')' is preceded with whitespace.471
'}' should be on the same line.472
'(' is followed by whitespace.473
')' is preceded with whitespace.473
'{' should be on the previous line.474
Line is longer than 80 characters.475
'(' is followed by whitespace.475
')' is preceded with whitespace.475
Missing a Javadoc comment.479
'(' is followed by whitespace.479
Parameter locale should be final.479
')' is preceded with whitespace.479
'{' should be on the previous line.480
Line is longer than 80 characters.481
'(' is followed by whitespace.481
')' is preceded with whitespace.481

org/apache/maven/plugin/checkstyle/CheckstyleReportListener.java

ViolationLine
'{' should be on the previous line.36
Missing a Javadoc comment.37
Missing a Javadoc comment.39
Missing a Javadoc comment.41
Missing a Javadoc comment.43
Missing a Javadoc comment.45
Line is longer than 80 characters.47
Missing a Javadoc comment.47
'(' is followed by whitespace.47
Parameter sink should be final.47
'sink' hides a field.47
Parameter sourceDirectory should be final.47
'sourceDirectory' hides a field.47
Parameter bundle should be final.47
'bundle' hides a field.47
')' is preceded with whitespace.47
Missing a Javadoc comment.54
'{' should be on the previous line.55
'(' is followed by whitespace.56
')' is preceded with whitespace.56
Method 'auditStarted' is not designed for extension - needs to be abstract, final or empty.59
Missing a Javadoc comment.59
'(' is followed by whitespace.59
Parameter event should be final.59
')' is preceded with whitespace.59
'{' should be on the previous line.60
'(' is followed by whitespace.63
')' is preceded with whitespace.63
'(' is followed by whitespace.71
')' is preceded with whitespace.71
Line is longer than 80 characters.75
'(' is followed by whitespace.75
'(' is followed by whitespace.75
')' is preceded with whitespace.75
')' is preceded with whitespace.75
'(' is followed by whitespace.76
')' is preceded with whitespace.76
'(' is followed by whitespace.77
')' is preceded with whitespace.77
'(' is followed by whitespace.85
'(' is followed by whitespace.85
')' is preceded with whitespace.85
')' is preceded with whitespace.85
Method 'auditFinished' is not designed for extension - needs to be abstract, final or empty.91
Missing a Javadoc comment.91
'(' is followed by whitespace.91
Parameter event should be final.91
')' is preceded with whitespace.91
'{' should be on the previous line.92
Method 'fileStarted' is not designed for extension - needs to be abstract, final or empty.99
Missing a Javadoc comment.99
'(' is followed by whitespace.99
Parameter event should be final.99
')' is preceded with whitespace.99
'{' should be on the previous line.100
Line is longer than 80 characters.101
'(' is followed by whitespace.101
')' is preceded with whitespace.101
'(' is followed by whitespace.102
')' is preceded with whitespace.102
Method 'fileFinished' is not designed for extension - needs to be abstract, final or empty.106
Missing a Javadoc comment.106
'(' is followed by whitespace.106
Parameter event should be final.106
')' is preceded with whitespace.106
'{' should be on the previous line.107
'(' is followed by whitespace.108
')' is preceded with whitespace.108
'{' should be on the previous line.109
Method 'addError' is not designed for extension - needs to be abstract, final or empty.115
Missing a Javadoc comment.115
'(' is followed by whitespace.115
Parameter event should be final.115
')' is preceded with whitespace.115
'{' should be on the previous line.116
'(' is followed by whitespace.117
'(' is followed by whitespace.117
')' is preceded with whitespace.117
')' is preceded with whitespace.117
'{' should be on the previous line.118
'(' is followed by whitespace.119
')' is preceded with whitespace.119
'{' should be on the previous line.120
'(' is followed by whitespace.123
')' is preceded with whitespace.123
Line is longer than 80 characters.129
'(' is followed by whitespace.129
'(' is followed by whitespace.129
')' is preceded with whitespace.129
')' is preceded with whitespace.129
Line is longer than 80 characters.132
'(' is followed by whitespace.132
'(' is followed by whitespace.132
')' is preceded with whitespace.132
')' is preceded with whitespace.132
'(' is followed by whitespace.141
')' is preceded with whitespace.141
'(' is followed by whitespace.144
'(' is followed by whitespace.144
')' is preceded with whitespace.144
')' is preceded with whitespace.144
Missing a Javadoc comment.150
'(' is followed by whitespace.150
Parameter event should be final.150
Parameter throwable should be final.150
')' is preceded with whitespace.150
'{' should be on the previous line.151
+
+ +
+
+
+ + + diff --git a/maven-plugins/maven-checkstyle-plugin/src/site/site.xml b/maven-plugins/maven-checkstyle-plugin/src/site/site.xml new file mode 100644 index 0000000000..469ca25452 --- /dev/null +++ b/maven-plugins/maven-checkstyle-plugin/src/site/site.xml @@ -0,0 +1,21 @@ + + + Maven Checkstyle plugin + http://maven.apache.org/images/apache-maven-project.png + http://maven.apache.org/ + + + http://maven.apache.org/images/maven-small.gif + + + + + + + + + + + ${reports} + +