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 java.util.ArrayList;
11 import java.util.Arrays;
12 import java.util.List;
13
14 import com.puppycrawl.tools.checkstyle.StatelessCheck;
15
16
17
18
19
20
21
22 /**
23 * <p>
24 * Checks the order of
25 * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDBEFIF">
26 * javadoc block-tags or javadoc tags</a>.
27 * </p>
28 * <p>
29 * Note: Google used the term "at-clauses" for block tags in their guide till 2017-02-28.
30 * </p>
31 *
32 * <ul>
33 * <li>
34 * Property {@code violateExecutionOnNonTightHtml} - Control when to print violations if the
35 * Javadoc being examined by this check violates the tight html rules defined at
36 * <a href="https://checkstyle.org/writingjavadocchecks.html#Tight-HTML_rules">Tight-HTML Rules</a>.
37 * Type is {@code boolean}.
38 * Default value is {@code false}.
39 * </li>
40 * <li>
41 * Property {@code target} - Specify block tags targeted.
42 * Type is {@code java.lang.String[]}.
43 * Validation type is {@code tokenSet}.
44 * Default value is
45 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CLASS_DEF">
46 * CLASS_DEF</a>,
47 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#INTERFACE_DEF">
48 * INTERFACE_DEF</a>,
49 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_DEF">
50 * ENUM_DEF</a>,
51 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF">
52 * METHOD_DEF</a>,
53 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CTOR_DEF">
54 * CTOR_DEF</a>,
55 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#VARIABLE_DEF">
56 * VARIABLE_DEF</a>,
57 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#RECORD_DEF">
58 * RECORD_DEF</a>,
59 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#COMPACT_CTOR_DEF">
60 * COMPACT_CTOR_DEF</a>.
61 * </li>
62 * <li>
63 * Property {@code tagOrder} - Specify the order by tags.
64 * Type is {@code java.lang.String[]}.
65 * Default value is
66 * {@code @author, @deprecated, @exception, @param, @return, @see, @serial, @serialData, @serialField, @since, @throws, @version}.
67 * </li>
68 * </ul>
69 * <p>
70 * To configure the default check:
71 * </p>
72 * <pre>
73 * skipped as not relevant for UTs
74 * </pre>
75 * <p>
76 * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
77 * </p>
78 * <p>
79 * Violation Message Keys:
80 * </p>
81 * <ul>
82 * <li>
83 * {@code at.clause.order}
84 * </li>
85 * <li>
86 * {@code javadoc.missed.html.close}
87 * </li>
88 * <li>
89 * {@code javadoc.parse.rule.error}
90 * </li>
91 * <li>
92 * {@code javadoc.wrong.singleton.html.tag}
93 * </li>
94 * </ul>
95 *
96 * @since 6.0
97 */
98 @StatelessCheck
99 public abstract class InputJavadocMetadataScraperAtclauseOrderCheck {
100
101 }