View Javadoc
1   /*
2   DesignForExtension
3   ignoredAnnotations = (default)After, AfterClass, Before, BeforeClass, Test
4   requiredJavadocPhrase = This implementation
5   
6   
7   */
8   
9   package com.puppycrawl.tools.checkstyle.checks.design.designforextension;
10  
11  public class InputDesignForExtensionRequiredJavadocPhrase {
12  
13      /**
14       * This implementation is for <p> some html code
15       * </p>.
16       *
17       * @param a
18       * @param b
19       * @return sum
20       */
21      public int foo1(int a, int b) {return a + b;}  // ok, required comment pattern in javadoc
22  
23      /**
24       * This implementation is required for ...
25       *
26       * @param a
27       * @param b
28       * @return sum
29       */
30      public int foo2(int a, int b) {return a + b;}  // ok, required comment pattern in javadoc
31  
32      /** This implementation is for ... */
33      public int foo3(int a, int b) {return a + b;}  // ok, required comment pattern in javadoc
34  
35      /**
36       * This implementation ...
37       */
38      public int foo4(int a, int b) {return a + b;}  // ok, required comment pattern in javadoc
39  
40      /** This method can safely be overridden. */
41      public int foo5(int a, int b) {return a + b;} // violation
42  
43      public final int foo6(int a) {return a - 2;} // ok, final
44  
45      protected final int foo7(int a) {return a - 2;} // ok, final
46  
47      /** */
48      public int foo8(int a) {return a - 2;} // violation
49  
50      // This implementation
51      public int foo9(int a, int b) {return a + b;} // violation
52  
53      @Deprecated
54      protected final int foo10(int a) {return a - 2;} // ok, deprecated
55  
56      /**
57       * This implementation is for <p> some html code
58       * </p>.
59       *
60       * @param a
61       * @param b
62       * @return sum
63       */
64      public int foo11(int a, int b) {return a + b;} // ok, required comment pattern in javadoc
65  
66      /**This method can safely be overridden. */
67      public int foo12(int a, int b) {  // violation
68          return a + b;
69      }
70  }