Enum JavadocContentLocationOption
java.lang.Object
java.lang.Enum<JavadocContentLocationOption>
com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationOption
- All Implemented Interfaces:
Serializable
,Comparable<JavadocContentLocationOption>
,Constable
Represents the locations for the javadoc content.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionRepresents a policy for the location of content starting from the same line as/**
.Represents a policy for the location of content starting from the next line after/**
. -
Method Summary
Modifier and TypeMethodDescriptionstatic JavadocContentLocationOption
Returns the enum constant of this type with the specified name.static JavadocContentLocationOption[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
FIRST_LINE
Represents a policy for the location of content starting from the same line as/**
. Example:/** Summary text. * More details. */ public void method();
This style is also known as "scala" style. -
SECOND_LINE
Represents a policy for the location of content starting from the next line after/**
. Example:/** * Summary text. * More details. */ public void method();
This style is common to java projects.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-