View Javadoc
1   package com.puppycrawl.tools.checkstyle.checks.javadoc.summaryjavadoc;
2   
3   /**
4    * Some Javadoc A {@code Foo} is a simple Javadoc.
5    */
6   class InputSummaryJavadocCorrect {
7   
8       /**
9        * Some Javadoc This method returns.
10       */
11      public static final byte NUL = 0;
12      
13      /**
14       * As of JDK 1.1, replaced by {@link #setBounds(int,int,int,int)}.
15       */
16      void foo3() {}
17      
18      /**
19       * This is valid.
20       * @throws Exception if an error occurs.
21       */
22      void foo4() throws Exception {}
23      
24      /** An especially This method returns short bit of Javadoc. */
25      void foo5() {}
26  
27      /**
28       * An especially short
29       * bit of Javadoc. This method returns.
30       */
31      void foo6() {}
32  
33      /** {@inheritDoc} */
34      void foo7() {}
35  
36      /**
37       * {@inheritDoc} */
38      void foo8() {}
39  
40      /**
41       * {@inheritDoc}
42       */
43      void foo9() {}
44  
45      /**
46       *
47       *
48       * {@inheritDoc}
49       */
50      void foo10() {}
51  
52      /**
53       * {@inheritDoc}mm
54       */
55      void foo9a() {}
56  
57      /**
58       * {@inheritDoc}mm.
59       */
60      void foo11() {}
61  
62      /**
63       * {@inheritDoc} M m m m
64       */
65      void foo12() {}
66  
67      /**
68       * {@inheritDoc} M m m m.
69       */
70      void foo13() {}
71  
72      /**
73       * mm. {@inheritDoc}
74       */
75      void foo14() {}
76  
77      /**
78       * M m m m. {@inheritDoc}
79       */
80      void foo15() {}
81  
82      /**
83       * This is summary java doc.
84       * <a href="mailto:vlad@htmlbook.ru"/>
85       */
86       class InnerInputCorrectJavaDocParagraphCheck {
87  
88           /**
89            * foooo@foooo.
90            */
91          public static final byte NUL = 0;
92          
93          /** 
94           * Some java@doc.
95           * This method returns.
96           */
97          public static final byte NUL_2 = 0;
98  
99          /**
100          * Returns the customer ID. This method returns.
101          */
102         int getId() {return 666;}
103         
104         /**
105          * This is valid.
106          * <a href="mailto:vlad@htmlbook.ru"/>.
107          */
108         void foo2() {}
109         
110         /**
111          * As of JDK 1.1,
112          * replaced by {@link #setBounds(int,int,int,int)}. This method returns.
113          */
114         void foo3() {}
115         
116         /**
117          * This is description.
118          * @throws Exception if an error occurs.
119          */
120         void foo4() throws Exception {}
121         
122         /** 
123          * JAXB Provider Use Only: Provides partial default
124          * implementations for some of the javax.xml.bind interfaces.
125          */
126         void foo5() {}
127 
128         /**
129          * An especially short (int... A) bit of Javadoc. This
130          * method returns.
131          */
132         void foo6() {}
133     }
134 
135      /**
136       * Some
137       * javadoc. A {@code Foo} is a simple Javadoc.
138       * 
139       * Some Javadoc. A {@code Foo}
140       * is a simple Javadoc.
141       */
142     InnerInputCorrectJavaDocParagraphCheck anon = new InnerInputCorrectJavaDocParagraphCheck() {
143 
144         /**
145          * JAXB 1.0 only default validation event handler.
146          */
147         public static final byte NUL = 0;
148 
149         /**
150          * Returns the current state.
151          * This method returns.
152          */
153         boolean emulated(String s) {return false;}
154         
155         /**
156          * As of JDK 1.1, replaced by {@link #setBounds(int,int,int,int)}.
157          */
158         void foo3() {}
159         
160         /**
161          * This is valid.
162          * @throws Exception if an error occurs.
163          */
164         void foo4() throws Exception {}
165         
166         /** An especially short bit of Javadoc. */
167         void foo5() {}
168 
169         /**
170          * An especially short bit of Javadoc.
171          */
172         void foo6() {}
173         
174         /**
175          * Some Javadoc. This method returns some javadoc.
176          */
177         boolean emulated() {return false;}
178         
179         /**
180          * Some Javadoc. This method returns some javadoc. Some Javadoc.
181          */
182         boolean emulated1() {return false;}
183         
184         /**
185          * This is valid.
186          * @return Some Javadoc the customer ID.
187          */
188         int geId() {return 666;} 
189         
190         /**
191          * This is valid.
192          * @return Sentence one. Sentence two.
193          */
194         String twoSentences() {return "Sentence one. Sentence two.";}
195 
196          /** Stop instances being created. **/
197          String twoSentences1() {return "Sentence one. Sentence two.";}
198     };
199 }