Package org.opencastproject.util.doc.rest

Annotation Interface RestService

@Retention(RUNTIME) @Target(TYPE) public @interface RestService
This annotation type is used for annotating RESTful service(each java class). This annotation type needs to be kept until runtime.

  • Element Details

    • name

      String name
      Returns:
      the name of the service.

    • title

      String title
      Returns:
      a title of the service documentation.

    • notes

      String[] notes
      Returns:
      an array of notes to add into the end of the documentation.

    • abstractText

      String abstractText
      Returns:
      an abstract section which is displayed at the top of the documentation.