View Javadoc
1   /*
2   SummaryJavadoc
3   violateExecutionOnNonTightHtml = (default)false
4   forbiddenSummaryFragments = (default)^$
5   period = (default).
6   
7   
8   */
9   
10  package com.puppycrawl.tools.checkstyle.checks.javadoc.summaryjavadoc;
11  
12  
13  public class InputSummaryJavadocPeriodAtEnd {
14      /**
15       * JAXB 1.0 only default validation event handler.
16       */
17      public static final byte NUL = 0;
18      // violation below 'Summary javadoc is missing.'
19      /**
20       * @throws Exception if a problem occurs.
21       */
22      public void foo1() throws Exception {
23  
24      }
25      // violation below 'Summary javadoc is missing.'
26      /**
27       * @return 1.
28       */
29      public int foo2(){
30          return 1;
31      }
32      // violation below 'Summary javadoc is missing.'
33      /**
34       * <a href="mailto:vlad@htmlbook.ru"></a>
35       */
36      public void foo3() {
37  
38      }
39      // violation below 'First sentence .* missing an ending period.'
40      /**
41       *  A {@code Foo.  Foo}
42       */
43      public void foo(){
44  
45      }
46      /**
47       * This is a test
48       * Valid or invalid.
49       */
50      public void foo4(){
51  
52      }
53      /**
54       * <p>This is valid java doc.</p>
55       */
56      public void foo5(){
57  
58      }
59      // violation below 'First sentence .* missing an ending period.'
60      /**
61       * <p>Sentence without period</p>
62       *
63       * <p> this is a <br>
64       *     paragraph.</p>
65       */
66      public void foo6() {
67  
68      }
69      // violation below 'First sentence .* missing an ending period.'
70      /**
71       * JAXB 1.0 missing end period
72       */
73      public void foo7() {
74  
75      }
76      /**
77       *.period at beginning of line, then summary sentence.
78       */
79      public void foo8() {
80  
81      }
82  }