001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2026 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018///////////////////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.checks.javadoc;
021
022import com.puppycrawl.tools.checkstyle.StatelessCheck;
023import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
024import com.puppycrawl.tools.checkstyle.api.DetailAST;
025import com.puppycrawl.tools.checkstyle.api.TokenTypes;
026import com.puppycrawl.tools.checkstyle.utils.CheckUtil;
027import com.puppycrawl.tools.checkstyle.utils.JavadocUtil;
028
029/**
030 * <div>
031 * Checks for missing package definition Javadoc comments in package-info.java files.
032 * </div>
033 *
034 * <p>
035 * Rationale: description and other related documentation for a package can be written up
036 * in the package-info.java file and it gets used in the production of the Javadocs.
037 * See <a
038 * href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#packagecomment"
039 * >link</a> for more info.
040 * </p>
041 *
042 * <p>
043 * This check specifically only validates package definitions. It will not validate any methods or
044 * interfaces declared in the package-info.java file.
045 * </p>
046 *
047 * @since 8.22
048 */
049@StatelessCheck
050public class MissingJavadocPackageCheck extends AbstractCheck {
051
052    /**
053     * A key is pointing to the warning message text in "messages.properties"
054     * file.
055     */
056    public static final String MSG_PKG_JAVADOC_MISSING = "package.javadoc.missing";
057
058    /**
059     * Creates a new {@code MissingJavadocPackageCheck} instance.
060     */
061    public MissingJavadocPackageCheck() {
062        // no code by default
063    }
064
065    @Override
066    public int[] getDefaultTokens() {
067        return getRequiredTokens();
068    }
069
070    @Override
071    public int[] getAcceptableTokens() {
072        return getRequiredTokens();
073    }
074
075    @Override
076    public int[] getRequiredTokens() {
077        return new int[] {TokenTypes.PACKAGE_DEF};
078    }
079
080    @Override
081    public boolean isCommentNodesRequired() {
082        return true;
083    }
084
085    @Override
086    public void visitToken(DetailAST ast) {
087        if (CheckUtil.isPackageInfo(getFilePath())
088                && JavadocUtil.getAttachedJavadocCommentForPackage(ast) == null) {
089            log(ast, MSG_PKG_JAVADOC_MISSING);
090        }
091    }
092
093}