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. See
037 * <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#packagecomment">
038 * link</a> for more info.
039 * </p>
040 *
041 * <p>
042 * This check specifically only validates package definitions. It will not validate any methods or
043 * interfaces declared in the package-info.java file.
044 * </p>
045 *
046 * @since 8.22
047 */
048@StatelessCheck
049public class MissingJavadocPackageCheck extends AbstractCheck {
050
051    /**
052     * A key is pointing to the warning message text in "messages.properties" file.
053     */
054    public static final String MSG_PKG_JAVADOC_MISSING = "package.javadoc.missing";
055
056    /**
057     * Creates a new {@code MissingJavadocPackageCheck} instance.
058     */
059    public MissingJavadocPackageCheck() {
060        // no code by default
061    }
062
063    @Override
064    public int[] getDefaultTokens() {
065        return getRequiredTokens();
066    }
067
068    @Override
069    public int[] getAcceptableTokens() {
070        return getRequiredTokens();
071    }
072
073    @Override
074    public int[] getRequiredTokens() {
075        return new int[] {TokenTypes.PACKAGE_DEF};
076    }
077
078    @Override
079    public boolean isCommentNodesRequired() {
080        return true;
081    }
082
083    @Override
084    public void visitToken(DetailAST ast) {
085        if (CheckUtil.isPackageInfo(getFilePath())
086                && JavadocUtil.getAttachedJavadocCommentForPackage(ast) == null) {
087            log(ast, MSG_PKG_JAVADOC_MISSING);
088        }
089    }
090
091}