Merge pull request #318 from apache/SHIRO-216
Add @Documented to Shiro annotations
diff --git a/core/src/main/java/org/apache/shiro/authz/annotation/RequiresAuthentication.java b/core/src/main/java/org/apache/shiro/authz/annotation/RequiresAuthentication.java
index c39edcf..7216a03 100644
--- a/core/src/main/java/org/apache/shiro/authz/annotation/RequiresAuthentication.java
+++ b/core/src/main/java/org/apache/shiro/authz/annotation/RequiresAuthentication.java
@@ -18,6 +18,7 @@
*/
package org.apache.shiro.authz.annotation;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@@ -42,5 +43,6 @@
*/
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
+@Documented
public @interface RequiresAuthentication {
}
diff --git a/core/src/main/java/org/apache/shiro/authz/annotation/RequiresGuest.java b/core/src/main/java/org/apache/shiro/authz/annotation/RequiresGuest.java
index 7c52bd4..f162414 100644
--- a/core/src/main/java/org/apache/shiro/authz/annotation/RequiresGuest.java
+++ b/core/src/main/java/org/apache/shiro/authz/annotation/RequiresGuest.java
@@ -18,6 +18,7 @@
*/
package org.apache.shiro.authz.annotation;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@@ -39,5 +40,6 @@
*/
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
+@Documented
public @interface RequiresGuest {
}
diff --git a/core/src/main/java/org/apache/shiro/authz/annotation/RequiresPermissions.java b/core/src/main/java/org/apache/shiro/authz/annotation/RequiresPermissions.java
index f8d92c9..50b5c25 100644
--- a/core/src/main/java/org/apache/shiro/authz/annotation/RequiresPermissions.java
+++ b/core/src/main/java/org/apache/shiro/authz/annotation/RequiresPermissions.java
@@ -18,6 +18,7 @@
*/
package org.apache.shiro.authz.annotation;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@@ -45,6 +46,7 @@
*/
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
+@Documented
public @interface RequiresPermissions {
/**
diff --git a/core/src/main/java/org/apache/shiro/authz/annotation/RequiresRoles.java b/core/src/main/java/org/apache/shiro/authz/annotation/RequiresRoles.java
index 8479c2c..016cd86 100644
--- a/core/src/main/java/org/apache/shiro/authz/annotation/RequiresRoles.java
+++ b/core/src/main/java/org/apache/shiro/authz/annotation/RequiresRoles.java
@@ -18,6 +18,7 @@
*/
package org.apache.shiro.authz.annotation;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@@ -52,6 +53,7 @@
*/
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
+@Documented
public @interface RequiresRoles {
/**
diff --git a/core/src/main/java/org/apache/shiro/authz/annotation/RequiresUser.java b/core/src/main/java/org/apache/shiro/authz/annotation/RequiresUser.java
index ca4f742..853056c 100644
--- a/core/src/main/java/org/apache/shiro/authz/annotation/RequiresUser.java
+++ b/core/src/main/java/org/apache/shiro/authz/annotation/RequiresUser.java
@@ -18,6 +18,7 @@
*/
package org.apache.shiro.authz.annotation;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@@ -47,5 +48,6 @@
*/
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
+@Documented
public @interface RequiresUser {
}
diff --git a/event/src/main/java/org/apache/shiro/event/Subscribe.java b/event/src/main/java/org/apache/shiro/event/Subscribe.java
index 03bc599..45ee436 100644
--- a/event/src/main/java/org/apache/shiro/event/Subscribe.java
+++ b/event/src/main/java/org/apache/shiro/event/Subscribe.java
@@ -18,6 +18,7 @@
*/
package org.apache.shiro.event;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@@ -41,5 +42,6 @@
*/
@Retention(value = RetentionPolicy.RUNTIME)
@Target(value = ElementType.METHOD)
+@Documented
public @interface Subscribe {
}
