1 /*
2 com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
3 writeXmlOutput = false
4
5
6 */
7
8 package com.puppycrawl.tools.checkstyle.meta.javadocmetadatascraper;
9
10 import com.puppycrawl.tools.checkstyle.StatelessCheck;
11 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
12
13
14
15 /**
16 * <p>
17 * Checks whether file contains code.
18 * Java compiler is not raising errors on files with no code or all commented out.
19 * Files which are considered to have no code:
20 * </p>
21 * <ul>
22 * <li>
23 * File with no text
24 * </li>
25 * <li>
26 * File with single-line comment(s)
27 * </li>
28 * <li>
29 * File with a multi line comment(s).
30 * </li>
31 * </ul>
32 * <p>
33 * To configure the check:
34 * </p>
35 * <pre>
36 * skipped as not relevant for UTs
37 * </pre>
38 * <p>
39 * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
40 * </p>
41 * <p>
42 * Violation Message Keys:
43 * </p>
44 * <ul>
45 * <li>
46 * {@code nocode.in.file}
47 * </li>
48 * </ul>
49 *
50 * @since 8.33
51 */
52 @StatelessCheck
53 public abstract class InputJavadocMetadataScraperNoCodeInFileCheck extends AbstractCheck {
54
55 }