Skip to content

Commit

Permalink
JavaDoc everything
Browse files Browse the repository at this point in the history
  • Loading branch information
@GrantPerkins
GrantPerkins committed Feb 21, 2018
1 parent afed3fa commit 1e2e527
Show file tree
Hide file tree
Showing 244 changed files with 1,332 additions and 5,482 deletions.
4 changes: 2 additions & 2 deletions doc/allclasses-frame.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 16:30:46 EST 2018 -->
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 18:27:45 EST 2018 -->
<title>All Classes</title>
<meta name="date" content="2018-02-21">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand All @@ -25,6 +25,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="org/usfirst/frc/team1100/robot/commands/claw/CloseClaw.html" title="class in org.usfirst.frc.team1100.robot.commands.claw" target="classFrame">CloseClaw</a></li>
<li><a href="org/usfirst/frc/team1100/robot/commands/auto/CrossLine.html" title="class in org.usfirst.frc.team1100.robot.commands.auto" target="classFrame">CrossLine</a></li>
<li><a href="org/usfirst/frc/team1100/robot/commands/climber/DefaultClimber.html" title="class in org.usfirst.frc.team1100.robot.commands.climber" target="classFrame">DefaultClimber</a></li>
<li><a href="org/usfirst/frc/team1100/robot/commands/drive/DefaultDrive.html" title="class in org.usfirst.frc.team1100.robot.commands.drive" target="classFrame">DefaultDrive</a></li>
<li><a href="org/usfirst/frc/team1100/robot/commands/intake/DefaultIntake.html" title="class in org.usfirst.frc.team1100.robot.commands.intake" target="classFrame">DefaultIntake</a></li>
<li><a href="org/usfirst/frc/team1100/robot/commands/wrist/DefaultWrist.html" title="class in org.usfirst.frc.team1100.robot.commands.wrist" target="classFrame">DefaultWrist</a></li>
<li><a href="org/usfirst/frc/team1100/robot/subsystems/Drive.html" title="class in org.usfirst.frc.team1100.robot.subsystems" target="classFrame">Drive</a></li>
Expand Down Expand Up @@ -60,7 +61,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="org/usfirst/frc/team1100/robot/commands/intake/ShootCubeOut.html" title="class in org.usfirst.frc.team1100.robot.commands.intake" target="classFrame">ShootCubeOut</a></li>
<li><a href="org/usfirst/frc/team1100/robot/commands/drive/TimedForwards.html" title="class in org.usfirst.frc.team1100.robot.commands.drive" target="classFrame">TimedForwards</a></li>
<li><a href="org/usfirst/frc/team1100/robot/commands/folder/Unfold.html" title="class in org.usfirst.frc.team1100.robot.commands.folder" target="classFrame">Unfold</a></li>
<li><a href="org/usfirst/frc/team1100/robot/commands/drive/UserDrive.html" title="class in org.usfirst.frc.team1100.robot.commands.drive" target="classFrame">UserDrive</a></li>
<li><a href="org/usfirst/frc/team1100/robot/commands/Wait.html" title="class in org.usfirst.frc.team1100.robot.commands" target="classFrame">Wait</a></li>
<li><a href="org/usfirst/frc/team1100/robot/subsystems/Wrist.html" title="class in org.usfirst.frc.team1100.robot.subsystems" target="classFrame">Wrist</a></li>
<li><a href="org/usfirst/frc/team1100/robot/input/XboxController.html" title="class in org.usfirst.frc.team1100.robot.input" target="classFrame">XboxController</a></li>
Expand Down
4 changes: 2 additions & 2 deletions doc/allclasses-noframe.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 16:30:46 EST 2018 -->
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 18:27:45 EST 2018 -->
<title>All Classes</title>
<meta name="date" content="2018-02-21">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand All @@ -25,6 +25,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="org/usfirst/frc/team1100/robot/commands/claw/CloseClaw.html" title="class in org.usfirst.frc.team1100.robot.commands.claw">CloseClaw</a></li>
<li><a href="org/usfirst/frc/team1100/robot/commands/auto/CrossLine.html" title="class in org.usfirst.frc.team1100.robot.commands.auto">CrossLine</a></li>
<li><a href="org/usfirst/frc/team1100/robot/commands/climber/DefaultClimber.html" title="class in org.usfirst.frc.team1100.robot.commands.climber">DefaultClimber</a></li>
<li><a href="org/usfirst/frc/team1100/robot/commands/drive/DefaultDrive.html" title="class in org.usfirst.frc.team1100.robot.commands.drive">DefaultDrive</a></li>
<li><a href="org/usfirst/frc/team1100/robot/commands/intake/DefaultIntake.html" title="class in org.usfirst.frc.team1100.robot.commands.intake">DefaultIntake</a></li>
<li><a href="org/usfirst/frc/team1100/robot/commands/wrist/DefaultWrist.html" title="class in org.usfirst.frc.team1100.robot.commands.wrist">DefaultWrist</a></li>
<li><a href="org/usfirst/frc/team1100/robot/subsystems/Drive.html" title="class in org.usfirst.frc.team1100.robot.subsystems">Drive</a></li>
Expand Down Expand Up @@ -60,7 +61,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="org/usfirst/frc/team1100/robot/commands/intake/ShootCubeOut.html" title="class in org.usfirst.frc.team1100.robot.commands.intake">ShootCubeOut</a></li>
<li><a href="org/usfirst/frc/team1100/robot/commands/drive/TimedForwards.html" title="class in org.usfirst.frc.team1100.robot.commands.drive">TimedForwards</a></li>
<li><a href="org/usfirst/frc/team1100/robot/commands/folder/Unfold.html" title="class in org.usfirst.frc.team1100.robot.commands.folder">Unfold</a></li>
<li><a href="org/usfirst/frc/team1100/robot/commands/drive/UserDrive.html" title="class in org.usfirst.frc.team1100.robot.commands.drive">UserDrive</a></li>
<li><a href="org/usfirst/frc/team1100/robot/commands/Wait.html" title="class in org.usfirst.frc.team1100.robot.commands">Wait</a></li>
<li><a href="org/usfirst/frc/team1100/robot/subsystems/Wrist.html" title="class in org.usfirst.frc.team1100.robot.subsystems">Wrist</a></li>
<li><a href="org/usfirst/frc/team1100/robot/input/XboxController.html" title="class in org.usfirst.frc.team1100.robot.input">XboxController</a></li>
Expand Down
2 changes: 1 addition & 1 deletion doc/constant-values.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 16:30:45 EST 2018 -->
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 18:27:44 EST 2018 -->
<title>Constant Field Values</title>
<meta name="date" content="2018-02-21">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand Down
2 changes: 1 addition & 1 deletion doc/deprecated-list.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 16:30:46 EST 2018 -->
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 18:27:45 EST 2018 -->
<title>Deprecated List</title>
<meta name="date" content="2018-02-21">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand Down
2 changes: 1 addition & 1 deletion doc/help-doc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 16:30:46 EST 2018 -->
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 18:27:45 EST 2018 -->
<title>API Help</title>
<meta name="date" content="2018-02-21">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand Down
2 changes: 1 addition & 1 deletion doc/index-files/index-1.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 16:30:46 EST 2018 -->
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 18:27:45 EST 2018 -->
<title>A-Index</title>
<meta name="date" content="2018-02-21">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
Expand Down
2 changes: 1 addition & 1 deletion doc/index-files/index-10.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 16:30:46 EST 2018 -->
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 18:27:45 EST 2018 -->
<title>O-Index</title>
<meta name="date" content="2018-02-21">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
Expand Down
26 changes: 18 additions & 8 deletions doc/index-files/index-11.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 16:30:46 EST 2018 -->
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 18:27:45 EST 2018 -->
<title>P-Index</title>
<meta name="date" content="2018-02-21">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
Expand Down Expand Up @@ -99,24 +99,34 @@ <h2 class="title">P</h2>
</dd>
<dt><a href="../org/usfirst/frc/team1100/robot/commands/pneumaticclimber/PneumaticClimb.html" title="class in org.usfirst.frc.team1100.robot.commands.pneumaticclimber"><span class="typeNameLink">PneumaticClimb</span></a> - Class in <a href="../org/usfirst/frc/team1100/robot/commands/pneumaticclimber/package-summary.html">org.usfirst.frc.team1100.robot.commands.pneumaticclimber</a></dt>
<dd>
<div class="block">Makes the Pneumatic Climber climb</div>
<div class="block">This command makes the Pneumatic Climber climb</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team1100/robot/commands/pneumaticclimber/PneumaticClimb.html#PneumaticClimb--">PneumaticClimb()</a></span> - Constructor for class org.usfirst.frc.team1100.robot.commands.pneumaticclimber.<a href="../org/usfirst/frc/team1100/robot/commands/pneumaticclimber/PneumaticClimb.html" title="class in org.usfirst.frc.team1100.robot.commands.pneumaticclimber">PneumaticClimb</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">Uses the pneumatic climber subsystem</div>
</dd>
<dt><a href="../org/usfirst/frc/team1100/robot/subsystems/PneumaticClimber.html" title="class in org.usfirst.frc.team1100.robot.subsystems"><span class="typeNameLink">PneumaticClimber</span></a> - Class in <a href="../org/usfirst/frc/team1100/robot/subsystems/package-summary.html">org.usfirst.frc.team1100.robot.subsystems</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../org/usfirst/frc/team1100/robot/commands/pneumaticclimber/PneumaticLower.html" title="class in org.usfirst.frc.team1100.robot.commands.pneumaticclimber"><span class="typeNameLink">PneumaticLower</span></a> - Class in <a href="../org/usfirst/frc/team1100/robot/commands/pneumaticclimber/package-summary.html">org.usfirst.frc.team1100.robot.commands.pneumaticclimber</a></dt>
<dd>
<div class="block">Makes the Pneumatic Climber lower</div>
<div class="block">This command makes the Pneumatic Climber lower</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team1100/robot/commands/pneumaticclimber/PneumaticLower.html#PneumaticLower--">PneumaticLower()</a></span> - Constructor for class org.usfirst.frc.team1100.robot.commands.pneumaticclimber.<a href="../org/usfirst/frc/team1100/robot/commands/pneumaticclimber/PneumaticLower.html" title="class in org.usfirst.frc.team1100.robot.commands.pneumaticclimber">PneumaticLower</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">Uses the pneumatic climber subsystem</div>
</dd>
<dt><a href="../org/usfirst/frc/team1100/robot/triggers/Proximity.html" title="class in org.usfirst.frc.team1100.robot.triggers"><span class="typeNameLink">Proximity</span></a> - Class in <a href="../org/usfirst/frc/team1100/robot/triggers/package-summary.html">org.usfirst.frc.team1100.robot.triggers</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">This trigger is used to close the claw when this is triggered 'insert meme here'</div>
</dd>
<dt><a href="../org/usfirst/frc/team1100/robot/commands/intake/PullCubeIn.html" title="class in org.usfirst.frc.team1100.robot.commands.intake"><span class="typeNameLink">PullCubeIn</span></a> - Class in <a href="../org/usfirst/frc/team1100/robot/commands/intake/package-summary.html">org.usfirst.frc.team1100.robot.commands.intake</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">This command pulls a cube in via the intake wheels</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team1100/robot/commands/intake/PullCubeIn.html#PullCubeIn-double-">PullCubeIn(double)</a></span> - Constructor for class org.usfirst.frc.team1100.robot.commands.intake.<a href="../org/usfirst/frc/team1100/robot/commands/intake/PullCubeIn.html" title="class in org.usfirst.frc.team1100.robot.commands.intake">PullCubeIn</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">Uses intake subsystem, initializes timer</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">C</a>&nbsp;<a href="index-3.html">D</a>&nbsp;<a href="index-4.html">E</a>&nbsp;<a href="index-5.html">F</a>&nbsp;<a href="index-6.html">G</a>&nbsp;<a href="index-7.html">I</a>&nbsp;<a href="index-8.html">K</a>&nbsp;<a href="index-9.html">L</a>&nbsp;<a href="index-10.html">O</a>&nbsp;<a href="index-11.html">P</a>&nbsp;<a href="index-12.html">R</a>&nbsp;<a href="index-13.html">S</a>&nbsp;<a href="index-14.html">T</a>&nbsp;<a href="index-15.html">U</a>&nbsp;<a href="index-16.html">V</a>&nbsp;<a href="index-17.html">W</a>&nbsp;<a href="index-18.html">X</a>&nbsp;</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
Expand Down
16 changes: 11 additions & 5 deletions doc/index-files/index-12.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 16:30:46 EST 2018 -->
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 18:27:45 EST 2018 -->
<title>R-Index</title>
<meta name="date" content="2018-02-21">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
Expand Down Expand Up @@ -75,9 +75,13 @@
<h2 class="title">R</h2>
<dl>
<dt><a href="../org/usfirst/frc/team1100/robot/commands/wrist/RaiseWrist.html" title="class in org.usfirst.frc.team1100.robot.commands.wrist"><span class="typeNameLink">RaiseWrist</span></a> - Class in <a href="../org/usfirst/frc/team1100/robot/commands/wrist/package-summary.html">org.usfirst.frc.team1100.robot.commands.wrist</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">This command raises the wrist until it hits the limit switch</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team1100/robot/commands/wrist/RaiseWrist.html#RaiseWrist--">RaiseWrist()</a></span> - Constructor for class org.usfirst.frc.team1100.robot.commands.wrist.<a href="../org/usfirst/frc/team1100/robot/commands/wrist/RaiseWrist.html" title="class in org.usfirst.frc.team1100.robot.commands.wrist">RaiseWrist</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">Uses the wrist subsystem</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team1100/robot/subsystems/Limelight.html#readNetworkTable--">readNetworkTable()</a></span> - Method in class org.usfirst.frc.team1100.robot.subsystems.<a href="../org/usfirst/frc/team1100/robot/subsystems/Limelight.html" title="class in org.usfirst.frc.team1100.robot.subsystems">Limelight</a></dt>
<dd>
<div class="block">Reads values from NetworkTable, puts them to SmartDashboard.</div>
Expand All @@ -99,7 +103,9 @@ <h2 class="title">R</h2>
<div class="block">Returns NavX yaw</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team1100/robot/commands/vision/CenterOnCube.html#returnPIDInput--">returnPIDInput()</a></span> - Method in class org.usfirst.frc.team1100.robot.commands.vision.<a href="../org/usfirst/frc/team1100/robot/commands/vision/CenterOnCube.html" title="class in org.usfirst.frc.team1100.robot.commands.vision">CenterOnCube</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">Returns the Y coordinate of the center of the cube</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team1100/robot/commands/wrist/PIDWrist.html#returnPIDInput--">returnPIDInput()</a></span> - Method in class org.usfirst.frc.team1100.robot.commands.wrist.<a href="../org/usfirst/frc/team1100/robot/commands/wrist/PIDWrist.html" title="class in org.usfirst.frc.team1100.robot.commands.wrist">PIDWrist</a></dt>
<dd>
<div class="block">Returns angle of wrist in voltage</div>
Expand Down Expand Up @@ -141,7 +147,7 @@ <h2 class="title">R</h2>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team1100/robot/subsystems/Wrist.html#rotateWrist-double-">rotateWrist(double)</a></span> - Method in class org.usfirst.frc.team1100.robot.subsystems.<a href="../org/usfirst/frc/team1100/robot/subsystems/Wrist.html" title="class in org.usfirst.frc.team1100.robot.subsystems">Wrist</a></dt>
<dd>
<div class="block">Move wrist with the given speed.</div>
<div class="block">Move wrist with the given speed, unless moving past limit switches.</div>
</dd>
<dt><a href="../org/usfirst/frc/team1100/robot/commands/RumbleMeme.html" title="class in org.usfirst.frc.team1100.robot.commands"><span class="typeNameLink">RumbleMeme</span></a> - Class in <a href="../org/usfirst/frc/team1100/robot/commands/package-summary.html">org.usfirst.frc.team1100.robot.commands</a></dt>
<dd>
Expand Down
12 changes: 8 additions & 4 deletions doc/index-files/index-13.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 16:30:46 EST 2018 -->
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 18:27:45 EST 2018 -->
<title>S-Index</title>
<meta name="date" content="2018-02-21">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
Expand Down Expand Up @@ -80,9 +80,13 @@ <h2 class="title">S</h2>
and shot out.</div>
</dd>
<dt><a href="../org/usfirst/frc/team1100/robot/commands/intake/ShootCubeOut.html" title="class in org.usfirst.frc.team1100.robot.commands.intake"><span class="typeNameLink">ShootCubeOut</span></a> - Class in <a href="../org/usfirst/frc/team1100/robot/commands/intake/package-summary.html">org.usfirst.frc.team1100.robot.commands.intake</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team1100/robot/commands/intake/ShootCubeOut.html#ShootCubeOut--">ShootCubeOut()</a></span> - Constructor for class org.usfirst.frc.team1100.robot.commands.intake.<a href="../org/usfirst/frc/team1100/robot/commands/intake/ShootCubeOut.html" title="class in org.usfirst.frc.team1100.robot.commands.intake">ShootCubeOut</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">This command shoots out a cube via the intake wheels</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team1100/robot/commands/intake/ShootCubeOut.html#ShootCubeOut-double-">ShootCubeOut(double)</a></span> - Constructor for class org.usfirst.frc.team1100.robot.commands.intake.<a href="../org/usfirst/frc/team1100/robot/commands/intake/ShootCubeOut.html" title="class in org.usfirst.frc.team1100.robot.commands.intake">ShootCubeOut</a></dt>
<dd>
<div class="block">Uses intake subsystem, sets up timer</div>
</dd>
<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team1100/robot/subsystems/Intake.html#spinWheels--">spinWheels()</a></span> - Method in class org.usfirst.frc.team1100.robot.subsystems.<a href="../org/usfirst/frc/team1100/robot/subsystems/Intake.html" title="class in org.usfirst.frc.team1100.robot.subsystems">Intake</a></dt>
<dd>
<div class="block">This function sets claw motors to pull a cube into
Expand Down
2 changes: 1 addition & 1 deletion doc/index-files/index-14.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 16:30:46 EST 2018 -->
<!-- Generated by javadoc (1.8.0_101) on Wed Feb 21 18:27:45 EST 2018 -->
<title>T-Index</title>
<meta name="date" content="2018-02-21">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
Expand Down

0 comments on commit 1e2e527

Please sign in to comment.