diff --git a/CHANGELOG.md b/CHANGELOG.md
index 9ec418d..39bae56 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,6 +1,14 @@
Changelog
===
+Version 24.0.1
+---
+* Added `@Documented` annotation where it would be useful.
+
+Version 24.0.0
+---
+* Added new annotation: `@CheckReturnValue`.
+
Version 23.1.0
---
* Added new annotation: `@ApiStatus.Obsolete`.
diff --git a/README.md b/README.md
index fdc6e28..2c80d3f 100644
--- a/README.md
+++ b/README.md
@@ -13,10 +13,19 @@ interpreted by IDEs and static analysis tools to improve code analysis.
## Using the annotations
The annotations are published on [Maven Central](https://repo1.maven.org/maven2/org/jetbrains/annotations/). To add a dependency
-using gradle write the following in the `build.gradle` file:
+using gradle write the following in the
+`build.gradle` file (Groovy DSL)
```
dependencies {
- compileOnly 'org.jetbrains:annotations:23.1.0'
+ compileOnly 'org.jetbrains:annotations:24.0.1'
+}
+
+```
+
+or in the `build.gradle.kts` file (Kotlin DSL)
+```
+dependencies {
+ compileOnly("org.jetbrains:annotations:24.0.1")
}
```
@@ -25,7 +34,7 @@ To add a dependency using Maven, write the following in `pom.xml`:
org.jetbrains
annotations
- 23.1.0
+ 24.0.1
provided
```
diff --git a/common/src/main/java/org/intellij/lang/annotations/Language.java b/common/src/main/java/org/intellij/lang/annotations/Language.java
index e71e0bb..f0322d1 100644
--- a/common/src/main/java/org/intellij/lang/annotations/Language.java
+++ b/common/src/main/java/org/intellij/lang/annotations/Language.java
@@ -18,6 +18,7 @@
import org.jetbrains.annotations.NonNls;
+import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@@ -41,6 +42,7 @@
* Note that using the derived annotation as meta-annotation is not supported.
* Meta-annotation works only one level deep.
*/
+@Documented
@Retention(RetentionPolicy.CLASS)
@Target({ METHOD, FIELD, PARAMETER, LOCAL_VARIABLE, ANNOTATION_TYPE })
public @interface Language {
diff --git a/common/src/main/java/org/intellij/lang/annotations/MagicConstant.java b/common/src/main/java/org/intellij/lang/annotations/MagicConstant.java
index 127f05c..3f02eb7 100644
--- a/common/src/main/java/org/intellij/lang/annotations/MagicConstant.java
+++ b/common/src/main/java/org/intellij/lang/annotations/MagicConstant.java
@@ -75,6 +75,7 @@
*
* The @MagicConstant annotation has SOURCE retention, i.e. it is removed upon compilation and does not create any runtime overhead.
*/
+@Documented
@Retention(RetentionPolicy.SOURCE)
@Target({
ElementType.FIELD, ElementType.PARAMETER, ElementType.LOCAL_VARIABLE,
diff --git a/common/src/main/java/org/intellij/lang/annotations/Pattern.java b/common/src/main/java/org/intellij/lang/annotations/Pattern.java
index 3f40e33..34ec818 100644
--- a/common/src/main/java/org/intellij/lang/annotations/Pattern.java
+++ b/common/src/main/java/org/intellij/lang/annotations/Pattern.java
@@ -19,6 +19,7 @@
import org.jetbrains.annotations.NonNls;
import static java.lang.annotation.ElementType.*;
+import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@@ -42,6 +43,7 @@
*
* @see RegExp
*/
+@Documented
@Retention(RetentionPolicy.CLASS)
@Target({ METHOD, FIELD, PARAMETER, LOCAL_VARIABLE, ANNOTATION_TYPE })
public @interface Pattern {
diff --git a/common/src/main/java/org/intellij/lang/annotations/PrintFormat.java b/common/src/main/java/org/intellij/lang/annotations/PrintFormat.java
index d69f1f7..24f7a16 100644
--- a/common/src/main/java/org/intellij/lang/annotations/PrintFormat.java
+++ b/common/src/main/java/org/intellij/lang/annotations/PrintFormat.java
@@ -15,6 +15,8 @@
*/
package org.intellij.lang.annotations;
+import java.lang.annotation.Documented;
+
/**
* Specifies that the method parameter is a printf-style print format pattern,
* as described in {@link java.util.Formatter}.
@@ -35,6 +37,7 @@
*
* @see Pattern
*/
+@Documented
@Pattern(PrintFormatPattern.PRINT_FORMAT)
public @interface PrintFormat {
}
diff --git a/common/src/main/java/org/intellij/lang/annotations/RegExp.java b/common/src/main/java/org/intellij/lang/annotations/RegExp.java
index 31c7724..ecdeedd 100644
--- a/common/src/main/java/org/intellij/lang/annotations/RegExp.java
+++ b/common/src/main/java/org/intellij/lang/annotations/RegExp.java
@@ -18,6 +18,7 @@
import org.jetbrains.annotations.NonNls;
import static java.lang.annotation.ElementType.*;
+import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@@ -31,6 +32,7 @@
*
* @see Language
*/
+@Documented
@Retention(RetentionPolicy.CLASS)
@Target({METHOD, FIELD, PARAMETER, LOCAL_VARIABLE, ANNOTATION_TYPE})
@Language("RegExp")
diff --git a/common/src/main/java/org/jetbrains/annotations/CheckReturnValue.java b/common/src/main/java/org/jetbrains/annotations/CheckReturnValue.java
index aaa99b0..997400c 100644
--- a/common/src/main/java/org/jetbrains/annotations/CheckReturnValue.java
+++ b/common/src/main/java/org/jetbrains/annotations/CheckReturnValue.java
@@ -1,5 +1,6 @@
package org.jetbrains.annotations;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
@@ -27,6 +28,7 @@
*
* @see Contract#pure()
*/
+@Documented
@Target({ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.TYPE, ElementType.PACKAGE})
@ApiStatus.Experimental
public @interface CheckReturnValue {
diff --git a/gradle.properties b/gradle.properties
index 45fd678..de0afeb 100644
--- a/gradle.properties
+++ b/gradle.properties
@@ -14,5 +14,5 @@
# limitations under the License.
#
-projectVersion=24.0.0
+projectVersion=24.0.1
#JDK_5=
\ No newline at end of file