Skip to content

Commit cb9a591

Browse files
committed
Now java docs should be fixed
1 parent cf1d478 commit cb9a591

File tree

4 files changed

+13
-16
lines changed

4 files changed

+13
-16
lines changed

src/main/java/org/carlmontrobotics/lib199/Limelight.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,11 @@ public Pose3d getTransform(Transform transform) {
214214
return new Pose3d(rawData[0], rawData[1], rawData[2], new Rotation3d(Math.toRadians(rawData[3]), Math.toRadians(rawData[4]), Math.toRadians(rawData[5])));
215215
}
216216

217+
/**
218+
* Gets Limelight Network Tables
219+
* @param key id of the NT
220+
* @return the NT
221+
*/
217222
public NetworkTableEntry getNTEntry(String key) {
218223
return NetworkTableInstance.getDefault().getTable(config.ntName).getEntry(key);
219224
}

src/main/java/org/carlmontrobotics/lib199/SimpleMechs/Drivetrain/SimpleDrivetrain.java

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -726,14 +726,6 @@ public void initSendable(SendableBuilder builder) {
726726

727727
// #region Drive Methods
728728

729-
/**
730-
* Drives the robot using the given x, y, and rotation speed
731-
*
732-
* @param forward The desired forward speed, in m/s. Forward is positive.
733-
* @param strafe The desired strafe speed, in m/s. Left is positive.
734-
* @param rotation The desired rotation speed, in rad/s. Counter clockwise is
735-
* positive
736-
*/
737729
public void setExtraSpeedMult(double set) {
738730
extraSpeedMult=set;
739731
}

src/main/java/org/carlmontrobotics/lib199/SimpleMechs/Spinner/SpinnerConfig.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ public SpinnerConfig(int spinnerMasterId, int spinnerFollowId, MotorConfig spinn
7777
* @param gearReduction 1 revolution of the spinner / how many revolution is needed by the motor
7878
* @param maxVolts maximum volts that the spinner can use autonomously
7979
* @param spinnerKPID 3 values for kP, kI, and kD
80-
* @param spinnerKPIDTolerance in rotations per second how much should pid care for speed
80+
* @param spinnerPIDTolerance in rotations per second how much should pid care for speed
8181
*/
8282
public static SpinnerConfig NEOSpinnerConfig(int spinnerMasterId, boolean spinnerMasterInverted, double gearReduction, double maxVolts, double[] spinnerKPID, double spinnerPIDTolerance) {
8383
return new SpinnerConfig(spinnerMasterId, -1, MotorConfig.NEO, null, spinnerMasterInverted, false, gearReduction, maxVolts, maxVolts/12.0, spinnerKPID, null, spinnerPIDTolerance);
@@ -86,7 +86,7 @@ public static SpinnerConfig NEOSpinnerConfig(int spinnerMasterId, boolean spinne
8686
/**
8787
* Creates a simple single NEO spinner without PID
8888
* @param spinnerMasterId id of the motor
89-
* @param spinnerMasterInversed inversed setting such that whichever is the desired movement of the spinner will be positive
89+
* @param spinnerMasterInverted inversed setting such that whichever is the desired movement of the spinner will be positive
9090
* @param gearReduction 1 revolution of the spinner / how many revolution is needed by the motor
9191
* @param maxManualInput maximum voltage percentage that the spinner can use while being manually controlled
9292
* @return
@@ -98,11 +98,11 @@ public static SpinnerConfig NEOSpinnerConfig(int spinnerMasterId, boolean spinne
9898
/**
9999
* Creates a simple single NEO spinner with PID
100100
* @param spinnerMasterId id of the motor
101-
* @param spinnerMasterInversed inversed setting such that whichever is the desired movement of the spinner will be positive
101+
* @param spinnerMasterInverted inversed setting such that whichever is the desired movement of the spinner will be positive
102102
* @param gearReduction 1 revolution of the spinner / how many revolution is needed by the motor
103103
* @param maxVolts maximum volts that the spinner can use autonomously
104104
* @param spinnerKPID 3 values for kP, kI, and kD
105-
* @param spinnerKPIDTolerance in rotations per second how much should pid care for speed
105+
* @param spinnerPIDTolerance in rotations per second how much should pid care for speed
106106
*/
107107
public static SpinnerConfig VORTEXSpinnerConfig(int spinnerMasterId, boolean spinnerMasterInverted, double gearReduction, double maxVolts, double[] spinnerKPID, double spinnerPIDTolerance) {
108108
return new SpinnerConfig(spinnerMasterId, -1, MotorConfig.NEO_VORTEX, null, spinnerMasterInverted, false, gearReduction, maxVolts, maxVolts/12.0, spinnerKPID, null, spinnerPIDTolerance);
@@ -111,7 +111,7 @@ public static SpinnerConfig VORTEXSpinnerConfig(int spinnerMasterId, boolean spi
111111
/**
112112
* Creates a simple single NEO spinner without PID
113113
* @param spinnerMasterId id of the motor
114-
* @param spinnerMasterInversed inversed setting such that whichever is the desired movement of the spinner will be positive
114+
* @param spinnerMasterInverted inversed setting such that whichever is the desired movement of the spinner will be positive
115115
* @param gearReduction 1 revolution of the spinner / how many revolution is needed by the motor
116116
* @param maxManualInput maximum voltage percentage that the spinner can use while being manually controlled
117117
* @return

src/main/java/org/carlmontrobotics/lib199/sim/MockedEncoder.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public class MockedEncoder implements AbsoluteEncoder, AnalogInput, AutoCloseabl
4444
* @param analog Whether the encoder is an analog sensor
4545
* @param absolute Whether the encoder is an absolute encoder. This flag caps the position to
4646
* one rotation via. {@link MathUtil#inputModulus(double, double, double)}, disables
47-
* {@link #setPosition(double)}, and enables {@link #setZeroOffset(double)}.
47+
* {@link #setPosition(double)}, and enables setZeroOffset(double).
4848
*
4949
* {@link #getVelocity()} will return a value in rpm.
5050
*/
@@ -59,7 +59,7 @@ public MockedEncoder(SimDevice device, int countsPerRev, boolean analog,
5959
* @param analog Whether the encoder is an analog sensor
6060
* @param absolute Whether the encoder is an absolute encoder. This flag caps the position to
6161
* one rotation via. {@link MathUtil#inputModulus(double, double, double)}, disables
62-
* {@link #setPosition(double)}, and enables {@link #setZeroOffset(double)}.
62+
* {@link #setPosition(double)}, and enables setZeroOffset(double). //FIXME where is this so called setZero
6363
* @param useRps Whether getVelocity() should return rps instead of rpm.
6464
*/
6565
public MockedEncoder(SimDevice device, int countsPerRev, boolean analog,
@@ -106,7 +106,7 @@ public REVLibError setPosition(double newPosition) {
106106
// }
107107

108108
/**
109-
* @return The current position of the encoder, not accounting for the position offset ({@link #setPosition(double)} and {@link #setZeroOffset(double)})
109+
* @return The current position of the encoder, not accounting for the position offset ({@link #setPosition(double)} and setZeroOffset(double)
110110
*/
111111
public double getRawPosition() {
112112
double rotationsOrVolts = voltage != null ? voltage.get() : position.get();

0 commit comments

Comments
 (0)