From 4c62b686fcb6fdfd202c56d29f052ef531fa6555 Mon Sep 17 00:00:00 2001 From: ProgrammingSR Date: Fri, 9 Feb 2024 17:26:32 -0800 Subject: [PATCH] docs: Documentation for ShuffleBoard Wrapper --- src/main/java/frc/robot/ShuffleBoardWrapper.java | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/src/main/java/frc/robot/ShuffleBoardWrapper.java b/src/main/java/frc/robot/ShuffleBoardWrapper.java index e2db17b..01a9879 100644 --- a/src/main/java/frc/robot/ShuffleBoardWrapper.java +++ b/src/main/java/frc/robot/ShuffleBoardWrapper.java @@ -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"); @@ -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); @@ -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)){