Skip to content

Commit 00ecdf6

Browse files
author
Bytekeeper
committed
Added more docs and javadoc content.
1 parent ff7629b commit 00ecdf6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+17654
-2
lines changed

build.gradle.kts

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,19 @@ configurations.jmhCompile.get().extendsFrom(configurations.implementation.get())
3636

3737
tasks {
3838
check {
39-
dependsOn("jmh")
39+
dependsOn("jmh", "javadoc")
4040
}
4141

4242
test {
4343
useJUnitPlatform()
4444
}
45+
46+
javadoc {
47+
destinationDir = File("docs")
48+
}
49+
4550
}
4651

4752
jmh {
4853
resultFormat = "JSON"
49-
}
54+
}

docs/allclasses-frame.html

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<!-- NewPage -->
3+
<html lang="de">
4+
<head>
5+
<!-- Generated by javadoc (1.8.0_222) on Wed Aug 14 19:33:40 CEST 2019 -->
6+
<title>All Classes (ass 1.1 API)</title>
7+
<meta name="date" content="2019-08-14">
8+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
9+
<script type="text/javascript" src="script.js"></script>
10+
</head>
11+
<body>
12+
<h1 class="bar">All&nbsp;Classes</h1>
13+
<div class="indexContainer">
14+
<ul>
15+
<li><a href="org/bk/ass/Agent.html" title="class in org.bk.ass" target="classFrame">Agent</a></li>
16+
<li><a href="org/bk/ass/AgentUtil.html" title="class in org.bk.ass" target="classFrame">AgentUtil</a></li>
17+
<li><a href="org/bk/ass/AttackerBehavior.html" title="class in org.bk.ass" target="classFrame">AttackerBehavior</a></li>
18+
<li><a href="org/bk/ass/BWAPI4JAgentFactory.html" title="class in org.bk.ass" target="classFrame">BWAPI4JAgentFactory</a></li>
19+
<li><a href="org/bk/ass/info/BWAPI4JUnitInfo.html" title="class in org.bk.ass.info" target="classFrame">BWAPI4JUnitInfo</a></li>
20+
<li><a href="org/bk/ass/BWMirrorAgentFactory.html" title="class in org.bk.ass" target="classFrame">BWMirrorAgentFactory</a></li>
21+
<li><a href="org/bk/ass/info/BWMirrorUnitInfo.html" title="class in org.bk.ass.info" target="classFrame">BWMirrorUnitInfo</a></li>
22+
<li><a href="org/bk/ass/cluster/Cluster.html" title="class in org.bk.ass.cluster" target="classFrame">Cluster</a></li>
23+
<li><a href="org/bk/ass/DamageType.html" title="enum in org.bk.ass" target="classFrame">DamageType</a></li>
24+
<li><a href="org/bk/ass/query/DistanceProvider.html" title="interface in org.bk.ass.query" target="classFrame"><span class="interfaceName">DistanceProvider</span></a></li>
25+
<li><a href="org/bk/ass/query/Distances.html" title="class in org.bk.ass.query" target="classFrame">Distances</a></li>
26+
<li><a href="org/bk/ass/Evaluator.html" title="class in org.bk.ass" target="classFrame">Evaluator</a></li>
27+
<li><a href="org/bk/ass/Evaluator.Parameters.html" title="class in org.bk.ass" target="classFrame">Evaluator.Parameters</a></li>
28+
<li><a href="org/bk/ass/FastArrayFill.html" title="class in org.bk.ass" target="classFrame">FastArrayFill</a></li>
29+
<li><a href="org/bk/ass/grid/Grid.html" title="interface in org.bk.ass.grid" target="classFrame"><span class="interfaceName">Grid</span></a></li>
30+
<li><a href="org/bk/ass/HealerBehavior.html" title="class in org.bk.ass" target="classFrame">HealerBehavior</a></li>
31+
<li><a href="org/bk/ass/path/Jps.html" title="class in org.bk.ass.path" target="classFrame">Jps</a></li>
32+
<li><a href="org/bk/ass/path/Map.html" title="interface in org.bk.ass.path" target="classFrame"><span class="interfaceName">Map</span></a></li>
33+
<li><a href="org/bk/ass/collection/PairingHeap.html" title="class in org.bk.ass.collection" target="classFrame">PairingHeap</a></li>
34+
<li><a href="org/bk/ass/path/Position.html" title="class in org.bk.ass.path" target="classFrame">Position</a></li>
35+
<li><a href="org/bk/ass/query/PositionAndId.html" title="class in org.bk.ass.query" target="classFrame">PositionAndId</a></li>
36+
<li><a href="org/bk/ass/PositionOutOfBoundsException.html" title="class in org.bk.ass" target="classFrame">PositionOutOfBoundsException</a></li>
37+
<li><a href="org/bk/ass/query/PositionQueries.html" title="class in org.bk.ass.query" target="classFrame">PositionQueries</a></li>
38+
<li><a href="org/bk/ass/path/PPJps.html" title="class in org.bk.ass.path" target="classFrame">PPJps</a></li>
39+
<li><a href="org/bk/ass/path/PPMap.html" title="interface in org.bk.ass.path" target="classFrame"><span class="interfaceName">PPMap</span></a></li>
40+
<li><a href="org/bk/ass/RepairerBehavior.html" title="class in org.bk.ass" target="classFrame">RepairerBehavior</a></li>
41+
<li><a href="org/bk/ass/path/Result.html" title="class in org.bk.ass.path" target="classFrame">Result</a></li>
42+
<li><a href="org/bk/ass/RetreatBehavior.html" title="class in org.bk.ass" target="classFrame">RetreatBehavior</a></li>
43+
<li><a href="org/bk/ass/Simulator.html" title="class in org.bk.ass" target="classFrame">Simulator</a></li>
44+
<li><a href="org/bk/ass/Simulator.Behavior.html" title="interface in org.bk.ass" target="classFrame"><span class="interfaceName">Simulator.Behavior</span></a></li>
45+
<li><a href="org/bk/ass/Simulator.RoleBasedBehavior.html" title="class in org.bk.ass" target="classFrame">Simulator.RoleBasedBehavior</a></li>
46+
<li><a href="org/bk/ass/SplashType.html" title="enum in org.bk.ass" target="classFrame">SplashType</a></li>
47+
<li><a href="org/bk/ass/cluster/StableDBScanner.html" title="class in org.bk.ass.cluster" target="classFrame">StableDBScanner</a></li>
48+
<li><a href="org/bk/ass/SuiciderBehavior.html" title="class in org.bk.ass" target="classFrame">SuiciderBehavior</a></li>
49+
<li><a href="org/bk/ass/UnitSize.html" title="enum in org.bk.ass" target="classFrame">UnitSize</a></li>
50+
<li><a href="org/bk/ass/collection/UnorderedCollection.html" title="class in org.bk.ass.collection" target="classFrame">UnorderedCollection</a></li>
51+
<li><a href="org/bk/ass/Weapon.html" title="class in org.bk.ass" target="classFrame">Weapon</a></li>
52+
</ul>
53+
</div>
54+
</body>
55+
</html>

docs/allclasses-noframe.html

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<!-- NewPage -->
3+
<html lang="de">
4+
<head>
5+
<!-- Generated by javadoc (1.8.0_222) on Wed Aug 14 19:33:40 CEST 2019 -->
6+
<title>All Classes (ass 1.1 API)</title>
7+
<meta name="date" content="2019-08-14">
8+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
9+
<script type="text/javascript" src="script.js"></script>
10+
</head>
11+
<body>
12+
<h1 class="bar">All&nbsp;Classes</h1>
13+
<div class="indexContainer">
14+
<ul>
15+
<li><a href="org/bk/ass/Agent.html" title="class in org.bk.ass">Agent</a></li>
16+
<li><a href="org/bk/ass/AgentUtil.html" title="class in org.bk.ass">AgentUtil</a></li>
17+
<li><a href="org/bk/ass/AttackerBehavior.html" title="class in org.bk.ass">AttackerBehavior</a></li>
18+
<li><a href="org/bk/ass/BWAPI4JAgentFactory.html" title="class in org.bk.ass">BWAPI4JAgentFactory</a></li>
19+
<li><a href="org/bk/ass/info/BWAPI4JUnitInfo.html" title="class in org.bk.ass.info">BWAPI4JUnitInfo</a></li>
20+
<li><a href="org/bk/ass/BWMirrorAgentFactory.html" title="class in org.bk.ass">BWMirrorAgentFactory</a></li>
21+
<li><a href="org/bk/ass/info/BWMirrorUnitInfo.html" title="class in org.bk.ass.info">BWMirrorUnitInfo</a></li>
22+
<li><a href="org/bk/ass/cluster/Cluster.html" title="class in org.bk.ass.cluster">Cluster</a></li>
23+
<li><a href="org/bk/ass/DamageType.html" title="enum in org.bk.ass">DamageType</a></li>
24+
<li><a href="org/bk/ass/query/DistanceProvider.html" title="interface in org.bk.ass.query"><span class="interfaceName">DistanceProvider</span></a></li>
25+
<li><a href="org/bk/ass/query/Distances.html" title="class in org.bk.ass.query">Distances</a></li>
26+
<li><a href="org/bk/ass/Evaluator.html" title="class in org.bk.ass">Evaluator</a></li>
27+
<li><a href="org/bk/ass/Evaluator.Parameters.html" title="class in org.bk.ass">Evaluator.Parameters</a></li>
28+
<li><a href="org/bk/ass/FastArrayFill.html" title="class in org.bk.ass">FastArrayFill</a></li>
29+
<li><a href="org/bk/ass/grid/Grid.html" title="interface in org.bk.ass.grid"><span class="interfaceName">Grid</span></a></li>
30+
<li><a href="org/bk/ass/HealerBehavior.html" title="class in org.bk.ass">HealerBehavior</a></li>
31+
<li><a href="org/bk/ass/path/Jps.html" title="class in org.bk.ass.path">Jps</a></li>
32+
<li><a href="org/bk/ass/path/Map.html" title="interface in org.bk.ass.path"><span class="interfaceName">Map</span></a></li>
33+
<li><a href="org/bk/ass/collection/PairingHeap.html" title="class in org.bk.ass.collection">PairingHeap</a></li>
34+
<li><a href="org/bk/ass/path/Position.html" title="class in org.bk.ass.path">Position</a></li>
35+
<li><a href="org/bk/ass/query/PositionAndId.html" title="class in org.bk.ass.query">PositionAndId</a></li>
36+
<li><a href="org/bk/ass/PositionOutOfBoundsException.html" title="class in org.bk.ass">PositionOutOfBoundsException</a></li>
37+
<li><a href="org/bk/ass/query/PositionQueries.html" title="class in org.bk.ass.query">PositionQueries</a></li>
38+
<li><a href="org/bk/ass/path/PPJps.html" title="class in org.bk.ass.path">PPJps</a></li>
39+
<li><a href="org/bk/ass/path/PPMap.html" title="interface in org.bk.ass.path"><span class="interfaceName">PPMap</span></a></li>
40+
<li><a href="org/bk/ass/RepairerBehavior.html" title="class in org.bk.ass">RepairerBehavior</a></li>
41+
<li><a href="org/bk/ass/path/Result.html" title="class in org.bk.ass.path">Result</a></li>
42+
<li><a href="org/bk/ass/RetreatBehavior.html" title="class in org.bk.ass">RetreatBehavior</a></li>
43+
<li><a href="org/bk/ass/Simulator.html" title="class in org.bk.ass">Simulator</a></li>
44+
<li><a href="org/bk/ass/Simulator.Behavior.html" title="interface in org.bk.ass"><span class="interfaceName">Simulator.Behavior</span></a></li>
45+
<li><a href="org/bk/ass/Simulator.RoleBasedBehavior.html" title="class in org.bk.ass">Simulator.RoleBasedBehavior</a></li>
46+
<li><a href="org/bk/ass/SplashType.html" title="enum in org.bk.ass">SplashType</a></li>
47+
<li><a href="org/bk/ass/cluster/StableDBScanner.html" title="class in org.bk.ass.cluster">StableDBScanner</a></li>
48+
<li><a href="org/bk/ass/SuiciderBehavior.html" title="class in org.bk.ass">SuiciderBehavior</a></li>
49+
<li><a href="org/bk/ass/UnitSize.html" title="enum in org.bk.ass">UnitSize</a></li>
50+
<li><a href="org/bk/ass/collection/UnorderedCollection.html" title="class in org.bk.ass.collection">UnorderedCollection</a></li>
51+
<li><a href="org/bk/ass/Weapon.html" title="class in org.bk.ass">Weapon</a></li>
52+
</ul>
53+
</div>
54+
</body>
55+
</html>

docs/constant-values.html

Lines changed: 215 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,215 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<!-- NewPage -->
3+
<html lang="de">
4+
<head>
5+
<!-- Generated by javadoc (1.8.0_222) on Wed Aug 14 19:33:40 CEST 2019 -->
6+
<title>Constant Field Values (ass 1.1 API)</title>
7+
<meta name="date" content="2019-08-14">
8+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
9+
<script type="text/javascript" src="script.js"></script>
10+
</head>
11+
<body>
12+
<script type="text/javascript"><!--
13+
try {
14+
if (location.href.indexOf('is-external=true') == -1) {
15+
parent.document.title="Constant Field Values (ass 1.1 API)";
16+
}
17+
}
18+
catch(err) {
19+
}
20+
//-->
21+
</script>
22+
<noscript>
23+
<div>JavaScript is disabled on your browser.</div>
24+
</noscript>
25+
<!-- ========= START OF TOP NAVBAR ======= -->
26+
<div class="topNav"><a name="navbar.top">
27+
<!-- -->
28+
</a>
29+
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
30+
<a name="navbar.top.firstrow">
31+
<!-- -->
32+
</a>
33+
<ul class="navList" title="Navigation">
34+
<li><a href="overview-summary.html">Overview</a></li>
35+
<li>Package</li>
36+
<li>Class</li>
37+
<li><a href="overview-tree.html">Tree</a></li>
38+
<li><a href="deprecated-list.html">Deprecated</a></li>
39+
<li><a href="index-all.html">Index</a></li>
40+
<li><a href="help-doc.html">Help</a></li>
41+
</ul>
42+
</div>
43+
<div class="subNav">
44+
<ul class="navList">
45+
<li>Prev</li>
46+
<li>Next</li>
47+
</ul>
48+
<ul class="navList">
49+
<li><a href="index.html?constant-values.html" target="_top">Frames</a></li>
50+
<li><a href="constant-values.html" target="_top">No&nbsp;Frames</a></li>
51+
</ul>
52+
<ul class="navList" id="allclasses_navbar_top">
53+
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
54+
</ul>
55+
<div>
56+
<script type="text/javascript"><!--
57+
allClassesLink = document.getElementById("allclasses_navbar_top");
58+
if(window==top) {
59+
allClassesLink.style.display = "block";
60+
}
61+
else {
62+
allClassesLink.style.display = "none";
63+
}
64+
//-->
65+
</script>
66+
</div>
67+
<a name="skip.navbar.top">
68+
<!-- -->
69+
</a></div>
70+
<!-- ========= END OF TOP NAVBAR ========= -->
71+
<div class="header">
72+
<h1 title="Constant Field Values" class="title">Constant Field Values</h1>
73+
<h2 title="Contents">Contents</h2>
74+
<ul>
75+
<li><a href="#org.bk">org.bk.*</a></li>
76+
</ul>
77+
</div>
78+
<div class="constantValuesContainer"><a name="org.bk">
79+
<!-- -->
80+
</a>
81+
<h2 title="org.bk">org.bk.*</h2>
82+
<ul class="blockList">
83+
<li class="blockList">
84+
<table class="constantsSummary" border="0" cellpadding="3" cellspacing="0" summary="Constant Field Values table, listing constant fields, and values">
85+
<caption><span>org.bk.ass.<a href="org/bk/ass/AttackerBehavior.html" title="class in org.bk.ass">AttackerBehavior</a></span><span class="tabEnd">&nbsp;</span></caption>
86+
<tr>
87+
<th class="colFirst" scope="col">Modifier and Type</th>
88+
<th scope="col">Constant Field</th>
89+
<th class="colLast" scope="col">Value</th>
90+
</tr>
91+
<tbody>
92+
<tr class="altColor">
93+
<td class="colFirst"><a name="org.bk.ass.AttackerBehavior.STIM_ENERGY_COST_SHIFTED">
94+
<!-- -->
95+
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
96+
<td><code><a href="org/bk/ass/AttackerBehavior.html#STIM_ENERGY_COST_SHIFTED">STIM_ENERGY_COST_SHIFTED</a></code></td>
97+
<td class="colLast"><code>2560</code></td>
98+
</tr>
99+
<tr class="rowColor">
100+
<td class="colFirst"><a name="org.bk.ass.AttackerBehavior.STIM_TIMER">
101+
<!-- -->
102+
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
103+
<td><code><a href="org/bk/ass/AttackerBehavior.html#STIM_TIMER">STIM_TIMER</a></code></td>
104+
<td class="colLast"><code>37</code></td>
105+
</tr>
106+
</tbody>
107+
</table>
108+
</li>
109+
<li class="blockList">
110+
<table class="constantsSummary" border="0" cellpadding="3" cellspacing="0" summary="Constant Field Values table, listing constant fields, and values">
111+
<caption><span>org.bk.ass.<a href="org/bk/ass/HealerBehavior.html" title="class in org.bk.ass">HealerBehavior</a></span><span class="tabEnd">&nbsp;</span></caption>
112+
<tr>
113+
<th class="colFirst" scope="col">Modifier and Type</th>
114+
<th scope="col">Constant Field</th>
115+
<th class="colLast" scope="col">Value</th>
116+
</tr>
117+
<tbody>
118+
<tr class="altColor">
119+
<td class="colFirst"><a name="org.bk.ass.HealerBehavior.MEDICS_HEAL_RANGE_SQUARED">
120+
<!-- -->
121+
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
122+
<td><code><a href="org/bk/ass/HealerBehavior.html#MEDICS_HEAL_RANGE_SQUARED">MEDICS_HEAL_RANGE_SQUARED</a></code></td>
123+
<td class="colLast"><code>900</code></td>
124+
</tr>
125+
</tbody>
126+
</table>
127+
</li>
128+
<li class="blockList">
129+
<table class="constantsSummary" border="0" cellpadding="3" cellspacing="0" summary="Constant Field Values table, listing constant fields, and values">
130+
<caption><span>org.bk.ass.<a href="org/bk/ass/RepairerBehavior.html" title="class in org.bk.ass">RepairerBehavior</a></span><span class="tabEnd">&nbsp;</span></caption>
131+
<tr>
132+
<th class="colFirst" scope="col">Modifier and Type</th>
133+
<th scope="col">Constant Field</th>
134+
<th class="colLast" scope="col">Value</th>
135+
</tr>
136+
<tbody>
137+
<tr class="altColor">
138+
<td class="colFirst"><a name="org.bk.ass.RepairerBehavior.SCV_REPAIR_RANGE_SQUARED">
139+
<!-- -->
140+
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
141+
<td><code><a href="org/bk/ass/RepairerBehavior.html#SCV_REPAIR_RANGE_SQUARED">SCV_REPAIR_RANGE_SQUARED</a></code></td>
142+
<td class="colLast"><code>25</code></td>
143+
</tr>
144+
</tbody>
145+
</table>
146+
</li>
147+
<li class="blockList">
148+
<table class="constantsSummary" border="0" cellpadding="3" cellspacing="0" summary="Constant Field Values table, listing constant fields, and values">
149+
<caption><span>org.bk.ass.<a href="org/bk/ass/Simulator.html" title="class in org.bk.ass">Simulator</a></span><span class="tabEnd">&nbsp;</span></caption>
150+
<tr>
151+
<th class="colFirst" scope="col">Modifier and Type</th>
152+
<th scope="col">Constant Field</th>
153+
<th class="colLast" scope="col">Value</th>
154+
</tr>
155+
<tbody>
156+
<tr class="altColor">
157+
<td class="colFirst"><a name="org.bk.ass.Simulator.MIN_SIMULATION_RANGE">
158+
<!-- -->
159+
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
160+
<td><code><a href="org/bk/ass/Simulator.html#MIN_SIMULATION_RANGE">MIN_SIMULATION_RANGE</a></code></td>
161+
<td class="colLast"><code>576</code></td>
162+
</tr>
163+
</tbody>
164+
</table>
165+
</li>
166+
</ul>
167+
</div>
168+
<!-- ======= START OF BOTTOM NAVBAR ====== -->
169+
<div class="bottomNav"><a name="navbar.bottom">
170+
<!-- -->
171+
</a>
172+
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
173+
<a name="navbar.bottom.firstrow">
174+
<!-- -->
175+
</a>
176+
<ul class="navList" title="Navigation">
177+
<li><a href="overview-summary.html">Overview</a></li>
178+
<li>Package</li>
179+
<li>Class</li>
180+
<li><a href="overview-tree.html">Tree</a></li>
181+
<li><a href="deprecated-list.html">Deprecated</a></li>
182+
<li><a href="index-all.html">Index</a></li>
183+
<li><a href="help-doc.html">Help</a></li>
184+
</ul>
185+
</div>
186+
<div class="subNav">
187+
<ul class="navList">
188+
<li>Prev</li>
189+
<li>Next</li>
190+
</ul>
191+
<ul class="navList">
192+
<li><a href="index.html?constant-values.html" target="_top">Frames</a></li>
193+
<li><a href="constant-values.html" target="_top">No&nbsp;Frames</a></li>
194+
</ul>
195+
<ul class="navList" id="allclasses_navbar_bottom">
196+
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
197+
</ul>
198+
<div>
199+
<script type="text/javascript"><!--
200+
allClassesLink = document.getElementById("allclasses_navbar_bottom");
201+
if(window==top) {
202+
allClassesLink.style.display = "block";
203+
}
204+
else {
205+
allClassesLink.style.display = "none";
206+
}
207+
//-->
208+
</script>
209+
</div>
210+
<a name="skip.navbar.bottom">
211+
<!-- -->
212+
</a></div>
213+
<!-- ======== END OF BOTTOM NAVBAR ======= -->
214+
</body>
215+
</html>

0 commit comments

Comments
 (0)