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 * This is the real summary.
14 * {@summary This is not the summary}
15 */
16 public class InputSummaryJavadocIncorrect3 {
17
18 /**
19 * {@summary This is the real summary.}
20 * {@summary This is not the summary}
21 */
22 public void testAnotherSummaryTag() {
23 }
24
25 /**
26 * <p>This is summary.</p>
27 * {@summary This is not the summary}
28 */
29 public void testHtmlTags() {
30 }
31
32 /**
33 * <p><i></i></p>
34 * {@summary This is summary}
35 */
36 // violation 2 lines above 'Summary of Javadoc is missing an ending period'
37 public void testHtmlTags2() {
38 }
39
40 // violation below 'Summary javadoc is missing.'
41 /**
42 * @param a parameter
43 * {@summary Wrong usage}
44 */
45 public void method(int a) {
46 }
47
48 // violation below 'First sentence of Javadoc is missing an ending period'
49 /**
50 * <p> This is the summary {@summary This is not summary.}
51 */
52 public void testParagraphTag() {
53 }
54
55 /**
56 * <pre></pre>
57 * {@summary This is summary}
58 */
59 // violation 2 lines above 'Summary of Javadoc is missing an ending period'
60 public void testPreTag() {
61 }
62
63 // violation below 'First sentence of Javadoc is missing an ending period'
64 /**
65 * <i>This will be in italics and is the summary</i>
66 * {@summary This is not summary}
67 */
68 public void testOtherTags() {
69 }
70
71 /**
72 * <br>
73 * <br>
74 * {@summary Line breaks will be there but this will be the summary}
75 */
76 // violation 2 lines above 'Summary of Javadoc is missing an ending period.'
77 public void testBreakTag() {
78 }
79
80 // Until https://github.com/checkstyle/checkstyle/issues/11425
81 // violation below 'Summary javadoc is missing'
82 /**
83 * <ul>
84 * <li><i>This is the summary</i></li>
85 * </ul>
86 * {@summary This is not the summary.}
87 */
88 public void testMultipleElements() {
89 }
90
91 /**
92 * <p> </p>
93 * {@summary This is not the summary}
94 */
95 // violation 2 lines above 'Summary of Javadoc is missing an ending period'
96 public void testHtmlTags3() {
97 }
98 }