Annotation Type DocString

@Retention(RUNTIME) public @interface DocString
An annotation type to expose documentation to ABCL. Note: the TAGS ant target also pulls information from here. It expects name to be the first item in the DocString declaration, and not broken onto multiple lines.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    args
    The arguments.
    String
    doc
    The documentation string.
    String
    name
    The lisp name.
    String
    returns
    The return value(s) of a function

  • Element Details

    • name

      String name
      The lisp name.
      Default:
      ""

    • args

      String args
      The arguments.
      Default:
      ""

    • returns

      String returns
      The return value(s) of a function
      Default:
      ""

    • doc

      String doc
      The documentation string.
      Default:
      ""