Make docs more verbose

FRC3494 · Feb 12, 2017 · c50c4d4 · c50c4d4
1 parent 5ed919c
commit c50c4d4
Show file tree

Hide file tree

Showing 80 changed files with 1,462 additions and 332 deletions.
diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_111) on Sat Feb 11 21:25:07 EST 2017 -->
+<!-- Generated by javadoc (1.8.0_111) on Sat Feb 11 21:26:36 EST 2017 -->
 <title>All Classes</title>
 <meta name="date" content="2017-02-11">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_111) on Sat Feb 11 21:25:07 EST 2017 -->
+<!-- Generated by javadoc (1.8.0_111) on Sat Feb 11 21:26:36 EST 2017 -->
 <title>All Classes</title>
 <meta name="date" content="2017-02-11">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/constant-values.html b/docs/constant-values.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_111) on Sat Feb 11 21:25:07 EST 2017 -->
+<!-- Generated by javadoc (1.8.0_111) on Sat Feb 11 21:26:36 EST 2017 -->
 <title>Constant Field Values</title>
 <meta name="date" content="2017-02-11">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/deprecated-list.html b/docs/deprecated-list.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_111) on Sat Feb 11 21:25:07 EST 2017 -->
+<!-- Generated by javadoc (1.8.0_111) on Sat Feb 11 21:26:36 EST 2017 -->
 <title>Deprecated List</title>
 <meta name="date" content="2017-02-11">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/help-doc.html b/docs/help-doc.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_111) on Sat Feb 11 21:25:08 EST 2017 -->
+<!-- Generated by javadoc (1.8.0_111) on Sat Feb 11 21:26:36 EST 2017 -->
 <title>API Help</title>
 <meta name="date" content="2017-02-11">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/docs/index-files/index-1.html b/docs/index-files/index-1.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_111) on Sat Feb 11 21:25:07 EST 2017 -->
+<!-- Generated by javadoc (1.8.0_111) on Sat Feb 11 21:26:36 EST 2017 -->
 <title>A-Index</title>
 <meta name="date" content="2017-02-11">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -69,7 +69,7 @@
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
-<div class="contentContainer"><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">G</a>&nbsp;<a href="index-6.html">I</a>&nbsp;<a href="index-7.html">L</a>&nbsp;<a href="index-8.html">O</a>&nbsp;<a href="index-9.html">P</a>&nbsp;<a href="index-10.html">R</a>&nbsp;<a href="index-11.html">S</a>&nbsp;<a href="index-12.html">T</a>&nbsp;<a href="index-13.html">U</a>&nbsp;<a href="index-14.html">V</a>&nbsp;<a href="index-15.html">W</a>&nbsp;<a href="index-16.html">X</a>&nbsp;<a name="I:A">
+<div class="contentContainer"><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">G</a>&nbsp;<a href="index-6.html">I</a>&nbsp;<a href="index-7.html">L</a>&nbsp;<a href="index-8.html">M</a>&nbsp;<a href="index-9.html">O</a>&nbsp;<a href="index-10.html">P</a>&nbsp;<a href="index-11.html">R</a>&nbsp;<a href="index-12.html">S</a>&nbsp;<a href="index-13.html">T</a>&nbsp;<a href="index-14.html">U</a>&nbsp;<a href="index-15.html">V</a>&nbsp;<a href="index-16.html">W</a>&nbsp;<a href="index-17.html">X</a>&nbsp;<a name="I:A">
 <!--   -->
 </a>
 <h2 class="title">A</h2>
@@ -78,6 +78,8 @@ <h2 class="title">A</h2>
 <dd>
 <div class="block">Drives the drivetrain, with the value passed in for left inverted.</div>
 </dd>
+<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team3494/robot/Robot.html#autonomousCommand">autonomousCommand</a></span> - Variable in class org.usfirst.frc.team3494.robot.<a href="../org/usfirst/frc/team3494/robot/Robot.html" title="class in org.usfirst.frc.team3494.robot">Robot</a></dt>
+<dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="../org/usfirst/frc/team3494/robot/Robot.html#autonomousInit--">autonomousInit()</a></span> - Method in class org.usfirst.frc.team3494.robot.<a href="../org/usfirst/frc/team3494/robot/Robot.html" title="class in org.usfirst.frc.team3494.robot">Robot</a></dt>
 <dd>
 <div class="block">This autonomous (along with the chooser code above) shows how to select
@@ -88,7 +90,7 @@ <h2 class="title">A</h2>
 <div class="block">This function is called periodically during autonomous</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">G</a>&nbsp;<a href="index-6.html">I</a>&nbsp;<a href="index-7.html">L</a>&nbsp;<a href="index-8.html">O</a>&nbsp;<a href="index-9.html">P</a>&nbsp;<a href="index-10.html">R</a>&nbsp;<a href="index-11.html">S</a>&nbsp;<a href="index-12.html">T</a>&nbsp;<a href="index-13.html">U</a>&nbsp;<a href="index-14.html">V</a>&nbsp;<a href="index-15.html">W</a>&nbsp;<a href="index-16.html">X</a>&nbsp;</div>
+<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">G</a>&nbsp;<a href="index-6.html">I</a>&nbsp;<a href="index-7.html">L</a>&nbsp;<a href="index-8.html">M</a>&nbsp;<a href="index-9.html">O</a>&nbsp;<a href="index-10.html">P</a>&nbsp;<a href="index-11.html">R</a>&nbsp;<a href="index-12.html">S</a>&nbsp;<a href="index-13.html">T</a>&nbsp;<a href="index-14.html">U</a>&nbsp;<a href="index-15.html">V</a>&nbsp;<a href="index-16.html">W</a>&nbsp;<a href="index-17.html">X</a>&nbsp;</div>
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">
 <!--   -->

diff --git a/docs/index-files/index-10.html b/docs/index-files/index-10.html
@@ -2,8 +2,8 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_111) on Sat Feb 11 21:25:07 EST 2017 -->
-<title>R-Index</title>
+<!-- Generated by javadoc (1.8.0_111) on Sat Feb 11 21:26:36 EST 2017 -->
+<title>P-Index</title>
 <meta name="date" content="2017-02-11">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 <script type="text/javascript" src="../script.js"></script>
@@ -12,7 +12,7 @@
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="R-Index";
+            parent.document.title="P-Index";
         }
     }
     catch(err) {
@@ -69,47 +69,15 @@
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
-<div class="contentContainer"><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">G</a>&nbsp;<a href="index-6.html">I</a>&nbsp;<a href="index-7.html">L</a>&nbsp;<a href="index-8.html">O</a>&nbsp;<a href="index-9.html">P</a>&nbsp;<a href="index-10.html">R</a>&nbsp;<a href="index-11.html">S</a>&nbsp;<a href="index-12.html">T</a>&nbsp;<a href="index-13.html">U</a>&nbsp;<a href="index-14.html">V</a>&nbsp;<a href="index-15.html">W</a>&nbsp;<a href="index-16.html">X</a>&nbsp;<a name="I:R">
+<div class="contentContainer"><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">G</a>&nbsp;<a href="index-6.html">I</a>&nbsp;<a href="index-7.html">L</a>&nbsp;<a href="index-8.html">M</a>&nbsp;<a href="index-9.html">O</a>&nbsp;<a href="index-10.html">P</a>&nbsp;<a href="index-11.html">R</a>&nbsp;<a href="index-12.html">S</a>&nbsp;<a href="index-13.html">T</a>&nbsp;<a href="index-14.html">U</a>&nbsp;<a href="index-15.html">V</a>&nbsp;<a href="index-16.html">W</a>&nbsp;<a href="index-17.html">X</a>&nbsp;<a name="I:P">
 <!--   -->
 </a>
-<h2 class="title">R</h2>
+<h2 class="title">P</h2>
 <dl>
-<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team3494/robot/subsystems/Drivetrain.html#resetRight--">resetRight()</a></span> - Method in class org.usfirst.frc.team3494.robot.subsystems.<a href="../org/usfirst/frc/team3494/robot/subsystems/Drivetrain.html" title="class in org.usfirst.frc.team3494.robot.subsystems">Drivetrain</a></dt>
-<dd>
-<div class="block">Resets the encoder on the right side of the drivetrain.</div>
-</dd>
-<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team3494/robot/OI.html#rightStick">rightStick</a></span> - Variable in class org.usfirst.frc.team3494.robot.<a href="../org/usfirst/frc/team3494/robot/OI.html" title="class in org.usfirst.frc.team3494.robot">OI</a></dt>
-<dd>&nbsp;</dd>
-<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team3494/robot/RobotMap.html#rightTalonOne">rightTalonOne</a></span> - Static variable in class org.usfirst.frc.team3494.robot.<a href="../org/usfirst/frc/team3494/robot/RobotMap.html" title="class in org.usfirst.frc.team3494.robot">RobotMap</a></dt>
-<dd>&nbsp;</dd>
-<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team3494/robot/RobotMap.html#rightTalonThree">rightTalonThree</a></span> - Static variable in class org.usfirst.frc.team3494.robot.<a href="../org/usfirst/frc/team3494/robot/RobotMap.html" title="class in org.usfirst.frc.team3494.robot">RobotMap</a></dt>
-<dd>&nbsp;</dd>
-<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team3494/robot/RobotMap.html#rightTalonTwo">rightTalonTwo</a></span> - Static variable in class org.usfirst.frc.team3494.robot.<a href="../org/usfirst/frc/team3494/robot/RobotMap.html" title="class in org.usfirst.frc.team3494.robot">RobotMap</a></dt>
-<dd>&nbsp;</dd>
-<dt><a href="../org/usfirst/frc/team3494/robot/Robot.html" title="class in org.usfirst.frc.team3494.robot"><span class="typeNameLink">Robot</span></a> - Class in <a href="../org/usfirst/frc/team3494/robot/package-summary.html">org.usfirst.frc.team3494.robot</a></dt>
-<dd>
-<div class="block">The VM is configured to automatically run this class, and to call the
- functions corresponding to each mode, as described in the IterativeRobot
- documentation.</div>
-</dd>
-<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team3494/robot/Robot.html#Robot--">Robot()</a></span> - Constructor for class org.usfirst.frc.team3494.robot.<a href="../org/usfirst/frc/team3494/robot/Robot.html" title="class in org.usfirst.frc.team3494.robot">Robot</a></dt>
-<dd>&nbsp;</dd>
-<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team3494/robot/Robot.html#robotInit--">robotInit()</a></span> - Method in class org.usfirst.frc.team3494.robot.<a href="../org/usfirst/frc/team3494/robot/Robot.html" title="class in org.usfirst.frc.team3494.robot">Robot</a></dt>
-<dd>
-<div class="block">This function is run when the robot is first started up and should be
- used for any initialization code.</div>
-</dd>
-<dt><a href="../org/usfirst/frc/team3494/robot/RobotMap.html" title="class in org.usfirst.frc.team3494.robot"><span class="typeNameLink">RobotMap</span></a> - Class in <a href="../org/usfirst/frc/team3494/robot/package-summary.html">org.usfirst.frc.team3494.robot</a></dt>
-<dd>
-<div class="block">The RobotMap is a mapping from the ports sensors and actuators are wired into
- to a variable name.</div>
-</dd>
-<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team3494/robot/RobotMap.html#RobotMap--">RobotMap()</a></span> - Constructor for class org.usfirst.frc.team3494.robot.<a href="../org/usfirst/frc/team3494/robot/RobotMap.html" title="class in org.usfirst.frc.team3494.robot">RobotMap</a></dt>
-<dd>&nbsp;</dd>
-<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team3494/robot/subsystems/Intake.html#runIntake-double-">runIntake(double)</a></span> - Method in class org.usfirst.frc.team3494.robot.subsystems.<a href="../org/usfirst/frc/team3494/robot/subsystems/Intake.html" title="class in org.usfirst.frc.team3494.robot.subsystems">Intake</a></dt>
+<dt><span class="memberNameLink"><a href="../org/usfirst/frc/team3494/robot/Robot.html#prefs">prefs</a></span> - Static variable in class org.usfirst.frc.team3494.robot.<a href="../org/usfirst/frc/team3494/robot/Robot.html" title="class in org.usfirst.frc.team3494.robot">Robot</a></dt>
 <dd>&nbsp;</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">G</a>&nbsp;<a href="index-6.html">I</a>&nbsp;<a href="index-7.html">L</a>&nbsp;<a href="index-8.html">O</a>&nbsp;<a href="index-9.html">P</a>&nbsp;<a href="index-10.html">R</a>&nbsp;<a href="index-11.html">S</a>&nbsp;<a href="index-12.html">T</a>&nbsp;<a href="index-13.html">U</a>&nbsp;<a href="index-14.html">V</a>&nbsp;<a href="index-15.html">W</a>&nbsp;<a href="index-16.html">X</a>&nbsp;</div>
+<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">G</a>&nbsp;<a href="index-6.html">I</a>&nbsp;<a href="index-7.html">L</a>&nbsp;<a href="index-8.html">M</a>&nbsp;<a href="index-9.html">O</a>&nbsp;<a href="index-10.html">P</a>&nbsp;<a href="index-11.html">R</a>&nbsp;<a href="index-12.html">S</a>&nbsp;<a href="index-13.html">T</a>&nbsp;<a href="index-14.html">U</a>&nbsp;<a href="index-15.html">V</a>&nbsp;<a href="index-16.html">W</a>&nbsp;<a href="index-17.html">X</a>&nbsp;</div>
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">
 <!--   -->