1 /* 2 JavadocTagContinuationIndentation 3 violateExecutionOnNonTightHtml = (default)false 4 offset = (default)4 5 6 7 */ 8 9 package com.puppycrawl.tools.checkstyle.checks.javadoc.javadoctagcontinuationindentation; 10 11 import java.io.Serializable; 12 13 /** 14 * Some javadoc. 15 * 16 * @since Some javadoc. 17 * Some javadoc. 18 * @version 1.0 19 * @see Some javadoc. 20 * Some javadoc. 21 * @see Some javadoc. 22 * @author max 23 * Some javadoc. 24 */ 25 class InputJavadocTagContinuationIndentation implements Serializable 26 { 27 /** 28 * The client's first name. 29 * @serial Some javadoc. 30 * Some javadoc. 31 */ 32 private String fFirstName; 33 34 /** 35 * The client's first name. 36 * @serial 37 * Some javadoc. 38 */ 39 private String sSecondName; 40 41 /** 42 * The client's first name. 43 * @serialField 44 * Some javadoc. 45 */ 46 private String tThirdName; 47 48 /** 49 * Some text. 50 * @param aString Some javadoc. 51 * Some javadoc. 52 * @return Some text. 53 * @serialData Some javadoc. 54 * @see Some text. 55 * Some javadoc. // violation 56 * @throws Exception Some text. 57 */ 58 String method(String aString) throws Exception 59 { 60 return "null"; 61 } 62 63 /** 64 * Some text. 65 * @serialData Some javadoc. 66 * @return Some text. 67 * Some javadoc. 68 * @param aString Some text. 69 * @throws Exception Some text. 70 */ 71 String method1(String aString) throws Exception 72 { 73 return "null"; 74 } 75 76 /** 77 * Some text. 78 * @throws Exception Some text. 79 * Some javadoc. 80 * @param aString Some text. 81 */ 82 void method2(String aString) throws Exception {} 83 84 /** 85 * Some text. 86 * @see Some text. 87 * @throws Exception Some text. 88 * Some javadoc. 89 */ 90 void method3() throws Exception {} 91 92 /** 93 * Some text. 94 * @return Some text. 95 * @throws Exception Some text. 96 */ 97 String method4() throws Exception 98 { 99 return "null"; 100 } 101 102 /** 103 * Some text. 104 * @see Some text. 105 * @return Some text. 106 * @param aString Some text. 107 */ 108 String method5(String aString) 109 { 110 return "null"; 111 } 112 113 /** 114 * Some text. 115 * @param aString Some text. 116 * @return Some text. 117 * Some javadoc. // violation 118 * @serialData Some javadoc. 119 * @param aInt Some text. 120 * Some javadoc. // violation 121 * @throws Exception Some text. 122 * @param aBoolean Some text. 123 * @see Some text. 124 */ 125 String method6(String aString, int aInt, boolean aBoolean) throws Exception 126 { 127 return "null"; 128 } 129 130 /** 131 * Some javadoc. 132 * 133 * @version 1.0 134 * @since Some javadoc. 135 * @serialData Some javadoc. 136 * @author max 137 */ 138 class InnerClassWithAnnotations 139 { 140 /** 141 * Some text. 142 * @return Some text. 143 * @see Some text. 144 * Some javadoc. 145 * @param aString Some text. 146 * @throws Exception Some text. 147 * Some javadoc. 148 */ 149 String method(String aString) throws Exception 150 { 151 return "null"; 152 } 153 154 /** 155 * Some text. 156 * @throws Exception Some text. 157 * Some javadoc. 158 * @return Some text. 159 * @param aString Some text. 160 * Some javadoc. 161 */ 162 String method1(String aString) throws Exception 163 { 164 return "null"; 165 } 166 167 /** 168 * Some text. 169 * @serialData Some javadoc. 170 * Some javadoc. 171 * @param aString Some text. 172 * Some javadoc. 173 * @throws Exception Some text. 174 */ 175 void method2(String aString) throws Exception {} 176 177 /** 178 * Some text. 179 * @see Some text. 180 * @throws Exception Some text. 181 */ 182 void method3() throws Exception {} 183 184 /** 185 * Some text. 186 * @throws Exception Some text. 187 * @serialData Some javadoc. 188 * @return Some text. 189 */ 190 String method4() throws Exception 191 { 192 return "null"; 193 } 194 195 /** 196 * Some text. 197 * @param aString Some text. 198 * @see Some text. 199 * @return Some text. 200 */ 201 String method5(String aString) 202 { 203 return "null"; 204 } 205 206 /** 207 * Some text. 208 * @param aString Some text. 209 * @return Some text. 210 * @param aInt Some text. 211 * Some javadoc. // violation 212 * @throws Exception Some text. 213 * @param aBoolean Some text. 214 * Some javadoc. // violation 215 * @see Some text. 216 */ 217 String method6(String aString, int aInt, boolean aBoolean) throws Exception 218 { 219 return "null"; 220 } 221 } 222 223 InnerClassWithAnnotations anon = new InnerClassWithAnnotations() 224 { 225 /** 226 * Some text. 227 * @throws Exception Some text. 228 * @param aString Some text. 229 * Some javadoc. // violation 230 * @serialData Some javadoc. 231 * Some javadoc. // violation 232 * @see Some text. 233 * @return Some text. 234 */ 235 String method(String aString) throws Exception 236 { 237 return "null"; 238 } 239 240 /** 241 * Some text. 242 * @param aString Some text. 243 * Some javadoc. 244 * @throws Exception Some text. 245 * @return Some text. 246 */ 247 String method1(String aString) throws Exception 248 { 249 return "null"; 250 } 251 252 /** 253 * Some text. 254 * @throws Exception Some text. 255 * Some javadoc. 256 * @param aString Some text. 257 */ 258 void method2(String aString) throws Exception {} 259 260 /** 261 * Some text. 262 * @see Some text. 263 * Some javadoc. 264 * @throws Exception Some text. 265 */ 266 void method3() throws Exception {} 267 268 /** 269 * Some text. 270 * @throws Exception Some text. 271 * @return Some text. 272 */ 273 String method4() throws Exception 274 { 275 return "null"; 276 } 277 278 /** 279 * Some text. 280 * @see Some text. 281 * @return Some text. 282 * @param aString Some text. 283 */ 284 String method5(String aString) 285 { 286 return "null"; 287 } 288 289 /** 290 * Some text. 291 * Some javadoc. 292 * @param aString Some text. 293 * Some javadoc. // violation 294 * @return Some text. 295 * @param aInt Some text. 296 * Some javadoc. // violation 297 * @throws Exception Some text. 298 * Some javadoc. // violation 299 * @param aBoolean Some text. 300 * @see Some text. 301 */ 302 String method6(String aString, int aInt, boolean aBoolean) throws Exception 303 { 304 return "null"; 305 } 306 }; 307 } 308 309 /** 310 * Some javadoc. 311 * 312 * @since Some javadoc. 313 * @version 1.0 314 * @see Some javadoc. 315 * Some javadoc. 316 * Some javadoc. 317 * @see Some javadoc. 318 * Some javadoc. // violation 319 * @author max 320 */ 321 enum Foo1 {} 322 323 /** 324 * Some javadoc. 325 * 326 * @version 1.0 327 * @since Some javadoc. 328 * Some javadoc. 329 * @serialData Some javadoc. 330 * Line below is empty on purpose. // violation 331 * @see Some Text. 332 * L. // violation 333 * 334 * @author max 335 * @customTag {@link com.puppycrawl.tools.checkstyle.AllChecksPresentOnAvailableChecksPageTest 336 * some description} // ok, as this is just inline tag description 337 */ 338 interface FooIn1 {} 339 340 /** 341 * <p>Testing javadoc with spanning tag {@linkplain #DEFAULT default mapping 342 * factory}.</p> // ok 343 */ 344 interface FooIn2 {} 345 class ShortNextLine { 346 /** 347 * Test. 348 * 349 * @return Test 350 * tt <code>null</code>. // violation 351 */ 352 public void example() { 353 } 354 }