Skip to content

Commit

Permalink
[JENKINS-68581] Improve Javadoc (#128)
Browse files Browse the repository at this point in the history
* [JENKINS-68581] Improve Javadoc

* Add some references for how permissions are looked up

Co-authored-by: Daniel Beck <daniel-beck@users.noreply.github.com>
  • Loading branch information
daniel-beck and daniel-beck committed Dec 8, 2022
1 parent 4e72dcc commit b738a49
Showing 1 changed file with 7 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,13 @@ default Map<Permission, Set<String>> getGrantedPermissions() {
* Works like {@link #add(Permission, PermissionEntry)} but takes both parameters
* from a single string of the form <code>PERMISSION_ID:sid</code> (legacy format, implicit 'EITHER' type)
* or <code>type:PERMISSION_ID:sid</code> (new since 3.0).
* <p>The supported formats for <code>PERMISSION_ID</code> are:</p>
* <ul>
* <li>Internal ID: <code>hudson.model.Hudson.ADMINISTER</code></li>
* <li>UI short form: <code>Overall/Administer</code></li>
* </ul>
* @see hudson.security.Permission#fromId(String)
* @see org.jenkinsci.plugins.matrixauth.integrations.PermissionFinder
*/
@Restricted(NoExternalUse.class)
default void add(String shortForm) {
Expand Down

0 comments on commit b738a49

Please sign in to comment.