Package de.espirit.common

Annotation Interface ApiDoc

@Documented @Target({METHOD,TYPE}) @Retention(RUNTIME) public @interface ApiDoc
Annotation for inline documentation, like suggestions when editing templates.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    @NotNull String
    comment
     
    @NotNull String
    since
     

  • Element Details

    • comment

      @NotNull @NotNull String comment
      Returns:
      the default comment for the method which is documented by this annotation

    • since

      @NotNull @NotNull String since
      Returns:
      the version string (e.g. 4.0.1) since this method is available