Package com.orchestranetworks.rest.annotation

Annotation Type Documentation

  • @Retention(RUNTIME)
@Target({PACKAGE,TYPE,METHOD})
public @interface Documentation
    Annotation used to document the purpose of a JAX-RS matched resource.

    This documentation is displayed when logging and debugging. If the annotation is applied to each level (package, class and method), then the contents are concatenated.

    It may also be applied on a class extending RESTApplicationAbstract. In this case, the documentation value is displayed in the related module's description in the administration menu 'Modules and data models'.

    Since:
    5.9.0

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String value