[jira] [Resolved] (SHIRO-216) Add @Documented to Shiro authorization annotations

["Benjamin Marwell (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/SHIRO-216?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Benjamin Marwell resolved SHIRO-216.
------------------------------------
    Resolution: Fixed

> Add @Documented to Shiro authorization annotations
> --------------------------------------------------
>
>                 Key: SHIRO-216
>                 URL: https://issues.apache.org/jira/browse/SHIRO-216
>             Project: Shiro
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 1.1.0
>            Reporter: Matt Brictson
>            Assignee: Benjamin Marwell
>            Priority: Minor
>             Fix For: 2.0.0, 1.8.0
>
>
> 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.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)