[SHIRO-216] Add @Documented to Shiro authorization annotations

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 1.1.0
• Fix Version/s: 2.0.0-alpha, 1.8.0
• Component/s: Documentation
• Assignee: Benjamin Marwell
• Reporter: Matt Brictson
• Created: 08/Nov/10 22:54
• Updated: 23/Aug/21 18:17
• Resolved: 20/Aug/21 13:10

Description

Since security concerns are an important part of good API documentation, it would be nice if the Shiro authorization annotations like @RequiresUser and @RequiresPermissions were included in standard Javadoc output.

For example, if a method in my application has this signature:

@RequiresAuthentication
public Account getAccount()

{ ... }

It would be nice if the javadoc generated for my method included the fact that the @RequiresAuthentication annotation is present.

I believe this can be done by simply adding @java.lang.annotation.Documented to each of the Shiro annotation types. See:

http://download.oracle.com/javase/6/docs/api/java/lang/annotation/Documented.html

As a point of reference, Spring annotations like @Transactional and @PreAuthorize do have the @java.lang.annotation.Documented annotation.

Issue Links

• links to: GH Pull Request
• links to: PR #318