Shiro
  1. Shiro
  2. SHIRO-216

Add @Documented to Shiro authorization annotations

    Details

    • Type: Improvement Improvement
    • Status: Open
    • Priority: Minor Minor
    • Resolution: Unresolved
    • Affects Version/s: 1.1.0
    • Fix Version/s: None
    • Labels:
      None

      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.

        Activity

        Matt Brictson created issue -
        Matt Brictson made changes -
        Field Original Value New Value
        Priority Major [ 3 ] Minor [ 4 ]

          People

          • Assignee:
            Unassigned
            Reporter:
            Matt Brictson
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:

              Development