Package flexagon.ff.common.core.suggestions

Annotation Interface SuggestionMethodMeta

@Retention(RUNTIME) @Target(METHOD) public @interface SuggestionMethodMeta

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    depAlternate
    What should be used instead of deprecated field
    boolean
    deprecated
     
    String
    description
    Markdown description of the method to show in suggestion help.
    boolean
    internalPublic
    Meant for public fields that meant to be internal and not exposed in UI Suggestions
    String[]
    params
    Param names, in order.

  • Element Details

    • description

      String description
      Markdown description of the method to show in suggestion help.
      Default:
      ""

    • params

      String[] params
      Param names, in order.
      Default:
      {}

    • internalPublic

      boolean internalPublic
      Meant for public fields that meant to be internal and not exposed in UI Suggestions
      Default:
      false

    • deprecated

      boolean deprecated
      Default:
      false

    • depAlternate

      String depAlternate
      What should be used instead of deprecated field
      Default:
      ""