1 /*
2 JavadocMethod
3 allowedAnnotations = (default)Override
4 validateThrows = (default)false
5 accessModifiers = (default)public, protected, package, private
6 allowMissingParamTags = (default)false
7 allowMissingReturnTag = (default)false
8 tokens = (default)METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF, COMPACT_CTOR_DEF
9 message.javadoc.return.expected = @return tag should be present and have description :)
10 message.javadoc.expectedTag = Expected {0} tag for ''{1}'' :)
11 message.javadoc.unusedTag = Unused {0} tag for ''{1}'' :)
12
13 */
14
15 package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocmethod;
16
17 public class InputJavadocMethodCustomMessage {
18
19 /** missing return **/
20 int method3() { // violation '@return tag should be present and have description :)'
21 return 3;
22 }
23
24 /** @param unused asd **/ // violation 'Unused @param tag for 'unused' :)'
25 void method2() {
26 }
27
28 /**
29 * Missing param tag.
30 */
31 void method3(int a) { // violation 'Expected @param tag for 'a' :)'
32 }
33 }