Annotation Type ProseSection


  • @Retention(RUNTIME)
    @Target(TYPE)
    @Documented
    public @interface ProseSection
    Annotation that provides a prose section for a commands help
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String title
      Title of the section
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String[] paragraphs
      An array of paragraphs of text that provides prose for the help section
      int suggestedOrder
      Suggested order in which the help section should be placed relative to other help sections
    • Element Detail

      • title

        java.lang.String title
        Title of the section
        Returns:
        Title
      • paragraphs

        java.lang.String[] paragraphs
        An array of paragraphs of text that provides prose for the help section
        Returns:
        Paragraphs
        Default:
        {}
      • suggestedOrder

        int suggestedOrder
        Suggested order in which the help section should be placed relative to other help sections

        Values less than zero will typically place the section before the standard sections while values greater than or equal to zero will place the section after the standard sections.

        Returns:
        Suggested order
        Default:
        0