Package me.hackware.api.scripting

Annotation Interface ArgumentDescription

@Repeatable(ArgumentDescriptions.class) @Retention(RUNTIME) @Target(METHOD) public @interface ArgumentDescription
Describes one argument of a FunctionName function, in declaration order — the annotation equivalent of a JSDoc @param line. Repeat it once per argument; the editor's IntelliSense builds the function's signature (format(num, precision)) and per-argument help from these.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    The argument's display name, e.g.
    String
    value
    What the argument does, written for the end user.

  • Element Details

    • name

      String name
      The argument's display name, e.g. precision.

    • value

      String value
      What the argument does, written for the end user.