Skip to content

Commit

Permalink
Merge pull request #188 from frc937/gkc-javadoc
Browse files Browse the repository at this point in the history
Gkc javadoc v2
  • Loading branch information
AraReighard authored Apr 29, 2024
2 parents 8587168 + 663e4e1 commit 149d70a
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 5 deletions.
6 changes: 5 additions & 1 deletion src/main/java/frc/robot/RobotContainer.java
Original file line number Diff line number Diff line change
Expand Up @@ -265,13 +265,17 @@ public class RobotContainer {
/** Singleton instance of {@link OnePieceAuto} for the whole robot. */
public static OnePieceAuto onePieceAuto = new OnePieceAuto();

/** Singleton instance of {@link OnePieceAutoButItWorksISwear} for the whole robot. */
public static OnePieceAutoButItWorksISwear onePieceAutoButItWorksISwear =
new OnePieceAutoButItWorksISwear();

/** Singleton instance of {@link TaxiLongAuto} for the whole robot. */
public static TaxiLongAuto taxiLongAuto = new TaxiLongAuto();

/** Singleton instance of {@link PickUpFromCenterAuto} for the whole robot. */
public static PickUpFromCenterAuto pickUpFromCenterAuto = new PickUpFromCenterAuto();

/** Singleton instance of {@link DriveToCenterAuto} for the whole robot. */
public static DriveToCenterAuto driveToCenterAuto = new DriveToCenterAuto();

/** Singleton instance of {@link TaxiAuto} for the whole robot. */
Expand All @@ -286,7 +290,7 @@ public class RobotContainer {
/** Singleton instance of {@link DisabledLight} for the whole robot. */
public static DisabledLight disabledLights = new DisabledLight();

/** Singleton instance of {@link EnableLights} for the whole robot. */
/** Singleton instance of {@link EnabledLight} for the whole robot. */
public static EnabledLight enabledLights = new EnabledLight();

/** Singleton instance of {@link NoteLight} for the whole robot. */
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/frc/robot/commands/auto/DriveToAmpBlue.java
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@
// NOTE: Consider using this command inline, rather than writing a subclass. For more
// information, see:
// https://docs.wpilib.org/en/stable/docs/software/commandbased/convenience-features.html
/** Auto that manually drives bot to blue amp. Made due to faulty limelight at comp. */
public class DriveToAmpBlue extends SequentialCommandGroup {

/** Creates a new DriveToAmp. */
/** Creates a new DriveToAmpBlue. */
public DriveToAmpBlue() {
super(
new ParallelDeadlineGroup(
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/frc/robot/commands/auto/DriveToAmpRed.java
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@
// NOTE: Consider using this command inline, rather than writing a subclass. For more
// information, see:
// https://docs.wpilib.org/en/stable/docs/software/commandbased/convenience-features.html
/** Auto that manually drives bot to red amp. Made due to faulty limelight at comp. */
public class DriveToAmpRed extends SequentialCommandGroup {

/** Creates a new DriveToAmp. */
/** Creates a new DriveToAmpRed. */
public DriveToAmpRed() {
super(
new ParallelDeadlineGroup(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
// NOTE: Consider using this command inline, rather than writing a subclass. For more
// information, see:
// https://docs.wpilib.org/en/stable/docs/software/commandbased/convenience-features.html
/** Auto that drives bot to center of field. */
public class DriveToCenterAuto extends ParallelCommandGroup {
/** Creates a new PickUpFromCenterAuto. */
public DriveToCenterAuto() {
Expand Down
1 change: 1 addition & 0 deletions src/main/java/frc/robot/commands/auto/DumpNote.java
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
// NOTE: Consider using this command inline, rather than writing a subclass. For more
// information, see:
// https://docs.wpilib.org/en/stable/docs/software/commandbased/convenience-features.html
/** Auto that dumps the preloaded note in the robot after 4 seconds. */
public class DumpNote extends ParallelDeadlineGroup {
/** Creates a new DumpNote. */
public DumpNote() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@
// NOTE: Consider using this command inline, rather than writing a subclass. For more
// information, see:
// https://docs.wpilib.org/en/stable/docs/software/commandbased/convenience-features.html
// One piece - the anime thing
/**
* Auto that manually drives to the amp and offloads the note. Made due to faulty limelight at comp.
*/
public class OnePieceAutoButItWorksISwear extends SequentialCommandGroup {
/** Creates a new OnePieceAutoButItWorksISwear. */
public OnePieceAutoButItWorksISwear() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
// NOTE: Consider using this command inline, rather than writing a subclass. For more
// information, see:
// https://docs.wpilib.org/en/stable/docs/software/commandbased/convenience-features.html
/** Auto that drives the bot to a note and intakes it. */
public class PickUpFromCenterAuto extends ParallelCommandGroup {
/** Creates a new PickUpFromCenterAuto. */
public PickUpFromCenterAuto() {
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/frc/robot/subsystems/AddressableLightStrip.java
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ public AddressableLightStrip(int pwmPort, int lightCount) {
/**
* Sets a light on the light strip to a {@link edu.wpi.first.wpilibj.util.Color}
*
* @param lightNumber
* @param color
* @param lightNumber the number of the LED.
* @param color The color to set the LED to.
*/
public void setColorLight(int lightNumber, Color color) {
if (lightNumber > this.buffer.getLength()) {
Expand Down

0 comments on commit 149d70a

Please sign in to comment.