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.CheckUtil;
27 import com.puppycrawl.tools.checkstyle.utils.JavadocUtil;
28
29 /**
30 * <div>
31 * Checks for missing package definition Javadoc comments in package-info.java files.
32 * </div>
33 *
34 * <p>
35 * Rationale: description and other related documentation for a package can be written up
36 * in the package-info.java file and it gets used in the production of the Javadocs.
37 * See <a
38 * href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#packagecomment"
39 * >link</a> for more info.
40 * </p>
41 *
42 * <p>
43 * This check specifically only validates package definitions. It will not validate any methods or
44 * interfaces declared in the package-info.java file.
45 * </p>
46 *
47 * @since 8.22
48 */
49 @StatelessCheck
50 public class MissingJavadocPackageCheck extends AbstractCheck {
51
52 /**
53 * A key is pointing to the warning message text in "messages.properties"
54 * file.
55 */
56 public static final String MSG_PKG_JAVADOC_MISSING = "package.javadoc.missing";
57
58 /**
59 * Creates a new {@code MissingJavadocPackageCheck} instance.
60 */
61 public MissingJavadocPackageCheck() {
62 // no code by default
63 }
64
65 @Override
66 public int[] getDefaultTokens() {
67 return getRequiredTokens();
68 }
69
70 @Override
71 public int[] getAcceptableTokens() {
72 return getRequiredTokens();
73 }
74
75 @Override
76 public int[] getRequiredTokens() {
77 return new int[] {TokenTypes.PACKAGE_DEF};
78 }
79
80 @Override
81 public boolean isCommentNodesRequired() {
82 return true;
83 }
84
85 @Override
86 public void visitToken(DetailAST ast) {
87 if (CheckUtil.isPackageInfo(getFilePath())
88 && JavadocUtil.getAttachedJavadocCommentForPackage(ast) == null) {
89 log(ast, MSG_PKG_JAVADOC_MISSING);
90 }
91 }
92
93 }