001/////////////////////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code and other text files for adherence to a set of rules. 003// Copyright (C) 2001-2024 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 locations for the javadoc content. 024 */ 025public enum JavadocContentLocationOption { 026 027 /** 028 * Represents a policy for the location of content starting from 029 * the same line as {@code /**}. 030 * Example: 031 * <pre> 032 * /** Summary text. 033 * * More details. 034 * */ 035 * public void method(); 036 * </pre> 037 * This style is also known as "scala" style. 038 */ 039 FIRST_LINE, 040 041 /** 042 * Represents a policy for the location of content starting from 043 * the next line after {@code /**}. 044 * Example: 045 * <pre> 046 * /** 047 * * Summary text. 048 * * More details. 049 * */ 050 * public void method(); 051 * </pre> 052 * This style is common to java projects. 053 */ 054 SECOND_LINE, 055 056}