Annotation Type Discussion


  • @Retention(RUNTIME)
    @Target(TYPE)
    @Documented
    public @interface Discussion
    Annotation that provides a discussion section for a commands help
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String[] paragraphs
      An array of paragraphs of text that provides an extended discussion on the behaviour of the command.
    • Element Detail

      • paragraphs

        java.lang.String[] paragraphs
        An array of paragraphs of text that provides an extended discussion on the behaviour of the command. Discussion typically goes into much greater detail about exact behaviour of commands particularly where complex commands may behave differently depending on the option combinations used.
        Returns:
        Command discussion
        Default:
        {}