Skip to content

Commit 810a927

Browse files
improve documentation
1 parent 48dc9f0 commit 810a927

File tree

3 files changed

+13
-4
lines changed

3 files changed

+13
-4
lines changed

src/main/kotlin/frc/robot/commands/ChangeDriveMode.kt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,13 @@ import java.time.LocalTime
1515
class ChangeDriveMode(val driveToggle: DriveModeToggleSubsystem,
1616
val activating: () -> Boolean) : CommandBase() {
1717
/**
18-
* Creates a new ExampleCommand.
18+
* Creates a new ChangeDriveMode command.
1919
*
20-
* @param m_subsystem The subsystem used by this command.
20+
* @param driveToggle The subsystem used by this command.
21+
* @param activating The function to call to determine if the driver
22+
* is trying to change the mode.
2123
*/
24+
2225
init {
2326
addRequirements(driveToggle)
2427
}

src/main/kotlin/frc/robot/commands/VisionModeChange.kt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@ import frc.robot.subsystems.VisionToggleSubsystem
1515
class VisionModeChange(val visionToggle: VisionToggleSubsystem,
1616
val mode: () -> Pair<VisionModes, Boolean>) : CommandBase() {
1717
/**
18-
* Creates a new ExampleCommand.
18+
* Creates a new VisionModeChange command.
1919
*
20-
* @param m_subsystem The subsystem used by this command.
20+
* @param visionToggle The subsystem used by this command.
21+
* @param mode The function to get the vision mode and automatic intake state as a pair
2122
*/
2223
init {
2324
addRequirements(visionToggle)

src/main/kotlin/frc/robot/subsystems/DriveModeToggleSubsystem.kt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ import java.lang.IndexOutOfBoundsException
1010
import java.util.*
1111
import kotlin.concurrent.schedule
1212

13+
/**
14+
* Subsystem to handle changing the command used to drive the robot.
15+
* This is intended to test the commands, not for use in real matches.
16+
*/
17+
1318
class DriveModeToggleSubsystem(private val drivetrain: DrivetrainSubsystem,
1419
private val controller1: XboxController,
1520
private val driveModes: List<CommandBase>,

0 commit comments

Comments
 (0)