From 239b782d2a1e8bd5758c24cdbb538ceca9eb3c97 Mon Sep 17 00:00:00 2001 From: thenetworkgrinch Date: Thu, 16 Feb 2023 22:12:57 -0600 Subject: [PATCH] Added documentation for packages --- docs/allclasses-index.html | 2 +- docs/allpackages-index.html | 46 ++++++++++++++----- docs/constant-values.html | 2 +- docs/help-doc.html | 2 +- docs/index-files/index-1.html | 2 +- docs/index-files/index-10.html | 2 +- docs/index-files/index-11.html | 2 +- docs/index-files/index-12.html | 2 +- docs/index-files/index-13.html | 2 +- docs/index-files/index-14.html | 2 +- docs/index-files/index-15.html | 2 +- docs/index-files/index-16.html | 2 +- docs/index-files/index-17.html | 46 ++++++++++++++----- docs/index-files/index-18.html | 2 +- docs/index-files/index-19.html | 2 +- docs/index-files/index-2.html | 2 +- docs/index-files/index-20.html | 2 +- docs/index-files/index-21.html | 2 +- docs/index-files/index-22.html | 2 +- docs/index-files/index-23.html | 2 +- docs/index-files/index-24.html | 2 +- docs/index-files/index-25.html | 2 +- docs/index-files/index-3.html | 2 +- docs/index-files/index-4.html | 2 +- docs/index-files/index-5.html | 2 +- docs/index-files/index-6.html | 2 +- docs/index-files/index-7.html | 2 +- docs/index-files/index-8.html | 2 +- docs/index-files/index-9.html | 2 +- docs/index.html | 46 ++++++++++++++----- docs/overview-summary.html | 2 +- docs/overview-tree.html | 2 +- docs/swervelib/SwerveController.html | 2 +- docs/swervelib/SwerveDrive.html | 2 +- docs/swervelib/SwerveModule.html | 2 +- docs/swervelib/encoders/CANCoderSwerve.html | 2 +- .../encoders/SparkMaxEncoderSwerve.html | 2 +- .../encoders/SwerveAbsoluteEncoder.html | 2 +- docs/swervelib/encoders/package-summary.html | 31 +++++++++---- docs/swervelib/encoders/package-tree.html | 2 +- docs/swervelib/imu/ADIS16448Swerve.html | 2 +- docs/swervelib/imu/ADIS16470Swerve.html | 2 +- docs/swervelib/imu/ADXRS450Swerve.html | 2 +- docs/swervelib/imu/AnalogGyroSwerve.html | 2 +- docs/swervelib/imu/NavXSwerve.html | 2 +- docs/swervelib/imu/Pigeon2Swerve.html | 2 +- docs/swervelib/imu/PigeonSwerve.html | 2 +- docs/swervelib/imu/SwerveIMU.html | 2 +- docs/swervelib/imu/package-summary.html | 31 +++++++++---- docs/swervelib/imu/package-tree.html | 2 +- docs/swervelib/math/SwerveKinematics2.html | 2 +- docs/swervelib/math/SwerveMath.html | 2 +- docs/swervelib/math/SwerveModuleState2.html | 2 +- docs/swervelib/math/package-summary.html | 31 +++++++++---- docs/swervelib/math/package-tree.html | 2 +- .../SparkMaxSwerve.SparkMAX_slotIdx.html | 2 +- docs/swervelib/motors/SparkMaxSwerve.html | 2 +- docs/swervelib/motors/SwerveMotor.html | 2 +- docs/swervelib/motors/TalonFXSwerve.html | 2 +- docs/swervelib/motors/TalonSRXSwerve.html | 2 +- docs/swervelib/motors/package-summary.html | 31 +++++++++---- docs/swervelib/motors/package-tree.html | 2 +- docs/swervelib/package-summary.html | 31 +++++++++---- docs/swervelib/package-tree.html | 2 +- docs/swervelib/parser/PIDFConfig.html | 2 +- .../parser/SwerveControllerConfiguration.html | 2 +- .../parser/SwerveDriveConfiguration.html | 2 +- .../parser/SwerveModuleConfiguration.html | 2 +- .../SwerveModulePhysicalCharacteristics.html | 2 +- docs/swervelib/parser/SwerveParser.html | 2 +- .../parser/deserializer/PIDFRange.html | 2 +- .../parser/deserializer/package-summary.html | 15 ++++-- .../parser/deserializer/package-tree.html | 2 +- .../parser/json/ControllerPropertiesJson.html | 2 +- docs/swervelib/parser/json/DeviceJson.html | 2 +- docs/swervelib/parser/json/ModuleJson.html | 2 +- .../parser/json/MotorConfigDouble.html | 2 +- .../swervelib/parser/json/MotorConfigInt.html | 2 +- .../parser/json/PIDFPropertiesJson.html | 2 +- .../parser/json/PhysicalPropertiesJson.html | 2 +- .../parser/json/SwerveDriveJson.html | 2 +- .../parser/json/modules/BoolMotorJson.html | 2 +- .../parser/json/modules/LocationJson.html | 2 +- .../parser/json/modules/package-summary.html | 11 +++-- .../parser/json/modules/package-tree.html | 2 +- .../parser/json/package-summary.html | 19 ++++++-- docs/swervelib/parser/json/package-tree.html | 2 +- docs/swervelib/parser/package-summary.html | 39 ++++++++++++---- docs/swervelib/parser/package-tree.html | 2 +- .../simulation/SwerveIMUSimulation.html | 2 +- .../simulation/SwerveModuleSimulation.html | 2 +- .../ctre/PhysicsSim.SimProfile.html | 2 +- .../swervelib/simulation/ctre/PhysicsSim.html | 2 +- .../simulation/ctre/TalonFXSimProfile.html | 2 +- .../simulation/ctre/TalonSRXSimProfile.html | 2 +- .../simulation/ctre/VictorSPXSimProfile.html | 2 +- .../simulation/ctre/package-summary.html | 11 +++-- .../simulation/ctre/package-tree.html | 2 +- .../swervelib/simulation/package-summary.html | 35 ++++++++++---- docs/swervelib/simulation/package-tree.html | 2 +- swervelib/encoders/package-info.java | 4 ++ swervelib/imu/package-info.java | 4 ++ swervelib/math/package-info.java | 4 ++ swervelib/motors/package-info.java | 4 ++ swervelib/package-info.java | 6 +++ .../parser/deserializer/package-info.java | 4 ++ .../parser/json/modules/package-info.java | 4 ++ swervelib/parser/json/package-info.java | 4 ++ swervelib/parser/package-info.java | 4 ++ swervelib/simulation/ctre/package-info.java | 4 ++ swervelib/simulation/package-info.java | 4 ++ 111 files changed, 445 insertions(+), 196 deletions(-) create mode 100644 swervelib/encoders/package-info.java create mode 100644 swervelib/imu/package-info.java create mode 100644 swervelib/math/package-info.java create mode 100644 swervelib/motors/package-info.java create mode 100644 swervelib/package-info.java create mode 100644 swervelib/parser/deserializer/package-info.java create mode 100644 swervelib/parser/json/modules/package-info.java create mode 100644 swervelib/parser/json/package-info.java create mode 100644 swervelib/parser/package-info.java create mode 100644 swervelib/simulation/ctre/package-info.java create mode 100644 swervelib/simulation/package-info.java diff --git a/docs/allclasses-index.html b/docs/allclasses-index.html index 7eb0392..5de5447 100644 --- a/docs/allclasses-index.html +++ b/docs/allclasses-index.html @@ -1,7 +1,7 @@ - + All Classes and Interfaces diff --git a/docs/allpackages-index.html b/docs/allpackages-index.html index 052d0ed..4d5ff6a 100644 --- a/docs/allpackages-index.html +++ b/docs/allpackages-index.html @@ -1,7 +1,7 @@ - + All Packages @@ -55,27 +55,49 @@ loadScripts(document, 'script');
Package
Description
swervelib
-
 
+
+
Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.
+
swervelib.encoders
-
 
+
+
Absolute encoders for the swerve drive, all implement SwerveAbsoluteEncoder.
+
swervelib.imu
-
 
+
+
IMUs used for controlling the robot heading.
+
swervelib.math
-
 
+
+
Mathematics for swerve drives.
+
swervelib.motors
-
 
+
+
Swerve motor controller wrappers which implement SwerveMotor.
+
swervelib.parser
-
 
+
+
JSON Parser for YAGSL configurations.
+
swervelib.parser.deserializer
-
 
+
+
Deserialize specific variables for outside the parser.
+
swervelib.parser.json
-
 
+
+
JSON Mapped classes for parsing configuration files.
+
swervelib.parser.json.modules
-
 
+
+
JSON Mapped Configuration types for modules.
+
swervelib.simulation
-
 
+
+
Classes used to simulate the swerve drive.
+
swervelib.simulation.ctre
-
 
+
+
CTRE Physics Simulator.
+
diff --git a/docs/constant-values.html b/docs/constant-values.html index 146feb7..d43e5ea 100644 --- a/docs/constant-values.html +++ b/docs/constant-values.html @@ -1,7 +1,7 @@ - + Constant Field Values diff --git a/docs/help-doc.html b/docs/help-doc.html index 2764136..4d1e899 100644 --- a/docs/help-doc.html +++ b/docs/help-doc.html @@ -1,7 +1,7 @@ - + API Help diff --git a/docs/index-files/index-1.html b/docs/index-files/index-1.html index ba9516d..7ac5c1a 100644 --- a/docs/index-files/index-1.html +++ b/docs/index-files/index-1.html @@ -1,7 +1,7 @@ - + A-Index diff --git a/docs/index-files/index-10.html b/docs/index-files/index-10.html index 6a8be0f..7ddd439 100644 --- a/docs/index-files/index-10.html +++ b/docs/index-files/index-10.html @@ -1,7 +1,7 @@ - + K-Index diff --git a/docs/index-files/index-11.html b/docs/index-files/index-11.html index bec4adb..dd716a9 100644 --- a/docs/index-files/index-11.html +++ b/docs/index-files/index-11.html @@ -1,7 +1,7 @@ - + L-Index diff --git a/docs/index-files/index-12.html b/docs/index-files/index-12.html index 8428893..4818b5a 100644 --- a/docs/index-files/index-12.html +++ b/docs/index-files/index-12.html @@ -1,7 +1,7 @@ - + M-Index diff --git a/docs/index-files/index-13.html b/docs/index-files/index-13.html index 78cf224..8882ff5 100644 --- a/docs/index-files/index-13.html +++ b/docs/index-files/index-13.html @@ -1,7 +1,7 @@ - + N-Index diff --git a/docs/index-files/index-14.html b/docs/index-files/index-14.html index af6e508..32678bb 100644 --- a/docs/index-files/index-14.html +++ b/docs/index-files/index-14.html @@ -1,7 +1,7 @@ - + O-Index diff --git a/docs/index-files/index-15.html b/docs/index-files/index-15.html index 1a43af4..8ada833 100644 --- a/docs/index-files/index-15.html +++ b/docs/index-files/index-15.html @@ -1,7 +1,7 @@ - + P-Index diff --git a/docs/index-files/index-16.html b/docs/index-files/index-16.html index 5fd6671..7fb2027 100644 --- a/docs/index-files/index-16.html +++ b/docs/index-files/index-16.html @@ -1,7 +1,7 @@ - + R-Index diff --git a/docs/index-files/index-17.html b/docs/index-files/index-17.html index e7e48e6..4a727a3 100644 --- a/docs/index-files/index-17.html +++ b/docs/index-files/index-17.html @@ -1,7 +1,7 @@ - + S-Index @@ -400,27 +400,49 @@ loadScripts(document, 'script');
Constructs a swerve drive kinematics object.
swervelib - package swervelib
-
 
+
+
Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.
+
swervelib.encoders - package swervelib.encoders
-
 
+
+
Absolute encoders for the swerve drive, all implement SwerveAbsoluteEncoder.
+
swervelib.imu - package swervelib.imu
-
 
+
+
IMUs used for controlling the robot heading.
+
swervelib.math - package swervelib.math
-
 
+
+
Mathematics for swerve drives.
+
swervelib.motors - package swervelib.motors
-
 
+
+
Swerve motor controller wrappers which implement SwerveMotor.
+
swervelib.parser - package swervelib.parser
-
 
+
+
JSON Parser for YAGSL configurations.
+
swervelib.parser.deserializer - package swervelib.parser.deserializer
-
 
+
+
Deserialize specific variables for outside the parser.
+
swervelib.parser.json - package swervelib.parser.json
-
 
+
+
JSON Mapped classes for parsing configuration files.
+
swervelib.parser.json.modules - package swervelib.parser.json.modules
-
 
+
+
JSON Mapped Configuration types for modules.
+
swervelib.simulation - package swervelib.simulation
-
 
+
+
Classes used to simulate the swerve drive.
+
swervelib.simulation.ctre - package swervelib.simulation.ctre
-
 
+
+
CTRE Physics Simulator.
+
SwerveMath - Class in swervelib.math
Mathematical functions which pertain to swerve drive.
diff --git a/docs/index-files/index-18.html b/docs/index-files/index-18.html index 61b9dc3..d5fb144 100644 --- a/docs/index-files/index-18.html +++ b/docs/index-files/index-18.html @@ -1,7 +1,7 @@ - + T-Index diff --git a/docs/index-files/index-19.html b/docs/index-files/index-19.html index 6825166..383e842 100644 --- a/docs/index-files/index-19.html +++ b/docs/index-files/index-19.html @@ -1,7 +1,7 @@ - + U-Index diff --git a/docs/index-files/index-2.html b/docs/index-files/index-2.html index 4cc81e3..b843066 100644 --- a/docs/index-files/index-2.html +++ b/docs/index-files/index-2.html @@ -1,7 +1,7 @@ - + B-Index diff --git a/docs/index-files/index-20.html b/docs/index-files/index-20.html index 3e7b7be..ebe4eab 100644 --- a/docs/index-files/index-20.html +++ b/docs/index-files/index-20.html @@ -1,7 +1,7 @@ - + V-Index diff --git a/docs/index-files/index-21.html b/docs/index-files/index-21.html index fd1bbfc..029b21a 100644 --- a/docs/index-files/index-21.html +++ b/docs/index-files/index-21.html @@ -1,7 +1,7 @@ - + W-Index diff --git a/docs/index-files/index-22.html b/docs/index-files/index-22.html index d2f8f34..3d479ed 100644 --- a/docs/index-files/index-22.html +++ b/docs/index-files/index-22.html @@ -1,7 +1,7 @@ - + X-Index diff --git a/docs/index-files/index-23.html b/docs/index-files/index-23.html index 39ea980..d01ac40 100644 --- a/docs/index-files/index-23.html +++ b/docs/index-files/index-23.html @@ -1,7 +1,7 @@ - + Y-Index diff --git a/docs/index-files/index-24.html b/docs/index-files/index-24.html index 09a1d43..ee7f205 100644 --- a/docs/index-files/index-24.html +++ b/docs/index-files/index-24.html @@ -1,7 +1,7 @@ - + Z-Index diff --git a/docs/index-files/index-25.html b/docs/index-files/index-25.html index e09eaf4..fc3df3c 100644 --- a/docs/index-files/index-25.html +++ b/docs/index-files/index-25.html @@ -1,7 +1,7 @@ - + _-Index diff --git a/docs/index-files/index-3.html b/docs/index-files/index-3.html index 819eeea..559275c 100644 --- a/docs/index-files/index-3.html +++ b/docs/index-files/index-3.html @@ -1,7 +1,7 @@ - + C-Index diff --git a/docs/index-files/index-4.html b/docs/index-files/index-4.html index f8c7a4c..025536a 100644 --- a/docs/index-files/index-4.html +++ b/docs/index-files/index-4.html @@ -1,7 +1,7 @@ - + D-Index diff --git a/docs/index-files/index-5.html b/docs/index-files/index-5.html index b37cd98..b5170a1 100644 --- a/docs/index-files/index-5.html +++ b/docs/index-files/index-5.html @@ -1,7 +1,7 @@ - + E-Index diff --git a/docs/index-files/index-6.html b/docs/index-files/index-6.html index 054101a..d6ae4ed 100644 --- a/docs/index-files/index-6.html +++ b/docs/index-files/index-6.html @@ -1,7 +1,7 @@ - + F-Index diff --git a/docs/index-files/index-7.html b/docs/index-files/index-7.html index 3e6ec1a..ff81468 100644 --- a/docs/index-files/index-7.html +++ b/docs/index-files/index-7.html @@ -1,7 +1,7 @@ - + G-Index diff --git a/docs/index-files/index-8.html b/docs/index-files/index-8.html index 6793ec3..6b27d40 100644 --- a/docs/index-files/index-8.html +++ b/docs/index-files/index-8.html @@ -1,7 +1,7 @@ - + H-Index diff --git a/docs/index-files/index-9.html b/docs/index-files/index-9.html index 1b01de7..a16ddd7 100644 --- a/docs/index-files/index-9.html +++ b/docs/index-files/index-9.html @@ -1,7 +1,7 @@ - + I-Index diff --git a/docs/index.html b/docs/index.html index 8171e10..f5af07a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,7 +1,7 @@ - + Overview @@ -53,27 +53,49 @@ loadScripts(document, 'script');
Package
Description
swervelib
-
 
+
+
Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.
+
swervelib.encoders
-
 
+
+
Absolute encoders for the swerve drive, all implement SwerveAbsoluteEncoder.
+
swervelib.imu
-
 
+
+
IMUs used for controlling the robot heading.
+
swervelib.math
-
 
+
+
Mathematics for swerve drives.
+
swervelib.motors
-
 
+
+
Swerve motor controller wrappers which implement SwerveMotor.
+
swervelib.parser
-
 
+
+
JSON Parser for YAGSL configurations.
+
swervelib.parser.deserializer
-
 
+
+
Deserialize specific variables for outside the parser.
+
swervelib.parser.json
-
 
+
+
JSON Mapped classes for parsing configuration files.
+
swervelib.parser.json.modules
-
 
+
+
JSON Mapped Configuration types for modules.
+
swervelib.simulation
-
 
+
+
Classes used to simulate the swerve drive.
+
swervelib.simulation.ctre
-
 
+
+
CTRE Physics Simulator.
+
diff --git a/docs/overview-summary.html b/docs/overview-summary.html index 12fa337..cc259d2 100644 --- a/docs/overview-summary.html +++ b/docs/overview-summary.html @@ -1,7 +1,7 @@ - + Generated Documentation (Untitled) diff --git a/docs/overview-tree.html b/docs/overview-tree.html index 25c6ce1..c84a77e 100644 --- a/docs/overview-tree.html +++ b/docs/overview-tree.html @@ -1,7 +1,7 @@ - + Class Hierarchy diff --git a/docs/swervelib/SwerveController.html b/docs/swervelib/SwerveController.html index e53e38e..86a3ee3 100644 --- a/docs/swervelib/SwerveController.html +++ b/docs/swervelib/SwerveController.html @@ -1,7 +1,7 @@ - + SwerveController diff --git a/docs/swervelib/SwerveDrive.html b/docs/swervelib/SwerveDrive.html index 7cfaa57..dd88a71 100644 --- a/docs/swervelib/SwerveDrive.html +++ b/docs/swervelib/SwerveDrive.html @@ -1,7 +1,7 @@ - + SwerveDrive diff --git a/docs/swervelib/SwerveModule.html b/docs/swervelib/SwerveModule.html index e55bdd6..ae720cc 100644 --- a/docs/swervelib/SwerveModule.html +++ b/docs/swervelib/SwerveModule.html @@ -1,7 +1,7 @@ - + SwerveModule diff --git a/docs/swervelib/encoders/CANCoderSwerve.html b/docs/swervelib/encoders/CANCoderSwerve.html index 9edae34..2414cbe 100644 --- a/docs/swervelib/encoders/CANCoderSwerve.html +++ b/docs/swervelib/encoders/CANCoderSwerve.html @@ -1,7 +1,7 @@ - + CANCoderSwerve diff --git a/docs/swervelib/encoders/SparkMaxEncoderSwerve.html b/docs/swervelib/encoders/SparkMaxEncoderSwerve.html index 9b8abbf..030a48c 100644 --- a/docs/swervelib/encoders/SparkMaxEncoderSwerve.html +++ b/docs/swervelib/encoders/SparkMaxEncoderSwerve.html @@ -1,7 +1,7 @@ - + SparkMaxEncoderSwerve diff --git a/docs/swervelib/encoders/SwerveAbsoluteEncoder.html b/docs/swervelib/encoders/SwerveAbsoluteEncoder.html index 6efab52..fd1befc 100644 --- a/docs/swervelib/encoders/SwerveAbsoluteEncoder.html +++ b/docs/swervelib/encoders/SwerveAbsoluteEncoder.html @@ -1,7 +1,7 @@ - + SwerveAbsoluteEncoder diff --git a/docs/swervelib/encoders/package-summary.html b/docs/swervelib/encoders/package-summary.html index a2f7552..e470360 100644 --- a/docs/swervelib/encoders/package-summary.html +++ b/docs/swervelib/encoders/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.encoders @@ -40,7 +40,7 @@ loadScripts(document, 'script');
@@ -60,6 +60,9 @@ loadScripts(document, 'script');
package swervelib.encoders
+
+
Absolute encoders for the swerve drive, all implement SwerveAbsoluteEncoder.
+
  • @@ -69,17 +72,29 @@ loadScripts(document, 'script');
    Package
    Description
    swervelib
    -
     
    +
    +
    Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.
    +
    swervelib.imu
    -
     
    +
    +
    IMUs used for controlling the robot heading.
    +
    swervelib.math
    -
     
    +
    +
    Mathematics for swerve drives.
    +
    swervelib.motors
    -
     
    +
    +
    Swerve motor controller wrappers which implement SwerveMotor.
    +
    swervelib.parser
    -
     
    +
    +
    JSON Parser for YAGSL configurations.
    +
    swervelib.simulation
    -
     
    +
    +
    Classes used to simulate the swerve drive.
    +
    • diff --git a/docs/swervelib/encoders/package-tree.html b/docs/swervelib/encoders/package-tree.html index 286f301..409a9b7 100644 --- a/docs/swervelib/encoders/package-tree.html +++ b/docs/swervelib/encoders/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.encoders Class Hierarchy diff --git a/docs/swervelib/imu/ADIS16448Swerve.html b/docs/swervelib/imu/ADIS16448Swerve.html index e45fc8e..0a351d9 100644 --- a/docs/swervelib/imu/ADIS16448Swerve.html +++ b/docs/swervelib/imu/ADIS16448Swerve.html @@ -1,7 +1,7 @@ - + ADIS16448Swerve diff --git a/docs/swervelib/imu/ADIS16470Swerve.html b/docs/swervelib/imu/ADIS16470Swerve.html index 843d62d..b511640 100644 --- a/docs/swervelib/imu/ADIS16470Swerve.html +++ b/docs/swervelib/imu/ADIS16470Swerve.html @@ -1,7 +1,7 @@ - + ADIS16470Swerve diff --git a/docs/swervelib/imu/ADXRS450Swerve.html b/docs/swervelib/imu/ADXRS450Swerve.html index 29e3896..6222675 100644 --- a/docs/swervelib/imu/ADXRS450Swerve.html +++ b/docs/swervelib/imu/ADXRS450Swerve.html @@ -1,7 +1,7 @@ - + ADXRS450Swerve diff --git a/docs/swervelib/imu/AnalogGyroSwerve.html b/docs/swervelib/imu/AnalogGyroSwerve.html index d434229..1f6f7dd 100644 --- a/docs/swervelib/imu/AnalogGyroSwerve.html +++ b/docs/swervelib/imu/AnalogGyroSwerve.html @@ -1,7 +1,7 @@ - + AnalogGyroSwerve diff --git a/docs/swervelib/imu/NavXSwerve.html b/docs/swervelib/imu/NavXSwerve.html index 3c3b599..1a2c9a6 100644 --- a/docs/swervelib/imu/NavXSwerve.html +++ b/docs/swervelib/imu/NavXSwerve.html @@ -1,7 +1,7 @@ - + NavXSwerve diff --git a/docs/swervelib/imu/Pigeon2Swerve.html b/docs/swervelib/imu/Pigeon2Swerve.html index 3080535..5b64fde 100644 --- a/docs/swervelib/imu/Pigeon2Swerve.html +++ b/docs/swervelib/imu/Pigeon2Swerve.html @@ -1,7 +1,7 @@ - + Pigeon2Swerve diff --git a/docs/swervelib/imu/PigeonSwerve.html b/docs/swervelib/imu/PigeonSwerve.html index 7c67db1..70ddbaa 100644 --- a/docs/swervelib/imu/PigeonSwerve.html +++ b/docs/swervelib/imu/PigeonSwerve.html @@ -1,7 +1,7 @@ - + PigeonSwerve diff --git a/docs/swervelib/imu/SwerveIMU.html b/docs/swervelib/imu/SwerveIMU.html index 1573998..a18472a 100644 --- a/docs/swervelib/imu/SwerveIMU.html +++ b/docs/swervelib/imu/SwerveIMU.html @@ -1,7 +1,7 @@ - + SwerveIMU diff --git a/docs/swervelib/imu/package-summary.html b/docs/swervelib/imu/package-summary.html index 2594783..c135aa7 100644 --- a/docs/swervelib/imu/package-summary.html +++ b/docs/swervelib/imu/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.imu @@ -40,7 +40,7 @@ loadScripts(document, 'script');
    @@ -60,6 +60,9 @@ loadScripts(document, 'script');
    package swervelib.imu
    +
    +
    IMUs used for controlling the robot heading. All implement SwerveIMU.
    +
    • @@ -69,17 +72,29 @@ loadScripts(document, 'script');
      Package
      Description
      swervelib
      -
       
      +
      +
      Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.
      +
      swervelib.encoders
      -
       
      +
      +
      Absolute encoders for the swerve drive, all implement SwerveAbsoluteEncoder.
      +
      swervelib.math
      -
       
      +
      +
      Mathematics for swerve drives.
      +
      swervelib.motors
      -
       
      +
      +
      Swerve motor controller wrappers which implement SwerveMotor.
      +
      swervelib.parser
      -
       
      +
      +
      JSON Parser for YAGSL configurations.
      +
      swervelib.simulation
      -
       
      +
      +
      Classes used to simulate the swerve drive.
      +
      • diff --git a/docs/swervelib/imu/package-tree.html b/docs/swervelib/imu/package-tree.html index 89ae631..38fb8ee 100644 --- a/docs/swervelib/imu/package-tree.html +++ b/docs/swervelib/imu/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.imu Class Hierarchy diff --git a/docs/swervelib/math/SwerveKinematics2.html b/docs/swervelib/math/SwerveKinematics2.html index 96760d7..37656a4 100644 --- a/docs/swervelib/math/SwerveKinematics2.html +++ b/docs/swervelib/math/SwerveKinematics2.html @@ -1,7 +1,7 @@ - + SwerveKinematics2 diff --git a/docs/swervelib/math/SwerveMath.html b/docs/swervelib/math/SwerveMath.html index 028fbe3..bfb7237 100644 --- a/docs/swervelib/math/SwerveMath.html +++ b/docs/swervelib/math/SwerveMath.html @@ -1,7 +1,7 @@ - + SwerveMath diff --git a/docs/swervelib/math/SwerveModuleState2.html b/docs/swervelib/math/SwerveModuleState2.html index a5df587..98d4eca 100644 --- a/docs/swervelib/math/SwerveModuleState2.html +++ b/docs/swervelib/math/SwerveModuleState2.html @@ -1,7 +1,7 @@ - + SwerveModuleState2 diff --git a/docs/swervelib/math/package-summary.html b/docs/swervelib/math/package-summary.html index a170b5d..a3a8bbf 100644 --- a/docs/swervelib/math/package-summary.html +++ b/docs/swervelib/math/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.math @@ -40,7 +40,7 @@ loadScripts(document, 'script');
      @@ -60,6 +60,9 @@ loadScripts(document, 'script');
      package swervelib.math
      +
      +
      Mathematics for swerve drives.
      +
      • @@ -69,17 +72,29 @@ loadScripts(document, 'script');
        Package
        Description
        swervelib
        -
         
        +
        +
        Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.
        +
        swervelib.encoders
        -
         
        +
        +
        Absolute encoders for the swerve drive, all implement SwerveAbsoluteEncoder.
        +
        swervelib.imu
        -
         
        +
        +
        IMUs used for controlling the robot heading.
        +
        swervelib.motors
        -
         
        +
        +
        Swerve motor controller wrappers which implement SwerveMotor.
        +
        swervelib.parser
        -
         
        +
        +
        JSON Parser for YAGSL configurations.
        +
        swervelib.simulation
        -
         
        +
        +
        Classes used to simulate the swerve drive.
        +
        • diff --git a/docs/swervelib/math/package-tree.html b/docs/swervelib/math/package-tree.html index 6491064..7527d96 100644 --- a/docs/swervelib/math/package-tree.html +++ b/docs/swervelib/math/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.math Class Hierarchy diff --git a/docs/swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html b/docs/swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html index 52bcc08..a372a77 100644 --- a/docs/swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html +++ b/docs/swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html @@ -1,7 +1,7 @@ - + SparkMaxSwerve.SparkMAX_slotIdx diff --git a/docs/swervelib/motors/SparkMaxSwerve.html b/docs/swervelib/motors/SparkMaxSwerve.html index e637ad8..142a194 100644 --- a/docs/swervelib/motors/SparkMaxSwerve.html +++ b/docs/swervelib/motors/SparkMaxSwerve.html @@ -1,7 +1,7 @@ - + SparkMaxSwerve diff --git a/docs/swervelib/motors/SwerveMotor.html b/docs/swervelib/motors/SwerveMotor.html index e5440bf..a17f2d7 100644 --- a/docs/swervelib/motors/SwerveMotor.html +++ b/docs/swervelib/motors/SwerveMotor.html @@ -1,7 +1,7 @@ - + SwerveMotor diff --git a/docs/swervelib/motors/TalonFXSwerve.html b/docs/swervelib/motors/TalonFXSwerve.html index aec09f6..39be6d8 100644 --- a/docs/swervelib/motors/TalonFXSwerve.html +++ b/docs/swervelib/motors/TalonFXSwerve.html @@ -1,7 +1,7 @@ - + TalonFXSwerve diff --git a/docs/swervelib/motors/TalonSRXSwerve.html b/docs/swervelib/motors/TalonSRXSwerve.html index 059f59b..c2bc38f 100644 --- a/docs/swervelib/motors/TalonSRXSwerve.html +++ b/docs/swervelib/motors/TalonSRXSwerve.html @@ -1,7 +1,7 @@ - + TalonSRXSwerve diff --git a/docs/swervelib/motors/package-summary.html b/docs/swervelib/motors/package-summary.html index f6f83f6..52e5a4d 100644 --- a/docs/swervelib/motors/package-summary.html +++ b/docs/swervelib/motors/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.motors @@ -44,7 +44,7 @@ loadScripts(document, 'script');
        @@ -64,6 +64,9 @@ loadScripts(document, 'script');
        package swervelib.motors
        +
        +
        Swerve motor controller wrappers which implement SwerveMotor.
        +
        • @@ -73,17 +76,29 @@ loadScripts(document, 'script');
          Package
          Description
          swervelib
          -
           
          +
          +
          Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.
          +
          swervelib.encoders
          -
           
          +
          +
          Absolute encoders for the swerve drive, all implement SwerveAbsoluteEncoder.
          +
          swervelib.imu
          -
           
          +
          +
          IMUs used for controlling the robot heading.
          +
          swervelib.math
          -
           
          +
          +
          Mathematics for swerve drives.
          +
          swervelib.parser
          -
           
          +
          +
          JSON Parser for YAGSL configurations.
          +
          swervelib.simulation
          -
           
          +
          +
          Classes used to simulate the swerve drive.
          +
          • diff --git a/docs/swervelib/motors/package-tree.html b/docs/swervelib/motors/package-tree.html index d56a3bd..f376b77 100644 --- a/docs/swervelib/motors/package-tree.html +++ b/docs/swervelib/motors/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.motors Class Hierarchy diff --git a/docs/swervelib/package-summary.html b/docs/swervelib/package-summary.html index f325bfe..bba9d9f 100644 --- a/docs/swervelib/package-summary.html +++ b/docs/swervelib/package-summary.html @@ -1,7 +1,7 @@ - + swervelib @@ -40,7 +40,7 @@ loadScripts(document, 'script');
          @@ -60,6 +60,9 @@ loadScripts(document, 'script');
          package swervelib
          +
          +
          Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.
          +
          • @@ -69,17 +72,29 @@ loadScripts(document, 'script');
            Package
            Description
            swervelib.encoders
            -
             
            +
            +
            Absolute encoders for the swerve drive, all implement SwerveAbsoluteEncoder.
            +
            swervelib.imu
            -
             
            +
            +
            IMUs used for controlling the robot heading.
            +
            swervelib.math
            -
             
            +
            +
            Mathematics for swerve drives.
            +
            swervelib.motors
            -
             
            +
            +
            Swerve motor controller wrappers which implement SwerveMotor.
            +
            swervelib.parser
            -
             
            +
            +
            JSON Parser for YAGSL configurations.
            +
            swervelib.simulation
            -
             
            +
            +
            Classes used to simulate the swerve drive.
            +
            • diff --git a/docs/swervelib/package-tree.html b/docs/swervelib/package-tree.html index 1f0103b..778c7d8 100644 --- a/docs/swervelib/package-tree.html +++ b/docs/swervelib/package-tree.html @@ -1,7 +1,7 @@ - + swervelib Class Hierarchy diff --git a/docs/swervelib/parser/PIDFConfig.html b/docs/swervelib/parser/PIDFConfig.html index 3f56292..0cda1de 100644 --- a/docs/swervelib/parser/PIDFConfig.html +++ b/docs/swervelib/parser/PIDFConfig.html @@ -1,7 +1,7 @@ - + PIDFConfig diff --git a/docs/swervelib/parser/SwerveControllerConfiguration.html b/docs/swervelib/parser/SwerveControllerConfiguration.html index 20d34c6..7f135f8 100644 --- a/docs/swervelib/parser/SwerveControllerConfiguration.html +++ b/docs/swervelib/parser/SwerveControllerConfiguration.html @@ -1,7 +1,7 @@ - + SwerveControllerConfiguration diff --git a/docs/swervelib/parser/SwerveDriveConfiguration.html b/docs/swervelib/parser/SwerveDriveConfiguration.html index fc01c98..21bc81f 100644 --- a/docs/swervelib/parser/SwerveDriveConfiguration.html +++ b/docs/swervelib/parser/SwerveDriveConfiguration.html @@ -1,7 +1,7 @@ - + SwerveDriveConfiguration diff --git a/docs/swervelib/parser/SwerveModuleConfiguration.html b/docs/swervelib/parser/SwerveModuleConfiguration.html index a898228..8e5e12f 100644 --- a/docs/swervelib/parser/SwerveModuleConfiguration.html +++ b/docs/swervelib/parser/SwerveModuleConfiguration.html @@ -1,7 +1,7 @@ - + SwerveModuleConfiguration diff --git a/docs/swervelib/parser/SwerveModulePhysicalCharacteristics.html b/docs/swervelib/parser/SwerveModulePhysicalCharacteristics.html index efe3a7f..9f76920 100644 --- a/docs/swervelib/parser/SwerveModulePhysicalCharacteristics.html +++ b/docs/swervelib/parser/SwerveModulePhysicalCharacteristics.html @@ -1,7 +1,7 @@ - + SwerveModulePhysicalCharacteristics diff --git a/docs/swervelib/parser/SwerveParser.html b/docs/swervelib/parser/SwerveParser.html index cd1bc55..63eed05 100644 --- a/docs/swervelib/parser/SwerveParser.html +++ b/docs/swervelib/parser/SwerveParser.html @@ -1,7 +1,7 @@ - + SwerveParser diff --git a/docs/swervelib/parser/deserializer/PIDFRange.html b/docs/swervelib/parser/deserializer/PIDFRange.html index abb011b..c769480 100644 --- a/docs/swervelib/parser/deserializer/PIDFRange.html +++ b/docs/swervelib/parser/deserializer/PIDFRange.html @@ -1,7 +1,7 @@ - + PIDFRange diff --git a/docs/swervelib/parser/deserializer/package-summary.html b/docs/swervelib/parser/deserializer/package-summary.html index da449f3..4ffa099 100644 --- a/docs/swervelib/parser/deserializer/package-summary.html +++ b/docs/swervelib/parser/deserializer/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.parser.deserializer @@ -40,7 +40,7 @@ loadScripts(document, 'script');
            @@ -60,6 +60,9 @@ loadScripts(document, 'script');
            package swervelib.parser.deserializer
            +
            +
            Deserialize specific variables for outside the parser.
            +
            • @@ -69,9 +72,13 @@ loadScripts(document, 'script');
              Package
              Description
              swervelib.parser
              -
               
              +
              +
              JSON Parser for YAGSL configurations.
              +
              swervelib.parser.json
              -
               
              +
              +
              JSON Mapped classes for parsing configuration files.
              +
              • diff --git a/docs/swervelib/parser/deserializer/package-tree.html b/docs/swervelib/parser/deserializer/package-tree.html index ebc2817..b4975bb 100644 --- a/docs/swervelib/parser/deserializer/package-tree.html +++ b/docs/swervelib/parser/deserializer/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.parser.deserializer Class Hierarchy diff --git a/docs/swervelib/parser/json/ControllerPropertiesJson.html b/docs/swervelib/parser/json/ControllerPropertiesJson.html index 2056a8d..c8ec6e8 100644 --- a/docs/swervelib/parser/json/ControllerPropertiesJson.html +++ b/docs/swervelib/parser/json/ControllerPropertiesJson.html @@ -1,7 +1,7 @@ - + ControllerPropertiesJson diff --git a/docs/swervelib/parser/json/DeviceJson.html b/docs/swervelib/parser/json/DeviceJson.html index 0ab8897..4cc4ee8 100644 --- a/docs/swervelib/parser/json/DeviceJson.html +++ b/docs/swervelib/parser/json/DeviceJson.html @@ -1,7 +1,7 @@ - + DeviceJson diff --git a/docs/swervelib/parser/json/ModuleJson.html b/docs/swervelib/parser/json/ModuleJson.html index 39fae0e..a6315d9 100644 --- a/docs/swervelib/parser/json/ModuleJson.html +++ b/docs/swervelib/parser/json/ModuleJson.html @@ -1,7 +1,7 @@ - + ModuleJson diff --git a/docs/swervelib/parser/json/MotorConfigDouble.html b/docs/swervelib/parser/json/MotorConfigDouble.html index 0ffac40..a7ff8e1 100644 --- a/docs/swervelib/parser/json/MotorConfigDouble.html +++ b/docs/swervelib/parser/json/MotorConfigDouble.html @@ -1,7 +1,7 @@ - + MotorConfigDouble diff --git a/docs/swervelib/parser/json/MotorConfigInt.html b/docs/swervelib/parser/json/MotorConfigInt.html index 8cb9176..6df3a81 100644 --- a/docs/swervelib/parser/json/MotorConfigInt.html +++ b/docs/swervelib/parser/json/MotorConfigInt.html @@ -1,7 +1,7 @@ - + MotorConfigInt diff --git a/docs/swervelib/parser/json/PIDFPropertiesJson.html b/docs/swervelib/parser/json/PIDFPropertiesJson.html index 6dcbd29..d08119b 100644 --- a/docs/swervelib/parser/json/PIDFPropertiesJson.html +++ b/docs/swervelib/parser/json/PIDFPropertiesJson.html @@ -1,7 +1,7 @@ - + PIDFPropertiesJson diff --git a/docs/swervelib/parser/json/PhysicalPropertiesJson.html b/docs/swervelib/parser/json/PhysicalPropertiesJson.html index f8ff2cb..2d9e2b2 100644 --- a/docs/swervelib/parser/json/PhysicalPropertiesJson.html +++ b/docs/swervelib/parser/json/PhysicalPropertiesJson.html @@ -1,7 +1,7 @@ - + PhysicalPropertiesJson diff --git a/docs/swervelib/parser/json/SwerveDriveJson.html b/docs/swervelib/parser/json/SwerveDriveJson.html index de17179..eb0a8c3 100644 --- a/docs/swervelib/parser/json/SwerveDriveJson.html +++ b/docs/swervelib/parser/json/SwerveDriveJson.html @@ -1,7 +1,7 @@ - + SwerveDriveJson diff --git a/docs/swervelib/parser/json/modules/BoolMotorJson.html b/docs/swervelib/parser/json/modules/BoolMotorJson.html index 05367ae..9c5444c 100644 --- a/docs/swervelib/parser/json/modules/BoolMotorJson.html +++ b/docs/swervelib/parser/json/modules/BoolMotorJson.html @@ -1,7 +1,7 @@ - + BoolMotorJson diff --git a/docs/swervelib/parser/json/modules/LocationJson.html b/docs/swervelib/parser/json/modules/LocationJson.html index 1ce7ccf..cc8bd36 100644 --- a/docs/swervelib/parser/json/modules/LocationJson.html +++ b/docs/swervelib/parser/json/modules/LocationJson.html @@ -1,7 +1,7 @@ - + LocationJson diff --git a/docs/swervelib/parser/json/modules/package-summary.html b/docs/swervelib/parser/json/modules/package-summary.html index a9ef6e5..21ca06b 100644 --- a/docs/swervelib/parser/json/modules/package-summary.html +++ b/docs/swervelib/parser/json/modules/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.parser.json.modules @@ -40,7 +40,7 @@ loadScripts(document, 'script');
              @@ -60,6 +60,9 @@ loadScripts(document, 'script');
              package swervelib.parser.json.modules
              +
              +
              JSON Mapped Configuration types for modules.
              +
              • @@ -69,7 +72,9 @@ loadScripts(document, 'script');
                Package
                Description
                swervelib.parser.json
                -
                 
                +
                +
                JSON Mapped classes for parsing configuration files.
                +
                • diff --git a/docs/swervelib/parser/json/modules/package-tree.html b/docs/swervelib/parser/json/modules/package-tree.html index 26d5e12..2bbfe26 100644 --- a/docs/swervelib/parser/json/modules/package-tree.html +++ b/docs/swervelib/parser/json/modules/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.parser.json.modules Class Hierarchy diff --git a/docs/swervelib/parser/json/package-summary.html b/docs/swervelib/parser/json/package-summary.html index 99c705e..80ee843 100644 --- a/docs/swervelib/parser/json/package-summary.html +++ b/docs/swervelib/parser/json/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.parser.json @@ -40,7 +40,7 @@ loadScripts(document, 'script');
                @@ -60,6 +60,9 @@ loadScripts(document, 'script');
                package swervelib.parser.json
                +
                +
                JSON Mapped classes for parsing configuration files.
                +
                • @@ -69,11 +72,17 @@ loadScripts(document, 'script');
                  Package
                  Description
                  swervelib.parser
                  -
                   
                  +
                  +
                  JSON Parser for YAGSL configurations.
                  +
                  swervelib.parser.json.modules
                  -
                   
                  +
                  +
                  JSON Mapped Configuration types for modules.
                  +
                  swervelib.parser.deserializer
                  -
                   
                  +
                  +
                  Deserialize specific variables for outside the parser.
                  +
                  • diff --git a/docs/swervelib/parser/json/package-tree.html b/docs/swervelib/parser/json/package-tree.html index a769373..c553eb7 100644 --- a/docs/swervelib/parser/json/package-tree.html +++ b/docs/swervelib/parser/json/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.parser.json Class Hierarchy diff --git a/docs/swervelib/parser/package-summary.html b/docs/swervelib/parser/package-summary.html index a1ea719..cd1a4b2 100644 --- a/docs/swervelib/parser/package-summary.html +++ b/docs/swervelib/parser/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.parser @@ -40,7 +40,7 @@ loadScripts(document, 'script');
                  @@ -60,6 +60,9 @@ loadScripts(document, 'script');
                  package swervelib.parser
                  +
                  +
                  JSON Parser for YAGSL configurations.
                  +
                  • @@ -69,21 +72,37 @@ loadScripts(document, 'script');
                    Package
                    Description
                    swervelib
                    -
                     
                    +
                    +
                    Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.
                    +
                    swervelib.parser.deserializer
                    -
                     
                    +
                    +
                    Deserialize specific variables for outside the parser.
                    +
                    swervelib.parser.json
                    -
                     
                    +
                    +
                    JSON Mapped classes for parsing configuration files.
                    +
                    swervelib.encoders
                    -
                     
                    +
                    +
                    Absolute encoders for the swerve drive, all implement SwerveAbsoluteEncoder.
                    +
                    swervelib.imu
                    -
                     
                    +
                    +
                    IMUs used for controlling the robot heading.
                    +
                    swervelib.math
                    -
                     
                    +
                    +
                    Mathematics for swerve drives.
                    +
                    swervelib.motors
                    -
                     
                    +
                    +
                    Swerve motor controller wrappers which implement SwerveMotor.
                    +
                    swervelib.simulation
                    -
                     
                    +
                    +
                    Classes used to simulate the swerve drive.
                    +
                    • diff --git a/docs/swervelib/parser/package-tree.html b/docs/swervelib/parser/package-tree.html index e124c2f..ec78e92 100644 --- a/docs/swervelib/parser/package-tree.html +++ b/docs/swervelib/parser/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.parser Class Hierarchy diff --git a/docs/swervelib/simulation/SwerveIMUSimulation.html b/docs/swervelib/simulation/SwerveIMUSimulation.html index 054bb9d..ff28b1a 100644 --- a/docs/swervelib/simulation/SwerveIMUSimulation.html +++ b/docs/swervelib/simulation/SwerveIMUSimulation.html @@ -1,7 +1,7 @@ - + SwerveIMUSimulation diff --git a/docs/swervelib/simulation/SwerveModuleSimulation.html b/docs/swervelib/simulation/SwerveModuleSimulation.html index df1278e..3e9210e 100644 --- a/docs/swervelib/simulation/SwerveModuleSimulation.html +++ b/docs/swervelib/simulation/SwerveModuleSimulation.html @@ -1,7 +1,7 @@ - + SwerveModuleSimulation diff --git a/docs/swervelib/simulation/ctre/PhysicsSim.SimProfile.html b/docs/swervelib/simulation/ctre/PhysicsSim.SimProfile.html index 36fc4b7..44cc349 100644 --- a/docs/swervelib/simulation/ctre/PhysicsSim.SimProfile.html +++ b/docs/swervelib/simulation/ctre/PhysicsSim.SimProfile.html @@ -1,7 +1,7 @@ - + PhysicsSim.SimProfile diff --git a/docs/swervelib/simulation/ctre/PhysicsSim.html b/docs/swervelib/simulation/ctre/PhysicsSim.html index d8d43c9..1cb2363 100644 --- a/docs/swervelib/simulation/ctre/PhysicsSim.html +++ b/docs/swervelib/simulation/ctre/PhysicsSim.html @@ -1,7 +1,7 @@ - + PhysicsSim diff --git a/docs/swervelib/simulation/ctre/TalonFXSimProfile.html b/docs/swervelib/simulation/ctre/TalonFXSimProfile.html index 9d9a23d..571f474 100644 --- a/docs/swervelib/simulation/ctre/TalonFXSimProfile.html +++ b/docs/swervelib/simulation/ctre/TalonFXSimProfile.html @@ -1,7 +1,7 @@ - + TalonFXSimProfile diff --git a/docs/swervelib/simulation/ctre/TalonSRXSimProfile.html b/docs/swervelib/simulation/ctre/TalonSRXSimProfile.html index 1065c77..2e7e8bd 100644 --- a/docs/swervelib/simulation/ctre/TalonSRXSimProfile.html +++ b/docs/swervelib/simulation/ctre/TalonSRXSimProfile.html @@ -1,7 +1,7 @@ - + TalonSRXSimProfile diff --git a/docs/swervelib/simulation/ctre/VictorSPXSimProfile.html b/docs/swervelib/simulation/ctre/VictorSPXSimProfile.html index 3e5a02d..ef8dbd9 100644 --- a/docs/swervelib/simulation/ctre/VictorSPXSimProfile.html +++ b/docs/swervelib/simulation/ctre/VictorSPXSimProfile.html @@ -1,7 +1,7 @@ - + VictorSPXSimProfile diff --git a/docs/swervelib/simulation/ctre/package-summary.html b/docs/swervelib/simulation/ctre/package-summary.html index 6eb8b72..7fb9bb9 100644 --- a/docs/swervelib/simulation/ctre/package-summary.html +++ b/docs/swervelib/simulation/ctre/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.simulation.ctre @@ -40,7 +40,7 @@ loadScripts(document, 'script');
                    @@ -60,6 +60,9 @@ loadScripts(document, 'script');
                    package swervelib.simulation.ctre
                    +
                    +
                    CTRE Physics Simulator.
                    +
                    • @@ -69,7 +72,9 @@ loadScripts(document, 'script');
                      Package
                      Description
                      swervelib.simulation
                      -
                       
                      +
                      +
                      Classes used to simulate the swerve drive.
                      +
                      • diff --git a/docs/swervelib/simulation/ctre/package-tree.html b/docs/swervelib/simulation/ctre/package-tree.html index c1e2f08..8098171 100644 --- a/docs/swervelib/simulation/ctre/package-tree.html +++ b/docs/swervelib/simulation/ctre/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.simulation.ctre Class Hierarchy diff --git a/docs/swervelib/simulation/package-summary.html b/docs/swervelib/simulation/package-summary.html index dc82f9b..df6b811 100644 --- a/docs/swervelib/simulation/package-summary.html +++ b/docs/swervelib/simulation/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.simulation @@ -40,7 +40,7 @@ loadScripts(document, 'script');
                      @@ -60,6 +60,9 @@ loadScripts(document, 'script');
                      package swervelib.simulation
                      +
                      +
                      Classes used to simulate the swerve drive.
                      +
                      • @@ -69,19 +72,33 @@ loadScripts(document, 'script');
                        Package
                        Description
                        swervelib
                        -
                         
                        +
                        +
                        Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.
                        +
                        swervelib.simulation.ctre
                        -
                         
                        +
                        +
                        CTRE Physics Simulator.
                        +
                        swervelib.encoders
                        -
                         
                        +
                        +
                        Absolute encoders for the swerve drive, all implement SwerveAbsoluteEncoder.
                        +
                        swervelib.imu
                        -
                         
                        +
                        +
                        IMUs used for controlling the robot heading.
                        +
                        swervelib.math
                        -
                         
                        +
                        +
                        Mathematics for swerve drives.
                        +
                        swervelib.motors
                        -
                         
                        +
                        +
                        Swerve motor controller wrappers which implement SwerveMotor.
                        +
                        swervelib.parser
                        -
                         
                        +
                        +
                        JSON Parser for YAGSL configurations.
                        +
                        • diff --git a/docs/swervelib/simulation/package-tree.html b/docs/swervelib/simulation/package-tree.html index 2aa2acd..dd89aba 100644 --- a/docs/swervelib/simulation/package-tree.html +++ b/docs/swervelib/simulation/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.simulation Class Hierarchy diff --git a/swervelib/encoders/package-info.java b/swervelib/encoders/package-info.java new file mode 100644 index 0000000..9535788 --- /dev/null +++ b/swervelib/encoders/package-info.java @@ -0,0 +1,4 @@ +/** + * Absolute encoders for the swerve drive, all implement {@link swervelib.encoders.SwerveAbsoluteEncoder}. + */ +package swervelib.encoders; \ No newline at end of file diff --git a/swervelib/imu/package-info.java b/swervelib/imu/package-info.java new file mode 100644 index 0000000..40e1ea1 --- /dev/null +++ b/swervelib/imu/package-info.java @@ -0,0 +1,4 @@ +/** + * IMUs used for controlling the robot heading. All implement {@link swervelib.imu.SwerveIMU}. + */ +package swervelib.imu; \ No newline at end of file diff --git a/swervelib/math/package-info.java b/swervelib/math/package-info.java new file mode 100644 index 0000000..2aa3099 --- /dev/null +++ b/swervelib/math/package-info.java @@ -0,0 +1,4 @@ +/** + * Mathematics for swerve drives. + */ +package swervelib.math; \ No newline at end of file diff --git a/swervelib/motors/package-info.java b/swervelib/motors/package-info.java new file mode 100644 index 0000000..6e1f6ea --- /dev/null +++ b/swervelib/motors/package-info.java @@ -0,0 +1,4 @@ +/** + * Swerve motor controller wrappers which implement {@link swervelib.motors.SwerveMotor}. + */ +package swervelib.motors; \ No newline at end of file diff --git a/swervelib/package-info.java b/swervelib/package-info.java new file mode 100644 index 0000000..10e78bc --- /dev/null +++ b/swervelib/package-info.java @@ -0,0 +1,6 @@ +/** + * Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib. + * + * @version 1.0.0 + */ +package swervelib; \ No newline at end of file diff --git a/swervelib/parser/deserializer/package-info.java b/swervelib/parser/deserializer/package-info.java new file mode 100644 index 0000000..76923d8 --- /dev/null +++ b/swervelib/parser/deserializer/package-info.java @@ -0,0 +1,4 @@ +/** + * Deserialize specific variables for outside the parser. + */ +package swervelib.parser.deserializer; \ No newline at end of file diff --git a/swervelib/parser/json/modules/package-info.java b/swervelib/parser/json/modules/package-info.java new file mode 100644 index 0000000..4ec91de --- /dev/null +++ b/swervelib/parser/json/modules/package-info.java @@ -0,0 +1,4 @@ +/** + * JSON Mapped Configuration types for modules. + */ +package swervelib.parser.json.modules; \ No newline at end of file diff --git a/swervelib/parser/json/package-info.java b/swervelib/parser/json/package-info.java new file mode 100644 index 0000000..14496ea --- /dev/null +++ b/swervelib/parser/json/package-info.java @@ -0,0 +1,4 @@ +/** + * JSON Mapped classes for parsing configuration files. + */ +package swervelib.parser.json; \ No newline at end of file diff --git a/swervelib/parser/package-info.java b/swervelib/parser/package-info.java new file mode 100644 index 0000000..60f8785 --- /dev/null +++ b/swervelib/parser/package-info.java @@ -0,0 +1,4 @@ +/** + * JSON Parser for YAGSL configurations. + */ +package swervelib.parser; \ No newline at end of file diff --git a/swervelib/simulation/ctre/package-info.java b/swervelib/simulation/ctre/package-info.java new file mode 100644 index 0000000..3999f5a --- /dev/null +++ b/swervelib/simulation/ctre/package-info.java @@ -0,0 +1,4 @@ +/** + * CTRE Physics Simulator. + */ +package swervelib.simulation.ctre; \ No newline at end of file diff --git a/swervelib/simulation/package-info.java b/swervelib/simulation/package-info.java new file mode 100644 index 0000000..e021267 --- /dev/null +++ b/swervelib/simulation/package-info.java @@ -0,0 +1,4 @@ +/** + * Classes used to simulate the swerve drive. + */ +package swervelib.simulation; \ No newline at end of file