1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
|
<?xml version="1.0" encoding="UTF-8"?>
<document xmlns="http://maven.apache.org/XDOC/2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
<head>
<title>Javadoc Comments</title>
<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"/>
<script type="text/javascript" src="js/anchors.js"/>
<script type="text/javascript" src="js/google-analytics.js"/>
<link rel="icon" href="images/favicon.png" type="image/x-icon" />
<link rel="shortcut icon" href="images/favicon.ico" type="image/ico" />
</head>
<body>
<section name="Content">
<macro name="toc">
<param name="fromDepth" value="1"/>
<param name="toDepth" value="1"/>
</macro>
</section>
<section name="AtclauseOrder">
<subsection name="Description">
<p>
Checks the order of at-clauses.
</p>
</subsection>
<subsection name="Properties">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
</tr>
<tr>
<td>target</td>
<td>allows to specify targets to check at-clauses.</td>
<td>subset of tokens
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CLASS_DEF">CLASS_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#INTERFACE_DEF">INTERFACE_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_DEF">ENUM_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF">METHOD_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CTOR_DEF">CTOR_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#VARIABLE_DEF">VARIABLE_DEF</a>.
</td>
<td>
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CLASS_DEF">CLASS_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#INTERFACE_DEF">INTERFACE_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_DEF">ENUM_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF">METHOD_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CTOR_DEF">CTOR_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#VARIABLE_DEF">VARIABLE_DEF</a>.
</td>
</tr>
<tr>
<td>tagOrder</td>
<td>allows to specify the order by tags.</td>
<td><a href="property_types.html#string">String</a></td>
<td><code>@author, @version, @param,
@return, @throws, @exception, @see, @since, @serial,
@serialField, @serialData, @deprecated</code></td>
</tr>
</table>
</subsection>
<subsection name="Examples">
<p>
Default configuration
</p>
<source>
<module name="AtclauseOrder">
<property name="tagOrder" value="@author, @version, @param,
@return, @throws, @exception, @see, @since, @serial,
@serialField, @serialData, @deprecated"/>
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
</module>
</source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Agoogle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+AtclauseOrder">
Google Style</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+AtclauseOrder">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Package">
<p>
com.puppycrawl.tools.checkstyle.checks.javadoc
</p>
</subsection>
<subsection name="Parent Module">
<p>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
<section name="JavadocMethod">
<subsection name="Description">
<p>
Checks the Javadoc of a method or constructor. By default,
does not check for unused throws. To allow documented
<code>java.lang.RuntimeException</code>s that are not
declared, set property allowUndeclaredRTE to true. The scope
to verify is specified using the <code>Scope</code> class and
defaults to <code>Scope.PRIVATE</code>. To verify another
scope, set property scope to a different
<a href="property_types.html#scope">scope</a>.
</p>
<p>
Error messages about parameters and type parameters
for which no param tags are
present can be suppressed by defining property
<code>allowMissingParamTags</code>. Error messages about
exceptions which are declared to be thrown, but for which no
throws tag is present can be suppressed by defining property
<code>allowMissingThrowsTags</code>. Error messages about
methods which return non-void but for which no return tag is
present can be suppressed by defining property
<code>allowMissingReturnTag</code>.
</p>
<p>
Javadoc is not required on a method that is tagged with the
<code>@Override</code> annotation. However under
Java 5 it is not possible to mark a method required for an
interface (this was <i>corrected</i> under Java 6). Hence
Checkstyle supports using the convention of using a single
<code>{@inheritDoc}</code> tag instead of all the
other tags.
</p>
<p>
Note that only inheritable items will allow the
<code>{@inheritDoc}</code> tag to be used in place
of comments. Static methods at all visibilities, private non-static
methods and constructors are not inheritable.
</p>
<p>
For example, if the following method is
implementing a method required by an interface, then the
Javadoc could be done as:
</p>
<pre>
/** {@inheritDoc} */
public int checkReturnTag(final int aTagIndex,
JavadocTag[] aTags,
int aLineNo)</pre>
<p>
The classpath may need to be configured to locate the class
information. The classpath configuration is dependent on the
mechanism used to invoke Checkstyle.
</p>
</subsection>
<subsection name="Properties">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
</tr>
<tr>
<td>minLineCount</td>
<td>Minimal amount of lines in method to demand documentation presence.</td>
<td><a href="property_types.html#integer">Integer</a></td>
<td><code>-1</code></td>
</tr>
<tr>
<td>allowedAnnotations</td>
<td>List of annotations that could allow missed documentation.</td>
<td><a href="property_types.html#stringSet">list of strings</a></td>
<td><code>Override</code></td>
</tr>
<tr>
<td>validateThrows</td>
<td>Allows validating throws tags.</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>false</code></td>
</tr>
<tr>
<td>scope</td>
<td>visibility scope where Javadoc comments are checked</td>
<td><a href="property_types.html#scope">scope</a></td>
<td><code>private</code></td>
</tr>
<tr>
<td>excludeScope</td>
<td>visibility scope where Javadoc comments are not checked</td>
<td><a href="property_types.html#scope">scope</a></td>
<td><code>null</code></td>
</tr>
<tr>
<td>allowUndeclaredRTE</td>
<td>whether to allow documented exceptions that
are not declared if they are a subclass of <code>java.lang.RuntimeException</code></td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>false</code></td>
</tr>
<tr>
<td>allowThrowsTagsForSubclasses</td>
<td>whether to allow documented exceptions that
are subclass of one of declared exception.</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>false</code></td>
</tr>
<tr>
<td>allowMissingParamTags</td>
<td>whether to ignore errors when a method has parameters
but does not have matching param tags in the javadoc.</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>false</code></td>
</tr>
<tr>
<td>allowMissingThrowsTags</td>
<td>whether to ignore errors when a method declares
that it throws exceptions but does have matching throws tags
in the javadoc.</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>false</code></td>
</tr>
<tr>
<td>allowMissingReturnTag</td>
<td>whether to ignore errors when a method returns
non-void type does have a return tag in the javadoc.</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>false</code></td>
</tr>
<tr>
<td>allowMissingJavadoc</td>
<td>whether to ignore errors when a method javadoc is missed.</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>false</code></td>
</tr>
<tr>
<td>allowMissingPropertyJavadoc</td>
<td>
Whether to allow missing Javadoc on accessor methods for
properties (setters and getters). The setter and getter
methods must match exactly the structures below.
<pre>
public void setNumber(final int number)
{
mNumber = number;
}
public int getNumber()
{
return mNumber;
}
public boolean isSomething()
{
return false;
}
</pre>
</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>false</code></td>
</tr>
<tr>
<td>logLoadErrors</td>
<td>This check may need to load exception classes mentioned in
the @throws tag to check whether they are RuntimeExceptions.
If loading the class fails, this property allows to control
checkstyle's error handling. If set to <code>false</code> a
classpath configuration problem is assumed and the TreeWalker
stops operating on the class completely.
If set to <code>true</code> (the default) , checkstyle assumes a
typo or refactoring problem in the
javadoc and logs the problem in the normal checkstyle report
(potentially masking a configuration error).</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>true</code></td>
</tr>
<tr>
<td>suppressLoadErrors</td>
<td>When logLoadErrors is set to true, the TreeWalker completely
processes a class and displays any problems with loading exceptions
as checkstyle violations.
When this property is set to true, the violations generated when
logLoadErrors is set true are suppressed from being reported as
violations in the checkstyle report.
</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>false</code></td>
</tr>
<tr>
<td>ignoreMethodNamesRegex</td>
<td>ignore method whose names are matching specified regex</td>
<td><a href="property_types.html#regexp">regular expression</a></td>
<td><code>null</code> (tag not required)</td>
</tr>
<tr>
<td>tokens</td>
<td>tokens to check</td>
<td>
subset of tokens
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF">METHOD_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CTOR_DEF">CTOR_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ANNOTATION_FIELD_DEF">ANNOTATION_FIELD_DEF</a>.
</td>
<td>
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF">METHOD_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CTOR_DEF">CTOR_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ANNOTATION_FIELD_DEF">ANNOTATION_FIELD_DEF</a>.
</td>
</tr>
</table>
</subsection>
<subsection name="Examples">
<p>
To configure the default check:
</p>
<source>
<module name="JavadocMethod"/>
</source>
<p>
To configure the check for <code>public</code>
scope and to allow documentation of undeclared
RuntimeExceptions:
</p>
<source>
<module name="JavadocMethod">
<property name="scope" value="public"/>
<property name="allowUndeclaredRTE" value="true"/>
</module>
</source>
<p>
To configure the check for for <code>public</code>
scope, to allow documentation of undeclared RuntimeExceptions,
while ignoring any missing param tags is:
</p>
<source>
<module name="JavadocMethod">
<property name="scope" value="public"/>
<property name="allowUndeclaredRTE" value="true"/>
<property name="allowMissingParamTags" value="true"/>
</module>
</source>
<p>
To configure the check for methods which are in <code>private</code> , but not in <code>protected</code> scope:
</p>
<source>
<module name="JavadocMethod">
<property name="scope" value="private"/>
<property name="excludeScope" value="protected"/>
</module>
</source>
<p>
To configure the check for ignoring methods named <code>foo(),foo1(),foo2()</code>, etc.:
</p>
<source>
<module name="JavadocMethod">
<property name="ignoreMethodNamesRegex" value="^foo.*$"/>
</module>
</source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Agoogle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+JavadocMethod">
Google Style</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Asun_checks.xml+repo%3Acheckstyle%2Fcheckstyle+JavadocMethod">
Sun Style</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+JavadocMethod">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Package">
<p>
com.puppycrawl.tools.checkstyle.checks.javadoc
</p>
</subsection>
<subsection name="Parent Module">
<p>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
<section name="JavadocPackage">
<subsection name="Description">
<p>
Checks that each Java package has a Javadoc file used for
commenting. By default it only allows a <code>package-info.java</code> file, but can be
configured to allow a <code>package.html</code>
file.
</p>
<p>
An error will be reported if both files exist as this is not
allowed by the Javadoc tool.
</p>
</subsection>
<subsection name="Properties">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
</tr>
<tr>
<td>allowLegacy</td>
<td>
If set then allow the use of a
<code>package.html</code> file.
</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>false</code></td>
</tr>
<tr>
<td>fileExtensions</td>
<td>file type extension of files to process</td>
<td><a href="property_types.html#stringSet">String Set</a></td>
<td><code>{}</code></td>
</tr>
</table>
</subsection>
<subsection name="Examples">
<p>
To configure the check:
</p>
<source>
<module name="JavadocPackage"/>
</source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Asun_checks.xml+repo%3Acheckstyle%2Fcheckstyle+JavadocPackage">
Sun Style</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+JavadocPackage">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Package">
<p>
com.puppycrawl.tools.checkstyle.checks.javadoc
</p>
</subsection>
<subsection name="Parent Module">
<p>
<a href="config.html#Checker">Checker</a>
</p>
</subsection>
</section>
<section name="JavadocParagraph">
<subsection name="Description">
<p>
Checks that:
</p>
<ul>
<li>
There is one blank line between each of two paragraphs and one blank line before the at-clauses block if it is present.
</li>
<li>
Each paragraph but the first has <p> immediately before the first word, with no space after.
</li>
</ul>
</subsection>
<subsection name="Properties">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
</tr>
<tr>
<td>allowNewlineParagraph</td>
<td>whether the <p> tag should be placed immediately before the first word</td>
<td><a href="property_types.html#boolean">Boolean</a></td>
<td><code>true</code></td>
</tr>
</table>
</subsection>
<subsection name="Examples">
<p>
Default configuration:
</p>
<source>
<module name="JavadocParagraph"/>
</source>
<p>
To allows to place text of a paragraph not immediately after a <p> tag:
</p>
<source>
<module name="JavadocParagraph">
<property name="allowNewlineParagraph" value="true"/>
</module>
</source>
<p>
In case of tagImmediatelyBeforeFirstWord set to false
the following example will not have any violations:
</p>
<source>
/**
* Some Javadoc.
*
* <p>
* Some Javadoc.
*
* <p> Some Javadoc.
*
* <p>
* <pre>
* Some preformatted Javadoc.
* </pre>
*
*/
</source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Agoogle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+JavadocParagraph">
Google Style</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+JavadocParagraph">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Package">
<p>
com.puppycrawl.tools.checkstyle.checks.javadoc
</p>
</subsection>
<subsection name="Parent Module">
<p>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
<section name="JavadocStyle">
<subsection name="Description">
<p>
Validates Javadoc comments to help ensure they are well
formed. The following checks are performed:
</p>
<ul>
<li>
Ensures the first sentence ends with proper punctuation
(That is a period, question mark, or exclamation mark, by default).
Javadoc automatically places the first sentence in the
method summary table and index. Without proper punctuation
the Javadoc may be malformed. All items eligible for the
<code>{@inheritDoc}</code> tag are exempt from this
requirement.
</li>
<li>
Check text for Javadoc statements that do not have any
description. This includes both completely empty Javadoc,
and Javadoc with only tags such as @param and @return.
</li>
<li>
Check text for incomplete HTML tags. Verifies that HTML
tags have corresponding end tags and issues an "Unclosed
HTML tag found:" error if not. An "Extra HTML tag found:"
error is issued if an end tag is found without a previous
open tag.
</li>
<li>
Check that a package Javadoc comment is well-formed (as
described above) and NOT missing from any package-info.java files.
</li>
<li>
Check for allowed HTML tags. The list of allowed HTML tags
is "a", "abbr", "acronym", "address", "area", "b", "bdo",
"big", "blockquote", "br", "caption", "cite", "code",
"colgroup", "dd", "del", "div", "dfn", "dl", "dt", "em",
"fieldset", "font", "h1" to "h6", "hr", "i", "img", "ins",
"kbd", "li", "ol", "p", "pre", "q", "samp", "small", "span",
"strong", "sub", "sup", "table", "tbody", "td", "tfoot", "th",
"thread", "tr", "tt", "u", "ul".
</li>
</ul>
<p>
These checks were patterned after the checks made by the <a
href="http://maven-doccheck.sourceforge.net/">DocCheck</a>
doclet available from Sun. Note: Original Sun's DocCheck tool does not exist anymore.
</p>
</subsection>
<subsection name="Properties">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
</tr>
<tr>
<td>scope</td>
<td>visibility scope where Javadoc comments are checked</td>
<td><a href="property_types.html#scope">scope</a></td>
<td><code>private</code></td>
</tr>
<tr>
<td>excludeScope</td>
<td>visibility scope where Javadoc comments are not checked</td>
<td><a href="property_types.html#scope">scope</a></td>
<td><code>null</code></td>
</tr>
<tr>
<td>checkFirstSentence</td>
<td>
Whether to check the first sentence for proper end of sentence.
</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>true</code></td>
</tr>
<tr>
<td>endOfSentenceFormat</td>
<td>
Format for matching the end of a sentence.
</td>
<td><a href="property_types.html#regexp">regular expression</a></td>
<td><code>([.?!][ \t\n\r\f<])|([.?!]$)</code></td>
</tr>
<tr>
<td>checkEmptyJavadoc</td>
<td>
Whether to check if the Javadoc is missing a describing text.
</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>false</code></td>
</tr>
<tr>
<td>checkHtml</td>
<td>Whether to check for incomplete HTML tags.</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>true</code></td>
</tr>
</table>
</subsection>
<subsection name="Examples">
<p>
To configure the default check:
</p>
<source>
<module name="JavadocStyle"/>
</source>
<p>
To configure the check for <code>public</code>
scope:
</p>
<source>
<module name="JavadocStyle">
<property name="scope" value="public"/>
</module>
</source>
<p>
To configure the check for javadoc which is in <code>private</code>, but not in <code>package</code> scope:
</p>
<source>
<module name="JavadocStyle">
<property name="scope" value="private"/>
<property name="excludeScope" value="package"/>
</module>
</source>
<p>
To configure the check to turn off first sentence checking:
</p>
<source>
<module name="JavadocStyle">
<property name="checkFirstSentence" value="false"/>
</module>
</source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Asun_checks.xml+repo%3Acheckstyle%2Fcheckstyle+JavadocStyle">
Sun Style</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+JavadocStyle">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Package">
<p>
com.puppycrawl.tools.checkstyle.checks.javadoc
</p>
</subsection>
<subsection name="Parent Module">
<p>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
<section name="JavadocTagContinuationIndentation">
<subsection name="Description">
<p>
Checks the indentation of the continuation lines in at-clauses.
</p>
</subsection>
<subsection name="Properties">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
</tr>
<tr>
<td>offset</td>
<td>How many spaces to use for new indentation level.</td>
<td><a href="property_types.html#integer">Integer</a></td>
<td><span class="default">4</span></td>
</tr>
</table>
</subsection>
<subsection name="Examples">
<p>
Default configuration
</p>
<source>
<module name="JavadocTagContinuationIndentation">
<property name="offset" value="4"/>
</module>
</source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Agoogle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+JavadocTagContinuationIndentation">
Google Style</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+JavadocTagContinuationIndentation">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Package">
<p>
com.puppycrawl.tools.checkstyle.checks.javadoc
</p>
</subsection>
<subsection name="Parent Module">
<p>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
<section name="JavadocType">
<subsection name="Description">
<p>
Checks Javadoc comments for class and interface definitions.
By default, does not check for author or version tags. The
scope to verify is specified using the <code>Scope</code>
class and defaults to <code>Scope.PRIVATE</code>. To verify
another scope, set property scope to one of the
<code>Scope</code> constants. To define the format for an
author tag or a version tag, set property authorFormat or
versionFormat respectively to a
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html">
regular expression</a>.
</p>
<p>
Does not perform checks for author and version tags for inner
classes, as they should be redundant because of outer class.
</p>
<p>
Error messages about type parameters for which no param tags are
present can be suppressed by defining property
<code>allowMissingParamTags</code>.
</p>
</subsection>
<subsection name="Properties">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
</tr>
<tr>
<td>scope</td>
<td>visibility scope where Javadoc comments are checked</td>
<td><a href="property_types.html#scope">scope</a></td>
<td><code>private</code></td>
</tr>
<tr>
<td>excludeScope</td>
<td>visibility scope where Javadoc comments are not checked</td>
<td><a href="property_types.html#scope">scope</a></td>
<td><code>null</code></td>
</tr>
<tr>
<td>authorFormat</td>
<td>pattern for @author tag</td>
<td><a href="property_types.html#regexp">regular expression</a></td>
<td><code>null</code> (tag not required)</td>
</tr>
<tr>
<td>versionFormat</td>
<td>pattern for @version tag</td>
<td><a href="property_types.html#regexp">regular expression</a></td>
<td><code>null</code> (tag not required)</td>
</tr>
<tr>
<td>allowMissingParamTags</td>
<td>whether to ignore errors when a class has type parameters
but does not have matching param tags in the javadoc.</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>false</code></td>
</tr>
<tr>
<td>allowUnknownTags</td>
<td>whether to ignore errors when a Javadoc tag is not recognised.</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>false</code></td>
</tr>
<tr>
<td>tokens</td>
<td>tokens to check</td>
<td>
subset of tokens
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#INTERFACE_DEF">INTERFACE_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CLASS_DEF">CLASS_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_DEF">ENUM_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ANNOTATION_DEF">ANNOTATION_DEF</a>.
</td>
<td>
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#INTERFACE_DEF">INTERFACE_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CLASS_DEF">CLASS_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_DEF">ENUM_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ANNOTATION_DEF">ANNOTATION_DEF</a>.
</td>
</tr>
</table>
</subsection>
<subsection name="Examples">
<p>
To configure the default check:
</p>
<source>
<module name="JavadocType"/>
</source>
<p>
To configure the check for <code>public</code> scope:
</p>
<source>
<module name="JavadocType">
<property name="scope" value="public"/>
</module>
</source>
<p>
To configure the check for an @author tag:
</p>
<source>
<module name="JavadocType">
<property name="authorFormat" value="\S"/>
</module>
</source>
<p>
To configure the check for a CVS revision version tag:
</p>
<source>
<module name="JavadocType">
<property name="versionFormat" value="\$Revision.*\$"/>
</module>
</source>
<p>
To configure the check for <code>private</code> classes only:
</p>
<source>
<module name="JavadocType">
<property name="scope" value="private"/>
<property name="excludeScope" value="package"/>
</module>
</source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Asun_checks.xml+repo%3Acheckstyle%2Fcheckstyle+JavadocType">
Sun Style</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+JavadocType">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Package">
<p>
com.puppycrawl.tools.checkstyle.checks.javadoc
</p>
</subsection>
<subsection name="Parent Module">
<p>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
<section name="JavadocVariable">
<subsection name="Description">
<p>
Checks that variables have Javadoc comments. Ignores <code>serialVersionUID</code>
fields.
</p>
</subsection>
<subsection name="Properties">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
</tr>
<tr>
<td>scope</td>
<td>visibility scope where Javadoc comments are checked</td>
<td><a href="property_types.html#scope">scope</a></td>
<td><code>private</code></td>
</tr>
<tr>
<td>excludeScope</td>
<td>visibility scope where Javadoc comments are not checked</td>
<td><a href="property_types.html#scope">scope</a></td>
<td><code>null</code></td>
</tr>
<tr>
<td>ignoreNamePattern</td>
<td>regexp to define variable names to ignore</td>
<td><a href="property_types.html#regexp">regular expression</a></td>
<td><code>null</code></td>
</tr>
<tr>
<td>tokens</td>
<td>tokens to check</td>
<td>subset of tokens
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_CONSTANT_DEF">ENUM_CONSTANT_DEF</a>.
</td>
<td>
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_CONSTANT_DEF">ENUM_CONSTANT_DEF</a>.
</td>
</tr>
</table>
</subsection>
<subsection name="Examples">
<p>
To configure the default check:
</p>
<source>
<module name="JavadocVariable"/>
</source>
<p>
To configure the check for <code>public</code>
scope:
</p>
<source>
<module name="JavadocVariable">
<property name="scope" value="public"/>
</module>
</source>
<p>
To configure the check for members which are in <code>private</code>, but not in <code>protected</code> scope:
</p>
<source>
<module name="JavadocVariable">
<property name="scope" value="private"/>
<property name="excludeScope" value="protected"/>
</module>
</source>
<p>
To ignore absence of Javadoc comments for variables with names <code>log</code> or <code>logger</code>:
</p>
<source>
<module name="JavadocVariable">
<property name="ignoreNamePattern" value="log|logger"/>
</module>
</source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Asun_checks.xml+repo%3Acheckstyle%2Fcheckstyle+JavadocVariable">
Sun Style</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+JavadocVariable">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Package">
<p>
com.puppycrawl.tools.checkstyle.checks.javadoc
</p>
</subsection>
<subsection name="Parent Module">
<p>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
<section name="NonEmptyAtclauseDescription">
<subsection name="Description">
<p>
Checks that the at-clause tag is followed by description.
</p>
</subsection>
<subsection name="Examples">
<p>
Default configuration that will check <code>@param</code>, <code>@return</code>,
<code>@throws</code>, <code>@deprecated</code>:
</p>
<source>
<module name="NonEmptyAtclauseDescription"/>
</source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Agoogle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+NonEmptyAtclauseDescription">
Google Style</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+NonEmptyAtclauseDescription">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Package">
<p>
com.puppycrawl.tools.checkstyle.checks.javadoc
</p>
</subsection>
<subsection name="Parent Module">
<p>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
<section name="SingleLineJavadoc">
<subsection name="Description">
<p>
Checks that a JavaDoc block can fit in a single line and doesn't
contain at-clauses. Javadoc comment that contains at least one at-clause
should be formatted in a few lines.
</p>
</subsection>
<subsection name="Properties">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
</tr>
<tr>
<td>ignoredTags</td>
<td>allows to specify at-clauses which are ignored by the check.</td>
<td><a href="property_types.html#string">String</a></td>
<td><code>null</code></td>
</tr>
<tr>
<td>ignoreInlineTags</td>
<td>whether inline tags must be ignored.</td>
<td><a href="property_types.html#boolean">Boolean</a></td>
<td><code>true</code></td>
</tr>
</table>
</subsection>
<subsection name="Examples">
<p>
Default configuration:
</p>
<source>
<module name="SingleLineJavadoc"/>
</source>
<p>
To specify a list of ignored at-clauses and make inline at-clauses not ignored:
</p>
<source>
<module name="SingleLineJavadoc">
<property name="ignoredTags" value="@inheritDoc, @see"/>
<property name="ignoreInlineTags" value="false"/>
</module>
</source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Agoogle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+SingleLineJavadoc">
Google Style</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+SingleLineJavadoc">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Package">
<p>
com.puppycrawl.tools.checkstyle.checks.javadoc
</p>
</subsection>
<subsection name="Parent Module">
<p>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
<section name="SummaryJavadoc">
<subsection name="Description">
<p>
Checks that <a href="http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#firstsentence">
Javadoc summary sentence</a> does not contain phrases that are not recommended to use.
</p>
</subsection>
<subsection name="Properties">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
</tr>
<tr>
<td>forbiddenSummaryFragments</td>
<td>forbidden summary fragments</td>
<td><a href="property_types.html#regexp">regular expression</a></td>
<td><code>^$</code></td>
</tr>
<tr>
<td>period</td>
<td>period symbol at the end of first javadoc sentence</td>
<td><a href="property_types.html#string">String literal</a></td>
<td><code>.</code></td>
</tr>
</table>
</subsection>
<subsection name="Examples">
<p>
By default Check validate that first sentence is not empty:
</p>
<source>
<module name="SummaryJavadocCheck"/>
</source>
<p>
To ensure that summary do not contain phrase like "This method returns" , use following config:
</p>
<source>
<module name="SummaryJavadocCheck">
<property name="forbiddenSummaryFragments" value="^This method returns.*"/>
</module>
</source>
<p>
To specify period symbol at the end of first javadoc sentence:
</p>
<source>
<module name="SummaryJavadocCheck">
<property name="period" value="STRING_LITERAL"/>
</module>
</source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Agoogle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+SummaryJavadoc">
Google Style</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+SummaryJavadoc">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Package">
<p>
com.puppycrawl.tools.checkstyle.checks.javadoc
</p>
</subsection>
<subsection name="Parent Module">
<p>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
<section name="WriteTag">
<subsection name="Description">
<p>
Outputs a JavaDoc tag as information. Can be used e.g. with the
stylesheets that sort the report by author name. To define the
format for a tag, set property tagFormat to a regular
expression. This check uses two different severity levels. The
normal one is used for reporting when the tag is missing. The
additional one (tagSeverity) is used for the level of reporting
when the tag exists.
</p>
</subsection>
<subsection name="Properties">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
</tr>
<tr>
<td>tag</td>
<td>Name of tag</td>
<td><a href="property_types.html#string">String</a></td>
<td><code>null</code></td>
</tr>
<tr>
<td>tagFormat</td>
<td>Format of tag</td>
<td><a href="property_types.html#regexp">regular expression</a></td>
<td><code>null</code></td>
</tr>
<tr>
<td>tagSeverity</td>
<td>Severity level when tag is found and printed</td>
<td><a href="property_types.html#severity">severity</a></td>
<td><code>info</code></td>
</tr>
<tr>
<td>tokens</td>
<td>tokens to check</td>
<td>subset of tokens
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#INTERFACE_DEF">INTERFACE_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CLASS_DEF">CLASS_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_DEF">ENUM_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ANNOTATION_DEF">ANNOTATION_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF">METHOD_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CTOR_DEF">CTOR_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_CONSTANT_DEF">ENUM_CONSTANT_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ANNOTATION_FIELD_DEF">ANNOTATION_FIELD_DEF</a>.
</td>
<td>
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#INTERFACE_DEF">INTERFACE_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CLASS_DEF">CLASS_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_DEF">ENUM_DEF</a>,
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ANNOTATION_DEF">ANNOTATION_DEF</a>.
</td>
</tr>
</table>
</subsection>
<subsection name="Examples">
<p>
An example of how to configure the check for printing author name is:
</p>
<source>
<module name="WriteTag">
<property name="tag" value="@author"/>
<property name="tagFormat" value="\S"/>
</module>
</source>
<p>
An example of how to configure the check to print warnings if an
"@incomplete" tag is found, and not print anything if it is not found:
</p>
<source>
<module name="WriteTag">
<property name="tag" value="@incomplete"/>
<property name="tagFormat" value="\S"/>
<property name="severity" value="ignore"/>
<property name="tagSeverity" value="warning"/>
</module>
</source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+WriteTag">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Package">
<p>
com.puppycrawl.tools.checkstyle.checks.javadoc
</p>
</subsection>
<subsection name="Parent Module">
<p>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
</body>
</document>
|
