1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2024 the original author or authors.
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ///////////////////////////////////////////////////////////////////////////////////////////////
19
20 package com.puppycrawl.tools.checkstyle.checks.javadoc;
21
22 /**
23 * Represents the locations for the javadoc content.
24 */
25 public enum JavadocContentLocationOption {
26
27 /**
28 * Represents a policy for the location of content starting from
29 * the same line as {@code /**}.
30 * Example:
31 * <pre>
32 * /** Summary text.
33 * * More details.
34 * */
35 * public void method();
36 * </pre>
37 * This style is also known as "scala" style.
38 */
39 FIRST_LINE,
40
41 /**
42 * Represents a policy for the location of content starting from
43 * the next line after {@code /**}.
44 * Example:
45 * <pre>
46 * /**
47 * * Summary text.
48 * * More details.
49 * */
50 * public void method();
51 * </pre>
52 * This style is common to java projects.
53 */
54 SECOND_LINE,
55
56 }