1 /*
2 SuppressWithPlainTextCommentFilter
3 offCommentFormat = (default)// CHECKSTYLE:OFF
4 onCommentFormat = (default)// CHECKSTYLE:ON
5 checkFormat = (default).*
6 messageFormat = (default)(null)
7 idFormat = foo
8
9
10 com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
11 allowedAnnotations = (default)Override
12 validateThrows = (default)false
13 accessModifiers = (default)public, protected, package, private
14 allowMissingParamTags = (default)false
15 allowMissingReturnTag = (default)false
16 tokens = (default)METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF, COMPACT_CTOR_DEF
17 id = foo
18
19
20 */
21
22 package com.puppycrawl.tools.checkstyle.filters.suppresswithplaintextcommentfilter;
23
24 public class InputSuppressWithPlainTextCommentFilterSuppressByIdJavadocCheck {
25 // CHECKSTYLE:OFF
26
27 /** missing return **/
28 int method3() { // filtered violation '@return tag should be present and have description.'
29 return 3;
30 }
31
32 /** @param unused asd **/ // filtered violation 'Unused @param tag for 'unused'.'
33 void method2() {
34 }
35
36 /**
37 * Missing param tag.
38 */
39 void method3(int a) { // filtered violation 'Expected @param tag for 'a'.'
40 }
41 // CHECKSTYLE:ON
42
43 }