Skip to content

Commit e1b7802

Browse files
bdemersbmarwell
authored andcommitted
Add @documented to Shiro annotations
Shiro annotations will now be included in generated Javadoc Fixes: SHIRO-216
1 parent b298f71 commit e1b7802

File tree

6 files changed

+12
-0
lines changed

6 files changed

+12
-0
lines changed

core/src/main/java/org/apache/shiro/authz/annotation/RequiresAuthentication.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
*/
1919
package org.apache.shiro.authz.annotation;
2020

21+
import java.lang.annotation.Documented;
2122
import java.lang.annotation.ElementType;
2223
import java.lang.annotation.Retention;
2324
import java.lang.annotation.RetentionPolicy;
@@ -42,5 +43,6 @@
4243
*/
4344
@Target({ElementType.TYPE, ElementType.METHOD})
4445
@Retention(RetentionPolicy.RUNTIME)
46+
@Documented
4547
public @interface RequiresAuthentication {
4648
}

core/src/main/java/org/apache/shiro/authz/annotation/RequiresGuest.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
*/
1919
package org.apache.shiro.authz.annotation;
2020

21+
import java.lang.annotation.Documented;
2122
import java.lang.annotation.ElementType;
2223
import java.lang.annotation.Retention;
2324
import java.lang.annotation.RetentionPolicy;
@@ -39,5 +40,6 @@
3940
*/
4041
@Target({ElementType.TYPE, ElementType.METHOD})
4142
@Retention(RetentionPolicy.RUNTIME)
43+
@Documented
4244
public @interface RequiresGuest {
4345
}

core/src/main/java/org/apache/shiro/authz/annotation/RequiresPermissions.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
*/
1919
package org.apache.shiro.authz.annotation;
2020

21+
import java.lang.annotation.Documented;
2122
import java.lang.annotation.ElementType;
2223
import java.lang.annotation.Retention;
2324
import java.lang.annotation.RetentionPolicy;
@@ -45,6 +46,7 @@
4546
*/
4647
@Target({ElementType.TYPE, ElementType.METHOD})
4748
@Retention(RetentionPolicy.RUNTIME)
49+
@Documented
4850
public @interface RequiresPermissions {
4951

5052
/**

core/src/main/java/org/apache/shiro/authz/annotation/RequiresRoles.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
*/
1919
package org.apache.shiro.authz.annotation;
2020

21+
import java.lang.annotation.Documented;
2122
import java.lang.annotation.ElementType;
2223
import java.lang.annotation.Retention;
2324
import java.lang.annotation.RetentionPolicy;
@@ -52,6 +53,7 @@
5253
*/
5354
@Target({ElementType.TYPE, ElementType.METHOD})
5455
@Retention(RetentionPolicy.RUNTIME)
56+
@Documented
5557
public @interface RequiresRoles {
5658

5759
/**

core/src/main/java/org/apache/shiro/authz/annotation/RequiresUser.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
*/
1919
package org.apache.shiro.authz.annotation;
2020

21+
import java.lang.annotation.Documented;
2122
import java.lang.annotation.ElementType;
2223
import java.lang.annotation.Retention;
2324
import java.lang.annotation.RetentionPolicy;
@@ -47,5 +48,6 @@
4748
*/
4849
@Target({ElementType.TYPE, ElementType.METHOD})
4950
@Retention(RetentionPolicy.RUNTIME)
51+
@Documented
5052
public @interface RequiresUser {
5153
}

event/src/main/java/org/apache/shiro/event/Subscribe.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
*/
1919
package org.apache.shiro.event;
2020

21+
import java.lang.annotation.Documented;
2122
import java.lang.annotation.ElementType;
2223
import java.lang.annotation.Retention;
2324
import java.lang.annotation.RetentionPolicy;
@@ -41,5 +42,6 @@
4142
*/
4243
@Retention(value = RetentionPolicy.RUNTIME)
4344
@Target(value = ElementType.METHOD)
45+
@Documented
4446
public @interface Subscribe {
4547
}

0 commit comments

Comments
 (0)