[jboss-jira] [JBoss JIRA] (ELY-1596) Verify all permission checks on public API are documented in the Javadoc

[Darran Lofthouse (JIRA)]

     [ https://issues.jboss.org/browse/ELY-1596?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Darran Lofthouse updated ELY-1596:
----------------------------------
    Description: 
We have methods such as the following where a permission check occurs but the Javadoc does not describe the required permission so an end user would only discover this by trial and error.

http://wildfly-security.github.io/wildfly-elytron/1.3.x/api-javadoc/index.html?org/wildfly/security/auth/server/SecurityIdentity.html

  was:We have methods such as the following where a permission check occurs but the Javadoc does not describe the required permission so an end user would only discover this by trial and error.



> Verify all permission checks on public API are documented in the Javadoc
> ------------------------------------------------------------------------
>
>                 Key: ELY-1596
>                 URL: https://issues.jboss.org/browse/ELY-1596
>             Project: WildFly Elytron
>          Issue Type: Task
>          Components: API / SPI
>            Reporter: Darran Lofthouse
>
> We have methods such as the following where a permission check occurs but the Javadoc does not describe the required permission so an end user would only discover this by trial and error.
> http://wildfly-security.github.io/wildfly-elytron/1.3.x/api-javadoc/index.html?org/wildfly/security/auth/server/SecurityIdentity.html



--
This message was sent by Atlassian JIRA
(v7.5.0#75005)