Package org.apache.cxf.jaxrs.model.wadl

Annotation Interface Description

@Target({TYPE,METHOD,PARAMETER,FIELD}) @Retention(RUNTIME) public @interface Description
Can be used to document resource classes and methods See WADL Documentation.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    docuri
    This uri, if set, will be used to retrieve the content which will be set as WADL doc content
    String
    lang
    Maps to WADL doc/@xml:lang attribute
    String
    target
    Target of this description, see DocTarget
    String
    title
    Maps to WADL doc/@title attribute
    String
    value
    This value, if set, will be set as WADL doc content

  • Element Details

    • value

      String value
      This value, if set, will be set as WADL doc content
      Default:
      ""

    • lang

      String lang
      Maps to WADL doc/@xml:lang attribute
      Default:
      ""

    • title

      String title
      Maps to WADL doc/@title attribute
      Default:
      ""

    • docuri

      String docuri
      This uri, if set, will be used to retrieve the content which will be set as WADL doc content
      Default:
      ""

    • target

      String target
      Target of this description, see DocTarget
      Default:
      ""