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
      java.lang.String args
      The arguments.
      java.lang.String doc
      The documentation string.
      java.lang.String name
      The lisp name.
      java.lang.String returns
      The return value(s) of a function
    • Element Detail

      • name

        java.lang.String name
        The lisp name.
        Default:
        ""
      • args

        java.lang.String args
        The arguments.
        Default:
        ""
      • returns

        java.lang.String returns
        The return value(s) of a function
        Default:
        ""
      • doc

        java.lang.String doc
        The documentation string.
        Default:
        ""