com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationOption Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of checkstyle Show documentation

Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard

There is a newer version: 10.20.1

///////////////////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
// Copyright (C) 2001-2024 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
///////////////////////////////////////////////////////////////////////////////////////////////

package com.puppycrawl.tools.checkstyle.checks.javadoc;

/**
 * Represents the locations for the javadoc content.
 */
public enum JavadocContentLocationOption {

    /**
     * Represents a policy for the location of content starting from
     * the same line as {@code /**}.
     * Example:
     *      * /** Summary text.
     *   * More details.
     *   */
     * public void method();
     * 
     * This style is also known as "scala" style.
     */
    FIRST_LINE,

    /**
     * Represents a policy for the location of content starting from
     * the next line after {@code /**}.
     * Example:
     *      * /**
     *  * Summary text.
     *  * More details.
     *  */
     * public void method();
     * 
     * This style is common to java projects.
     */
    SECOND_LINE,

}