1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2025 the original author or authors.
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ///////////////////////////////////////////////////////////////////////////////////////////////
19
20 package com.puppycrawl.tools.checkstyle.checks.javadoc;
21
22 import com.puppycrawl.tools.checkstyle.StatelessCheck;
23 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
24 import com.puppycrawl.tools.checkstyle.api.DetailAST;
25 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
26 import com.puppycrawl.tools.checkstyle.utils.JavadocUtil;
27
28 /**
29 * <div>
30 * Checks that Javadocs are located at the correct position. As specified at
31 * <a href="https://docs.oracle.com/en/java/javase/11/docs/specs/doc-comment-spec.html">
32 * Documentation Comment Specification for the Standard Doclet</a>, Javadocs are recognized
33 * only when placed immediately before module, package, class, interface,
34 * constructor, method, or field declarations. Any other position, like in the
35 * body of a method, will be ignored by the javadoc tool and is considered
36 * invalid by this check.
37 * </div>
38 *
39 * <p>
40 * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
41 * </p>
42 *
43 * <p>
44 * Violation Message Keys:
45 * </p>
46 * <ul>
47 * <li>
48 * {@code invalid.position}
49 * </li>
50 * </ul>
51 *
52 * @since 8.23
53 */
54 @StatelessCheck
55 public class InvalidJavadocPositionCheck extends AbstractCheck {
56
57 /**
58 * A key is pointing to the warning message text in "messages.properties"
59 * file.
60 */
61 public static final String MSG_KEY = "invalid.position";
62
63 @Override
64 public int[] getDefaultTokens() {
65 return new int[] {
66 TokenTypes.BLOCK_COMMENT_BEGIN,
67 };
68 }
69
70 @Override
71 public int[] getAcceptableTokens() {
72 return getDefaultTokens();
73 }
74
75 @Override
76 public int[] getRequiredTokens() {
77 return getDefaultTokens();
78 }
79
80 @Override
81 public boolean isCommentNodesRequired() {
82 return true;
83 }
84
85 @Override
86 public void visitToken(DetailAST ast) {
87 final String commentContent = JavadocUtil.getBlockCommentContent(ast);
88
89 if (JavadocUtil.isJavadocComment(commentContent)
90 && !JavadocUtil.isCorrectJavadocPosition(ast)) {
91 log(ast, MSG_KEY);
92 }
93 }
94
95 }