Annotation Type Description
@Target({TYPE,FIELD,METHOD})
@Retention(RUNTIME)
public @interface Description Annotation that describes an element by using a sentence or two.
Use sentence-style capitalization, capitalize the first letter of the first word, and any proper names such as the word Java. If the description is one sentence, a period should not be included.
- Since:
- 9
Required Elements
| Modifier and Type | Required Element | Description |
|---|---|---|
String | value | Returns a sentence or two that describes the annotated element. |
Elements
value
String value
Returns a sentence or two that describes the annotated element.
- Returns:
- a description, not
null
© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/11/docs/api/jdk.jfr/jdk/jfr/Description.html