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