diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/Command.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/Command.java index 8f9901bfc5..bc464f34d6 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/Command.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/Command.java @@ -14,6 +14,8 @@ import java.util.function.BooleanSupplier; * *

Commands are run synchronously from the main robot loop; no multithreading is used, unless * specified explicitly from the command implementation. + * + *

This class is provided by the NewCommands VendorDep */ public interface Command { /** The initial subroutine of a command. Called once when the command is initially scheduled. */ diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/CommandBase.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/CommandBase.java index bb1df60fd4..619f3301be 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/CommandBase.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/CommandBase.java @@ -10,7 +10,11 @@ import edu.wpi.first.util.sendable.SendableRegistry; import java.util.HashSet; import java.util.Set; -/** A {@link Sendable} base class for {@link Command}s. */ +/** + * A {@link Sendable} base class for {@link Command}s. + * + *

This class is provided by the NewCommands VendorDep + */ public abstract class CommandBase implements Sendable, Command { protected Set m_requirements = new HashSet<>(); diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/CommandGroupBase.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/CommandGroupBase.java index d3a35d4004..ad62554bcb 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/CommandGroupBase.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/CommandGroupBase.java @@ -13,6 +13,8 @@ import java.util.WeakHashMap; * A base for CommandGroups. Statically tracks commands that have been allocated to groups to ensure * those commands are not also used independently, which can result in inconsistent command state * and unpredictable execution. + * + *

This class is provided by the NewCommands VendorDep */ public abstract class CommandGroupBase extends CommandBase { private static final Set m_groupedCommands = diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/CommandScheduler.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/CommandScheduler.java index 0a8284e91b..b5c2d3cfd0 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/CommandScheduler.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/CommandScheduler.java @@ -33,6 +33,8 @@ import java.util.function.Consumer; * synchronously from the main loop. Subsystems should be registered with the scheduler using {@link * CommandScheduler#registerSubsystem(Subsystem...)} in order for their {@link Subsystem#periodic()} * methods to be called and for their default commands to be scheduled. + * + *

This class is provided by the NewCommands VendorDep */ public final class CommandScheduler implements NTSendable, AutoCloseable { /** The Singleton Instance. */ diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/CommandState.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/CommandState.java index 2d60982954..173bc54b59 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/CommandState.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/CommandState.java @@ -8,6 +8,8 @@ import edu.wpi.first.wpilibj.Timer; /** * Class that holds scheduling state for a command. Used internally by the {@link CommandScheduler}. + * + *

This class is provided by the NewCommands VendorDep */ class CommandState { // The time since this command was initialized. diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ConditionalCommand.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ConditionalCommand.java index 74bf1ce149..18d392aa7a 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ConditionalCommand.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ConditionalCommand.java @@ -21,6 +21,8 @@ import java.util.function.BooleanSupplier; * scheduled individually. * *

As a rule, CommandGroups require the union of the requirements of their component commands. + * + *

This class is provided by the NewCommands VendorDep */ public class ConditionalCommand extends CommandBase { private final Command m_onTrue; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/FunctionalCommand.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/FunctionalCommand.java index d9469c3149..d235bfeaad 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/FunctionalCommand.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/FunctionalCommand.java @@ -14,6 +14,8 @@ import java.util.function.Consumer; * the constructor. Useful for inline definitions of complex commands - note, however, that if a * command is beyond a certain complexity it is usually better practice to write a proper class for * it than to inline it. + * + *

This class is provided by the NewCommands VendorDep */ public class FunctionalCommand extends CommandBase { protected final Runnable m_onInit; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/InstantCommand.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/InstantCommand.java index 10816df8bd..586a2d57e7 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/InstantCommand.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/InstantCommand.java @@ -10,6 +10,8 @@ import static edu.wpi.first.wpilibj.util.ErrorMessages.requireNonNullParam; * A Command that runs instantly; it will initialize, execute once, and end on the same iteration of * the scheduler. Users can either pass in a Runnable and a set of requirements, or else subclass * this command if desired. + * + *

This class is provided by the NewCommands VendorDep */ public class InstantCommand extends CommandBase { private final Runnable m_toRun; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/MecanumControllerCommand.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/MecanumControllerCommand.java index c22259c256..dbe71d7c15 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/MecanumControllerCommand.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/MecanumControllerCommand.java @@ -35,6 +35,8 @@ import java.util.function.Supplier; * *

The robot angle controller does not follow the angle given by the trajectory but rather goes * to the angle given in the final state of the trajectory. + * + *

This class is provided by the NewCommands VendorDep */ @SuppressWarnings("MemberName") public class MecanumControllerCommand extends CommandBase { diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/NotifierCommand.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/NotifierCommand.java index 487aa12eaf..751c5075e5 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/NotifierCommand.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/NotifierCommand.java @@ -14,6 +14,8 @@ import edu.wpi.first.wpilibj.Notifier; *

WARNING: Do not use this class unless you are confident in your ability to make the executed * code thread-safe. If you do not know what "thread-safe" means, that is a good sign that you * should not use this class. + * + *

This class is provided by the NewCommands VendorDep */ public class NotifierCommand extends CommandBase { protected final Notifier m_notifier; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/PIDCommand.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/PIDCommand.java index dcf8decc40..bf9541c529 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/PIDCommand.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/PIDCommand.java @@ -15,6 +15,8 @@ import java.util.function.DoubleSupplier; * A command that controls an output with a {@link PIDController}. Runs forever by default - to add * exit conditions and/or other behavior, subclass this class. The controller calculation and output * are performed synchronously in the command's execute() method. + * + *

This class is provided by the NewCommands VendorDep */ public class PIDCommand extends CommandBase { protected final PIDController m_controller; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/PIDSubsystem.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/PIDSubsystem.java index ad9bb7759a..c15360d29c 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/PIDSubsystem.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/PIDSubsystem.java @@ -11,6 +11,8 @@ import edu.wpi.first.math.controller.PIDController; /** * A subsystem that uses a {@link PIDController} to control an output. The controller is run * synchronously from the subsystem's periodic() method. + * + *

This class is provided by the NewCommands VendorDep */ public abstract class PIDSubsystem extends SubsystemBase { protected final PIDController m_controller; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ParallelCommandGroup.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ParallelCommandGroup.java index 7195606e19..688435c569 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ParallelCommandGroup.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ParallelCommandGroup.java @@ -12,6 +12,8 @@ import java.util.Map; * A CommandGroup that runs a set of commands in parallel, ending when the last command ends. * *

As a rule, CommandGroups require the union of the requirements of their component commands. + * + *

This class is provided by the NewCommands VendorDep */ public class ParallelCommandGroup extends CommandGroupBase { // maps commands in this group to whether they are still running diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ParallelDeadlineGroup.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ParallelDeadlineGroup.java index 682fb6bdfb..5d54b2f50a 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ParallelDeadlineGroup.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ParallelDeadlineGroup.java @@ -13,6 +13,8 @@ import java.util.Map; * "deadline") ends, interrupting all other commands that are still running at that point. * *

As a rule, CommandGroups require the union of the requirements of their component commands. + * + *

This class is provided by the NewCommands VendorDep */ public class ParallelDeadlineGroup extends CommandGroupBase { // maps commands in this group to whether they are still running diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ParallelRaceGroup.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ParallelRaceGroup.java index 2d798852f5..be3f909fce 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ParallelRaceGroup.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ParallelRaceGroup.java @@ -13,6 +13,8 @@ import java.util.Set; * and interrupting all the others. * *

As a rule, CommandGroups require the union of the requirements of their component commands. + * + *

This class is provided by the NewCommands VendorDep */ public class ParallelRaceGroup extends CommandGroupBase { private final Set m_commands = new HashSet<>(); diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/PerpetualCommand.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/PerpetualCommand.java index af219dc523..7113be674b 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/PerpetualCommand.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/PerpetualCommand.java @@ -14,6 +14,8 @@ import static edu.wpi.first.wpilibj2.command.CommandGroupBase.requireUngrouped; * cannot be added to any other groups, or scheduled individually. * *

As a rule, CommandGroups require the union of the requirements of their component commands. + * + *

This class is provided by the NewCommands VendorDep */ public class PerpetualCommand extends CommandBase { protected final Command m_command; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/PrintCommand.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/PrintCommand.java index 33415d0a12..3d7726e46f 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/PrintCommand.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/PrintCommand.java @@ -4,7 +4,11 @@ package edu.wpi.first.wpilibj2.command; -/** A command that prints a string when initialized. */ +/** + * A command that prints a string when initialized. + * + *

This class is provided by the NewCommands VendorDep + */ public class PrintCommand extends InstantCommand { /** * Creates a new a PrintCommand. diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ProfiledPIDCommand.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ProfiledPIDCommand.java index df56561955..9e44f2d723 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ProfiledPIDCommand.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ProfiledPIDCommand.java @@ -17,6 +17,8 @@ import java.util.function.Supplier; * A command that controls an output with a {@link ProfiledPIDController}. Runs forever by default - * to add exit conditions and/or other behavior, subclass this class. The controller calculation and * output are performed synchronously in the command's execute() method. + * + *

This class is provided by the NewCommands VendorDep */ public class ProfiledPIDCommand extends CommandBase { protected final ProfiledPIDController m_controller; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ProfiledPIDSubsystem.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ProfiledPIDSubsystem.java index 85ece1f44a..0f28d852ec 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ProfiledPIDSubsystem.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ProfiledPIDSubsystem.java @@ -13,6 +13,8 @@ import edu.wpi.first.math.trajectory.TrapezoidProfile; /** * A subsystem that uses a {@link ProfiledPIDController} to control an output. The controller is run * synchronously from the subsystem's periodic() method. + * + *

This class is provided by the NewCommands VendorDep */ public abstract class ProfiledPIDSubsystem extends SubsystemBase { protected final ProfiledPIDController m_controller; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ProxyScheduleCommand.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ProxyScheduleCommand.java index ae403a42e3..858d9d0629 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ProxyScheduleCommand.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ProxyScheduleCommand.java @@ -10,6 +10,8 @@ import java.util.Set; * Schedules the given commands when this command is initialized, and ends when all the commands are * no longer scheduled. Useful for forking off from CommandGroups. If this command is interrupted, * it will cancel all of the commands. + * + *

This class is provided by the NewCommands VendorDep */ public class ProxyScheduleCommand extends CommandBase { private final Set m_toSchedule; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/RamseteCommand.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/RamseteCommand.java index 8d8d4d3254..8bd57eb7d6 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/RamseteCommand.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/RamseteCommand.java @@ -29,6 +29,8 @@ import java.util.function.Supplier; *

Advanced teams seeking more flexibility (for example, those who wish to use the onboard PID * functionality of a "smart" motor controller) may use the secondary constructor that omits the PID * and feedforward functionality, returning only the raw wheel speeds from the RAMSETE controller. + * + *

This class is provided by the NewCommands VendorDep */ public class RamseteCommand extends CommandBase { private final Timer m_timer = new Timer(); diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/RunCommand.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/RunCommand.java index e1a729649b..c48f6c8d75 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/RunCommand.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/RunCommand.java @@ -12,6 +12,8 @@ import java.util.function.BooleanSupplier; * A command that runs a Runnable continuously. Has no end condition as-is; either subclass it or * use {@link Command#withTimeout(double)} or {@link Command#withInterrupt(BooleanSupplier)} to give * it one. If you only wish to execute a Runnable once, use {@link InstantCommand}. + * + *

This class is provided by the NewCommands VendorDep */ public class RunCommand extends CommandBase { protected final Runnable m_toRun; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ScheduleCommand.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ScheduleCommand.java index 75b5774462..98062f9a90 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ScheduleCommand.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/ScheduleCommand.java @@ -10,6 +10,8 @@ import java.util.Set; * Schedules the given commands when this command is initialized. Useful for forking off from * CommandGroups. Note that if run from a CommandGroup, the group will not know about the status of * the scheduled commands, and will treat this command as finishing instantly. + * + *

This class is provided by the NewCommands VendorDep */ public class ScheduleCommand extends CommandBase { private final Set m_toSchedule; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/SelectCommand.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/SelectCommand.java index a5c885942e..e7748160cd 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/SelectCommand.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/SelectCommand.java @@ -23,6 +23,8 @@ import java.util.function.Supplier; * scheduled individually. * *

As a rule, CommandGroups require the union of the requirements of their component commands. + * + *

This class is provided by the NewCommands VendorDep */ public class SelectCommand extends CommandBase { private final Map m_commands; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/SequentialCommandGroup.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/SequentialCommandGroup.java index 38dff8d228..43426b0975 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/SequentialCommandGroup.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/SequentialCommandGroup.java @@ -11,6 +11,8 @@ import java.util.List; * A CommandGroups that runs a list of commands in sequence. * *

As a rule, CommandGroups require the union of the requirements of their component commands. + * + *

This class is provided by the NewCommands VendorDep */ public class SequentialCommandGroup extends CommandGroupBase { private final List m_commands = new ArrayList<>(); diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/StartEndCommand.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/StartEndCommand.java index 05e46cb949..5fd6a7ced6 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/StartEndCommand.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/StartEndCommand.java @@ -11,6 +11,8 @@ import static edu.wpi.first.wpilibj.util.ErrorMessages.requireNonNullParam; * Useful for running and then stopping a motor, or extending and then retracting a solenoid. Has no * end condition as-is; either subclass it or use {@link Command#withTimeout(double)} or {@link * Command#withInterrupt(java.util.function.BooleanSupplier)} to give it one. + * + *

This class is provided by the NewCommands VendorDep */ public class StartEndCommand extends CommandBase { protected final Runnable m_onInit; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/Subsystem.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/Subsystem.java index 4e28b16e37..a42df7125c 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/Subsystem.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/Subsystem.java @@ -18,6 +18,8 @@ package edu.wpi.first.wpilibj2.command; * Subsystem#periodic()} method to be called. It is recommended that this method be called from the * constructor of users' Subsystem implementations. The {@link SubsystemBase} class offers a simple * base for user implementations that handles this. + * + *

This class is provided by the NewCommands VendorDep */ public interface Subsystem { /** diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/SubsystemBase.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/SubsystemBase.java index c6858034a3..6cf926ee23 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/SubsystemBase.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/SubsystemBase.java @@ -11,6 +11,8 @@ import edu.wpi.first.util.sendable.SendableRegistry; /** * A base for subsystems that handles registration in the constructor, and provides a more intuitive * method for setting the default command. + * + *

This class is provided by the NewCommands VendorDep */ public abstract class SubsystemBase implements Subsystem, Sendable { /** Constructor. */ diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/SwerveControllerCommand.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/SwerveControllerCommand.java index 95b42eed66..91162fad4c 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/SwerveControllerCommand.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/SwerveControllerCommand.java @@ -28,6 +28,8 @@ import java.util.function.Supplier; * *

The robot angle controller does not follow the angle given by the trajectory but rather goes * to the angle given in the final state of the trajectory. + * + *

This class is provided by the NewCommands VendorDep */ @SuppressWarnings("MemberName") public class SwerveControllerCommand extends CommandBase { diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/TrapezoidProfileCommand.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/TrapezoidProfileCommand.java index 674328ea23..afc09d3046 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/TrapezoidProfileCommand.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/TrapezoidProfileCommand.java @@ -13,6 +13,8 @@ import java.util.function.Consumer; /** * A command that runs a {@link TrapezoidProfile}. Useful for smoothly controlling mechanism motion. + * + *

This class is provided by the NewCommands VendorDep */ public class TrapezoidProfileCommand extends CommandBase { private final TrapezoidProfile m_profile; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/TrapezoidProfileSubsystem.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/TrapezoidProfileSubsystem.java index 0a6c65877b..547ddf6be4 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/TrapezoidProfileSubsystem.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/TrapezoidProfileSubsystem.java @@ -11,6 +11,8 @@ import edu.wpi.first.math.trajectory.TrapezoidProfile; /** * A subsystem that generates and runs trapezoidal motion profiles automatically. The user specifies * how to use the current state of the motion profile by overriding the `useState` method. + * + *

This class is provided by the NewCommands VendorDep */ public abstract class TrapezoidProfileSubsystem extends SubsystemBase { private final double m_period; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/WaitCommand.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/WaitCommand.java index b2856693b3..e51d23ac0d 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/WaitCommand.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/WaitCommand.java @@ -10,6 +10,8 @@ import edu.wpi.first.wpilibj.Timer; /** * A command that does nothing but takes a specified amount of time to finish. Useful for * CommandGroups. Can also be subclassed to make a command with an internal timer. + * + *

This class is provided by the NewCommands VendorDep */ public class WaitCommand extends CommandBase { protected Timer m_timer = new Timer(); diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/WaitUntilCommand.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/WaitUntilCommand.java index 92283624ad..ace287a614 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/WaitUntilCommand.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/WaitUntilCommand.java @@ -12,6 +12,8 @@ import java.util.function.BooleanSupplier; /** * A command that does nothing but ends after a specified match time or condition. Useful for * CommandGroups. + * + *

This class is provided by the NewCommands VendorDep */ public class WaitUntilCommand extends CommandBase { private final BooleanSupplier m_condition; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/Button.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/Button.java index 0f8594d9f4..a50512fe9a 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/Button.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/Button.java @@ -17,6 +17,8 @@ import java.util.function.BooleanSupplier; *

This class represents a subclass of Trigger that is specifically aimed at buttons on an * operator interface as a common use case of the more generalized Trigger objects. This is a simple * wrapper around Trigger with the method names renamed to fit the Button object use. + * + *

This class is provided by the OldCommands VendorDep */ public class Button extends Trigger { /** diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/InternalButton.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/InternalButton.java index e02f07836c..d856089b52 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/InternalButton.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/InternalButton.java @@ -7,6 +7,8 @@ package edu.wpi.first.wpilibj2.command.button; /** * This class is intended to be used within a program. The programmer can manually set its value. * Also includes a setting for whether or not it should invert its value. + * + *

This class is provided by the NewCommands VendorDep */ public class InternalButton extends Button { private boolean m_pressed; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/JoystickButton.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/JoystickButton.java index c42ab4f5a4..ae4aa1c8bc 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/JoystickButton.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/JoystickButton.java @@ -8,7 +8,11 @@ import static edu.wpi.first.wpilibj.util.ErrorMessages.requireNonNullParam; import edu.wpi.first.wpilibj.GenericHID; -/** A {@link Button} that gets its state from a {@link GenericHID}. */ +/** + * A {@link Button} that gets its state from a {@link GenericHID}. + * + *

This class is provided by the NewCommands VendorDep + */ public class JoystickButton extends Button { private final GenericHID m_joystick; private final int m_buttonNumber; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/NetworkButton.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/NetworkButton.java index ec4f81924f..5c66af64f6 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/NetworkButton.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/NetworkButton.java @@ -8,7 +8,11 @@ import edu.wpi.first.networktables.NetworkTable; import edu.wpi.first.networktables.NetworkTableEntry; import edu.wpi.first.networktables.NetworkTableInstance; -/** A {@link Button} that uses a {@link NetworkTable} boolean field. */ +/** + * A {@link Button} that uses a {@link NetworkTable} boolean field. + * + *

This class is provided by the NewCommands VendorDep + */ public class NetworkButton extends Button { private final NetworkTableEntry m_entry; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/POVButton.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/POVButton.java index bd0c585b12..626ac9b5e3 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/POVButton.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/POVButton.java @@ -8,7 +8,11 @@ import static edu.wpi.first.wpilibj.util.ErrorMessages.requireNonNullParam; import edu.wpi.first.wpilibj.GenericHID; -/** A {@link Button} that gets its state from a POV on a {@link GenericHID}. */ +/** + * A {@link Button} that gets its state from a POV on a {@link GenericHID}. + * + *

This class is provided by the NewCommands VendorDep + */ public class POVButton extends Button { private final GenericHID m_joystick; private final int m_angle; diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/Trigger.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/Trigger.java index 25d253e825..f36aeb2fcd 100644 --- a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/Trigger.java +++ b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/button/Trigger.java @@ -23,6 +23,8 @@ import java.util.function.BooleanSupplier; * (for instance, if they want to react to the user holding a button while the robot is reading a * certain sensor input). For this, they only have to write the {@link Trigger#get()} method to get * the full functionality of the Trigger class. + * + *

This class is provided by the NewCommands VendorDep */ public class Trigger implements BooleanSupplier { private final BooleanSupplier m_isActive; diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/Command.h b/wpilibNewCommands/src/main/native/include/frc2/command/Command.h index 66f4f7e012..a19441b274 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/Command.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/Command.h @@ -42,6 +42,8 @@ class ProxyScheduleCommand; *

Note: ALWAYS create a subclass by extending CommandHelper, * or decorators will not function! * + * This class is provided by the NewCommands VendorDep + * * @see CommandScheduler * @see CommandHelper */ diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/CommandBase.h b/wpilibNewCommands/src/main/native/include/frc2/command/CommandBase.h index 9a498bc49e..9050a127e9 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/CommandBase.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/CommandBase.h @@ -18,6 +18,8 @@ namespace frc2 { /** * A Sendable base class for Commands. + * + * This class is provided by the NewCommands VendorDep */ class CommandBase : public Command, public wpi::Sendable, diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/CommandGroupBase.h b/wpilibNewCommands/src/main/native/include/frc2/command/CommandGroupBase.h index 6a84ee0b79..d7ae4473cc 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/CommandGroupBase.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/CommandGroupBase.h @@ -18,6 +18,8 @@ namespace frc2 { * A base for CommandGroups. Statically tracks commands that have been * allocated to groups to ensure those commands are not also used independently, * which can result in inconsistent command state and unpredictable execution. + * + * This class is provided by the NewCommands VendorDep */ class CommandGroupBase : public CommandBase { public: diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/CommandHelper.h b/wpilibNewCommands/src/main/native/include/frc2/command/CommandHelper.h index 5709f0c423..3c5fd7b6ef 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/CommandHelper.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/CommandHelper.h @@ -17,6 +17,8 @@ namespace frc2 { * *

Note: ALWAYS create a subclass by extending CommandHelper, * or decorators will not function! + * + * This class is provided by the NewCommands VendorDep */ template >> diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/CommandScheduler.h b/wpilibNewCommands/src/main/native/include/frc2/command/CommandScheduler.h index 8976e852d2..e0abd0f4a4 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/CommandScheduler.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/CommandScheduler.h @@ -26,6 +26,8 @@ class Subsystem; * commands synchronously from the main loop. Subsystems should be registered * with the scheduler using RegisterSubsystem() in order for their Periodic() * methods to be called and for their default commands to be scheduled. + * + * This class is provided by the NewCommands VendorDep */ class CommandScheduler final : public nt::NTSendable, public wpi::SendableHelper { diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/CommandState.h b/wpilibNewCommands/src/main/native/include/frc2/command/CommandState.h index 4c731b3d22..e040e4b861 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/CommandState.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/CommandState.h @@ -10,6 +10,8 @@ namespace frc2 { /** * Class that holds scheduling state for a command. Used internally by the * CommandScheduler + * + * This class is provided by the NewCommands VendorDep */ class CommandState final { public: diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/ConditionalCommand.h b/wpilibNewCommands/src/main/native/include/frc2/command/ConditionalCommand.h index 2c37200245..507ce9a1de 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/ConditionalCommand.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/ConditionalCommand.h @@ -29,6 +29,8 @@ namespace frc2 { *

As a rule, CommandGroups require the union of the requirements of their * component commands. * + * This class is provided by the NewCommands VendorDep + * * @see ScheduleCommand */ class ConditionalCommand diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/FunctionalCommand.h b/wpilibNewCommands/src/main/native/include/frc2/command/FunctionalCommand.h index 31b2ada3f9..a4891a4f10 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/FunctionalCommand.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/FunctionalCommand.h @@ -19,6 +19,8 @@ namespace frc2 { * complex commands - note, however, that if a command is beyond a certain * complexity it is usually better practice to write a proper class for it than * to inline it. + * + * This class is provided by the NewCommands VendorDep */ class FunctionalCommand : public CommandHelper { public: diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/InstantCommand.h b/wpilibNewCommands/src/main/native/include/frc2/command/InstantCommand.h index 3aba587e24..c2638da8d1 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/InstantCommand.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/InstantCommand.h @@ -17,6 +17,8 @@ namespace frc2 { * A Command that runs instantly; it will initialize, execute once, and end on * the same iteration of the scheduler. Users can either pass in a Runnable and * a set of requirements, or else subclass this command if desired. + * + * This class is provided by the NewCommands VendorDep */ class InstantCommand : public CommandHelper { public: diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/MecanumControllerCommand.h b/wpilibNewCommands/src/main/native/include/frc2/command/MecanumControllerCommand.h index 29f0fd4203..92c569d768 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/MecanumControllerCommand.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/MecanumControllerCommand.h @@ -47,6 +47,8 @@ namespace frc2 { *

The robot angle controller does not follow the angle given by * the trajectory but rather goes to the angle given in the final state of the * trajectory. + * + * This class is provided by the NewCommands VendorDep */ class MecanumControllerCommand : public CommandHelper { diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/NotifierCommand.h b/wpilibNewCommands/src/main/native/include/frc2/command/NotifierCommand.h index ec68fe7ed5..ec77134361 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/NotifierCommand.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/NotifierCommand.h @@ -24,6 +24,8 @@ namespace frc2 { *

WARNING: Do not use this class unless you are confident in your ability to * make the executed code thread-safe. If you do not know what "thread-safe" * means, that is a good sign that you should not use this class. + * + * This class is provided by the NewCommands VendorDep */ class NotifierCommand : public CommandHelper { public: diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/PIDCommand.h b/wpilibNewCommands/src/main/native/include/frc2/command/PIDCommand.h index 31baf9eb43..a63d55c2b6 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/PIDCommand.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/PIDCommand.h @@ -20,6 +20,8 @@ namespace frc2 { * The controller calculation and output are performed synchronously in the * command's execute() method. * + * This class is provided by the NewCommands VendorDep + * * @see PIDController */ class PIDCommand : public CommandHelper { diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/PIDSubsystem.h b/wpilibNewCommands/src/main/native/include/frc2/command/PIDSubsystem.h index c8a53db3d6..37571adc2f 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/PIDSubsystem.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/PIDSubsystem.h @@ -13,6 +13,8 @@ namespace frc2 { * A subsystem that uses a PIDController to control an output. The controller * is run synchronously from the subsystem's periodic() method. * + * This class is provided by the NewCommands VendorDep + * * @see PIDController */ class PIDSubsystem : public SubsystemBase { diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/ParallelCommandGroup.h b/wpilibNewCommands/src/main/native/include/frc2/command/ParallelCommandGroup.h index 342265acb2..d1f5aa6424 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/ParallelCommandGroup.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/ParallelCommandGroup.h @@ -23,6 +23,8 @@ namespace frc2 { * *

As a rule, CommandGroups require the union of the requirements of their * component commands. + * + * This class is provided by the NewCommands VendorDep */ class ParallelCommandGroup : public CommandHelper { diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/ParallelDeadlineGroup.h b/wpilibNewCommands/src/main/native/include/frc2/command/ParallelDeadlineGroup.h index af78c3b0bd..81d25cb93e 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/ParallelDeadlineGroup.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/ParallelDeadlineGroup.h @@ -24,6 +24,8 @@ namespace frc2 { * *

As a rule, CommandGroups require the union of the requirements of their * component commands. + * + * This class is provided by the NewCommands VendorDep */ class ParallelDeadlineGroup : public CommandHelper { diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/ParallelRaceGroup.h b/wpilibNewCommands/src/main/native/include/frc2/command/ParallelRaceGroup.h index 3ba390711f..0092223771 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/ParallelRaceGroup.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/ParallelRaceGroup.h @@ -23,6 +23,8 @@ namespace frc2 { * *

As a rule, CommandGroups require the union of the requirements of their * component commands. + * + * This class is provided by the NewCommands VendorDep */ class ParallelRaceGroup : public CommandHelper { diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/PerpetualCommand.h b/wpilibNewCommands/src/main/native/include/frc2/command/PerpetualCommand.h index a288ae23b4..4818cdab1f 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/PerpetualCommand.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/PerpetualCommand.h @@ -26,6 +26,8 @@ namespace frc2 { * *

As a rule, CommandGroups require the union of the requirements of their * component commands. + * + * This class is provided by the NewCommands VendorDep */ class PerpetualCommand : public CommandHelper { public: diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/PrintCommand.h b/wpilibNewCommands/src/main/native/include/frc2/command/PrintCommand.h index 536e77f46f..c69a702ac6 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/PrintCommand.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/PrintCommand.h @@ -12,6 +12,8 @@ namespace frc2 { /** * A command that prints a string when initialized. + * + * This class is provided by the NewCommands VendorDep */ class PrintCommand : public CommandHelper { public: diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/ProfiledPIDCommand.h b/wpilibNewCommands/src/main/native/include/frc2/command/ProfiledPIDCommand.h index b02c81d249..48ce6b9b53 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/ProfiledPIDCommand.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/ProfiledPIDCommand.h @@ -22,6 +22,8 @@ namespace frc2 { * class. The controller calculation and output are performed synchronously in * the command's execute() method. * + * This class is provided by the NewCommands VendorDep + * * @see ProfiledPIDController */ template diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/ProfiledPIDSubsystem.h b/wpilibNewCommands/src/main/native/include/frc2/command/ProfiledPIDSubsystem.h index c8639b653e..032ee4b958 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/ProfiledPIDSubsystem.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/ProfiledPIDSubsystem.h @@ -14,6 +14,8 @@ namespace frc2 { * A subsystem that uses a ProfiledPIDController to control an output. The * controller is run synchronously from the subsystem's periodic() method. * + * This class is provided by the NewCommands VendorDep + * * @see ProfiledPIDController */ template diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/ProxyScheduleCommand.h b/wpilibNewCommands/src/main/native/include/frc2/command/ProxyScheduleCommand.h index ad603f941c..afc6f542e8 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/ProxyScheduleCommand.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/ProxyScheduleCommand.h @@ -17,6 +17,8 @@ namespace frc2 { * all the commands are no longer scheduled. Useful for forking off from * CommandGroups. If this command is interrupted, it will cancel all of the * commands. + * + * This class is provided by the NewCommands VendorDep */ class ProxyScheduleCommand : public CommandHelper { diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/RamseteCommand.h b/wpilibNewCommands/src/main/native/include/frc2/command/RamseteCommand.h index 5f8499729d..73c5527215 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/RamseteCommand.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/RamseteCommand.h @@ -37,6 +37,8 @@ namespace frc2 { * secondary constructor that omits the PID and feedforward functionality, * returning only the raw wheel speeds from the RAMSETE controller. * + * This class is provided by the NewCommands VendorDep + * * @see RamseteController * @see Trajectory */ diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/RunCommand.h b/wpilibNewCommands/src/main/native/include/frc2/command/RunCommand.h index 510840ef34..692aff59e6 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/RunCommand.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/RunCommand.h @@ -18,6 +18,8 @@ namespace frc2 { * either subclass it or use Command.WithTimeout() or * Command.WithInterrupt() to give it one. If you only wish * to execute a Runnable once, use InstantCommand. + * + * This class is provided by the NewCommands VendorDep */ class RunCommand : public CommandHelper { public: diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/ScheduleCommand.h b/wpilibNewCommands/src/main/native/include/frc2/command/ScheduleCommand.h index ca476d0779..b099fb3b20 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/ScheduleCommand.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/ScheduleCommand.h @@ -17,6 +17,8 @@ namespace frc2 { * forking off from CommandGroups. Note that if run from a CommandGroup, the * group will not know about the status of the scheduled commands, and will * treat this command as finishing instantly. + * + * This class is provided by the NewCommands VendorDep */ class ScheduleCommand : public CommandHelper { public: diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/SelectCommand.h b/wpilibNewCommands/src/main/native/include/frc2/command/SelectCommand.h index b4e7f898b3..6e1b2bd7f5 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/SelectCommand.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/SelectCommand.h @@ -35,6 +35,8 @@ namespace frc2 { * *

As a rule, CommandGroups require the union of the requirements of their * component commands. + * + * This class is provided by the NewCommands VendorDep */ template class SelectCommand : public CommandHelper> { diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/SequentialCommandGroup.h b/wpilibNewCommands/src/main/native/include/frc2/command/SequentialCommandGroup.h index d80c07b5f2..928af8e493 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/SequentialCommandGroup.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/SequentialCommandGroup.h @@ -29,6 +29,8 @@ const size_t invalid_index = std::numeric_limits::max(); * *

As a rule, CommandGroups require the union of the requirements of their * component commands. + * + * This class is provided by the NewCommands VendorDep */ class SequentialCommandGroup : public CommandHelper { diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/StartEndCommand.h b/wpilibNewCommands/src/main/native/include/frc2/command/StartEndCommand.h index d364696360..908420dff8 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/StartEndCommand.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/StartEndCommand.h @@ -19,6 +19,8 @@ namespace frc2 { * extending and then retracting a solenoid. Has no end condition as-is; either * subclass it or use Command.WithTimeout() or Command.WithInterrupt() to give * it one. + * + * This class is provided by the NewCommands VendorDep */ class StartEndCommand : public CommandHelper { public: diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/Subsystem.h b/wpilibNewCommands/src/main/native/include/frc2/command/Subsystem.h index 4744463221..7ee99505b3 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/Subsystem.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/Subsystem.h @@ -29,6 +29,8 @@ class Command; * SubsystemBase class offers a simple base for user implementations * that handles this. * + * This class is provided by the NewCommands VendorDep + * * @see Command * @see CommandScheduler * @see SubsystemBase diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/SubsystemBase.h b/wpilibNewCommands/src/main/native/include/frc2/command/SubsystemBase.h index 748271a5a0..86fb026fc1 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/SubsystemBase.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/SubsystemBase.h @@ -16,6 +16,8 @@ namespace frc2 { /** * A base for subsystems that handles registration in the constructor, and * provides a more intuitive method for setting the default command. + * + * This class is provided by the NewCommands VendorDep */ class SubsystemBase : public Subsystem, public wpi::Sendable, diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/SwerveControllerCommand.h b/wpilibNewCommands/src/main/native/include/frc2/command/SwerveControllerCommand.h index 9620fef1f3..212beb5d80 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/SwerveControllerCommand.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/SwerveControllerCommand.h @@ -46,6 +46,8 @@ namespace frc2 { *

The robot angle controller does not follow the angle given by * the trajectory but rather goes to the angle given in the final state of the * trajectory. + * + * This class is provided by the NewCommands VendorDep */ template class SwerveControllerCommand diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/TrapezoidProfileCommand.h b/wpilibNewCommands/src/main/native/include/frc2/command/TrapezoidProfileCommand.h index 1d8d2c5936..3a609be52b 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/TrapezoidProfileCommand.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/TrapezoidProfileCommand.h @@ -19,6 +19,8 @@ namespace frc2 { * A command that runs a TrapezoidProfile. Useful for smoothly controlling * mechanism motion. * + * This class is provided by the NewCommands VendorDep + * * @see TrapezoidProfile */ template diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/TrapezoidProfileSubsystem.h b/wpilibNewCommands/src/main/native/include/frc2/command/TrapezoidProfileSubsystem.h index fbebaf3241..abce33ce20 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/TrapezoidProfileSubsystem.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/TrapezoidProfileSubsystem.h @@ -14,6 +14,8 @@ namespace frc2 { * A subsystem that generates and runs trapezoidal motion profiles * automatically. The user specifies how to use the current state of the motion * profile by overriding the `UseState` method. + * + * This class is provided by the NewCommands VendorDep */ template class TrapezoidProfileSubsystem : public SubsystemBase { diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/WaitCommand.h b/wpilibNewCommands/src/main/native/include/frc2/command/WaitCommand.h index 82249c303e..4670d53f71 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/WaitCommand.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/WaitCommand.h @@ -15,6 +15,8 @@ namespace frc2 { * A command that does nothing but takes a specified amount of time to finish. * Useful for CommandGroups. Can also be subclassed to make a command with an * internal timer. + * + * This class is provided by the NewCommands VendorDep */ class WaitCommand : public CommandHelper { public: diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/WaitUntilCommand.h b/wpilibNewCommands/src/main/native/include/frc2/command/WaitUntilCommand.h index ca74218621..3b26999abe 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/WaitUntilCommand.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/WaitUntilCommand.h @@ -15,6 +15,8 @@ namespace frc2 { /** * A command that does nothing but ends after a specified match time or * condition. Useful for CommandGroups. + * + * This class is provided by the NewCommands VendorDep */ class WaitUntilCommand : public CommandHelper { public: diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/button/Button.h b/wpilibNewCommands/src/main/native/include/frc2/command/button/Button.h index bab7a0fb1d..12a5aa7ff5 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/button/Button.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/button/Button.h @@ -18,6 +18,8 @@ class Command; * A class used to bind command scheduling to button presses. Can be composed * with other buttons with the operators in Trigger. * + * This class is provided by the NewCommands VendorDep + * * @see Trigger */ class Button : public Trigger { diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/button/JoystickButton.h b/wpilibNewCommands/src/main/native/include/frc2/command/button/JoystickButton.h index 4cd4689e1c..7d74358be8 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/button/JoystickButton.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/button/JoystickButton.h @@ -12,6 +12,8 @@ namespace frc2 { * A class used to bind command scheduling to joystick button presses. Can be * composed with other buttons with the operators in Trigger. * + * This class is provided by the NewCommands VendorDep + * * @see Trigger */ class JoystickButton : public Button { diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/button/NetworkButton.h b/wpilibNewCommands/src/main/native/include/frc2/command/button/NetworkButton.h index 191e55d8c1..de5044ba0b 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/button/NetworkButton.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/button/NetworkButton.h @@ -15,6 +15,8 @@ namespace frc2 { /** * A Button that uses a NetworkTable boolean field. + * + * This class is provided by the NewCommands VendorDep */ class NetworkButton : public Button { public: diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/button/POVButton.h b/wpilibNewCommands/src/main/native/include/frc2/command/button/POVButton.h index cd8b62cf05..c0f0e6b782 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/button/POVButton.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/button/POVButton.h @@ -12,6 +12,8 @@ namespace frc2 { * A class used to bind command scheduling to joystick POV presses. Can be * composed with other buttons with the operators in Trigger. * + * This class is provided by the NewCommands VendorDep + * * @see Trigger */ class POVButton : public Button { diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/button/Trigger.h b/wpilibNewCommands/src/main/native/include/frc2/command/button/Trigger.h index 8762cab7f0..d5fcb34bc0 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/button/Trigger.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/button/Trigger.h @@ -24,6 +24,8 @@ class Command; * methods are named fairly abstractly; for purpose-specific wrappers, see * Button. * + * This class is provided by the NewCommands VendorDep + * * @see Button */ class Trigger { diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDBase.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDBase.java index 960c80d894..4a5eccc0fa 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDBase.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDBase.java @@ -25,6 +25,8 @@ import java.util.concurrent.locks.ReentrantLock; * and derivative calculations. Therefore, the sample rate affects the controller's behavior for a * given set of PID constants. * + *

This class is provided by the OldCommands VendorDep + * * @deprecated All APIs which use this have been deprecated. */ @Deprecated(since = "2020", forRemoval = true) diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDController.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDController.java index ea7e98da71..98580ef049 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDController.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDController.java @@ -16,6 +16,8 @@ import edu.wpi.first.util.sendable.SendableBuilder; * and derivative calculations. Therefore, the sample rate affects the controller's behavior for a * given set of PID constants. * + *

This class is provided by the OldCommands VendorDep + * * @deprecated Use {@link edu.wpi.first.math.controller.PIDController} instead. */ @Deprecated(since = "2020", forRemoval = true) diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDInterface.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDInterface.java index 0e8b2f1b6d..4e7fd90d91 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDInterface.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDInterface.java @@ -4,6 +4,13 @@ package edu.wpi.first.wpilibj; +/** + * Interface for PID Controller. + * + *

This class is provided by the OldCommands VendorDep + * + * @deprecated All APIs which use this have been deprecated. + */ @Deprecated(since = "2020", forRemoval = true) @SuppressWarnings("SummaryJavadoc") public interface PIDInterface { diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDOutput.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDOutput.java index 52f5a99f83..a330daf8c8 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDOutput.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDOutput.java @@ -7,6 +7,8 @@ package edu.wpi.first.wpilibj; /** * This interface allows PIDController to write it's results to its output. * + *

This class is provided by the OldCommands VendorDep + * * @deprecated Use DoubleConsumer and new PIDController class. */ @FunctionalInterface diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDSource.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDSource.java index c50a988c3c..e582168110 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDSource.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDSource.java @@ -7,6 +7,8 @@ package edu.wpi.first.wpilibj; /** * This interface allows for PIDController to automatically read from this object. * + *

This class is provided by the OldCommands VendorDep + * * @deprecated Use DoubleSupplier and new PIDController class. */ @Deprecated(since = "2020", forRemoval = true) diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDSourceType.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDSourceType.java index 4018ba61d0..3f41eb1924 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDSourceType.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/PIDSourceType.java @@ -4,7 +4,11 @@ package edu.wpi.first.wpilibj; -/** A description for the type of output value to provide to a PIDController. */ +/** + * A description for the type of output value to provide to a PIDController. + * + *

This class is provided by the OldCommands VendorDep + */ @Deprecated(since = "2020", forRemoval = true) public enum PIDSourceType { kDisplacement, diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/Button.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/Button.java index f674be3be8..8347993551 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/Button.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/Button.java @@ -15,6 +15,8 @@ import edu.wpi.first.wpilibj.command.Command; *

This class represents a subclass of Trigger that is specifically aimed at buttons on an * operator interface as a common use case of the more generalized Trigger objects. This is a simple * wrapper around Trigger with the method names renamed to fit the Button object use. + * + *

This class is provided by the OldCommands VendorDep */ public abstract class Button extends Trigger { /** diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/InternalButton.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/InternalButton.java index c77e9aa882..37cf28d9e8 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/InternalButton.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/InternalButton.java @@ -5,8 +5,10 @@ package edu.wpi.first.wpilibj.buttons; /** - * This class is intended to be used within a program. The programmer can manually set its value. - * Also includes a setting for whether or not it should invert its value. + * This {@link Button} is intended to be used within a program. The programmer can manually set its + * value. * Also includes a setting for whether or not it should invert its value. + * + *

This class is provided by the OldCommands VendorDep */ public class InternalButton extends Button { private boolean m_pressed; diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/JoystickButton.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/JoystickButton.java index f7f09e78ed..241683aafd 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/JoystickButton.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/JoystickButton.java @@ -6,7 +6,11 @@ package edu.wpi.first.wpilibj.buttons; import edu.wpi.first.wpilibj.GenericHID; -/** A {@link Button} that gets its state from a {@link GenericHID}. */ +/** + * A {@link Button} that gets its state from a {@link GenericHID}. + * + *

This class is provided by the OldCommands VendorDep + */ public class JoystickButton extends Button { private final GenericHID m_joystick; private final int m_buttonNumber; diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/NetworkButton.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/NetworkButton.java index 1351d16413..dd538bf5f5 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/NetworkButton.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/NetworkButton.java @@ -8,7 +8,11 @@ import edu.wpi.first.networktables.NetworkTable; import edu.wpi.first.networktables.NetworkTableEntry; import edu.wpi.first.networktables.NetworkTableInstance; -/** A {@link Button} that uses a {@link NetworkTable} boolean field. */ +/** + * A {@link Button} that uses a {@link NetworkTable} boolean field. + * + *

This class is provided by the OldCommands VendorDep + */ public class NetworkButton extends Button { private final NetworkTableEntry m_entry; diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/POVButton.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/POVButton.java index 73db913312..a58ba03eae 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/POVButton.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/POVButton.java @@ -6,7 +6,11 @@ package edu.wpi.first.wpilibj.buttons; import edu.wpi.first.wpilibj.GenericHID; -/** A {@link Button} that gets its state from a POV on a {@link GenericHID}. */ +/** + * A {@link Button} that gets its state from a POV on a {@link GenericHID}. + * + *

This class is provided by the OldCommands VendorDep + */ public class POVButton extends Button { private final GenericHID m_joystick; private final int m_angle; diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/Trigger.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/Trigger.java index 22db6f65f6..10240683f7 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/Trigger.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/buttons/Trigger.java @@ -19,6 +19,8 @@ import edu.wpi.first.wpilibj.command.Scheduler; * (for instance, if they want to react to the user holding a button while the robot is reading a * certain sensor input). For this, they only have to write the {@link Trigger#get()} method to get * the full functionality of the Trigger class. + * + *

This class is provided by the OldCommands VendorDep */ public abstract class Trigger implements Sendable { private volatile boolean m_sendablePressed; diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/Command.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/Command.java index 234fed4fc3..8732186953 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/Command.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/Command.java @@ -32,6 +32,8 @@ import java.util.Enumeration; * active command is not interruptible, the other one will not even be started, and the active one * will continue functioning. * + *

This class is provided by the OldCommands VendorDep + * * @see Subsystem * @see CommandGroup * @see IllegalUseOfCommandException diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/CommandGroup.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/CommandGroup.java index 367a862861..10f5066f4d 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/CommandGroup.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/CommandGroup.java @@ -24,6 +24,8 @@ import java.util.Vector; *

CommandGroups can also execute commands in parallel, simply by adding them using {@link * CommandGroup#addParallel(Command) addParallel(...)}. * + *

This class is provided by the OldCommands VendorDep + * * @see Command * @see Subsystem * @see IllegalUseOfCommandException diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/ConditionalCommand.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/ConditionalCommand.java index 80c2903907..79c043d735 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/ConditionalCommand.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/ConditionalCommand.java @@ -22,6 +22,8 @@ import java.util.Enumeration; *

A ConditionalCommand will require the superset of subsystems of the onTrue and onFalse * commands. * + *

This class is provided by the OldCommands VendorDep + * * @see Command * @see Scheduler */ diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/IllegalUseOfCommandException.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/IllegalUseOfCommandException.java index 0579fc7219..833b4fb765 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/IllegalUseOfCommandException.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/IllegalUseOfCommandException.java @@ -13,6 +13,8 @@ package edu.wpi.first.wpilibj.command; *

This exception should be thrown if (after a command has been locked) its requirements change, * it is put into multiple command groups, it is started from outside its command group, or it adds * a new child. + * + *

This class is provided by the OldCommands VendorDep */ @SuppressWarnings("serial") public class IllegalUseOfCommandException extends RuntimeException { diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/InstantCommand.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/InstantCommand.java index d40f626a40..42278f6087 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/InstantCommand.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/InstantCommand.java @@ -9,6 +9,8 @@ package edu.wpi.first.wpilibj.command; * *

Subclassing {@link InstantCommand} is shorthand for returning true from {@link Command * isFinished}. + * + *

This class is provided by the OldCommands VendorDep */ public class InstantCommand extends Command { private Runnable m_func; diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/LinkedListElement.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/LinkedListElement.java index 365667a2ad..b657ba7a9a 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/LinkedListElement.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/LinkedListElement.java @@ -4,7 +4,11 @@ package edu.wpi.first.wpilibj.command; -/** An element that is in a LinkedList. */ +/** + * An element that is in a LinkedList. + * + *

This class is provided by the OldCommands VendorDep + */ class LinkedListElement { private LinkedListElement m_next; private LinkedListElement m_previous; diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/PIDCommand.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/PIDCommand.java index 03343163f8..1f63267db9 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/PIDCommand.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/PIDCommand.java @@ -16,6 +16,8 @@ import edu.wpi.first.wpilibj.PIDSourceType; *

It provides some convenience methods to run an internal {@link PIDController} . It will also * start and stop said {@link PIDController} when the {@link PIDCommand} is first initialized and * ended/interrupted. + * + *

This class is provided by the OldCommands VendorDep */ public abstract class PIDCommand extends Command { /** The internal {@link PIDController}. */ diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/PIDSubsystem.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/PIDSubsystem.java index bf70f91f70..2fa18f1887 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/PIDSubsystem.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/PIDSubsystem.java @@ -16,6 +16,8 @@ import edu.wpi.first.wpilibj.PIDSourceType; * *

It provides some convenience methods to run an internal {@link PIDController} . It also allows * access to the internal {@link PIDController} in order to give total control to the programmer. + * + *

This class is provided by the OldCommands VendorDep */ public abstract class PIDSubsystem extends Subsystem { /** The internal {@link PIDController}. */ diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/PrintCommand.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/PrintCommand.java index 5013b1bfee..d8cbd9dc66 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/PrintCommand.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/PrintCommand.java @@ -8,6 +8,8 @@ package edu.wpi.first.wpilibj.command; * A {@link PrintCommand} is a command which prints out a string when it is initialized, and then * immediately finishes. It is useful if you want a {@link CommandGroup} to print out a string when * it reaches a certain point. + * + *

This class is provided by the OldCommands VendorDep */ public class PrintCommand extends InstantCommand { /** The message to print out. */ diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/Scheduler.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/Scheduler.java index ca1ed330c7..351ae99ce3 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/Scheduler.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/Scheduler.java @@ -28,6 +28,8 @@ import java.util.Vector; * Scheduler#run() run()} often to have {@link Command Commands} function correctly. However, this * is already done for you if you use the CommandBased Robot template. * + *

This class is provided by the OldCommands VendorDep + * * @see Command */ public final class Scheduler implements NTSendable, AutoCloseable { diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/Set.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/Set.java index d47f16f0e9..91180eba53 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/Set.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/Set.java @@ -8,7 +8,11 @@ import java.util.Enumeration; import java.util.Vector; @SuppressWarnings("all") -/** A set. */ +/** + * A set. + * + *

This class is provided by the OldCommands VendorDep + */ class Set { private Vector m_set = new Vector(); diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/StartCommand.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/StartCommand.java index 56b41502b6..ba6cec416e 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/StartCommand.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/StartCommand.java @@ -7,6 +7,8 @@ package edu.wpi.first.wpilibj.command; /** * A {@link StartCommand} will call the {@link Command#start() start()} method of another command * when it is initialized and will finish immediately. + * + *

This class is provided by the OldCommands VendorDep */ public class StartCommand extends InstantCommand { /** The command to fork. */ diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/Subsystem.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/Subsystem.java index 2ba01af3bf..df5984b572 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/Subsystem.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/Subsystem.java @@ -12,15 +12,17 @@ import java.util.Collections; /** * This class defines a major component of the robot. * - *

A good example of a subsystem is the driveline, or a claw if the robot has one. + *

A good example of a subsystem is the drivetrain, or a claw if the robot has one. * *

All motors should be a part of a subsystem. For instance, all the wheel motors should be a - * part of some kind of "Driveline" subsystem. + * part of some kind of "Drivetrain" subsystem. * *

Subsystems are used within the command system as requirements for {@link Command}. Only one * command which requires a subsystem can run at a time. Also, subsystems can have default commands * which are started if there is no command running which requires this subsystem. * + *

This class is provided by the OldCommands VendorDep + * * @see Command */ public abstract class Subsystem implements Sendable, AutoCloseable { diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/TimedCommand.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/TimedCommand.java index 36e651b85a..70fb087350 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/TimedCommand.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/TimedCommand.java @@ -7,6 +7,8 @@ package edu.wpi.first.wpilibj.command; /** * A {@link TimedCommand} will wait for a timeout before finishing. {@link TimedCommand} is used to * execute a command for a given amount of time. + * + *

This class is provided by the OldCommands VendorDep */ public class TimedCommand extends Command { /** diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/WaitCommand.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/WaitCommand.java index a541944b1a..b19a959573 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/WaitCommand.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/WaitCommand.java @@ -8,6 +8,8 @@ package edu.wpi.first.wpilibj.command; * A {@link WaitCommand} will wait for a certain amount of time before finishing. It is useful if * you want a {@link CommandGroup} to pause for a moment. * + *

This class is provided by the OldCommands VendorDep + * * @see CommandGroup */ public class WaitCommand extends TimedCommand { diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/WaitForChildren.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/WaitForChildren.java index 23e21d35b4..5b24c5a9e4 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/WaitForChildren.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/WaitForChildren.java @@ -11,6 +11,8 @@ package edu.wpi.first.wpilibj.command; * *

This class is useful for the situation where you want to allow anything running in parallel to * finish, before continuing in the main {@link CommandGroup} sequence. + * + *

This class is provided by the OldCommands VendorDep */ public class WaitForChildren extends Command { @Override diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/WaitUntilCommand.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/WaitUntilCommand.java index b7226bd7e1..7f617ebc7c 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/WaitUntilCommand.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/command/WaitUntilCommand.java @@ -9,6 +9,8 @@ import edu.wpi.first.wpilibj.Timer; /** * WaitUntilCommand - waits until an absolute game time. This will wait until the game clock reaches * some value, then continue to the next command. + * + *

This class is provided by the OldCommands VendorDep */ public class WaitUntilCommand extends Command { private final double m_time; diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDAnalogAccelerometer.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDAnalogAccelerometer.java index 0ee0fd0a57..22a0611e87 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDAnalogAccelerometer.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDAnalogAccelerometer.java @@ -12,6 +12,8 @@ import edu.wpi.first.wpilibj.PIDSourceType; /** * Wrapper so that PIDSource is implemented for AnalogAccelerometer for old PIDController. * + *

This class is provided by the OldCommands VendorDep + * * @deprecated Use {@link edu.wpi.first.math.controller.PIDController} which doesn't require this * wrapper. */ diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDAnalogGyro.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDAnalogGyro.java index e96279b1eb..9881657606 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDAnalogGyro.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDAnalogGyro.java @@ -12,6 +12,8 @@ import edu.wpi.first.wpilibj.PIDSourceType; /** * Wrapper so that PIDSource is implemented for AnalogGyro for old PIDController. * + *

This class is provided by the OldCommands VendorDep + * * @deprecated Use {@link edu.wpi.first.math.controller.PIDController} which doesn't require this * wrapper. */ diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDAnalogInput.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDAnalogInput.java index e64638470b..797be71d39 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDAnalogInput.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDAnalogInput.java @@ -11,6 +11,8 @@ import edu.wpi.first.wpilibj.PIDSourceType; /** * Wrapper so that PIDSource is implemented for AnalogInput for old PIDController. * + *

This class is provided by the OldCommands VendorDep + * * @deprecated Use {@link edu.wpi.first.math.controller.PIDController} which doesn't require this * wrapper. */ diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDAnalogPotentiometer.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDAnalogPotentiometer.java index b4a38abd73..f905e5a6e7 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDAnalogPotentiometer.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDAnalogPotentiometer.java @@ -12,6 +12,8 @@ import edu.wpi.first.wpilibj.PIDSourceType; /** * Wrapper so that PIDSource is implemented for AnalogPotentiometer for old PIDController. * + *

This class is provided by the OldCommands VendorDep + * * @deprecated Use {@link edu.wpi.first.math.controller.PIDController} which doesn't require this * wrapper. */ diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDEncoder.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDEncoder.java index 6c5f8dc26e..67c3ed198b 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDEncoder.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDEncoder.java @@ -12,6 +12,8 @@ import edu.wpi.first.wpilibj.PIDSourceType; /** * Wrapper so that PIDSource is implemented for Encoder for old PIDController. * + *

This class is provided by the OldCommands VendorDep + * * @deprecated Use {@link edu.wpi.first.math.controller.PIDController} which doesn't require this * wrapper. */ diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDMotorController.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDMotorController.java index 45ed652a90..11d033bb2c 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDMotorController.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDMotorController.java @@ -12,6 +12,8 @@ import edu.wpi.first.wpilibj.motorcontrol.MotorController; /** * Wrapper so that PIDOutput is implemented for MotorController for old PIDController. * + *

This class is provided by the OldCommands VendorDep + * * @deprecated Use {@link edu.wpi.first.math.controller.PIDController} which doesn't require this * wrapper. */ diff --git a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDUltrasonic.java b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDUltrasonic.java index 050912d570..e542b6825d 100644 --- a/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDUltrasonic.java +++ b/wpilibOldCommands/src/main/java/edu/wpi/first/wpilibj/pidwrappers/PIDUltrasonic.java @@ -13,6 +13,8 @@ import edu.wpi.first.wpilibj.Ultrasonic; /** * Wrapper so that PIDSource is implemented for Ultrasonic for old PIDController. * + *

This class is provided by the OldCommands VendorDep + * * @deprecated Use {@link edu.wpi.first.math.controller.PIDController} which doesn't require this * wrapper. */ diff --git a/wpilibOldCommands/src/main/native/include/frc/PIDBase.h b/wpilibOldCommands/src/main/native/include/frc/PIDBase.h index e834006a24..8c72ae77dc 100644 --- a/wpilibOldCommands/src/main/native/include/frc/PIDBase.h +++ b/wpilibOldCommands/src/main/native/include/frc/PIDBase.h @@ -30,6 +30,8 @@ namespace frc { * in the integral and derivative calculations. Therefore, the sample rate * affects the controller's behavior for a given set of PID constants. * + * This class is provided by the OldCommands VendorDep + * * @deprecated All APIs which use this have been deprecated. */ class PIDBase : public PIDInterface, diff --git a/wpilibOldCommands/src/main/native/include/frc/PIDController.h b/wpilibOldCommands/src/main/native/include/frc/PIDController.h index 763752de15..224c5e9dbc 100644 --- a/wpilibOldCommands/src/main/native/include/frc/PIDController.h +++ b/wpilibOldCommands/src/main/native/include/frc/PIDController.h @@ -30,6 +30,8 @@ class PIDOutput; * in the integral and derivative calculations. Therefore, the sample rate * affects the controller's behavior for a given set of PID constants. * + * This class is provided by the OldCommands VendorDep + * * @deprecated Use frc2::PIDController class instead. */ class PIDController : public PIDBase, public Controller { diff --git a/wpilibOldCommands/src/main/native/include/frc/PIDInterface.h b/wpilibOldCommands/src/main/native/include/frc/PIDInterface.h index 20d26ef6bd..7af3ec6bc3 100644 --- a/wpilibOldCommands/src/main/native/include/frc/PIDInterface.h +++ b/wpilibOldCommands/src/main/native/include/frc/PIDInterface.h @@ -11,6 +11,8 @@ namespace frc { /** * Interface for PID Control Loop. * + * This class is provided by the OldCommands VendorDep + * * @deprecated All APIs which use this have been deprecated. */ class PIDInterface { diff --git a/wpilibOldCommands/src/main/native/include/frc/PIDOutput.h b/wpilibOldCommands/src/main/native/include/frc/PIDOutput.h index 98c4af4bcc..3e1e780709 100644 --- a/wpilibOldCommands/src/main/native/include/frc/PIDOutput.h +++ b/wpilibOldCommands/src/main/native/include/frc/PIDOutput.h @@ -9,8 +9,10 @@ namespace frc { /** * PIDOutput interface is a generic output for the PID class. * - * PWMs use this class. Users implement this interface to allow for a - * PIDController to read directly from the inputs. + * MotorControllers use this class. Users implement this interface to allow for + * a PIDController to read directly from the inputs. + * + * This class is provided by the OldCommands VendorDep */ class PIDOutput { public: diff --git a/wpilibOldCommands/src/main/native/include/frc/PIDSource.h b/wpilibOldCommands/src/main/native/include/frc/PIDSource.h index 3f6ca23e1f..52990a1e42 100644 --- a/wpilibOldCommands/src/main/native/include/frc/PIDSource.h +++ b/wpilibOldCommands/src/main/native/include/frc/PIDSource.h @@ -13,6 +13,8 @@ enum class PIDSourceType { kDisplacement, kRate }; * * All sensors that can be used with the PID class will implement the PIDSource * that returns a standard value that will be used in the PID code. + * + * This class is provided by the OldCommands VendorDep */ class PIDSource { public: diff --git a/wpilibOldCommands/src/main/native/include/frc/buttons/Button.h b/wpilibOldCommands/src/main/native/include/frc/buttons/Button.h index 89e2b41523..51fe09802c 100644 --- a/wpilibOldCommands/src/main/native/include/frc/buttons/Button.h +++ b/wpilibOldCommands/src/main/native/include/frc/buttons/Button.h @@ -19,6 +19,8 @@ namespace frc { * buttons on an operator interface as a common use case of the more generalized * Trigger objects. This is a simple wrapper around Trigger with the method * names renamed to fit the Button object use. + * + * This class is provided by the OldCommands VendorDep */ class Button : public Trigger { public: diff --git a/wpilibOldCommands/src/main/native/include/frc/buttons/InternalButton.h b/wpilibOldCommands/src/main/native/include/frc/buttons/InternalButton.h index e9c1fb1a78..05c8348263 100644 --- a/wpilibOldCommands/src/main/native/include/frc/buttons/InternalButton.h +++ b/wpilibOldCommands/src/main/native/include/frc/buttons/InternalButton.h @@ -8,6 +8,13 @@ namespace frc { +/** + * This Button is intended to be used within a program. The programmer can + * manually set its value. Also includes a setting for whether or not it should + * invert its value. + * + * This class is provided by the OldCommands VendorDep + */ class InternalButton : public Button { public: InternalButton() = default; diff --git a/wpilibOldCommands/src/main/native/include/frc/buttons/JoystickButton.h b/wpilibOldCommands/src/main/native/include/frc/buttons/JoystickButton.h index 24900b4bd1..7e92cc1a63 100644 --- a/wpilibOldCommands/src/main/native/include/frc/buttons/JoystickButton.h +++ b/wpilibOldCommands/src/main/native/include/frc/buttons/JoystickButton.h @@ -9,6 +9,11 @@ namespace frc { +/** + * A Button} that gets its state from a GenericHID. + * + * This class is provided by the OldCommands VendorDep + */ class JoystickButton : public Button { public: JoystickButton(GenericHID* joystick, int buttonNumber); diff --git a/wpilibOldCommands/src/main/native/include/frc/buttons/NetworkButton.h b/wpilibOldCommands/src/main/native/include/frc/buttons/NetworkButton.h index 3c468df72c..e277230557 100644 --- a/wpilibOldCommands/src/main/native/include/frc/buttons/NetworkButton.h +++ b/wpilibOldCommands/src/main/native/include/frc/buttons/NetworkButton.h @@ -14,6 +14,11 @@ namespace frc { +/** + * A that uses a NetworkTable boolean field. + * + *

This class is provided by the OldCommands VendorDep + */ class NetworkButton : public Button { public: NetworkButton(std::string_view tableName, std::string_view field); diff --git a/wpilibOldCommands/src/main/native/include/frc/buttons/POVButton.h b/wpilibOldCommands/src/main/native/include/frc/buttons/POVButton.h index 87e1789dbc..72ff50a8ad 100644 --- a/wpilibOldCommands/src/main/native/include/frc/buttons/POVButton.h +++ b/wpilibOldCommands/src/main/native/include/frc/buttons/POVButton.h @@ -8,6 +8,12 @@ #include "frc/buttons/Button.h" namespace frc { + +/** + * A Button that gets its state from a POV on a GenericHID. + * + *

This class is provided by the OldCommands VendorDep + */ class POVButton : public Button { public: /** diff --git a/wpilibOldCommands/src/main/native/include/frc/buttons/Trigger.h b/wpilibOldCommands/src/main/native/include/frc/buttons/Trigger.h index 966a29f80f..4edceaa10b 100644 --- a/wpilibOldCommands/src/main/native/include/frc/buttons/Trigger.h +++ b/wpilibOldCommands/src/main/native/include/frc/buttons/Trigger.h @@ -25,6 +25,8 @@ class Command; * a button while the robot is reading a certain sensor input). For this, they * only have to write the Trigger::Get() method to get the full functionality of * the Trigger class. + * + * This class is provided by the OldCommands VendorDep */ class Trigger : public wpi::Sendable, public wpi::SendableHelper { public: diff --git a/wpilibOldCommands/src/main/native/include/frc/commands/Command.h b/wpilibOldCommands/src/main/native/include/frc/commands/Command.h index aa20134e96..3e43cff1c2 100644 --- a/wpilibOldCommands/src/main/native/include/frc/commands/Command.h +++ b/wpilibOldCommands/src/main/native/include/frc/commands/Command.h @@ -40,6 +40,8 @@ class CommandGroup; * other one will not even be started, and the active one will continue * functioning. * + * This class is provided by the OldCommands VendorDep + * * * @see CommandGroup * @see Subsystem */ diff --git a/wpilibOldCommands/src/main/native/include/frc/commands/CommandGroup.h b/wpilibOldCommands/src/main/native/include/frc/commands/CommandGroup.h index 016f7007cc..f48ddbfa1d 100644 --- a/wpilibOldCommands/src/main/native/include/frc/commands/CommandGroup.h +++ b/wpilibOldCommands/src/main/native/include/frc/commands/CommandGroup.h @@ -28,6 +28,8 @@ namespace frc { * CommandGroups can also execute commands in parallel, simply by adding them * using AddParallel(). * + * This class is provided by the OldCommands VendorDep + * * @see Command * @see Subsystem */ diff --git a/wpilibOldCommands/src/main/native/include/frc/commands/ConditionalCommand.h b/wpilibOldCommands/src/main/native/include/frc/commands/ConditionalCommand.h index 19d6d755fd..46e73cb23b 100644 --- a/wpilibOldCommands/src/main/native/include/frc/commands/ConditionalCommand.h +++ b/wpilibOldCommands/src/main/native/include/frc/commands/ConditionalCommand.h @@ -26,6 +26,8 @@ namespace frc { * A ConditionalCommand will require the superset of subsystems of the onTrue * and onFalse commands. * + * This class is provided by the OldCommands VendorDep + * * @see Command * @see Scheduler */ diff --git a/wpilibOldCommands/src/main/native/include/frc/commands/InstantCommand.h b/wpilibOldCommands/src/main/native/include/frc/commands/InstantCommand.h index d16b34e582..f1683eb42f 100644 --- a/wpilibOldCommands/src/main/native/include/frc/commands/InstantCommand.h +++ b/wpilibOldCommands/src/main/native/include/frc/commands/InstantCommand.h @@ -16,6 +16,8 @@ namespace frc { * This command will execute once, then finish immediately afterward. * * Subclassing InstantCommand is shorthand for returning true from IsFinished(). + * + * This class is provided by the OldCommands VendorDep */ class InstantCommand : public Command { public: diff --git a/wpilibOldCommands/src/main/native/include/frc/commands/PIDCommand.h b/wpilibOldCommands/src/main/native/include/frc/commands/PIDCommand.h index 7eb85ec4fc..ba8aa6eaa4 100644 --- a/wpilibOldCommands/src/main/native/include/frc/commands/PIDCommand.h +++ b/wpilibOldCommands/src/main/native/include/frc/commands/PIDCommand.h @@ -14,6 +14,15 @@ namespace frc { +/** + * This class defines aCommand which interacts heavily with a PID loop. + * + * It provides some convenience methods to run an internal PIDController . It + * will also start and stop said PIDController when the PIDCommand is first + * initialized and ended/interrupted. + * + * This class is provided by the OldCommands VendorDep + */ class PIDCommand : public Command, public PIDOutput, public PIDSource { public: PIDCommand(std::string_view name, double p, double i, double d); diff --git a/wpilibOldCommands/src/main/native/include/frc/commands/PIDSubsystem.h b/wpilibOldCommands/src/main/native/include/frc/commands/PIDSubsystem.h index 6339c26999..b66ad38f53 100644 --- a/wpilibOldCommands/src/main/native/include/frc/commands/PIDSubsystem.h +++ b/wpilibOldCommands/src/main/native/include/frc/commands/PIDSubsystem.h @@ -22,6 +22,8 @@ namespace frc { * It provides some convenience methods to run an internal PIDController. It * also allows access to the internal PIDController in order to give total * control to the programmer. + * + * This class is provided by the OldCommands VendorDep */ class PIDSubsystem : public Subsystem, public PIDOutput, public PIDSource { public: diff --git a/wpilibOldCommands/src/main/native/include/frc/commands/PrintCommand.h b/wpilibOldCommands/src/main/native/include/frc/commands/PrintCommand.h index 01d0d4bbb1..b72b4c9d44 100644 --- a/wpilibOldCommands/src/main/native/include/frc/commands/PrintCommand.h +++ b/wpilibOldCommands/src/main/native/include/frc/commands/PrintCommand.h @@ -11,6 +11,13 @@ namespace frc { +/** + * A PrintCommand is a command which prints out a string when it is initialized, + * and then immediately finishes. It is useful if you want a CommandGroup to + * print out a string when it reaches a certain point. + * + * This class is provided by the OldCommands VendorDep + */ class PrintCommand : public InstantCommand { public: explicit PrintCommand(std::string_view message); diff --git a/wpilibOldCommands/src/main/native/include/frc/commands/Scheduler.h b/wpilibOldCommands/src/main/native/include/frc/commands/Scheduler.h index ad82f63dfd..1c67df3c50 100644 --- a/wpilibOldCommands/src/main/native/include/frc/commands/Scheduler.h +++ b/wpilibOldCommands/src/main/native/include/frc/commands/Scheduler.h @@ -15,6 +15,18 @@ class ButtonScheduler; class Command; class Subsystem; +/** + * The Scheduler is a singleton which holds the top-level running commands. It + * is in charge of both calling the command's run() method and to make sure that + * there are no two commands with conflicting requirements running. + * + * It is fine if teams wish to take control of the Scheduler themselves, all + * that needs to be done is to call frc::Scheduler::getInstance()->run() often + * to have Commands function correctly. However, this is already done for you if + * you use the CommandBased Robot template. + * + * This class is provided by the OldCommands VendorDep + */ class Scheduler : public nt::NTSendable, public wpi::SendableHelper { public: /** diff --git a/wpilibOldCommands/src/main/native/include/frc/commands/StartCommand.h b/wpilibOldCommands/src/main/native/include/frc/commands/StartCommand.h index a58c0587c4..2186fe5924 100644 --- a/wpilibOldCommands/src/main/native/include/frc/commands/StartCommand.h +++ b/wpilibOldCommands/src/main/native/include/frc/commands/StartCommand.h @@ -8,6 +8,13 @@ namespace frc { +/** + * A PrintCommand is a command which prints out a string when it is initialized, + * and then immediately finishes. It is useful if you want a CommandGroup to + * print out a string when it reaches a certain point. + * + * This class is provided by the OldCommands VendorDep + */ class StartCommand : public InstantCommand { public: explicit StartCommand(Command* commandToStart); diff --git a/wpilibOldCommands/src/main/native/include/frc/commands/Subsystem.h b/wpilibOldCommands/src/main/native/include/frc/commands/Subsystem.h index 8c18d5c66d..6357f0cee3 100644 --- a/wpilibOldCommands/src/main/native/include/frc/commands/Subsystem.h +++ b/wpilibOldCommands/src/main/native/include/frc/commands/Subsystem.h @@ -15,6 +15,22 @@ namespace frc { class Command; +/** + * This class defines a major component of the robot. + * + * A good example of a subsystem is the drivetrain, or a claw if the robot has + * one. + * + * All motors should be a part of a subsystem. For instance, all the wheel + * motors should be a part of some kind of "Drivetrain" subsystem. + * + * Subsystems are used within the command system as requirements for Command. + * Only one command which requires a subsystem can run at a time. Also, + * subsystems can have default commands which are started if there is no command + * running which requires this subsystem. + * + * This class is provided by the OldCommands VendorDep + */ class Subsystem : public wpi::Sendable, public wpi::SendableHelper { friend class Scheduler; diff --git a/wpilibOldCommands/src/main/native/include/frc/commands/TimedCommand.h b/wpilibOldCommands/src/main/native/include/frc/commands/TimedCommand.h index 17eb4f49cb..912bcec0d0 100644 --- a/wpilibOldCommands/src/main/native/include/frc/commands/TimedCommand.h +++ b/wpilibOldCommands/src/main/native/include/frc/commands/TimedCommand.h @@ -16,6 +16,8 @@ namespace frc { * A TimedCommand will wait for a timeout before finishing. * * TimedCommand is used to execute a command for a given amount of time. + * + * This class is provided by the OldCommands VendorDep */ class TimedCommand : public Command { public: diff --git a/wpilibOldCommands/src/main/native/include/frc/commands/WaitCommand.h b/wpilibOldCommands/src/main/native/include/frc/commands/WaitCommand.h index 3902fb6b77..9f4090b091 100644 --- a/wpilibOldCommands/src/main/native/include/frc/commands/WaitCommand.h +++ b/wpilibOldCommands/src/main/native/include/frc/commands/WaitCommand.h @@ -12,6 +12,12 @@ namespace frc { +/** + * A WaitCommand will wait for a certain amount of time before finishing. It is + * useful if you want a CommandGroup to pause for a moment. + * + * This class is provided by the OldCommands VendorDep + */ class WaitCommand : public TimedCommand { public: /** diff --git a/wpilibOldCommands/src/main/native/include/frc/commands/WaitForChildren.h b/wpilibOldCommands/src/main/native/include/frc/commands/WaitForChildren.h index b92d78d596..775826bcd7 100644 --- a/wpilibOldCommands/src/main/native/include/frc/commands/WaitForChildren.h +++ b/wpilibOldCommands/src/main/native/include/frc/commands/WaitForChildren.h @@ -12,6 +12,18 @@ namespace frc { +/** + * This command will only finish if whatever CommandGroup it is in has no active + * children. If it is not a part of a CommandGroup, then it will finish + * immediately. If it is itself an active child, then the CommandGroup will + * never end. + * + * This class is useful for the situation where you want to allow anything + * running in parallel to finish, before continuing in the main CommandGroup + * sequence. + * + * This class is provided by the OldCommands VendorDep + */ class WaitForChildren : public Command { public: explicit WaitForChildren(units::second_t timeout); diff --git a/wpilibOldCommands/src/main/native/include/frc/commands/WaitUntilCommand.h b/wpilibOldCommands/src/main/native/include/frc/commands/WaitUntilCommand.h index 715e7bb0a0..e9a5cba336 100644 --- a/wpilibOldCommands/src/main/native/include/frc/commands/WaitUntilCommand.h +++ b/wpilibOldCommands/src/main/native/include/frc/commands/WaitUntilCommand.h @@ -12,16 +12,18 @@ namespace frc { +/** + * A WaitCommand will wait until a certain match time before finishing. + * + * This will wait until the game clock reaches some value, then continue to + * the next command. + * + * This class is provided by the OldCommands VendorDep + * + * @see CommandGroup + */ class WaitUntilCommand : public Command { public: - /** - * A WaitCommand will wait until a certain match time before finishing. - * - * This will wait until the game clock reaches some value, then continue to - * the next command. - * - * @see CommandGroup - */ explicit WaitUntilCommand(units::second_t time); WaitUntilCommand(std::string_view name, units::second_t time); diff --git a/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDAnalogAccelerometer.h b/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDAnalogAccelerometer.h index 45a5b44ade..d7c0ce8926 100644 --- a/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDAnalogAccelerometer.h +++ b/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDAnalogAccelerometer.h @@ -13,6 +13,8 @@ namespace frc { * Wrapper so that PIDSource is implemented for AnalogAccelerometer for old * PIDController * + * This class is provided by the OldCommands VendorDep + * * @deprecated Use frc2::PIDController class instead which doesn't require this * wrapper. */ diff --git a/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDAnalogGyro.h b/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDAnalogGyro.h index 43d32b5985..dc73f1e614 100644 --- a/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDAnalogGyro.h +++ b/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDAnalogGyro.h @@ -12,6 +12,8 @@ namespace frc { /** * Wrapper so that PIDSource is implemented for AnalogGyro for old PIDController * + * This class is provided by the OldCommands VendorDep + * * @deprecated Use frc2::PIDController class instead which doesn't require this * wrapper. */ diff --git a/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDAnalogInput.h b/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDAnalogInput.h index cca49ce7e4..ae34e1cdb3 100644 --- a/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDAnalogInput.h +++ b/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDAnalogInput.h @@ -13,6 +13,8 @@ namespace frc { * Wrapper so that PIDSource is implemented for AnalogInput for old * PIDController * + * This class is provided by the OldCommands VendorDep + * * @deprecated Use frc2::PIDController class instead which doesn't require this * wrapper. */ diff --git a/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDAnalogPotentiometer.h b/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDAnalogPotentiometer.h index f1b5016efd..cd77b9e348 100644 --- a/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDAnalogPotentiometer.h +++ b/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDAnalogPotentiometer.h @@ -13,6 +13,7 @@ namespace frc { * Wrapper so that PIDSource is implemented for AnalogPotentiometer for old * PIDController * + * This class is provided by the OldCommands VendorDep * * @deprecated Use frc2::PIDController class instead which doesn't require this * wrapper. diff --git a/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDEncoder.h b/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDEncoder.h index 42fd36df58..4e6d5c3a2e 100644 --- a/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDEncoder.h +++ b/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDEncoder.h @@ -12,6 +12,8 @@ namespace frc { /** * Wrapper so that PIDSource is implemented for Encoder for old PIDController * + * This class is provided by the OldCommands VendorDep + * * @deprecated Use frc2::PIDController class instead which doesn't require this * wrapper. */ diff --git a/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDMotorController.h b/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDMotorController.h index 2bc4fef748..547264b592 100644 --- a/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDMotorController.h +++ b/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDMotorController.h @@ -16,6 +16,8 @@ namespace frc { * Wrapper so that PIDOutput is implemented for MotorController for old * PIDController * + * This class is provided by the OldCommands VendorDep + * * @deprecated Use frc2::PIDController class instead which doesn't require this * wrapper. */ diff --git a/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDUltrasonic.h b/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDUltrasonic.h index e9f8c592ab..d3b9fc8689 100644 --- a/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDUltrasonic.h +++ b/wpilibOldCommands/src/main/native/include/frc/pidwrappers/PIDUltrasonic.h @@ -12,6 +12,8 @@ namespace frc { /** * Wrapper so that PIDSource is implemented for Ultrasonic for old PIDController * + * This class is provided by the OldCommands VendorDep + * * @deprecated Use frc2::PIDController class instead which doesn't require this * wrapper. */