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.JavadocUtil;
027
028/**
029 * <div>
030 * Checks that the Javadoc closing delimiter contains exactly one asterisk before
031 * the slash.
032 * </div>
033 *
034 * <p>
035 * The closing delimiter of a Javadoc comment is <code>*&#47;</code>. This check reports
036 * Javadoc comments whose closing delimiter is preceded by another asterisk, such as
037 * <code>**&#47;</code> or <code>***&#47;</code>.
038 * </p>
039 *
040 * @noinspection HtmlTagCanBeJavadocTag
041 * @noinspectionreason HtmlTagCanBeJavadocTag - HTML code tags allow escaping the slash
042 *      in Javadoc delimiter examples without rendering the entity text.
043 * @since 14.1.0
044 */
045@StatelessCheck
046public class JavadocEndCommentDelimiterCheck extends AbstractCheck {
047
048    /**
049     * A key is pointing to the warning message text in "messages.properties"
050     * file.
051     */
052    public static final String MSG_KEY = "javadoc.end.delimiter";
053
054    /**
055     * Creates a new {@code JavadocEndCommentDelimiterCheck} instance.
056     */
057    public JavadocEndCommentDelimiterCheck() {
058        // no code by default
059    }
060
061    @Override
062    public int[] getDefaultTokens() {
063        return getRequiredTokens();
064    }
065
066    @Override
067    public int[] getAcceptableTokens() {
068        return getRequiredTokens();
069    }
070
071    @Override
072    public int[] getRequiredTokens() {
073        return new int[] {
074            TokenTypes.BLOCK_COMMENT_BEGIN,
075        };
076    }
077
078    @Override
079    public boolean isCommentNodesRequired() {
080        return true;
081    }
082
083    @Override
084    public void visitToken(DetailAST ast) {
085        if (JavadocUtil.isJavadocComment(ast)) {
086            final String commentContent = JavadocUtil.getBlockCommentContent(ast);
087
088            if (commentContent.endsWith("*")) {
089                log(ast.getLastChild(), MSG_KEY);
090            }
091        }
092    }
093
094}