From 29056fcc333504b7781a1bd8353e1f264f6b1d40 Mon Sep 17 00:00:00 2001
From: Brian Demers <bdemers@apache.org>
Date: Wed, 18 Aug 2021 17:58:20 -0400
Subject: [PATCH] Add @Documented to Shiro annotations

Shiro annotations will now be included in generated Javadoc

Fixes: SHIRO-216
---
 .../apache/shiro/authz/annotation/RequiresAuthentication.java   | 2 ++
 .../java/org/apache/shiro/authz/annotation/RequiresGuest.java   | 2 ++
 .../org/apache/shiro/authz/annotation/RequiresPermissions.java  | 2 ++
 .../java/org/apache/shiro/authz/annotation/RequiresRoles.java   | 2 ++
 .../java/org/apache/shiro/authz/annotation/RequiresUser.java    | 2 ++
 event/src/main/java/org/apache/shiro/event/Subscribe.java       | 2 ++
 6 files changed, 12 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 c39edcfe29..7216a03d92 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 7c52bd4b1a..f16241490c 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 f8d92c9afd..50b5c25b26 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 8479c2c479..016cd864cb 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 ca4f74279d..853056cf2c 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 03bc5996a6..45ee436abc 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 {
 }