Skip to content

Commit

Permalink
(DEPLOYED ACF) Updated JavaDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
aikar committed Jun 3, 2018
1 parent cbe1507 commit 0499f83
Show file tree
Hide file tree
Showing 16 changed files with 533 additions and 94 deletions.
1 change: 1 addition & 0 deletions docs/acf-jda/allclasses-frame.html
Expand Up @@ -16,6 +16,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="co/aikar/commands/CommandConfig.html" title="interface in co.aikar.commands" target="classFrame"><span class="interfaceName">CommandConfig</span></a></li>
<li><a href="co/aikar/commands/CommandConfigProvider.html" title="interface in co.aikar.commands" target="classFrame"><span class="interfaceName">CommandConfigProvider</span></a></li>
<li><a href="co/aikar/commands/CommandPermissionResolver.html" title="interface in co.aikar.commands" target="classFrame"><span class="interfaceName">CommandPermissionResolver</span></a></li>
<li><a href="co/aikar/commands/annotation/CrossGuild.html" title="annotation in co.aikar.commands.annotation" target="classFrame">CrossGuild</a></li>
<li><a href="co/aikar/commands/JDACommandCompletions.html" title="class in co.aikar.commands" target="classFrame">JDACommandCompletions</a></li>
<li><a href="co/aikar/commands/JDACommandConfig.html" title="class in co.aikar.commands" target="classFrame">JDACommandConfig</a></li>
<li><a href="co/aikar/commands/JDACommandContexts.html" title="class in co.aikar.commands" target="classFrame">JDACommandContexts</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/acf-jda/allclasses-noframe.html
Expand Up @@ -16,6 +16,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="co/aikar/commands/CommandConfig.html" title="interface in co.aikar.commands"><span class="interfaceName">CommandConfig</span></a></li>
<li><a href="co/aikar/commands/CommandConfigProvider.html" title="interface in co.aikar.commands"><span class="interfaceName">CommandConfigProvider</span></a></li>
<li><a href="co/aikar/commands/CommandPermissionResolver.html" title="interface in co.aikar.commands"><span class="interfaceName">CommandPermissionResolver</span></a></li>
<li><a href="co/aikar/commands/annotation/CrossGuild.html" title="annotation in co.aikar.commands.annotation">CrossGuild</a></li>
<li><a href="co/aikar/commands/JDACommandCompletions.html" title="class in co.aikar.commands">JDACommandCompletions</a></li>
<li><a href="co/aikar/commands/JDACommandConfig.html" title="class in co.aikar.commands">JDACommandConfig</a></li>
<li><a href="co/aikar/commands/JDACommandContexts.html" title="class in co.aikar.commands">JDACommandContexts</a></li>
Expand Down
4 changes: 2 additions & 2 deletions docs/acf-jda/co/aikar/commands/JDACommandContexts.html
Expand Up @@ -107,7 +107,7 @@ <h2 title="Class JDACommandContexts" class="title">Class JDACommandContexts</h2>
<li class="blockList">
<hr>
<br>
<pre>public class <a href="../../../src-html/co/aikar/commands/JDACommandContexts.html#line.17">JDACommandContexts</a>
<pre>public class <a href="../../../src-html/co/aikar/commands/JDACommandContexts.html#line.20">JDACommandContexts</a>
extends co.aikar.commands.CommandContexts&lt;<a href="../../../co/aikar/commands/JDACommandExecutionContext.html" title="class in co.aikar.commands">JDACommandExecutionContext</a>&gt;</pre>
</li>
</ul>
Expand Down Expand Up @@ -187,7 +187,7 @@ <h3>Constructor Detail</h3>
<ul class="blockListLast">
<li class="blockList">
<h4>JDACommandContexts</h4>
<pre>public&nbsp;<a href="../../../src-html/co/aikar/commands/JDACommandContexts.html#line.21">JDACommandContexts</a>(<a href="../../../co/aikar/commands/JDACommandManager.html" title="class in co.aikar.commands">JDACommandManager</a>&nbsp;manager)</pre>
<pre>public&nbsp;<a href="../../../src-html/co/aikar/commands/JDACommandContexts.html#line.24">JDACommandContexts</a>(<a href="../../../co/aikar/commands/JDACommandManager.html" title="class in co.aikar.commands">JDACommandManager</a>&nbsp;manager)</pre>
</li>
</ul>
</li>
Expand Down
8 changes: 4 additions & 4 deletions docs/acf-jda/co/aikar/commands/annotation/Author.html
Expand Up @@ -43,7 +43,7 @@
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../co/aikar/commands/annotation/SelfUser.html" title="annotation in co.aikar.commands.annotation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="../../../../co/aikar/commands/annotation/CrossGuild.html" title="annotation in co.aikar.commands.annotation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?co/aikar/commands/annotation/Author.html" target="_top">Frames</a></li>
Expand Down Expand Up @@ -98,8 +98,8 @@ <h2 title="Annotation Type Author" class="title">Annotation Type Author</h2>
<div class="block">The <a href="../../../../co/aikar/commands/annotation/Author.html" title="annotation in co.aikar.commands.annotation"><code>Author</code></a> annotation is to define whether the parameter should be the author object from the event or
parsed from the user's input.
<p>
Using this on a User/Member will fetch the author, while if not, it'll parse the input.
The same happens with channels, guilds, and so on.</div>
Using this on a User/Member will fetch the author and otherwise it'll parse the input.
</p></div>
</li>
</ul>
</div>
Expand All @@ -126,7 +126,7 @@ <h2 title="Annotation Type Author" class="title">Annotation Type Author</h2>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../co/aikar/commands/annotation/SelfUser.html" title="annotation in co.aikar.commands.annotation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="../../../../co/aikar/commands/annotation/CrossGuild.html" title="annotation in co.aikar.commands.annotation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?co/aikar/commands/annotation/Author.html" target="_top">Frames</a></li>
Expand Down
170 changes: 170 additions & 0 deletions docs/acf-jda/co/aikar/commands/annotation/CrossGuild.html
@@ -0,0 +1,170 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CrossGuild (ACF (JDA) 0.5.0-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CrossGuild (ACF (JDA) 0.5.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CrossGuild.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../co/aikar/commands/annotation/Author.html" title="annotation in co.aikar.commands.annotation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../co/aikar/commands/annotation/SelfUser.html" title="annotation in co.aikar.commands.annotation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?co/aikar/commands/annotation/CrossGuild.html" target="_top">Frames</a></li>
<li><a href="CrossGuild.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li>Optional</li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Element</li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">co.aikar.commands.annotation</div>
<h2 title="Annotation Type CrossGuild" class="title">Annotation Type CrossGuild</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER" title="class or interface in java.lang.annotation">PARAMETER</a>)
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
public @interface <a href="../../../../src-html/co/aikar/commands/annotation/CrossGuild.html#line.18">CrossGuild</a></pre>
<div class="block">The <a href="../../../../co/aikar/commands/annotation/CrossGuild.html" title="annotation in co.aikar.commands.annotation"><code>CrossGuild</code></a> annotation is to define whether the parameter should be guild-specific or global.
<p>
If a supported parameter is marked with the CrossGuild annotation, the parameter will be filled from
a global perspective (i.e., all of the guilds the bot is connected to). Otherwise, the parameter will
be filled from command input.
</p></div>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CrossGuild.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../co/aikar/commands/annotation/Author.html" title="annotation in co.aikar.commands.annotation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../co/aikar/commands/annotation/SelfUser.html" title="annotation in co.aikar.commands.annotation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?co/aikar/commands/annotation/CrossGuild.html" target="_top">Frames</a></li>
<li><a href="CrossGuild.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li>Optional</li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Element</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
</body>
</html>
8 changes: 5 additions & 3 deletions docs/acf-jda/co/aikar/commands/annotation/SelfUser.html
Expand Up @@ -42,7 +42,7 @@
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../co/aikar/commands/annotation/Author.html" title="annotation in co.aikar.commands.annotation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../co/aikar/commands/annotation/CrossGuild.html" title="annotation in co.aikar.commands.annotation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
Expand Down Expand Up @@ -94,7 +94,9 @@ <h2 title="Annotation Type SelfUser" class="title">Annotation Type SelfUser</h2>
<br>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER" title="class or interface in java.lang.annotation">PARAMETER</a>)
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
public @interface <a href="../../../../src-html/co/aikar/commands/annotation/SelfUser.html#line.10">SelfUser</a></pre>
public @interface <a href="../../../../src-html/co/aikar/commands/annotation/SelfUser.html#line.14">SelfUser</a></pre>
<div class="block">The <a href="../../../../co/aikar/commands/annotation/SelfUser.html" title="annotation in co.aikar.commands.annotation"><code>SelfUser</code></a> annotation is to define whether the parameter should be represented by JDA's user object
or if it should be parsed from command input.</div>
</li>
</ul>
</div>
Expand All @@ -120,7 +122,7 @@ <h2 title="Annotation Type SelfUser" class="title">Annotation Type SelfUser</h2>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../co/aikar/commands/annotation/Author.html" title="annotation in co.aikar.commands.annotation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../co/aikar/commands/annotation/CrossGuild.html" title="annotation in co.aikar.commands.annotation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
Expand Down
123 changes: 123 additions & 0 deletions docs/acf-jda/co/aikar/commands/annotation/class-use/CrossGuild.html
@@ -0,0 +1,123 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Uses of Class co.aikar.commands.annotation.CrossGuild (ACF (JDA) 0.5.0-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Uses of Class co.aikar.commands.annotation.CrossGuild (ACF (JDA) 0.5.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../co/aikar/commands/annotation/CrossGuild.html" title="annotation in co.aikar.commands.annotation">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?co/aikar/commands/annotation/class-use/CrossGuild.html" target="_top">Frames</a></li>
<li><a href="CrossGuild.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h2 title="Uses of Class co.aikar.commands.annotation.CrossGuild" class="title">Uses of Class<br>co.aikar.commands.annotation.CrossGuild</h2>
</div>
<div class="classUseContainer">No usage of co.aikar.commands.annotation.CrossGuild</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../co/aikar/commands/annotation/CrossGuild.html" title="annotation in co.aikar.commands.annotation">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?co/aikar/commands/annotation/class-use/CrossGuild.html" target="_top">Frames</a></li>
<li><a href="CrossGuild.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
</body>
</html>

0 comments on commit 0499f83

Please sign in to comment.