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
022/**
023 * Represents the options for the position of the block comment end delimiter.
024 */
025public enum BlockCommentEndPositionOption {
026
027    /**
028     * Represents the policy that the block comment end must be alone on its own line.
029     * For example:
030     *
031     * {@snippet lang="text" :
032     * /**
033     *  * Multiple lines of Javadoc text are written here,
034     *  * wrapped normally...
035     *  */
036     * public void method();
037     * }
038     */
039    ALONE,
040
041    /**
042     * Represents the policy that the block comment end must be alone on its
043     * own line or on the same line as the block comment begin.
044     * For example:
045     *
046     * {@snippet lang="text" :
047     * // Block comment end is alone on its own line
048     * /**
049     *  * Multiple lines of Javadoc text are written here,
050     *  * wrapped normally...
051     *  */
052     * public void method();
053     *
054     * // Single-line Javadoc
055     * /** Javadoc summary. */
056     * public void method1();
057     * }
058     */
059    ALONE_OR_SINGLELINE,
060
061}