From c50c4d49a907b865cec4e4c96bc47b74aed445c0 Mon Sep 17 00:00:00 2001 From: Edwan Vi Date: Sat, 11 Feb 2017 21:27:04 -0500 Subject: [PATCH] Make docs more verbose --- docs/allclasses-frame.html | 2 +- docs/allclasses-noframe.html | 2 +- docs/constant-values.html | 2 +- docs/deprecated-list.html | 2 +- docs/help-doc.html | 2 +- docs/index-files/index-1.html | 8 +- docs/index-files/index-10.html | 46 +---- docs/index-files/index-11.html | 51 ++--- docs/index-files/index-12.html | 63 ++++--- docs/index-files/index-13.html | 56 +++++- docs/index-files/index-14.html | 43 ++--- docs/index-files/index-15.html | 39 +++- docs/index-files/index-16.html | 24 +-- docs/index-files/index-17.html | 131 +++++++++++++ docs/index-files/index-2.html | 8 +- docs/index-files/index-3.html | 38 +++- docs/index-files/index-4.html | 24 ++- docs/index-files/index-5.html | 6 +- docs/index-files/index-6.html | 34 +++- docs/index-files/index-7.html | 6 +- docs/index-files/index-8.html | 37 +--- docs/index-files/index-9.html | 37 +++- docs/index.html | 2 +- .../frc/team3494/robot/DriveDirections.html | 4 +- docs/org/usfirst/frc/team3494/robot/OI.html | 4 +- .../org/usfirst/frc/team3494/robot/Robot.html | 32 +++- .../usfirst/frc/team3494/robot/RobotMap.html | 4 +- .../usfirst/frc/team3494/robot/UnitTypes.html | 4 +- .../robot/class-use/DriveDirections.html | 17 +- .../frc/team3494/robot/class-use/OI.html | 2 +- .../frc/team3494/robot/class-use/Robot.html | 2 +- .../team3494/robot/class-use/RobotMap.html | 2 +- .../team3494/robot/class-use/UnitTypes.html | 15 +- .../robot/commands/auto/DistanceDrive.html | 177 ++++++++++++++++-- .../auto/class-use/DistanceDrive.html | 2 +- .../robot/commands/auto/package-frame.html | 2 +- .../robot/commands/auto/package-summary.html | 2 +- .../robot/commands/auto/package-tree.html | 2 +- .../robot/commands/auto/package-use.html | 2 +- .../team3494/robot/commands/climb/Climb.html | 167 +++++++++++++++-- .../robot/commands/climb/StopClimber.html | 120 +++++++++++- .../robot/commands/climb/class-use/Climb.html | 2 +- .../commands/climb/class-use/StopClimber.html | 2 +- .../robot/commands/climb/package-frame.html | 2 +- .../robot/commands/climb/package-summary.html | 2 +- .../robot/commands/climb/package-tree.html | 2 +- .../robot/commands/climb/package-use.html | 2 +- .../team3494/robot/commands/drive/Drive.html | 120 +++++++++++- .../robot/commands/drive/class-use/Drive.html | 2 +- .../robot/commands/drive/package-frame.html | 2 +- .../robot/commands/drive/package-summary.html | 2 +- .../robot/commands/drive/package-tree.html | 2 +- .../robot/commands/drive/package-use.html | 2 +- .../robot/commands/package-frame.html | 2 +- .../robot/commands/package-summary.html | 2 +- .../team3494/robot/commands/package-tree.html | 2 +- .../team3494/robot/commands/package-use.html | 2 +- .../frc/team3494/robot/package-frame.html | 2 +- .../frc/team3494/robot/package-summary.html | 2 +- .../frc/team3494/robot/package-tree.html | 2 +- .../frc/team3494/robot/package-use.html | 2 +- .../team3494/robot/subsystems/Climber.html | 50 ++++- .../team3494/robot/subsystems/Drivetrain.html | 143 +++++++++++++- .../robot/subsystems/IMotorizedSubsystem.html | 2 +- .../frc/team3494/robot/subsystems/Intake.html | 57 +++++- .../frc/team3494/robot/subsystems/Turret.html | 131 ++++++++++++- .../robot/subsystems/TurretEncoders.html | 4 +- .../robot/subsystems/class-use/Climber.html | 2 +- .../subsystems/class-use/Drivetrain.html | 2 +- .../class-use/IMotorizedSubsystem.html | 2 +- .../robot/subsystems/class-use/Intake.html | 2 +- .../robot/subsystems/class-use/Turret.html | 2 +- .../subsystems/class-use/TurretEncoders.html | 2 +- .../robot/subsystems/package-frame.html | 2 +- .../robot/subsystems/package-summary.html | 2 +- .../robot/subsystems/package-tree.html | 2 +- .../robot/subsystems/package-use.html | 2 +- docs/overview-frame.html | 2 +- docs/overview-summary.html | 2 +- docs/overview-tree.html | 2 +- 80 files changed, 1462 insertions(+), 332 deletions(-) create mode 100644 docs/index-files/index-17.html diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html index 6f7c2e1..f46fcb7 100644 --- a/docs/allclasses-frame.html +++ b/docs/allclasses-frame.html @@ -2,7 +2,7 @@ - + All Classes diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html index f642d12..dc18cba 100644 --- a/docs/allclasses-noframe.html +++ b/docs/allclasses-noframe.html @@ -2,7 +2,7 @@ - + All Classes diff --git a/docs/constant-values.html b/docs/constant-values.html index 24e80a6..d2674a1 100644 --- a/docs/constant-values.html +++ b/docs/constant-values.html @@ -2,7 +2,7 @@ - + Constant Field Values diff --git a/docs/deprecated-list.html b/docs/deprecated-list.html index d696dd5..5094839 100644 --- a/docs/deprecated-list.html +++ b/docs/deprecated-list.html @@ -2,7 +2,7 @@ - + Deprecated List diff --git a/docs/help-doc.html b/docs/help-doc.html index ed02942..4dcd00c 100644 --- a/docs/help-doc.html +++ b/docs/help-doc.html @@ -2,7 +2,7 @@ - + API Help diff --git a/docs/index-files/index-1.html b/docs/index-files/index-1.html index cc1d755..b368f7c 100644 --- a/docs/index-files/index-1.html +++ b/docs/index-files/index-1.html @@ -2,7 +2,7 @@ - + A-Index @@ -69,7 +69,7 @@ -
A C D E G I L O P R S T U V W X  +
A C D E G I L M O P R S T U V W X 

A

@@ -78,6 +78,8 @@

A

Drives the drivetrain, with the value passed in for left inverted.
+
autonomousCommand - Variable in class org.usfirst.frc.team3494.robot.Robot
+
 
autonomousInit() - Method in class org.usfirst.frc.team3494.robot.Robot
This autonomous (along with the chooser code above) shows how to select @@ -88,7 +90,7 @@

A

This function is called periodically during autonomous
-A C D E G I L O P R S T U V W X 
+A C D E G I L M O P R S T U V W X 
diff --git a/docs/index-files/index-10.html b/docs/index-files/index-10.html index d1f5315..22f9b3b 100644 --- a/docs/index-files/index-10.html +++ b/docs/index-files/index-10.html @@ -2,8 +2,8 @@ - -R-Index + +P-Index @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D E G I L M O P R S T U V W X  + + +

X

+
+
xbox - Variable in class org.usfirst.frc.team3494.robot.OI
+
 
+
xbox_a - Variable in class org.usfirst.frc.team3494.robot.OI
+
 
+
+A C D E G I L M O P R S T U V W X 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/index-files/index-2.html b/docs/index-files/index-2.html index b5792ff..da5f0be 100644 --- a/docs/index-files/index-2.html +++ b/docs/index-files/index-2.html @@ -2,7 +2,7 @@ - + C-Index @@ -69,11 +69,13 @@
-
A C D E G I L O P R S T U V W X  +
A C D E G I L M O P R S T U V W X 

C

+
chooser - Variable in class org.usfirst.frc.team3494.robot.Robot
+
 
Climb - Class in org.usfirst.frc.team3494.robot.commands.climb
Command for climbing.
@@ -97,7 +99,7 @@

C

CLIMBER_MOTOR - Static variable in class org.usfirst.frc.team3494.robot.RobotMap
 
-A C D E G I L O P R S T U V W X 
+A C D E G I L M O P R S T U V W X 
diff --git a/docs/index-files/index-3.html b/docs/index-files/index-3.html index a5af6e6..abc212b 100644 --- a/docs/index-files/index-3.html +++ b/docs/index-files/index-3.html @@ -2,7 +2,7 @@ - + D-Index @@ -69,17 +69,23 @@
-
A C D E G I L O P R S T U V W X  +
A C D E G I L M O P R S T U V W X 

D

+
direction - Variable in class org.usfirst.frc.team3494.robot.commands.climb.Climb
+
+
The direction to climb in.
+
disabledInit() - Method in class org.usfirst.frc.team3494.robot.Robot
This function is called once each time the robot enters Disabled mode.
disabledPeriodic() - Method in class org.usfirst.frc.team3494.robot.Robot
 
+
dist - Variable in class org.usfirst.frc.team3494.robot.commands.auto.DistanceDrive
+
 
DistanceDrive - Class in org.usfirst.frc.team3494.robot.commands.auto
Drives a given distance.
@@ -100,6 +106,32 @@

D

Enum of directions to drive in.
+
DriveDirections() - Constructor for enum org.usfirst.frc.team3494.robot.DriveDirections
+
 
+
driveLeftFollower_One - Variable in class org.usfirst.frc.team3494.robot.subsystems.Drivetrain
+
+
Follower talon on left side.
+
+
driveLeftFollower_Two - Variable in class org.usfirst.frc.team3494.robot.subsystems.Drivetrain
+
+
Follower talon on left side.
+
+
driveLeftMaster - Variable in class org.usfirst.frc.team3494.robot.subsystems.Drivetrain
+
+
Master drive talon, left side.
+
+
driveRightFollower_One - Variable in class org.usfirst.frc.team3494.robot.subsystems.Drivetrain
+
+
Follower talon on right side.
+
+
driveRightFollower_Two - Variable in class org.usfirst.frc.team3494.robot.subsystems.Drivetrain
+
+
Follower talon on right side.
+
+
driveRightMaster - Variable in class org.usfirst.frc.team3494.robot.subsystems.Drivetrain
+
+
Master drive talon, right side.
+
driveTrain - Static variable in class org.usfirst.frc.team3494.robot.Robot
 
Drivetrain - Class in org.usfirst.frc.team3494.robot.subsystems
@@ -109,7 +141,7 @@

D

Drivetrain() - Constructor for class org.usfirst.frc.team3494.robot.subsystems.Drivetrain
 
-A C D E G I L O P R S T U V W X 
+A C D E G I L M O P R S T U V W X 
diff --git a/docs/index-files/index-4.html b/docs/index-files/index-4.html index 04dce7a..8a38df5 100644 --- a/docs/index-files/index-4.html +++ b/docs/index-files/index-4.html @@ -2,7 +2,7 @@ - + E-Index @@ -69,7 +69,7 @@
-
A C D E G I L O P R S T U V W X  +
A C D E G I L M O P R S T U V W X 

E

@@ -78,8 +78,26 @@

E

 
ENCODER_RIGHT_B - Static variable in class org.usfirst.frc.team3494.robot.RobotMap
 
+
encRight - Variable in class org.usfirst.frc.team3494.robot.subsystems.Drivetrain
+
 
+
end() - Method in class org.usfirst.frc.team3494.robot.commands.auto.DistanceDrive
+
 
+
end() - Method in class org.usfirst.frc.team3494.robot.commands.climb.Climb
+
 
+
end() - Method in class org.usfirst.frc.team3494.robot.commands.climb.StopClimber
+
 
+
end() - Method in class org.usfirst.frc.team3494.robot.commands.drive.Drive
+
 
+
execute() - Method in class org.usfirst.frc.team3494.robot.commands.auto.DistanceDrive
+
 
+
execute() - Method in class org.usfirst.frc.team3494.robot.commands.climb.Climb
+
 
+
execute() - Method in class org.usfirst.frc.team3494.robot.commands.climb.StopClimber
+
 
+
execute() - Method in class org.usfirst.frc.team3494.robot.commands.drive.Drive
+
 
-A C D E G I L O P R S T U V W X 
+A C D E G I L M O P R S T U V W X 
diff --git a/docs/index-files/index-5.html b/docs/index-files/index-5.html index be5b1dd..56533f7 100644 --- a/docs/index-files/index-5.html +++ b/docs/index-files/index-5.html @@ -2,7 +2,7 @@ - + G-Index @@ -69,7 +69,7 @@
-
A C D E G I L O P R S T U V W X  +
A C D E G I L M O P R S T U V W X 

G

@@ -81,7 +81,7 @@

G

Gets the distance the right encoder has counted in the specified unit.
-A C D E G I L O P R S T U V W X 
+A C D E G I L M O P R S T U V W X 
diff --git a/docs/index-files/index-6.html b/docs/index-files/index-6.html index f12cd31..7511617 100644 --- a/docs/index-files/index-6.html +++ b/docs/index-files/index-6.html @@ -2,7 +2,7 @@ - + I-Index @@ -69,7 +69,7 @@
-
A C D E G I L O P R S T U V W X  +
A C D E G I L M O P R S T U V W X 

I

@@ -86,6 +86,18 @@

I

 
initDefaultCommand() - Method in class org.usfirst.frc.team3494.robot.subsystems.Turret
 
+
initialize() - Method in class org.usfirst.frc.team3494.robot.commands.auto.DistanceDrive
+
 
+
initialize() - Method in class org.usfirst.frc.team3494.robot.commands.climb.Climb
+
 
+
initialize() - Method in class org.usfirst.frc.team3494.robot.commands.climb.StopClimber
+
 
+
initialize() - Method in class org.usfirst.frc.team3494.robot.commands.drive.Drive
+
 
+
inMotor - Variable in class org.usfirst.frc.team3494.robot.subsystems.Intake
+
+
Talon that controls the intake.
+
Intake - Class in org.usfirst.frc.team3494.robot.subsystems
Intake subsystem.
@@ -94,8 +106,24 @@

I

 
INTAKE_MOTOR - Static variable in class org.usfirst.frc.team3494.robot.RobotMap
 
+
interrupted() - Method in class org.usfirst.frc.team3494.robot.commands.auto.DistanceDrive
+
 
+
interrupted() - Method in class org.usfirst.frc.team3494.robot.commands.climb.Climb
+
 
+
interrupted() - Method in class org.usfirst.frc.team3494.robot.commands.climb.StopClimber
+
 
+
interrupted() - Method in class org.usfirst.frc.team3494.robot.commands.drive.Drive
+
 
+
isFinished() - Method in class org.usfirst.frc.team3494.robot.commands.auto.DistanceDrive
+
 
+
isFinished() - Method in class org.usfirst.frc.team3494.robot.commands.climb.Climb
+
 
+
isFinished() - Method in class org.usfirst.frc.team3494.robot.commands.climb.StopClimber
+
 
+
isFinished() - Method in class org.usfirst.frc.team3494.robot.commands.drive.Drive
+
 
-A C D E G I L O P R S T U V W X 
+A C D E G I L M O P R S T U V W X 
diff --git a/docs/index-files/index-7.html b/docs/index-files/index-7.html index 419a174..04ef128 100644 --- a/docs/index-files/index-7.html +++ b/docs/index-files/index-7.html @@ -2,7 +2,7 @@ - + L-Index @@ -69,7 +69,7 @@
-
A C D E G I L O P R S T U V W X  +
A C D E G I L M O P R S T U V W X 

L

@@ -83,7 +83,7 @@

L

leftTalonTwo - Static variable in class org.usfirst.frc.team3494.robot.RobotMap
 
-A C D E G I L O P R S T U V W X 
+A C D E G I L M O P R S T U V W X 
diff --git a/docs/index-files/index-8.html b/docs/index-files/index-8.html index 2bf9b8b..1a76a5f 100644 --- a/docs/index-files/index-8.html +++ b/docs/index-files/index-8.html @@ -2,8 +2,8 @@ - -O-Index + +M-Index @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@
@@ -121,6 +127,29 @@

Class DistanceDrive

@@ -237,15 +392,15 @@

DistanceDrive

diff --git a/docs/org/usfirst/frc/team3494/robot/commands/auto/class-use/DistanceDrive.html b/docs/org/usfirst/frc/team3494/robot/commands/auto/class-use/DistanceDrive.html index 84cedae..2400762 100644 --- a/docs/org/usfirst/frc/team3494/robot/commands/auto/class-use/DistanceDrive.html +++ b/docs/org/usfirst/frc/team3494/robot/commands/auto/class-use/DistanceDrive.html @@ -2,7 +2,7 @@ - + Uses of Class org.usfirst.frc.team3494.robot.commands.auto.DistanceDrive diff --git a/docs/org/usfirst/frc/team3494/robot/commands/auto/package-frame.html b/docs/org/usfirst/frc/team3494/robot/commands/auto/package-frame.html index 1874018..2943cdb 100644 --- a/docs/org/usfirst/frc/team3494/robot/commands/auto/package-frame.html +++ b/docs/org/usfirst/frc/team3494/robot/commands/auto/package-frame.html @@ -2,7 +2,7 @@ - + org.usfirst.frc.team3494.robot.commands.auto diff --git a/docs/org/usfirst/frc/team3494/robot/commands/auto/package-summary.html b/docs/org/usfirst/frc/team3494/robot/commands/auto/package-summary.html index 27e0005..0f1dd97 100644 --- a/docs/org/usfirst/frc/team3494/robot/commands/auto/package-summary.html +++ b/docs/org/usfirst/frc/team3494/robot/commands/auto/package-summary.html @@ -2,7 +2,7 @@ - + org.usfirst.frc.team3494.robot.commands.auto diff --git a/docs/org/usfirst/frc/team3494/robot/commands/auto/package-tree.html b/docs/org/usfirst/frc/team3494/robot/commands/auto/package-tree.html index 826b158..c650a59 100644 --- a/docs/org/usfirst/frc/team3494/robot/commands/auto/package-tree.html +++ b/docs/org/usfirst/frc/team3494/robot/commands/auto/package-tree.html @@ -2,7 +2,7 @@ - + org.usfirst.frc.team3494.robot.commands.auto Class Hierarchy diff --git a/docs/org/usfirst/frc/team3494/robot/commands/auto/package-use.html b/docs/org/usfirst/frc/team3494/robot/commands/auto/package-use.html index a1bbb18..6137a56 100644 --- a/docs/org/usfirst/frc/team3494/robot/commands/auto/package-use.html +++ b/docs/org/usfirst/frc/team3494/robot/commands/auto/package-use.html @@ -2,7 +2,7 @@ - + Uses of Package org.usfirst.frc.team3494.robot.commands.auto diff --git a/docs/org/usfirst/frc/team3494/robot/commands/climb/Climb.html b/docs/org/usfirst/frc/team3494/robot/commands/climb/Climb.html index 45aa891..52d34c2 100644 --- a/docs/org/usfirst/frc/team3494/robot/commands/climb/Climb.html +++ b/docs/org/usfirst/frc/team3494/robot/commands/climb/Climb.html @@ -2,7 +2,7 @@ - + Climb @@ -18,6 +18,12 @@ catch(err) { } //--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab";