You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@shiro.apache.org by bd...@apache.org on 2021/08/18 21:58:29 UTC
[shiro] branch SHIRO-216 created (now da9d70f)
This is an automated email from the ASF dual-hosted git repository.
bdemers pushed a change to branch SHIRO-216
in repository https://gitbox.apache.org/repos/asf/shiro.git.
at da9d70f Add @Documented to Shiro annotations
This branch includes the following new commits:
new da9d70f Add @Documented to Shiro annotations
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[shiro] 01/01: Add @Documented to Shiro annotations
Posted by bd...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
bdemers pushed a commit to branch SHIRO-216
in repository https://gitbox.apache.org/repos/asf/shiro.git
commit da9d70f71a84c2890e3d34ff5a17f2aa9b4f96d8
Author: Brian Demers <bd...@apache.org>
AuthorDate: Wed Aug 18 17:58:20 2021 -0400
Add @Documented to Shiro annotations
Shiro annotations will now be included in generated Javadoc
Fixes: SHIRO-216
---
.../java/org/apache/shiro/authz/annotation/RequiresAuthentication.java | 2 ++
core/src/main/java/org/apache/shiro/authz/annotation/RequiresGuest.java | 2 ++
.../java/org/apache/shiro/authz/annotation/RequiresPermissions.java | 2 ++
core/src/main/java/org/apache/shiro/authz/annotation/RequiresRoles.java | 2 ++
core/src/main/java/org/apache/shiro/authz/annotation/RequiresUser.java | 2 ++
5 files changed, 10 insertions(+)
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 @@ import java.lang.annotation.Target;
*/
@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 @@ import java.lang.annotation.Target;
*/
@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 @@ import java.lang.annotation.Target;
*/
@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 @@ import java.lang.annotation.Target;
*/
@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 @@ import java.lang.annotation.Target;
*/
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
+@Documented
public @interface RequiresUser {
}