Skip to content

Commit

Permalink
Fixed links in Permission and updated param docs for JDABuilder#setProxy
Browse files Browse the repository at this point in the history
  • Loading branch information
MinnDevelopment committed Sep 24, 2016
1 parent 35a4d3d commit 1fe7056
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 17 deletions.
6 changes: 2 additions & 4 deletions src/main/java/net/dv8tion/jda/core/JDABuilder.java
Expand Up @@ -89,10 +89,8 @@ public JDABuilder setToken(String token) {
* After a JDA instance as been created, this method can never be called again, even if you are creating a new JDA object.<br>
* <b>Note:</b> currently this only supports HTTP proxies.
*
* @param proxyUrl
* The url of the proxy.
* @param proxyPort
* The port of the proxy. Usually this is 8080.
* @param proxy
* The proxy to use.
* @return
* Returns the {@link net.dv8tion.jda.core.JDABuilder JDABuilder} instance. Useful for chaining.
* @throws UnsupportedOperationException
Expand Down
26 changes: 13 additions & 13 deletions src/main/java/net/dv8tion/jda/core/Permission.java
Expand Up @@ -67,22 +67,22 @@ public enum Permission
* <a href="https://discordapi.readthedocs.org/en/latest/reference/channels/permissions.html#permissions-number">Discord Permission Numbers</a>.
*
* @return
* The offset that represents this {@link net.dv8tion.jda.Permission Permission}.
* The offset that represents this {@link net.dv8tion.jda.core.Permission Permission}.
*/
public int getOffset()
{
return offset;
}

/**
* Gets the {@link net.dv8tion.jda.Permission Permission} relating to the provided offset.<br>
* If there is no {@link net.dv8tion.jda.Permission Permssions} that matches the provided
* offset, {@link net.dv8tion.jda.Permission#UNKNOWN Permission.UNKNOWN} is returned.
* Gets the {@link net.dv8tion.jda.core.Permission Permission} relating to the provided offset.<br>
* If there is no {@link net.dv8tion.jda.core.Permission Permssions} that matches the provided
* offset, {@link net.dv8tion.jda.core.Permission#UNKNOWN Permission.UNKNOWN} is returned.
*
* @param offset
* The offset to match a {@link net.dv8tion.jda.Permission Permission} to.
* The offset to match a {@link net.dv8tion.jda.core.Permission Permission} to.
* @return
* {@link net.dv8tion.jda.Permission Permission} relating to the provided offset.
* {@link net.dv8tion.jda.core.Permission Permission} relating to the provided offset.
*/
public static Permission getFromOffset(int offset)
{
Expand Down Expand Up @@ -117,19 +117,19 @@ public boolean isChannel()
}

/**
* A list of all {@link net.dv8tion.jda.Permission Permissions} that are specified by this raw int representation of
* permissions. The is best used with the getRaw methods in {@link net.dv8tion.jda.entities.Role Role},
* {@link net.dv8tion.jda.entities.PermissionOverride PermissionOverride} or {@link net.dv8tion.jda.utils.PermissionUtil}.
* A list of all {@link net.dv8tion.jda.core.Permission Permissions} that are specified by this raw int representation of
* permissions. The is best used with the getRaw methods in {@link net.dv8tion.jda.core.entities.Role Role},
* {@link net.dv8tion.jda.core.entities.PermissionOverride PermissionOverride} or {@link net.dv8tion.jda.core.utils.PermissionUtil}.
* <p>
* Examples:<br>
* {@link net.dv8tion.jda.utils.PermissionUtil#getEffectivePermission(net.dv8tion.jda.entities.User, net.dv8tion.jda.entities.Channel) PermissionUtil.getEffectivePermission(user, channel)}<br>
* {@link net.dv8tion.jda.entities.PermissionOverride#getAllowedRaw() PermissionOverride.getAllowedRaw()}<br>
* {@link net.dv8tion.jda.entities.Role#getPermissionsRaw() Role.getPermissionsRaw()}
* {@link net.dv8tion.jda.core.utils.PermissionUtil#getEffectivePermission(net.dv8tion.jda.core.entities.Channel, net.dv8tion.jda.core.entities.Member) PermissionUtil.getEffectivePermission(channel, member)}<br>
* {@link net.dv8tion.jda.core.entities.PermissionOverride#getAllowedRaw() PermissionOverride.getAllowedRaw()}<br>
* {@link net.dv8tion.jda.core.entities.Role#getPermissionsRaw() Role.getPermissionsRaw()}
*
* @param permissions
* The raw <code>int</code> representation of permissions.
* @return
* Possibly-empty list of {@link net.dv8tion.jda.Permission Permissions}.
* Possibly-empty list of {@link net.dv8tion.jda.core.Permission Permissions}.
*/
public static List<Permission> getPermissions(int permissions)
{
Expand Down

0 comments on commit 1fe7056

Please sign in to comment.