Enum JavadocContentLocationOption

    • Enum Constant Detail

      • FIRST_LINE

        public static final JavadocContentLocationOption 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

        public static final JavadocContentLocationOption 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 Detail

      • values

        public static JavadocContentLocationOption[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (JavadocContentLocationOption c : JavadocContentLocationOption.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static JavadocContentLocationOption valueOf​(String name)
        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 name
        NullPointerException - if the argument is null