1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2026 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/17/docs/specs/javadoc/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 * @since 8.23
40 */
41 @StatelessCheck
42 public class InvalidJavadocPositionCheck extends AbstractCheck {
43
44 /**
45 * A key is pointing to the warning message text in "messages.properties"
46 * file.
47 */
48 public static final String MSG_KEY = "invalid.position";
49
50 /**
51 * Creates a new {@code InvalidJavadocPositionCheck} instance.
52 */
53 public InvalidJavadocPositionCheck() {
54 // no code by default
55 }
56
57 @Override
58 public int[] getDefaultTokens() {
59 return new int[] {
60 TokenTypes.BLOCK_COMMENT_BEGIN,
61 };
62 }
63
64 @Override
65 public int[] getAcceptableTokens() {
66 return getDefaultTokens();
67 }
68
69 @Override
70 public int[] getRequiredTokens() {
71 return getDefaultTokens();
72 }
73
74 @Override
75 public boolean isCommentNodesRequired() {
76 return true;
77 }
78
79 @Override
80 public void visitToken(DetailAST ast) {
81 final String commentContent = JavadocUtil.getBlockCommentContent(ast);
82
83 if (JavadocUtil.isJavadocComment(commentContent)
84 && !JavadocUtil.isCorrectJavadocPosition(ast)) {
85 log(ast, MSG_KEY);
86 }
87 }
88
89 }