Annotation Interface ApiDescription.Extra

Enclosing class:
ApiDescription

@Documented @Retention(CLASS) @Target({METHOD,PACKAGE,MODULE,RECORD_COMPONENT,TYPE}) public static @interface ApiDescription.Extra
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Returns additional information about API.
    Express precaution about the use of this API.
  • Element Details

    • info

      String info
      Returns additional information about API.
      Returns:
      the version string
      Since:
      1.0
      Default:
      ""
    • warning

      String warning
      Express precaution about the use of this API.
      Returns:
      the version string
      Since:
      1.0
      Default:
      ""