org.modeshape.common.annotation

## Annotation Type Description

-     @Documented
      @Retention(value=RUNTIME)
      @Target(value={FIELD,METHOD,CONSTRUCTOR,PACKAGE,TYPE})
      public @interface Description

  Annotation that can be used provide a human-readable description.

- - ### Required Element Summary

    Required Elements
    Modifier and Type | Required Element and Description
    --- | ---
    `String` | `value` The description for the element.

  - ### Optional Element Summary

    Optional Elements
    Modifier and Type | Optional Element and Description
    --- | ---
    `Class<?>` | `i18n` The class that contains the `I18n` instances used for internationalization.

- - ### Element Detail

    - #### value

          public abstract String value

      The description for the element. This value can either be the literal description, or it can be the `identifier` of an `I18n` instance on the non-null `i18n()` I18n container class.
      Returns:
        the issue

    - #### i18n

          public abstract Class<?> i18n

      The class that contains the `I18n` instances used for internationalization. This may be Object.class if the description is a literal value.
      Returns:
        the class that contains the I18n instance identified by the `value()`
      Default:
        java.lang.Object.class

Copyright © 2008-2014 JBoss, a division of Red Hat. All Rights Reserved.