Skip to content

Commit

Permalink
docs: Documentation for ShuffleBoard Wrapper
Browse files Browse the repository at this point in the history
  • Loading branch information
ProgrammingSR committed Feb 10, 2024
1 parent 8d43307 commit 4c62b68
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion src/main/java/frc/robot/ShuffleBoardWrapper.java
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@
import edu.wpi.first.wpilibj2.command.Subsystem;
import frc.robot.subsystems.ShooterSubsystem;

/** Add your docs here. */
/**
* ShuffleBoard Wrapper
*/
public class ShuffleBoardWrapper {
public static ShuffleBoardWrapper m_default = new ShuffleBoardWrapper("Default");

Expand All @@ -26,6 +28,14 @@ private static boolean checkForTitle(String title, ShuffleboardLayout lay) {
return true;
}

/**
* Initilize SHuffleBoardWrapper
* @apiNote Timer
* @apiNote Enabled
* @apiNote Driver Controller
* @apiNote Operator Controller
* @param name Name Of Tab to be initialized in SmartDashBoard
*/
private ShuffleBoardWrapper(String name) {
m_name = name;
ShuffleboardLayout lay = Shuffleboard.getTab(m_name).getLayout("Match Info", BuiltInLayouts.kList);
Expand All @@ -39,6 +49,10 @@ private ShuffleBoardWrapper(String name) {
lay.addBoolean("Operator Controller", () -> DriverStation.isJoystickConnected(1));
}

/**
* Adds the Shooter Subsytem to ShuffleBoard
* @param shooter Shooter Class
*/
protected void addShooter(ShooterSubsystem shooter) {
ShuffleboardLayout lay = Shuffleboard.getTab(m_name).getLayout("Shooter", BuiltInLayouts.kList);
if(checkForTitle("Dummy", lay)){
Expand Down

0 comments on commit 4c62b68

Please sign in to comment.